HTTP Interface

API for sending and receiving text messages via the HTTP protocol

Send SMS messages using the HTTPS interface.

POST https://www.intellisoftware.co.uk/api/json/sendmsg.aspx

{
  "auth": {
    "authtype": "accesskey",
    "accesskey": "Yva$ER%Uhs\u002BUU[MzwEYe",
    "secretkey": "F{kQ^s\u0060wVpm!EU~Bx8yB^A$N$[l{pxJA"
  },
  "request_version": "1.0.0",
  "response_version": "1.0.3",
  "message": {
    "to": "44771012345",
    "from": "SENDER_ID",
    "channel": "sms",
    "content": {
      "msgtype": "text",
      "text": "The message body",
      "maxconcat": 1
    }
  }
}

Parameters:

accesskeyThis is your AccessKey used to authenticate to you IntelliSoftware account
Click here to create an AccessKey / SecretKey pair
secretkeyThis is your SecretKey used to authenticate to you IntelliSoftware account
Click here to create an AccessKey / SecretKey pair
request_versionThis specifies the version of the request format
response_versionThis specifies the required version of the response format
toThis is the destination phone number. A maximum of 100 numbers can be specified, separated by commas.
from(Optional) This is the source/sender's phone number
channelSelect message channel, use 'sms'. Default 'sms'
msgtype(Optional) 'text' = SMS Message, 'voice' = Text-to-Voice message (default is text)
textThe content of the text message
maxconcat(Optional) Maximum number of concatenated SMS messages that will be sent per recipient (Default is 1)

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "msgparts": 1,
      "creditsused": "1.0"
    }
  ]
}

Response multiple recipients:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "msgparts": 1,
      "creditsused": "1.0"
    },
    {
      "to": "44771012346",
      "error": "invalid_number",
      "error_code": 2
    }
  ]
}

Response overall reject:

{
  "response_status": "failure",
  "errors": [
    {
      "error": "login_invalid",
      "error_code": 11
    }
  ]
}

Parameters:

response_statusOverall return status
toThe recipient number
idUnique message ID
msgpartsNo of message parts
creditsusedCredits used to send message
errorError
error_codeError Code (Numerical representation of the 'error' parameter)
error_description(Optional) Error Description. Optionally provides additional information about the error (parameter not always provided). Error description messages subject to change at anytime without notice.

Error Codes:

login_invalid11AccessKey or SecretKey is invalid
auth_parameter_missing20Required authentication parameters are missing
auth_parameter_invalid21Required authentication parameters are invalid
connection_not_secure22Connection refused as the connection is not secure
insufficient_credit10Insufficient credit balance to fulfil request
invalid_number2Unable to route to the destination phone number
invalid_request3The request was not valid
no_to5The 'to' parameter is missing
daily_allowance_exceeded18The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded19The configured monthly allowance on the AccessKey has been exceeded
internal_error12Unable to process request at this time
gateway_error1Unable to process request at this time
invalid_from27Invalid From \ SenderId specified
number_not_supported28Number not supported
POST https://www.intellisoftware.co.uk/api/https/sendmsg.aspx

accesskey=Yva%24ER%25Uhs%2bUU%5bMzwEYe&secretkey=F%7bkQ%5es%60wVpm!EU%7eBx8yB%5eA%24N%24%5bl%7bpxJA&to=44771012345&from=SENDER_ID&type=1&text=The+message+body&maxconcat=1

Parameters:

accesskeyThis is your AccessKey used to authenticate to you IntelliSoftware account
Click here to create an AccessKey / SecretKey pair
secretkeyThis is your SecretKey used to authenticate to you IntelliSoftware account
Click here to create an AccessKey / SecretKey pair
toThis is the destination phone number. A maximum of 100 numbers can be specified, separated by commas.
from(Optional) This is the source/sender's phone number
type(Optional) 1=Text, 6=Voice-SMS (Default is Text)
textThe content of the text message
maxconcat(Optional) Maximum number of concatenated SMS messages that will be sent per recipient (Default is 1)

Responses:

Single line response is returned when sending to a single recipient or when the whole submission fails:

ID:10011000000000000001

Multiline response is returned when sending to multiple recipients:

44771012345,ID:10011000000000000001
44771012346,ERR:INVALID_NUMBER

A line is returned per recipient. Each line contains the recipient's number (international format), followed by comma, followed by the response. The ID applies to the whole submission and is identical for each recipient.

NOTE: The phone numbers listed in the response may not be identical to the numbers submitted. This is due to processing done to the numbers, e.g. international dialling codes added, duplicate numbers removed.

ERR:LOGIN_INVALID

Error Codes:

LOGIN_INVALID11AccessKey or SecretKey is invalid
AUTH_PARAMETER_MISSING20Required authentication parameters are missing
AUTH_PARAMETER_INVALID21Required authentication parameters are invalid
CONNECTION_NOT_SECURE22Connection refused as the connection is not secure
INSUFFICIENT_CREDIT10Insufficient credit balance to fulfil request
INVALID_NUMBER2Unable to route to the destination phone number
INVALID_REQUEST3The request was not valid
NO_TO5The 'to' parameter is missing
DAILY_ALLOWANCE_EXCEEDED18The configured daily allowance on the AccessKey has been exceeded
MONTHLY_ALLOWANCE_EXCEEDED19The configured monthly allowance on the AccessKey has been exceeded
INTERNAL_ERROR12Unable to process request at this time
GATEWAY_ERROR1Unable to process request at this time
INVALID_FROM27Invalid From \ SenderId specified
NUMBER_NOT_SUPPORTED28Number not supported