mod-sms-proxy

Proxy SMS Service that support extension

License

License

GroupId

GroupId

fr.wseduc
ArtifactId

ArtifactId

mod-sms-proxy
Last Version

Last Version

0.1.1
Release Date

Release Date

Type

Type

jar
Description

Description

mod-sms-proxy
Proxy SMS Service that support extension
Project URL

Project URL

https://github.com/web-education/mod-sms-sender
Source Code Management

Source Code Management

https://github.com/web-education/mod-sms-sender.git

Download mod-sms-proxy

How to add to project

<!-- https://jarcasting.com/artifacts/fr.wseduc/mod-sms-proxy/ -->
<dependency>
    <groupId>fr.wseduc</groupId>
    <artifactId>mod-sms-proxy</artifactId>
    <version>0.1.1</version>
</dependency>
// https://jarcasting.com/artifacts/fr.wseduc/mod-sms-proxy/
implementation 'fr.wseduc:mod-sms-proxy:0.1.1'
// https://jarcasting.com/artifacts/fr.wseduc/mod-sms-proxy/
implementation ("fr.wseduc:mod-sms-proxy:0.1.1")
'fr.wseduc:mod-sms-proxy:jar:0.1.1'
<dependency org="fr.wseduc" name="mod-sms-proxy" rev="0.1.1">
  <artifact name="mod-sms-proxy" type="jar" />
</dependency>
@Grapes(
@Grab(group='fr.wseduc', module='mod-sms-proxy', version='0.1.1')
)
libraryDependencies += "fr.wseduc" % "mod-sms-proxy" % "0.1.1"
[fr.wseduc/mod-sms-proxy "0.1.1"]

Dependencies

test (2)

Group / Artifact Type Version
junit : junit jar 4.10
io.vertx : testtools jar 2.0.0-final

Project Modules

There are no modules declared in this project.

Vertx sms-proxy

This vert.x module can be used to send sms using various sms provders.

Usage

This module registers itself on the vert.x bus and waits for a Message<JsonObject>. Its address is "entcore.sms" by default, this can be changed by defining the field "sms-address" in the module configuration file.

Below is a short description of the json message syntax :

{
    "action" -> Action field, describes which action to perform
                List of all available actions :
                  - "send-sms" : sends a text message.
                  - "get-info" : retrieves the sms account information
    "provider" -> Provider name
    "parameters" -> JsonObject, used by each implementation differently. (depends on the action)

}

Providers

OVH

Specific json configuration :

{
    "main":"fr.wseduc.smsproxy.sms.Sms",
    "providers"{
        "OVH": {
            "applicationKey": "",
            "applicationSecret": "",
            "consumerKey": ""
        }
    }
}

Check the following link for more details on the API : OVH API

fr.wseduc

Open Digital Education

Startup EdTech, notre vocation est de concevoir des solutions qui font évoluer les pratiques pédagogiques et favorisent la réussite scolaire

Versions

Version
0.1.1
0.1.0