The REST API allows programmatic access to SMSGlobal features in MXT. To use the REST API, you will need an MXT account and an API key and secret. You can generate these inside your MXT account. The REST API can be accessed at api.smsglobal.com. Use of SSL is supported and strongly encouraged. The REST API takes full advantage of all HTTP headers. Each part of a request and response is meaningful, including the request method (GET/POST, etc.), the individual headers (Location, Content-Type, Accept, etc.), and the response status code (200, 400, 404, etc.). Use of this API assumes a working knowledge of these HTTP components, and general use of RESTful web APIs.
The REST API uses an authentication scheme based on this OAuth 2 specification . All requests to resources (excluding the schema pages) must be accompanied by a correct
Authorization
header as per this specification. The header looks like this:
Authorization: MAC id="your API key", ts="1325376000", nonce="random-string", mac="base64-encoded-hash"
The value of the header is made up of the following components.
Field | Meaning |
---|---|
id | Your API key, issued to you by SMSGlobal. Information on managing API keys can be found here . |
ts | The Unix timestamp of the time you made the request. We allow a slight buffer on this in case of any time sync issues. |
nonce | A randomly generated string of your choice. Ensure it is unique to each request, and no more than 32 characters long. To prevent replay attacks, a single nonce can only be used once. |
mac | This is the base 64 encoded hash of the request. |
Calculating the mac
hash
The hash is a SHA-256 digest of a concatenation of a series of strings related to the request. The string is:
Timestamp Nonce HTTP request method HTTP request URI HTTP host HTTP port Optional extra data
Each part of the string is separated by a line feed character (\n
or 0x0A
; not \r
or \r\n
). The entire string also ends with a line feed character. Here’s an example for a POST
request to
the sms
resource via HTTPS. The \n
characters are shown for clarity.
1325376000\n random-string\n POST\n /v2/sms/\n api.smsglobal.com\n 443\n \n
Note that the optional extra data line is blank. Our API does not currently use this field, but it must be included in the hash as an empty string as per the OAuth 2 specification. Once this string has been constructed, you must then hash it using the HMAC method, with your API secret (issued with your API key) used as the hash key. SMSGlobal uses the SHA-256 algorithm for hashing. It is recommended that you use a pre-existing library to calculate the hash, as it is quite calculated. Ensure the hash is output in binary, and not in hexadecimal. Once the hash is calculated, base 64 encode it and include it in the HTTP header. For this example, the hashed string is:
EJQ15pg5cEYsotgQaGyCHRxnPvmAemamOh6w7YRDif4
Things to check include checking to ensure the REST API keys are correct as well as the time they are authenticating with.
The computer must have accurate time as the authentication MAC is build using the time, so authentication will fail if the client computer time is different to our server time.
The following response codes apply to all requests. Check each request type in the list below for more response codes specific to that request.
Status Code | Meaning | Scenario |
---|---|---|
200 | OK | The request was processed successfully |
400 | Bad Request | Your request contained invalid or missing data |
401 | Unauthorized | Authentication failed or the |
404 | Not Found | The URI does not match any of the recognised resources, or, if you are asking for a specific resource with an ID, that resource does not exist |
405 | Method Not Allowed | The HTTP request method you are trying to use is not allowed. Make an |
406 | Not Acceptable | The |
415 | Unsupported Media Type | The |
You can specify the formats you want to use for request and response data.
Use the Content-Type
header to specify the format your data is in.
Use the Accept
header to specify the output desired format.
If you can’t set that header, use the format
parameter in the query string. The format
parameter takes precedence over the Accept
header.
You can get HTTP post-backs for delivery receipts, message status updates and incoming messages.
Post-backs are HTTP GET requests by default and parameters passed in the query string. You can set the post-back format in the following formats.
Click here to see more on Delivery Receipts
SMSGlobal can notify you of change in message delivery status to allow you to monitor the status of messages sent.
To use notifyURL, delivery receipts will need to be enabled in your MXT settings first.
Please find below the list of parameters that are sent.
Field | Meaning |
---|---|
id | Message part identifier |
status | Current status of the sms message |
update_time | The date in UTC when the message status was updated |
outgoing_id | Outgoing message identifier |
https://example.url?id=6419785166510955&outgoing_id=5346907663&status=Delivered&update_time=2020-09-16T16%3A32%3A17%2B10%3A00
id=6419785166510955&outgoing_id=5346907663&status=Delivered&update_time=2020-09-16T16%3A32%3A17%2B10%3A00
{ "id":"6968154134564265", "outgoing_id":"5347047793", "status":"Delivered", "update_time":"2020-09-16T16:50:33+10:00" }
<?xml version="1.0" encoding="UTF-8"?> <delivery_receipt> <id>6929949692100437</id> <outgoing_id>5347049893</outgoing_id> <status>Delivered</status> <updated_time>2020-09-16T16:53:09+10:00</updated_time> </delivery_receipt>
If you would like to receive notification of your Incoming SMS to be pushed to your server, please ensure you specify a URL in your outgoing message request or default URL in your account settings.
In order for our system to know that your URL has received the delivery notice, at the end of your script you must echo out “OK”.
Please find below the list of parameters that are sent.
Field | Meaning |
---|---|
to | Mobile Terminated Number, where the message was sent to |
from | Mobile Originated Number, where the message was sent from |
msg | Contents of the message |
date | Date the message was received by SMSGlobal. |
msgid | Message identifier |
http://www.example.com/?from=61433111222&to=61499057767&msg=response+&date=2020-09-16+16%3A29%3A50&msgid=471047771
from=61433111222&to=61499057767&msg=response+&date=2020-09-16+16%3A29%3A50&msgid=471047771
{ "from":"61433111222", "to":61499057767, "msg":"response ", "date":"2020-09-16 16:51:59", "msgid":471051471 }
<?xml version="1.0" ?> <incoming> <from>61433111222</from> <to>61499057767</to> <msg>response</msg> <date>2020-09-16 16:53:19</date> <msgid>471051701</msgid> </incoming>
Get the auto top-up information associated to the authenticated account.
Parameter | Type | Versions | Description |
---|---|---|---|
disabled | boolean | >=v2 | Whether auto top-up is disabled for the authenticated user. |
balanceThreshold | integer | >=v2 | The auto top-up low balance threshold. |
balanceAmount | integer | >=v2 | The auto top-up amount. |
card | object (CreditCards) | >=v2 | The credit card to be charged the auto top-up amount. |
card[number] | string | >=v2 | Masked credit card number |
card[type] | string | >=v2 | Credit card type |
periodicFrequency | integer | >=v2 | The auto top up periodic frequency. |
periodicStartDate | DateTime | >=v2 | The auto top up start date |
periodicEndDate | DateTime | >=v2 | The auto top up end date |
periodicAmount | integer | >=v2 | The periodic top up amount |
Status Code | Description |
---|---|
200 |
|
403 |
|
405 |
|
Delete a contact
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | The contact identifier. |
Status Code | Description |
---|---|
204 |
|
403 |
|
404 |
|
405 |
|
Get the contact as identified by the given id.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | The contact identifier. |
Parameter | Type | Versions | Description |
---|---|---|---|
id | integer | >=v2 | |
groupId | string | >=v2 | |
givenName | string | >=v2 | Contact given name. |
familyName | string | >=v2 | Contact surname. |
displayName | string | >=v2 | Contact display name. |
msisdn | string | >=v2 | Contact mobile number. |
emailAddress | string | >=v2 | Contact email address. |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
405 |
|
Update the contact as identified by the given id. You can only update the default fields associated with each contact.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | The contact identifier. |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
givenName | string | true | Given name. | |
familyName | string | true | Family name. | |
displayName | string | true | Display name. | |
msisdn | string | true | Mobile number. Maximum of 15 characters. | |
emailAddress | string | true | Email address. |
Status Code | Description |
---|---|
204 |
|
403 |
|
404 |
|
405 |
|
Get a list of all contact groups.
Name | Information |
---|---|
offset | Requirement \d+ Description Pagination offset (default 1) Default 1 |
limit | Requirement \d+ Description Number of items to return (default 20) Default 20 |
Parameter | Type | Versions | Description |
---|---|---|---|
offset | integer | * | |
limit | integer | * | |
total | integer | * | |
groups[] | array of objects (ContactGroup) | >=v2 | A collection of contact groups |
groups[][id] | integer | >=v2 | |
groups[][name] | string | >=v2 | |
groups[][keyword] | string | >=v2 | |
groups[][isGlobal] | boolean | >=v2 | |
groups[][contactCount] | integer | >=v2 | |
groups[][defaultOrigin] | string | >=v2 |
Status Code | Description |
---|---|
200 |
|
403 |
|
405 |
|
Create a new contact group.
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | Group name. Max length of 100 characters. | |
keyword | string | false | Email to SMS keyword. | |
defaultOrigin | string | false | The default SMS origin for this group. 4-11 characters for alphanumeric or 4-15 * digits for numeric. Defaults to shared pool numbers. | |
isGlobal | boolean | false | Is the group globally visible to sub accounts. Defaults to false. |
Status Code | Description |
---|---|
200 |
|
400 |
|
403 |
|
405 |
|
Create a contact
Name | Requirement | Type? | Description |
---|---|---|---|
groupId | \d+ | integer | The contact group identifier. |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
msisdn | string | true | Group name. Max length of 100 characters. | |
givenName | string | false | Given name. | |
familyName | string | false | Family name. | |
displayName | string | false | Display name. | |
emailAddress | string | false | Email address. | |
contacts[] | array of objects (Contact) | false | A collection of contacts | |
contacts[][givenName] | string | false | ||
contacts[][familyName] | string | false | ||
contacts[][displayName] | string | false | ||
contacts[][msisdn] | string | false | ||
contacts[][emailAddress] | string | false |
Status Code | Description |
---|---|
201 |
|
400 |
|
403 |
|
405 |
|
Get a list of all contacts in a group.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | The contact group identifier. |
groupId |
Name | Information |
---|---|
offset | Requirement \d+ Description Pagination offset (default 1) Default 1 |
limit | Requirement \d+ Number of items to return (default 20) Default 20 |
sort | Requirement string Description Sort by field id or msisdn. Prefix with minus (-) for descending order. Default id |
Status Code | Description |
---|---|
200 |
|
400 |
|
403 |
|
404 |
|
405 |
|
Delete a contact group
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | The contact group identifier. |
groupId |
Status Code | Description |
---|---|
204 |
|
403 |
|
404 |
|
405 |
|
Get the contact group as identified by the given id.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | The contact group identifier. |
Parameter | Type | Versions | Description |
---|---|---|---|
id | integer | >=v2 | |
name | string | >=v2 | |
keyword | string | >=v2 | |
isGlobal | boolean | >=v2 | |
contactCount | integer | >=v2 | |
defaultOrigin | string | >=v2 |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
405 |
|
Update fields of a group as identified by the given id.
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | The contact group identifier. |
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | false | Group name. Max length of 100 characters. | |
keyword | string | false | Email to SMS keyword. | |
defaultOrigin | string | false | The default SMS origin for this group. 4-11 characters for alphanumeric or 4-15 * digits for numeric. Pass an empty string " for shared pool numbers. | |
isGlobal | boolean | false | Is the group globally visible to sub accounts. Defaults to false. |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
405 |
|
View list of dedicated numbers
Parameter | Type | Versions | Description |
---|---|---|---|
dedicatedNumbers[] | array of objects (DedicatedNumber) | >=v2 | A collection of Dedicated Number objects |
dedicatedNumbers[][id] | integer | >=v2 | Dedicated number identifier |
dedicatedNumbers[][userId] | integer | >=v2 | User identifier |
dedicatedNumbers[][msisdn] | string | >=v2 | Mobile phone number including country and area codes. 4 to 15 digits; no spaces or other formatting |
dedicatedNumbers[][type] | string | >=v2 | How to handle incoming messages. 0 = Disable this number, 1 = SMPP, 2 = HTTP Callback, 3 = Email, 4 = SMSGlobal website only. All messages still appear on the SMSGlobal website regardless of this setting |
dedicatedNumbers[][emailAddress] | integer | >=v2 | Email address to send incoming SMS to |
dedicatedNumbers[][httpCallbackUrl] | integer | >=v2 | HTTP callback URL for incoming SMS |
dedicatedNumbers[][isAutoReplyEnabled] | boolean | >=v2 | Whether auto reply messages are enabled |
dedicatedNumbers[][autoReplyMessage] | string | >=v2 | The auto reply message. Maximum of 480 characters |
dedicatedNumbers[][autoReplyOrigin] | string | >=v2 | Where the auto reply should appear to come from. Blank to use the dedicated number itself. 4-15 digits or 3-11 numbers and letters |
Status Code | Description |
---|---|
200 |
|
403 |
|
405 |
|
View list of opted out numbers
Name | Information |
---|---|
phoneNumber | Requirement [0-9]+ Description Filter by phone number Default |
offset | Requirement \d+ Description Pagination Offset (default 1) Default 1 |
limit | Requirement \d+ Description Number of items to return (default 20) Default 20 |
Parameter | Type | Versions | Description |
---|---|---|---|
optouts[] | array of objects (Optout) | >=v2 | A collection of Optout number object. Optout object consist of number and status(exist, valid, and invalid) properties. |
offset | integer | * | |
limit | integer | * | |
total | integer | * |
Status Code | Description |
---|---|
200 |
|
403 |
|
405 |
|
Opt out mobile numbers
Name | Requirement | Type | Description |
---|---|---|---|
optouts | array | array of Opt-out mobile numbers |
Parameter | Type | Versions | Description |
---|---|---|---|
optouts[] | array of objects (Optout) | >=v2 | A collection of Optout number object. Optout object consist of number and status(exist, valid, and invalid) properties. |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
405 |
|
Validate mobile numbers for opt out
Name | Requirement | Type | Description |
---|---|---|---|
optouts | array | array of Opt-out mobile numbers |
Parameter | Type | Versions | Description |
---|---|---|---|
optouts[] | array of objects (Optout) | >=v2 | A collection of Optout number object. Optout object consist of number and status(exist, valid, and invalid) properties. |
Status Code | Description |
---|---|
200 |
|
400 |
|
403 |
|
405 |
|
Opt in a mobile number
Name | Requirement | Type | Description |
---|---|---|---|
number | \d+ | integer | Opt in mobile number (msidn) |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
405 |
|
View list of shared pools
Parameter | Type | Versions | Description |
---|---|---|---|
SharedPools[] | array of objects (SharedPool) | >=v2 | A collection of shared pool objects |
SharedPools[][id] | integer | >=v2 | Shared pool identifier |
SharedPools[][name] | string | >=v2 | |
SharedPools[][size] | integer | >=v2 | |
SharedPools[][numbers][] | array of objects (DedicatedNumber) | >=v2 | |
SharedPools[][numbers][] [msisdn] | string | >=v2 | Mobile phone number including country and area codes. 4 to 15 digits; no spaces or other formatting |
Status Code | Description |
---|---|
200 |
|
403 |
|
405 |
|
View details of a shared pool
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | Shared pool id |
Parameter | Type | Versions | Description |
---|---|---|---|
id | integer | >=v2 | Shared pool identifier |
name | string | >=v2 | |
size | integer | >=v2 | |
numbers[] | array of objects (DedicatedNumber) | >=v2 | |
numbers[] [msisdn] | string | >=v2 | Mobile phone number including country and area codes. 4 to 15 digits; no spaces or other formatting |
Status Code | Description |
---|---|
200 |
|
204 |
|
403 |
|
404 |
|
405 |
|
View list of outgoing messages
Name | Information |
---|---|
offset | Requirement \d+ Description Pagination offset (default 1, maximum offset + limit = 10,000) Default 1 |
limit | Requirement \d+ Description Number of items to return (default 20, maximum 1000) Default 20 |
status | Requirement Description Filter by message status. Allowed values [delivered, sent, scheduled, noCredits, invalidNumber, undelivered] |
startDate | Requirement Description Start date of the date range filter. Date format |
endDate | Requirement Description End date of the date range filter. Date format |
destination | Requirement \d+ Description The number message was sent to |
source | Requirement \d+ Description The number message was sent from |
search | Requirement \d+ Description Search string in source, destination and message |
Parameter | Type | Versions | Description |
---|---|---|---|
total | integer | >=v2 | Total number of sms sent message objects. |
offset | integer | >=v2 | Pagination Offset (default 1) |
limit | integer | >=v2 | Number of outgoing message objects to return |
messages[] | array of objects (SmsSent) | >=v2 | A collection of outgoing message objects |
messages[][id] | array of objects (SmsSent) | >=v2 | Message part identifier |
messages[][outgoing_id] | array of objects (SmsSent) | >=v2 | Outgoing message identifier |
messages[][origin] | string | >=v2 | Where the SMS appears to come from. 4-11 characters A-Za-z0-9 if alphanumeric; 4-15 digits if numeric (if set, set sharedPool to null) |
messages[][destination] | string | >=v2 | Destination mobile number. 4-15 digits |
messages[][message] | string | >=v2 | Outgoing message |
messages[][status] | string | >=v2 | Message status |
messages[][dateTime] | string | >=v2 | The date the message was created in UTC |
Status Code | Description |
---|---|
200 |
|
403 |
|
405 |
|
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
destination | string | false | Destination mobile number. 3-15 digits | |
destinations[] | array of strings | false | A collection of destination mobile numbers. 3-15 digits | |
message | string | false | The SMS message. If longer than 160 characters (GSM) or 70 characters (Unicode), splits into multiple SMS | |
origin | string | false | Where the SMS appears to come from. 3-11 characters A-Za-z0-9 if alphanumeric; 3-15 digits if numeric (if set, set sharedPool to null) | |
scheduledDateTime | datetime | false | yyyy-MM-dd HH:mm:ss | The datetime the message should be sent in UTC |
campaign | datetime | false | yyyy-MM-dd HH:mm:ss | The campaign the message is associated with (optional) |
sharedPool | string | false | The shared pool to use (if set, set origin to null) | |
notifyUrl | string | false | Url to post back the status of message | |
incomingUrl | string | false | Url to post back incoming messages | |
expiryDateTime | datetime | false | yyyy-MM-dd HH:mm:ss | The datetime in UTC at message will expire |
messages[] | array of objects (Sms) | true | A collection of sms messages | |
messages[][destination] | string | false | Destination mobile number. 3-15 digits | |
messages[][destinations][] | array of strings | false | A collection of destination mobile numbers. 3-15 digits | |
messages[][message] | string | false | The SMS message. If longer than 160 characters (GSM) or 70 characters (Unicode), splits into multiple SMS | |
messages[][origin] | string | false | Where the SMS appears to come from. 3-11 characters A-Za-z0-9 if alphanumeric; 3-15 digits if numeric (if set, set sharedPool to null) | |
messages[][scheduledDateTime] | datetime | false | yyyy-MM-dd HH:mm:ss | The datetime the message should be sent in UTC |
messages[][campaign] | string | false | The campaign the message is associated with (optional) | |
messages[][sharedPool] | string | false | The shared pool to use (if set, set origin to null) | |
messages[][notifyUrl] | string | false | Url to post back the status of message | |
messages[][incomingUrl] | string | false | Url to post back incoming messages | |
messages[][expiryDateTime] | datetime | false | yyyy-MM-dd HH:mm:ss | The datetime in UTC at message will expire |
Parameter | Type | Versions | Description |
---|---|---|---|
messages[] | array of objects (SmsSent) | >=v2 | A collection of outgoing message objects |
messages[][id] | integer | >=v2 | Message part identifier |
messages[][outgoing_id] | integer | >=v2 | Outgoing message identifier |
messages[][origin] | string | >=v2 | Where the SMS appears to come from. 4-11 characters A-Za-z0-9 if alphanumeric; 4-15 digits if numeric (if set, set sharedPool to null) |
messages[][destination] | string | >=v2 | Destination mobile number. 4-15 digits |
messages[][message] | string | >=v2 | Outgoing message |
messages[][status] | string | >=v2 | Message status |
messages[][dateTime] | DateTime | >=v2 | The date the message was created in UTC |
Status Code | Description |
---|---|
200 |
|
202 |
|
400 |
|
402 |
|
403 |
|
405 |
|
View details of an outgoing message
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | id or outgoing_id |
Parameter | Type | Versions | Description |
---|---|---|---|
id | integer | >=v2 | Message part identifier |
outgoing_id | integer | >=v2 | Outgoing message identifier |
origin | string | >=v2 | Where the SMS appears to come from. 4-11 characters A-Za-z0-9 if alphanumeric; 4-15 digits if numeric (if set, set sharedPool to null) |
destination | string | >=v2 | Destination mobile number. 4-15 digits |
message | string | >=v2 | Outgoing message |
status | string | >=v2 | Message status |
dateTime | DateTime | >=v2 | The date the message was created in UTC |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
405 |
|
View list of incoming messages
Name | Information |
---|---|
offset | Requirement \d+ Description Pagination offset (default 1, maximum offset + limit = 10,000) Default 1 |
limit | Requirement \d+ Description Number of items to return (default 20, maximum 1000) Default 20 |
startDate | Requirement \d+ Description Start date of the date range filter. Date format |
endDate | Requirement Description End date of the date range filter. Date format |
destination | Requirement \d+ Description The shared pool or dedicated number which the sms was sent to |
origin | Requirement \d+ Description The number where the SMS appears to come from |
search | Requirement \d+ Description Search string in source, destination and message |
Parameter | Type | Versions | Description |
---|---|---|---|
total | integer | >=v2 | Total number of incoming message objects |
offset | integer | >=v2 | Pagination Offset (default 1) |
limit | integer | >=v2 | Number of incoming message objects to return |
messages[] | array of objects (SmsIncoming) | >=v2 | A collection of incoming message objects |
messages[][id] | integer | >=v2 | Incoming message identifier |
messages[][origin] | integer | >=v2 | Where the SMS appears to come from |
messages[][destination] | string | >=v2 | The shared pool or dedicated number which the sms was sent to |
messages[][message] | string | >=v2 | The SMS message. If longer than 160 characters (GSM) or 70 characters (Unicode), splits into multiple SMS |
messages[][isUnicode] | boolean | >=v2 | If incoming message contains Unicode characters |
messages[][dateTime] | DateTime | >=v2 | The date and time this message was received |
messages[][campaign] | object (Campaign) | >=v2 | The campaign the message is associated with (optional) |
messages[][campaign][id] | integer | >=v2 | Campaign identifier |
messages[][isMultipart] | boolean | >=v2 | Whether the message exceeded the maximum length and had to be split into multiple parts |
messages[][partNumber] | integer | >=v2 | If concatenated, the part number this SMS represents; otherwise 1 |
messages[][totalParts] | integer | >=v2 | If concatenated, the total number of parts in this SMS. Ranges from 1-255 |
Status Code | Description |
---|---|
200 |
|
403 |
|
405 |
|
Delete incoming message
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | Incoming message id |
Status Code | Description |
---|---|
204 |
|
403 |
|
404 |
|
405 |
|
View details of a incoming message
Name | Requirement | Type | Description |
---|---|---|---|
id | \d+ | integer | Incoming message id |
Parameter | Type | Versions | Description |
---|---|---|---|
id | integer | >=v2 | Incoming message identifier |
origin | string | >=v2 | Where the SMS appears to come from |
destination | string | >=v2 | The shared pool or dedicated number which the sms was sent to |
message | string | >=v2 | The SMS message. If longer than 160 characters (GSM) or 70 characters (Unicode), splits into multiple SMS |
isUnicode | boolean | >=v2 | If incoming message contains Unicode characters |
dateTime | DateTime | >=v2 | The date and time this message was received |
campaign | object (Campaign) | >=v2 | The campaign the message is associated with (optional) |
campaign[id] | integer | >=v2 | Campaign identifier |
isMultipart | boolean | >=v2 | Whether the message exceeded the maximum length and had to be split into multiple parts |
partNumber | integer | >=v2 | If concatenated, the part number this SMS represents; otherwise 1 |
totalParts | integer | >=v2 | If concatenated, the total number of parts in this SMS. Ranges from 1-255 |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
405 |
|
Get the authenticated account's billing details.
Parameter | Type | Versions | Description |
---|---|---|---|
id | integer | >=v2 | |
name | string | >=v2 | The account holder's full name. |
phone | string | >=v2 | The account holder's phone number. |
string | >=v2 | The account holder's email address. | |
address | string | >=v2 | The account holder's address. |
city | string | >=v2 | The account holder's city. |
state | string | >=v2 | The account holder's state. |
postcode | string | >=v2 | The account holder's postcode. |
country | string | >=v2 | The account holder's country. |
Status Code | Description |
---|---|
200 |
|
403 |
|
405 |
|
Update the authenticated account's billing details.
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
id | integer | true | ||
name | string | true | The account holder's full name. | |
phone | string | true | The account holder's phone number. | |
string | true | The account holder's email address. | ||
address | string | true | The account holder's address. | |
city | string | true | The account holder's city. | |
state | string | true | The account holder's state. | |
postcode | string | true | The account holder's postcode. | |
country | string | true | The account holder's country. |
Status Code | Description |
---|---|
204 |
|
400 |
|
402 |
|
403 |
|
405 |
|
Get the authenticated account's contact details.
Parameter | Type | Versions | Description |
---|---|---|---|
id | integer | >=v2 | |
name | string | >=v2 | The account holder's full name. |
phone | string | >=v2 | The account holder's phone number. |
string | >=v2 | The account holder's email address. | |
address | string | >=v2 | The account holder's address. |
city | string | >=v2 | The account holder's city. |
state | string | >=v2 | The account holder's state. |
postcode | string | >=v2 | The account holder's postcode. |
country | string | >=v2 | The account holder's country. |
Status Code | Description |
---|---|
200 |
|
403 |
|
405 |
|
Update the authenticated account's contact details.
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
id | integer | true | ||
name | string | true | The account holder's full name. | |
phone | string | true | The account holder's phone number. | |
string | true | The account holder's email address. | ||
address | string | true | The account holder's address. | |
city | string | true | The account holder's city. | |
state | string | true | The account holder's state. | |
postcode | string | true | The account holder's postcode. | |
country | string | true | The account holder's country. |
Status Code | Description |
---|---|
204 |
|
400 |
|
403 |
|
405 |
|
View the account balance
Parameter | Type | Versions | Description |
---|---|---|---|
balance | double | >=v2 | Account Credit Balance (available for Pre-paid customers) |
currency | string | >=v2 | Currency Code |
Status Code | Description |
---|---|
200 |
|
403 |
|
404 |
|
405 |
|
Get the low balance alerts information associated to the authenticated account.
Parameter | Type | Versions | Description |
---|---|---|---|
enabled | boolean | >=v2 | Whether to send low balance alerts. |
threshold | integer | >=v2 | The low balance alerts threshold amount. |
sendto | string | >=v2 | The low balance alerts contact delivery destination. |
Status Code | Description |
---|---|
200 |
|
403 |
|
405 |
|
Update the authenticated account's billing details.
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
enabled | boolean | true | Whether to send low balance alerts. | |
threshold | integer | true | The low balance alerts threshold amount. | |
sendto | integer | true | The low balance alerts contact delivery destination. |
Status Code | Description |
---|---|
204 |
|
400 |
|
402 |
|
403 |
|
405 |
|
Create sub account
Parameter | Type | Required? | Format | Description |
---|---|---|---|---|
name | string | true | The sub account's display name. | |
string | true | The sub account's email address. | ||
password | string | true | The sub account's password. | |
mobile | string | true | The sub account's mobile number. |
Status Code | Description |
---|---|
201 |
|
400 |
|
403 |
|
405 |
|