SMS Connector APIs Documentation

Overview

SMS Connector API specifications

Version information

Version : 12.0

Contact information

Contact Email : info@expertflow.com

URI scheme

Host : localhost:8080
BasePath : /sms-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
TypeNameDescriptionSchema

FormData

MessageSid
required

SMS id that was set earlier by third party(Twilio) while sending SMS

string

FormData

SmsStatus
required

Destination number that customer uses to send SMS to

enum (delivered, undelivered, failed, queued, sent)

Responses
HTTP CodeDescriptionSchema

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
TypeNameDescriptionSchema

FormData

Body
required

SMS Text

string

FormData

From
required

Customer Number

string

FormData

SmsSid
optional

any id that third party assign to an SMS

string

FormData

To
required

Destination number that customer uses to send SMS to

string

Responses
HTTP CodeDescriptionSchema

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
/receive
Request formData
"string"

Queue an SMS for sending to customer

POST /send
Description

This API method is called by the client application that needs to sends an SMS message to a mobile number

Parameters
TypeNameDescriptionSchema

Body

body
required

SMS object that needs to be sent to customer

send

Responses
HTTP CodeDescriptionSchema

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
/send
Request body
{
  "To" : "string",
  "Body" : "string",
  "From" : "string"
}

Definitions

delivery-status

NameDescriptionSchema

MessageSid
optional

Example : "string"

string

MessageStatus
optional

Example : "string"

enum (delivered, undelivered, failed, queued, sent)

receive

NameDescriptionSchema

Body
required

SMS message text
Example : "string"

string

From
required

Customer mobile phone number(Originator MSISDN).
Example : "string"

string

To
required

destination mobile number or short code
Example : "string"

string

send

NameDescriptionSchema

Body
required

SMS message text
Example : "string"

string

From
optional

short code or source address, not required
Example : "string"

string

To
required

Customer mobile phone number(Destination MSISDN).
Example : "string"

string