Overview
SMS Connector API specifications
Version information
Version : 12.0
Contact information
Contact Email : info@expertflow.com
URI scheme
Host : localhost:8080
BasePath: /msg-client
Schemes: HTTP, HTTPS
Tags
-
SMS Client
Resources
SMS Client
Has the message been delivered or not
POST /delivery-notification
Description
This API is called by the SMS gateway to notify delivery status of an SMS.
Parameters
|
Type |
Name |
Description |
Schema |
|---|---|---|---|
|
FormData |
MessageSid
|
SMS id that was set earlier by third party(Twilio) while sending SMS |
string |
|
FormData |
SmsStatus
|
Destination number that customer uses to send SMS to |
enum (delivered, undelivered, failed, queued, sent) |
Responses
|
HTTP Code |
Description |
Schema |
|---|---|---|
|
200 |
Received notification successfully |
No Content |
|
400 |
Bad request, any or all required paramters are not supplied with request |
No Content |
|
404 |
wrong API url supplied |
No Content |
|
500 |
Internal server error, check server logs for details |
No Content |
Consumes
-
application/x-www-form-urlencoded
Produces
-
application/json
Example HTTP request
Request path
/delivery-notification
Request formData
"string"
SMS Gateway application calls this method to pass customer SMS message to the SMS Client.
POST /receive
Description
Called by the SMS Gateway or any 3rd party SMS service provider to pass customer SMS message to the SMS Client.
Parameters
|
Type |
Name |
Description |
Schema |
|---|---|---|---|
|
FormData |
Body
|
SMS Text |
string |
|
FormData |
From
|
Customer Number |
string |
|
FormData |
SmsSid
|
any id that third party assign to an SMS |
string |
|
FormData |
To
|
Destination number that customer uses to send SMS to |
string |
Responses
|
HTTP Code |
Description |
Schema |
|---|---|---|
|
200 |
message received successfully |
No Content |
|
400 |
Bad request, any or all required paramters are not supplied with the request |
No Content |
|
404 |
Not found, wrong API url supplied |
No Content |
|
500 |
Internal server error, check the server logs for details |
No Content |
Consumes
-
application/x-www-form-urlencoded
Produces
-
application/json
Example HTTP request
Request path
/msg-client/receive
Request formData
"string"
Queue an SMS for sending to customer
POST /msg-client/send
Description
This API method is called by the client application that needs to sends an SMS message to a mobile number
Parameters
|
Type |
Name |
Description |
Schema |
|---|---|---|---|
|
Body |
body
|
SMS object that needs to be sent to customer |
Responses
|
HTTP Code |
Description |
Schema |
|---|---|---|
|
200 |
OK, message queued at SMS Connector |
No Content |
|
400 |
Bad request, any or all required paramters are not supplied with request |
No Content |
|
404 |
Not found, wrong API url supplied |
No Content |
|
500 |
Internal server error, check logs for details |
No Content |
Example HTTP request
Request path
/msg-client/send
Request body
{ "To" : "string", "Body" : "string", "From" : "string", // optional "channel" : "smpp", }
Definitions
delivery-status
|
Name |
Description |
Schema |
|---|---|---|
|
MessageSid
|
Example : |
string |
|
MessageStatus
|
Example : |
enum (delivered, undelivered, failed, queued, sent) |
receive
|
Name |
Description |
Schema |
|---|---|---|
|
Body
|
SMS message text
|
string |
|
From
|
Customer mobile phone number(Originator MSISDN).
|
string |
|
To
|
destination mobile number or short code
|
string |
send
|
Name |
Description |
Schema |
|---|---|---|
|
Body
|
SMS message text
|
string |
|
From
|
short code or source address, not required
|
string |
|
To
|
Customer mobile phone number(Destination MSISDN).
|
string |
Delivery Notifications
Sms Connector produces delivery notifications over an Active MQ queue. Following are the message details:
Active MQ Queue Name : delivery-report
Format : JSON
Jms Type / Header : <channel-type>
Message : {
"MessageSID" : "<message-submission-id>",
"DeliveryStatus" : "DELIVERED / FAILED",
"ProviderStatusCode" : "<integer or string provider status code>"
}