Messages
Send message via REST integration
Authorizations
Body
Send sms request
contentstringOptional
tostring[]Optional
fromstringOptional
binarybooleanOptional
clientMessageIdstringOptional
scheduledDeliveryTimestringOptional
userDataHeaderstring · min: 1 · max: 2147483647Optional
validityPeriodinteger · int32Optional
charsetstringOptional
Responses
202
Success
post
/messagesPOST /messages HTTP/1.1
Host: platform.clickatell.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 176
{
"content": "text",
"to": [
"text"
],
"from": "text",
"binary": true,
"clientMessageId": "text",
"scheduledDeliveryTime": "text",
"userDataHeader": "text",
"validityPeriod": 1,
"charset": "text"
}202
Success
{
"messages": [
{
"apiMessageId": "text",
"accepted": true,
"to": "text",
"errorCode": 1,
"error": "text",
"errorDescription": "text"
}
],
"errorCode": 1,
"error": "text",
"errorDescription": "text"
}Send bulk messages via REST integration
Authorizations
Body
Responses
202
Success
application/json
post
/messages/rest/bulkPOST /messages/rest/bulk HTTP/1.1
Host: platform.clickatell.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 194
{
"messageList": [
{
"content": "text",
"to": [
"text"
],
"from": "text",
"binary": true,
"clientMessageId": "text",
"scheduledDeliveryTime": "text",
"userDataHeader": "text",
"validityPeriod": 1,
"charset": "text"
}
]
}202
Success
[
{
"messages": [
{
"apiMessageId": "text",
"accepted": true,
"to": "text",
"errorCode": 1,
"error": "text",
"errorDescription": "text"
}
],
"errorCode": 1,
"error": "text",
"errorDescription": "text"
}
]Send message via HTTP integration
Query parameters
apiKeystringRequired
Integration API key.
tostringRequired
Receiver number.
fromstringOptional
Sender number in two-way integration.
contentstringRequired
Message content.
clientMessageIdstringOptional
Client message id
Responses
202
Success
get
/messages/http/sendGET /messages/http/send?apiKey=text&to=text&content=text HTTP/1.1
Host: platform.clickatell.com
Accept: */*
202
Success
{
"messages": [
{
"apiMessageId": "text",
"accepted": true,
"to": "text",
"errorCode": 1,
"error": "text",
"errorDescription": "text"
}
],
"errorCode": 1,
"error": "text",
"errorDescription": "text"
}Last updated