digitaluapi

<back to all web services

SendClickatellSmsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/communication/message/clickatell/smsSends an SMS to phone numbers provided.
SendClickatellSmsRequest Parameters:
NameParameterData TypeRequiredDescription
MessagesbodyList<ClickatellMessage>YesMessages to be Sent
ClickatellMessage Parameters:
NameParameterData TypeRequiredDescription
channelformstringNo
toformstringNo
contentformstringNo
clientMessageIdformstringNo
ClickatellMessageResponse Parameters:
NameParameterData TypeRequiredDescription
messagesformList<ClickatellResponsesMsg>No
errorformstringNo
ResponseStatusformResponseStatusNo
ClickatellResponsesMsg Parameters:
NameParameterData TypeRequiredDescription
apiMessageIdformstringNo
acceptedformboolNo
toformstringNo
errorformstringNo
msgformClickatellMessageNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /communication/message/clickatell/sms HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Messages":[{"channel":"String","to":"String","content":"String","clientMessageId":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"messages":[{"apiMessageId":"String","accepted":false,"to":"String","error":"String","msg":{"channel":"String","to":"String","content":"String","clientMessageId":"String"}}],"error":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}