digitaluapi

<back to all web services

SendGrandcomSmsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/communication/message/grandcom/smsSends an SMS to phone numbers provided.
SendGrandcomSmsRequest Parameters:
NameParameterData TypeRequiredDescription
MessagesbodyList<GrandcomMessage>YesMessages to be Sent
GrandcomMessage Parameters:
NameParameterData TypeRequiredDescription
channelformstringNo
toformstringNo
contentformstringNo
clientMessageIdformstringNo
GrandcomMsgResponse Parameters:
NameParameterData TypeRequiredDescription
messagesformList<GrandcomResponseMsg>No
errorformstringNo
ResponseStatusformResponseStatusNo
GrandcomResponseMsg Parameters:
NameParameterData TypeRequiredDescription
apiMessageIdformstringNo
acceptedformboolNo
toformstringNo
errorformstringNo
hasErrorformboolNo
msgformGrandcomMessageNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /communication/message/grandcom/sms HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

{"messages":[{"apiMessageId":"String","accepted":false,"to":"String","error":"String","hasError":false,"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"}}}