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": "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 |
response_version | This specifies the required version of the response format |
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'. Default 'sms' |
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",
"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_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 |
creditsused | Credits used to send message |
error | Error |
error_code | Error 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_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": {
"to": "44771012345",
"from": "SENDER_ID",
"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 |
response_version | This specifies the required version of the response format |
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'. Default 'sms' |
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",
"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_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 |
creditsused | Credits used to send message |
error | Error |
error_code | Error 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_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": {
"to": "44771012345",
"from": "SENDER_ID",
"channel": "whatsapp",
"content": {
"format": "wa_msgobject_v2",
"msgobject": {
"type": "contacts",
"contacts": [
{
"addresses": [
{
"streetstring": "STREET",
"city": "CITY",
"state": "STATE",
"zipstring": "ZIP",
"country": "COUNTRY",
"country_code": "COUNTRY_CODE",
"type": "WORK"
},
{
"streetstring": "STREET",
"city": "CITY",
"state": "STATE",
"zipstring": "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 |
response_version | This specifies the required version of the response format |
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'. Default 'sms' |
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",
"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_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 |
creditsused | Credits used to send message |
error | Error |
error_code | Error 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_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": {
"to": "44771012345",
"from": "SENDER_ID",
"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 |
response_version | This specifies the required version of the response format |
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'. Default 'sms' |
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",
"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_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 |
creditsused | Credits used to send message |
error | Error |
error_code | Error 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_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": {
"to": "44771012345",
"from": "SENDER_ID",
"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 |
response_version | This specifies the required version of the response format |
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'. Default 'sms' |
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",
"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_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 |
creditsused | Credits used to send message |
error | Error |
error_code | Error 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_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": {
"to": "44771012345",
"from": "SENDER_ID",
"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 |
response_version | This specifies the required version of the response format |
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'. Default 'sms' |
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",
"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_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 |
creditsused | Credits used to send message |
error | Error |
error_code | Error 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_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": {
"to": "44771012345",
"from": "SENDER_ID",
"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 |
response_version | This specifies the required version of the response format |
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'. Default 'sms' |
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",
"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_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 |
creditsused | Credits used to send message |
error | Error |
error_code | Error 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_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": {
"to": "44771012345",
"from": "SENDER_ID",
"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 |
response_version | This specifies the required version of the response format |
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'. Default 'sms' |
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",
"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_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 |
creditsused | Credits used to send message |
error | Error |
error_code | Error 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_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": {
"to": "44771012345",
"from": "SENDER_ID",
"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 |
response_version | This specifies the required version of the response format |
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'. Default 'sms' |
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",
"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_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 |
creditsused | Credits used to send message |
error | Error |
error_code | Error 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_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": {
"to": "44771012345",
"from": "SENDER_ID",
"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 |
response_version | This specifies the required version of the response format |
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'. Default 'sms' |
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",
"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_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 |
creditsused | Credits used to send message |
error | Error |
error_code | Error 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_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 |