Customer callbacks

Example of a customer's sms status end-point

get
Query parameters
integrationNamestringOptional
messageIdstringOptional
requestIdstringOptional
clientMessageIdstringOptional
tostringOptional
fromstringOptional
statusCodeinteger · int32Optional
statusstringOptional
statusDescriptionstringOptional
timestampstringOptional
Responses
200

Success

No content
get
/client-callback/sms-status
GET /client-callback/sms-status HTTP/1.1
Host: platform.clickatell.com
Accept: */*
200

Success

No content

Example of a customer's sms status end-point

post
Body
integrationNamestringOptional
messageIdstringOptional
requestIdstringOptional
clientMessageIdstringOptional
tostringOptional
fromstringOptional
statusCodeinteger · int32Optional
statusstringOptional
statusDescriptionstringOptional
timestampstringOptional
Responses
200

Success

No content
post
/client-callback/sms-status
POST /client-callback/sms-status HTTP/1.1
Host: platform.clickatell.com
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "integrationName": "text",
  "messageId": "text",
  "requestId": "text",
  "clientMessageId": "text",
  "to": "text",
  "from": "text",
  "statusCode": 1,
  "status": "text",
  "statusDescription": "text",
  "timestamp": "text"
}
200

Success

No content

Example of a customer's sms status end-point

get
Query parameters
integrationNamestringOptional

Integration name

Example: My production integration
replyMessageIdstringOptional
messageIdstringOptional
fromNumberstringOptional
toNumberstringOptional
timestampinteger · int64Optional
textstringOptional
charsetstringOptional
udhstringOptional
networkinteger · int32Optional
keywordstringOptional
Responses
200

Success

No content
get
/client-callback/sms-reply
GET /client-callback/sms-reply HTTP/1.1
Host: platform.clickatell.com
Accept: */*
200

Success

No content

Example of a customer's sms reply end-point

post
Body
integrationNamestringOptional
replyMessageIdstringOptional
messageIdstringOptional
fromNumberstringOptional
toNumberstringOptional
timestampinteger · int64Optional
textstringOptional
charsetstringOptional
udhstringOptional
networkinteger · int32Optional
keywordstringOptional
Responses
200

Success

No content
post
/client-callback/sms-reply
POST /client-callback/sms-reply HTTP/1.1
Host: platform.clickatell.com
Content-Type: application/json
Accept: */*
Content-Length: 194

{
  "integrationName": "text",
  "replyMessageId": "text",
  "messageId": "text",
  "fromNumber": "text",
  "toNumber": "text",
  "timestamp": 1,
  "text": "text",
  "charset": "text",
  "udh": "text",
  "network": 1,
  "keyword": "text"
}
200

Success

No content

PreviousMessagesNextSMS Gateway Docs

Last updated