Documentation Powered by ReDoc

SMS Gateway API Reference (1.0.0)

Download OpenAPI specification:Download

Welcome to the SMS gateway API reference.

The SMS Gateway API is a REST based API, and it uses resource-oriented URLs, and common HTTP response codes to indicate API errors. All requests are authenticated using an x-api-key header.

Authentication

key

Security Scheme Type API Key
Header parameter name: x-api-key

SMS

Send SMS

Send SMS

Authorizations:
key
Request Body schema: application/json

Parameters to send a message

body
required
string

The body of the SMS

from
required
string

The from SMS number

to
required
string

The to SMS number

applicationId
string

The application Id used for verification

statusCallback
string

Location to send SMS status updates

Responses

Request samples

Content type
application/json
{
  • "body": "This is the SMS body",
  • "from": "+11111111111",
  • "to": "+11111111111",
  • "applicationId": "Application1",
  • "statusCallback": "http://site.com"
}

Response samples

Content type
application/json
{
  • "body": "This is the SMS body",
  • "from": "+11111111111",
  • "to": "+11111111111",
  • "sid": "573j1dlo7grlk430icc9hnio7bpt0f1qif94hmg0",
  • "status": "sent"
}