Send SMS Message

Send SMS messages using the HTTPS interface.

JSON
Form Post

Message Type:

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "sms",
    "content": {
      "msgtype": "text",
      "text": "The message body",
      "maxconcat": 1
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'sms'
msgtype	'text' = SMS Message, 'voice' = Text-to-Voice message
text	The 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 failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
msgparts	No of message parts used
creditsused	Credits used to send message to recipient
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
number_not_supported	28	Number not supported

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "sms",
    "content": {
      "msgtype": "unicode",
      "text": "Simley Emoji \uD83D\uDE03",
      "maxconcat": 1
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'sms'
msgtype	'unicode' for Unicode Messages
text	Unicode text
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 failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
msgparts	No of message parts used
creditsused	Credits used to send message to recipient
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
parameter_missing	13	The mandatory 'hex' parameter is missing
parameter_invalid	14	The 'hex' parameter are malformed
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
number_not_supported	28	Number not supported

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "sms",
    "content": {
      "msgtype": "binary",
      "udh": "06050415820000",
      "ud": "32F40100480E01000000000000000000000000000000000000000000000000000000000001247803000000E0080120CC0640000040080120CC06C00000479E7124F0EFFADCF64448892479B6DAC6CD4448F9241DB6DACECF44488124CDB6CD96CC44488924CDB6CD96CDE446712478E66D9EC6000000000000000000000000000000000000"
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'sms'
msgtype	(Optional) 'binary' for Binary Messages
udh	(Optional) User Data Header
ud	User Data (140 octets max)

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 failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
msgparts	No of message parts used
creditsused	Credits used to send message to recipient
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
parameter_missing	13	The mandatory 'ud' parameter is missing
parameter_invalid	14	The 'ud' or 'udh' are malformed
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
number_not_supported	28	Number not supported

Message Type:

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:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
to	This 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	1=Text, 6=Voice-SMS (Default is Text)
text	The 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_INVALID	11	AccessKey or SecretKey is invalid
AUTH_PARAMETER_MISSING	20	Required authentication parameters are missing
AUTH_PARAMETER_INVALID	21	Required authentication parameters are invalid
CONNECTION_NOT_SECURE	22	Connection refused as the connection is not secure
INSUFFICIENT_CREDIT	10	Insufficient credit balance to fulfil request
INVALID_NUMBER	2	Unable to route to the destination phone number
INVALID_REQUEST	3	The request was not valid
NO_TO	5	The 'to' parameter is missing
DAILY_ALLOWANCE_EXCEEDED	18	The configured daily allowance on the AccessKey has been exceeded
MONTHLY_ALLOWANCE_EXCEEDED	19	The configured monthly allowance on the AccessKey has been exceeded
INTERNAL_ERROR	12	Unable to process request at this time
GATEWAY_ERROR	1	Unable to process request at this time
INVALID_FROM	27	Invalid From \ SenderId specified
NUMBER_NOT_SUPPORTED	28	Number 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=2&text=Simley%2bEmoji%2b%25F0%259F%2598%2583&maxconcat=1

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
to	This 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	Message Type (2 = Unicode)
text	Unicode text
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_INVALID	11	AccessKey or SecretKey is invalid
AUTH_PARAMETER_MISSING	20	Required authentication parameters are missing
AUTH_PARAMETER_INVALID	21	Required authentication parameters are invalid
CONNECTION_NOT_SECURE	22	Connection refused as the connection is not secure
INSUFFICIENT_CREDIT	10	Insufficient credit balance to fulfil request
INVALID_NUMBER	2	Unable to route to the destination phone number
INVALID_REQUEST	3	The request was not valid
NO_TO	5	The 'to' parameter is missing
PARAMETER_MISSING	13	The mandatory 'hex' parameter is missing
PARAMETER_INVALID	14	The 'hex' parameter are malformed
DAILY_ALLOWANCE_EXCEEDED	18	The configured daily allowance on the AccessKey has been exceeded
MONTHLY_ALLOWANCE_EXCEEDED	19	The configured monthly allowance on the AccessKey has been exceeded
INTERNAL_ERROR	12	Unable to process request at this time
GATEWAY_ERROR	1	Unable to process request at this time
INVALID_FROM	27	Invalid From \ SenderId specified
NUMBER_NOT_SUPPORTED	28	Number 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=3&udh=06050415820000&ud=32F40100480E01000000000000000000000000000000000000000000000000000000000001247803000000E0080120CC0640000040080120CC06C00000479E7124F0EFFADCF64448892479B6DAC6CD4448F9241DB6DACECF44488124CDB6CD96CC44488924CDB6CD96CDE446712478E66D9EC6000000000000000000000000000000000000

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
to	This 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) Message Type (3 = Binary)
udh	(Optional) User Data Header
ud	User Data (140 octets max)

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_INVALID	11	AccessKey or SecretKey is invalid
AUTH_PARAMETER_MISSING	20	Required authentication parameters are missing
AUTH_PARAMETER_INVALID	21	Required authentication parameters are invalid
CONNECTION_NOT_SECURE	22	Connection refused as the connection is not secure
INSUFFICIENT_CREDIT	10	Insufficient credit balance to fulfil request
INVALID_NUMBER	2	Unable to route to the destination phone number
INVALID_REQUEST	3	The request was not valid
NO_TO	5	The 'to' parameter is missing
PARAMETER_MISSING	13	The mandatory 'ud' parameter is missing
PARAMETER_INVALID	14	The 'ud' or 'udh' are malformed
DAILY_ALLOWANCE_EXCEEDED	18	The configured daily allowance on the AccessKey has been exceeded
MONTHLY_ALLOWANCE_EXCEEDED	19	The configured monthly allowance on the AccessKey has been exceeded
INTERNAL_ERROR	12	Unable to process request at this time
GATEWAY_ERROR	1	Unable to process request at this time
INVALID_FROM	27	Invalid From \ SenderId specified
NUMBER_NOT_SUPPORTED	28	Number not supported

Send WhatsApp Message

Send a message via WhatsApp

Message Type:

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "whatsapp",
    "content": {
      "format": "wa_msgobject_v2",
      "msgobject": {
        "type": "text",
        "text": {
          "body": "MESSAGE_CONTENT"
        }
      }
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'whatsapp'
format	Format of WhatsApp Message Object. Use 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0). Click here (External Link) for details of WhatsApp specific parameters.

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5"
    }
  ]
}

Response multiple recipients:

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

Response overall failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
invalid_template	26	Invalid message template
number_not_supported	28	Number not supported
number_not_in_sandbox	29	Number not in sandbox

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "whatsapp",
    "content": {
      "format": "wa_msgobject_v2",
      "msgobject": {
        "type": "template",
        "template": {
          "name": "TEMPLATE_NAME",
          "language": {
            "policy": "deterministic",
            "code": "en_GB"
          },
          "components": [
            {
              "type": "body",
              "parameters": [
                {
                  "type": "text",
                  "parameter_name": "PARAMETER_NAME",
                  "text": "PARAMETER_TEXT"
                }
              ]
            }
          ]
        }
      }
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'whatsapp'
format	Format of WhatsApp Message Object. Use 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0). Click here (External Link) for details of WhatsApp specific parameters.

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5"
    }
  ]
}

Response multiple recipients:

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

Response overall failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
invalid_template	26	Invalid message template
number_not_supported	28	Number not supported
number_not_in_sandbox	29	Number not in sandbox

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "whatsapp",
    "content": {
      "format": "wa_msgobject_v2",
      "msgobject": {
        "type": "contacts",
        "contacts": [
          {
            "addresses": [
              {
                "street": "STREET",
                "city": "CITY",
                "state": "STATE",
                "zip": "ZIP",
                "country": "COUNTRY",
                "country_code": "COUNTRY_CODE",
                "type": "WORK"
              },
              {
                "street": "STREET",
                "city": "CITY",
                "state": "STATE",
                "zip": "ZIP",
                "country": "COUNTRY",
                "country_code": "COUNTRY_CODE",
                "type": "HOME"
              }
            ],
            "birthday": "YYYY-MM-DD",
            "emails": [
              {
                "email": "EMAIL",
                "type": "WORK"
              },
              {
                "email": "EMAIL",
                "type": "HOME"
              }
            ],
            "name": {
              "formatted_name": "NAME",
              "first_name": "FIRST_NAME",
              "last_name": "LAST_NAME",
              "middle_name": "MIDDLE_NAME",
              "suffix": "SUFFIX",
              "prefix": "SUFFIX"
            },
            "org": {
              "company": "COMPANY",
              "department": "DEPARTMENT",
              "title": "TITLE"
            },
            "phones": [
              {
                "phone": "PHONE_NUMBER",
                "type": "WORK"
              },
              {
                "phone": "PHONE_NUMBER",
                "type": "HOME"
              }
            ],
            "urls": [
              {
                "url": "URL",
                "type": "WORK"
              }
            ]
          }
        ]
      }
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'whatsapp'
format	Format of WhatsApp Message Object. Use 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0). Click here (External Link) for details of WhatsApp specific parameters.

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5"
    }
  ]
}

Response multiple recipients:

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

Response overall failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
invalid_template	26	Invalid message template
number_not_supported	28	Number not supported
number_not_in_sandbox	29	Number not in sandbox

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "whatsapp",
    "content": {
      "format": "wa_msgobject_v2",
      "msgobject": {
        "type": "audio",
        "audio": {
          "link": "MEDIA_URL",
          "caption": "CAPTION"
        }
      }
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'whatsapp'
format	Format of WhatsApp Message Object. Use 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0). Click here (External Link) for details of WhatsApp specific parameters.

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5"
    }
  ]
}

Response multiple recipients:

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

Response overall failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
invalid_template	26	Invalid message template
number_not_supported	28	Number not supported
number_not_in_sandbox	29	Number not in sandbox

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "whatsapp",
    "content": {
      "format": "wa_msgobject_v2",
      "msgobject": {
        "type": "image",
        "image": {
          "link": "MEDIA_URL",
          "caption": "CAPTION"
        }
      }
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'whatsapp'
format	Format of WhatsApp Message Object. Use 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0). Click here (External Link) for details of WhatsApp specific parameters.

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5"
    }
  ]
}

Response multiple recipients:

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

Response overall failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
invalid_template	26	Invalid message template
number_not_supported	28	Number not supported
number_not_in_sandbox	29	Number not in sandbox

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "whatsapp",
    "content": {
      "format": "wa_msgobject_v2",
      "msgobject": {
        "type": "video",
        "video": {
          "link": "MEDIA_URL",
          "caption": "CAPTION"
        }
      }
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'whatsapp'
format	Format of WhatsApp Message Object. Use 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0). Click here (External Link) for details of WhatsApp specific parameters.

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5"
    }
  ]
}

Response multiple recipients:

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

Response overall failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
invalid_template	26	Invalid message template
number_not_supported	28	Number not supported
number_not_in_sandbox	29	Number not in sandbox

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "whatsapp",
    "content": {
      "format": "wa_msgobject_v2",
      "msgobject": {
        "type": "sticker",
        "sticker": {
          "link": "MEDIA_URL",
          "caption": "CAPTION"
        }
      }
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'whatsapp'
format	Format of WhatsApp Message Object. Use 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0). Click here (External Link) for details of WhatsApp specific parameters.

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5"
    }
  ]
}

Response multiple recipients:

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

Response overall failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
invalid_template	26	Invalid message template
number_not_supported	28	Number not supported
number_not_in_sandbox	29	Number not in sandbox

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "whatsapp",
    "content": {
      "format": "wa_msgobject_v2",
      "msgobject": {
        "type": "document",
        "document": {
          "link": "MEDIA_URL",
          "caption": "CAPTION"
        }
      }
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'whatsapp'
format	Format of WhatsApp Message Object. Use 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0). Click here (External Link) for details of WhatsApp specific parameters.

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5"
    }
  ]
}

Response multiple recipients:

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

Response overall failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
invalid_template	26	Invalid message template
number_not_supported	28	Number not supported
number_not_in_sandbox	29	Number not in sandbox

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "whatsapp",
    "content": {
      "format": "wa_msgobject_v2",
      "msgobject": {
        "type": "location",
        "location": {
          "longitude": 0,
          "latitude": 0,
          "name": "LOCATION_NAME",
          "address": "LOCATION_ADDRESS"
        }
      }
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'whatsapp'
format	Format of WhatsApp Message Object. Use 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0). Click here (External Link) for details of WhatsApp specific parameters.

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5"
    }
  ]
}

Response multiple recipients:

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

Response overall failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
invalid_template	26	Invalid message template
number_not_supported	28	Number not supported
number_not_in_sandbox	29	Number not in sandbox

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": {
    "from": "SENDER_ID",
    "to": "44771012345",
    "channel": "whatsapp",
    "content": {
      "format": "wa_msgobject_v2",
      "msgobject": {
        "type": "interactive",
        "interactive": {
          "type": "button",
          "action": {
            "buttons": [
              {
                "type": "reply",
                "reply": {
                  "title": "BUTTON1"
                }
              },
              {
                "type": "reply",
                "reply": {
                  "title": "BUTTON2"
                }
              }
            ]
          },
          "body": {
            "text": "MESSAGE_CONTENT"
          },
          "header": {
            "type": "text",
            "text": "HEADER_TEXT"
          }
        }
      }
    }
  }
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'
to	This 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
channel	Select message channel, use 'whatsapp'
format	Format of WhatsApp Message Object. Use 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0). Click here (External Link) for details of WhatsApp specific parameters.

Responses:

Response single recipient:

{
  "response_status": "ok",
  "messages": [
    {
      "to": "44771012345",
      "id": "21ba6a2ee454d1710d88f357df34fdb3f5"
    }
  ]
}

Response multiple recipients:

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

Response overall failure:

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

Parameters:

response_status	Overall return status
to	The recipient number
id	Unique message ID
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
insufficient_credit	10	Insufficient credit balance to fulfil request
invalid_number	2	Unable to route to the destination phone number
invalid_request	3	The request was not valid
no_to	5	The 'to' parameter is missing
daily_allowance_exceeded	18	The configured daily allowance on the AccessKey has been exceeded
monthly_allowance_exceeded	19	The configured monthly allowance on the AccessKey has been exceeded
internal_error	12	Unable to process request at this time
gateway_error	1	Unable to process request at this time
invalid_from	27	Invalid From \ SenderId specified
invalid_template	26	Invalid message template
number_not_supported	28	Number not supported
number_not_in_sandbox	29	Number not in sandbox

Get Balance

You can obtain your current balance via the HTTPS interface as follows:

JSON
Form Post

POST https://www.intellisoftware.co.uk/api/json/getbalance.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"
}

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
request_version	This specifies the version of the request format. Current version is '1.0.0'.
response_version	This specifies the required version of the response format. Current version is '1.0.3'

Responses:

Response success:

{
  "response_status": "ok",
  "balance": "100.0"
}

Response failure:

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

Parameters:

response_status	Overall return status
balance	(Optional) Remaining Credit Balance
error	Error
error_code	Error Code (Numerical representation of the 'error' parameter)
error_description	(Optional) Provides additional information about the error (parameter not always present). Error description messages subject to change without notice.

Error Codes:

login_invalid	11	AccessKey or SecretKey is invalid
auth_parameter_missing	20	Required authentication parameters are missing
auth_parameter_invalid	21	Required authentication parameters are invalid
connection_not_secure	22	Connection refused as the connection is not secure
internal_error	12	Unable to process request at this time

POST https://www.intellisoftware.co.uk/api/https/getbalance.aspx

accesskey=Yva%24ER%25Uhs%2bUU%5bMzwEYe&secretkey=F%7bkQ%5es%60wVpm!EU%7eBx8yB%5eA%24N%24%5bl%7bpxJA

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair

Responses:

Response success:

BALANCE:100.0

Response failure:

ERR:LOGIN_INVALID

Error Codes:

LOGIN_INVALID	11	AccessKey or SecretKey is invalid
AUTH_PARAMETER_MISSING	20	Required authentication parameters are missing
AUTH_PARAMETER_INVALID	21	Required authentication parameters are invalid
CONNECTION_NOT_SECURE	22	Connection refused as the connection is not secure
INTERNAL_ERROR	12	Unable to process request at this time

Update Subscription List

Use this interface to update, remove and add entries to Subscription List. For more information about Subscription Lists please click here.

POST https://www.intellisoftware.co.uk/api/https/updatesubscriptionlist.aspx

accesskey=Yva$ER%Uhs+UU[MzwEYe&secretkey=F{kQ^s`wVpm!EU~Bx8yB^A$N$[l{pxJA
&sublistname=MySubscriptionListName&msisdn=44771012345&action=1

For secure SSL connection use https:

Parameters:

accesskey	This is your AccessKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
secretkey	This is your SecretKey used to authenticate to you IntelliSoftware account Click here to create an AccessKey / SecretKey pair
sublistname	This is the name of the subscription list
msisdn	This is the phone number to be updated
action	Action to be performed 1 = Subscribe phone number (Opt-in) 2 = Unsubscribe phone number (Opt-out) 3 = Delete phone number from subscription list

Responses:

OK	The request action has been completed
ERR:LOGIN_INVALID	AccessKey or SecretKey is invalid
ERR:AUTH_PARAMETER_MISSING	Parameter(s) required authenitcation are missing
ERR:AUTH_PARAMETER_INVALID	Parameter(s) required authenitcation are invalid
ERR:CONNECTION_NOT_SECURE	Connection refused as the connection is not secure
ERR:PARAMETER_MISSING	sublistname, msisdn or action parameter is missing
ERR:PPARAMETER_INVALID	sublistname or action parameter is invalid
ERR:INVALID_REQUEST	The request was not valid
ERR:INTERNAL_ERROR	Unable to process request at this time
ERR:GATEWAY_ERROR	Unable to process request at this time

Receive Message

Our server can be configured to forward received SMS messages to you webserver via a HTTP POST.

To configure HTTP forwarding please login into your account and go to Preferences and then select the Forwarding tab.

JSON
Form Post

Message Type:

{
  "messages": [
    {
      "from": "44771012345",
      "to": "44771012346",
      "messageid": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "channel": "sms",
      "sent": "2025-06-03T13:50:05-00:00",
      "content": {
        "msgtype": "text",
        "text": "Message Text"
      }
    }
  ]
}

Parameters:

from	The mobile number of the message sender
to	Virtual number the message was received on
messageid	IntelliSoftware's allocated message id
channel	Message channel ('sms')
sent	Date and time message was sent (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST
msgtype	Message Type ('text')
text	The content of the text message

{
  "messages": [
    {
      "from": "44771012345",
      "to": "44771012346",
      "messageid": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "channel": "sms",
      "sent": "2025-06-03T13:50:05-00:00",
      "content": {
        "msgtype": "unicode",
        "text": "Simley Emoji \uD83D\uDE03"
      }
    }
  ]
}

Parameters:

from	The mobile number of the message sender
to	Virtual number the message was received on
messageid	IntelliSoftware's allocated message id
channel	Message channel ('sms')
sent	Date and time message was sent (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST
msgtype	Message Type ('unicode')
text	The content of the text message

{
  "messages": [
    {
      "from": "44771012345",
      "to": "44771012346",
      "messageid": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "channel": "sms",
      "sent": "2025-06-03T13:50:05-00:00",
      "content": {
        "msgtype": "binary",
        "ud": "32F40100480E01000000000000000000000000000000000000000000000000000000000001247803000000E0080120CC0640000040080120CC06C00000479E7124F0EFFADCF64448892479B6DAC6CD4448F9241DB6DACECF44488124CDB6CD96CC44488924CDB6CD96CDE446712478E66D9EC6000000000000000000000000000000000000"
      }
    }
  ]
}

Parameters:

from	The mobile number of the message sender
to	Virtual number the message was received on
messageid	IntelliSoftware's allocated message id
channel	Message channel ('sms')
sent	Date and time message was sent (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST
msgtype	Message Type ('binary')
ud	User Data

{
  "messages": [
    {
      "from": "44771012345",
      "to": "44771012346",
      "messageid": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "channel": "whatsapp",
      "sent": "2025-06-03T13:50:05-00:00",
      "content": {
        "format": "wa_msgobject_v2",
        "msgobject": {
          "type": "text",
          "text": {
            "body": "MESSAGE_CONTENT"
          }
        }
      }
    }
  ]
}

Parameters:

from	The mobile number of the message sender
to	Virtual number the message was received on
messageid	IntelliSoftware's allocated message id
channel	Message channel ('whatsapp')
sent	Date and time message was sent (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST
format	Format of WhatsApp Message Object. Latest version is 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0)

{
  "messages": [
    {
      "from": "44771012345",
      "to": "44771012346",
      "messageid": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "channel": "whatsapp",
      "sent": "2025-06-03T13:50:05-00:00",
      "content": {
        "format": "wa_msgobject_v2",
        "msgobject": {
          "type": "button",
          "button": {
            "text": "BUTTON_TEXT"
          }
        }
      }
    }
  ]
}

Parameters:

from	The mobile number of the message sender
to	Virtual number the message was received on
messageid	IntelliSoftware's allocated message id
channel	Message channel ('whatsapp')
sent	Date and time message was sent (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST
format	Format of WhatsApp Message Object. Latest version is 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0)

{
  "messages": [
    {
      "from": "44771012345",
      "to": "44771012346",
      "messageid": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "channel": "whatsapp",
      "sent": "2025-06-03T13:50:05-00:00",
      "content": {
        "format": "wa_msgobject_v2",
        "msgobject": {
          "type": "interactive",
          "interactive": {
            "type": "button_reply",
            "button_reply": {
              "title": "Button1",
              "id": "BUTTON1"
            }
          }
        }
      }
    }
  ]
}

Parameters:

from	The mobile number of the message sender
to	Virtual number the message was received on
messageid	IntelliSoftware's allocated message id
channel	Message channel ('whatsapp')
sent	Date and time message was sent (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST
format	Format of WhatsApp Message Object. Latest version is 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0)

{
  "messages": [
    {
      "from": "44771012345",
      "to": "44771012346",
      "messageid": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "channel": "whatsapp",
      "sent": "2025-06-03T13:50:05-00:00",
      "content": {
        "format": "wa_msgobject_v2",
        "msgobject": {
          "type": "image",
          "image": {
            "link": "MEDIA_URL"
          }
        }
      }
    }
  ]
}

Parameters:

from	The mobile number of the message sender
to	Virtual number the message was received on
messageid	IntelliSoftware's allocated message id
channel	Message channel ('whatsapp')
sent	Date and time message was sent (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST
format	Format of WhatsApp Message Object. Latest version is 'wa_msgobject_v2'
msgobject	WhatsApp Message Object (Version 2.0)

Message Type:

text=Message+Text&msgid=10011000000000000001&networkcode=234010&sent=2025-06-03T13%3a50%3a05-00%3a00

Parameters:

text	The content of the text message
msgid	IntelliSoftware's allocated message id
networkcode	The sender's home network. This parameter is only available for messages received on shortcodes. See Network Code table below for values.
sent	Date and time message was sent (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST

text=Message+Text&msgid=10011000000000000001&networkcode=234010&sent=2025-06-03T13%3a50%3a05-00%3a00

Parameters:

text	The content of the text message
msgid	IntelliSoftware's allocated message id
networkcode	The sender's home network. This parameter is only available for messages received on shortcodes. See Network Code table below for values.
sent	Date and time message was sent (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST

text=Message+Text&msgid=10011000000000000001&networkcode=234010&sent=2025-06-03T13%3a50%3a05-00%3a00

Parameters:

text	The content of the text message
msgid	IntelliSoftware's allocated message id
networkcode	The sender's home network. This parameter is only available for messages received on shortcodes. See Network Code table below for values.
sent	Date and time message was sent (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST

HTTP Response:

Our server expects a HTTP 200 (OK) status. Any content returned by your server will be ignored.

If anything other than a status 200 is returned then our server will consider this an error. On an error condition our server will retry to delivery the same message every 5 minute until the error is resolved.

Message Status Report

Our server can be configured to forward message status reports (e.g. Delivery Reports) to you webserver via a HTTP POST.

To configure HTTP forwarding please login into your account and go to Preferences and then select the Forwarding tab.

JSON
Form Post

{
  "notifications": [
    {
      "notificationtype": "status",
      "messageid": "21ba6a2ee454d1710d88f357df34fdb3f5",
      "to": "44771012345",
      "status": "delivered",
      "status_code": 4,
      "category": "success",
      "userkey": "UserKey"
    }
  ]
}

Parameters:

notificationtype	Notification Type ('status')
messageid	Unique message id (as returned when message was sent)
to	Phone Number message was sent to
status	Message status (See table below)
status_code	Status Code (Numerical representation of the 'status' parameter, see table below)
category	Message status category (success/interim/failure/rejection)
userkey	(Optional) Userkey provided when message was sent

Message Status:

queued	2	Message Queued
sent	3	Message Sent
delivered	4	Message Delivered
error_with_request	5	Error With Request
unable_to_deliver	6	Unable To Deliver
routing_error	7	Routing Error
expired	8	Message Expired
acknowledged_by_recipient	11	Acknowledged By Recipient (Voice-SMS Only)
rejected_by_recipient	12	Rejected By Recipient (Voice-SMS Only)
rejected_spam_filter	13	Rejected (Spam Filtering)
read	14	Message Read (WhatsApp and RCS Only)
rejected_response_window	15	Rejected Response Window (WhatsApp Only)
rejected_age_restriction	16	Rejected Age Restriction (WhatsApp Only)
recipient_not_provisioned	17	Rejected Recipient Not Provisioned (WhatsApp Only)

msgid=10011000000000000001&status=4&toaddr=44771012345

Parameters:

msgid	Unique message id (as returned when message was sent)
status	Message status (See table below)
toaddr	Phone Number message was sent to

Message Status:

2	Message Queued
3	Message Sent
4	Message Delivered
5	Error With Request
6	Unable To Deliver
7	Routing Error
8	Message Expired
11	Acknowledged By Recipient (Voice-SMS Only)
12	Rejected By Recipient (Voice-SMS Only)
13	Rejected (Spam Filtering)
14	Message Read (WhatsApp and RCS Only)
15	Rejected Response Window (WhatsApp Only)
16	Rejected Age Restriction (WhatsApp Only)
17	Rejected Recipient Not Provisioned (WhatsApp Only)

HTTP Response:

Our server expects a HTTP 200 (OK) status. Any content returned by your server will be ignored.

If anything other than a status 200 is returned then our server will consider this an error. On an error condition our server will retry to delivery the same status report every 5 minute until the error is resolved.

Subscription List Event

Our server can be configured to send notifications of changes to Subscription Lists. For more information about Subscription Lists please click here.

To configure Subscription Lists Event notifications, please login into your account and go to Preferences and then select the Forwarding tab.

POST Fields:

sublistname	Subscription list name.
sublisttype	Subscription List Type: 1 = Premium Rate Subscription List (ARB) 2 = User Subscription List (Setup in SMSWeb)
msisdn	Mobile phone number that has been updated within the Subscription List
action	Action that was performed: 1 = Subscribed phone number (Opt-in) 2 = Unsubscribed phone number (Opt-out) 3 = Deleted phone number from subscription list
source	The source of the change: 1 = Inbound SMS Message (MO) 2 = Inbound MMS Message (MO) 3 = Outgoing SMS Message (MT) 4 = Outgoing MMS Message (MT) 5 = Web Portal (WebSMS) 6 = Change made by IntelliSoftware Support 7 = Change made via API 8 = Platform Level Event (e.g. STOP to 86688) 9 = Message Delivery Status Report 10 = IntelliSoftware Help Desk (via Phone Call) 11 = IntelliSoftware Help Desk (via Email) 12 = IntelliSoftware Help Desk (via Web Form)
timestamp	Date and time change was made (in W3CDTF DateTime Format) Examples: 2010-02-03T13:50:05-00:00 = 3rd February 2010 13:50:05 GMT 2010-06-10T14:45:12+01:00 = 10th June 2010 14:45:12 BST

HTTP Response:

Our server expects a HTTP 200 (OK) status. Any content returned by your server will be ignored.

If anything other than a status 200 is returned, then our server will consider this an error. On receipt of an error our server will retry to deliver the same message every 5 minutes until the error is resolved.

ASP Example:

<%
SubscriptionListName = Request("sublistname")
PhoneNumber = Request("msisdn")
Action = Request("action")


-- Place code here to use SubscriptionListName, PhoneNumber
-- and Action values
-- e.g. store notification to a database

%>

Network Codes

Here is a list of network codes returned by the IntelliSoftware SMS platform:

234010	O2 (UK)
234015	Vodafone (UK)
234020	Three (UK)
234030	T-Mobile (UK)
234033	Orange (UK)
0	Network Unknown

Advanced Features

Send to Distribution Lists (or Group Send)

Our gateway allows you to send SMS messages to preconfigured Distribution Lists or Groups. To send to a Distribution List or Group simply insert the Group Name were you would normally place the recipient's phone number. Distribution Lists or Groups are setup in your online account login on the Contacts page.

Reply Tracking:

The IntelliSoftware platform provides tracking of SMS replies, allowing you to determine which particular message a mobile user is replying to. When you submit a message to the SMS Gateway you can supply a User Context parameter. When a reply is received, the IntelliSoftware platform will included the User Context parameter when forwarding the message to your server.

The User Context can be supplied to the IntelliSoftware platform in the following ways:

.Net Component	use SendMsgWithUserContext method
COM Component	use SendMessageWithUserContext method
HTTP Interface	add 'usercontext' POST/GET parameter
SMTP Interface (Email to SMS)	add 'UserContext:' parameter
PHP SDK	use SendMessageWithUserContext method
Java SDK	use SendMessageWithUserContext method

The IntelliSoftware platform will forward the User Context for received messages in the following ways:

HTTP Interface	'usercontext' POST/GET parameter
SMTP Interface (SMS to Email)	User Context appears in Subject line

HTTP Interface

Send SMS Message

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Error Codes:

Parameters:

Responses:

Error Codes:

Parameters:

Responses:

Error Codes:

Send WhatsApp Message

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Parameters:

Error Codes:

Get Balance

Parameters:

Responses:

Parameters:

Error Codes:

Parameters:

Responses:

Error Codes:

Update Subscription List

Parameters:

Responses:

Receive Message

Parameters:

Parameters:

Parameters:

Parameters: