digitaluapi

SendSmsRequest

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
POST	/communication/message/sms	Sends an SMS to phone numbers provided.

**SendSmsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Messages	body	List<SmsMessage>	Yes	Messages to be Sent

**SmsMessage** Parameters:
Name	Parameter	Data Type	Required
channel	form	string	No
to	form	string	No
content	form	string	No
clientMessageId	form	string	No

**SmsMsgResponse** Parameters:
Name	Parameter	Data Type	Required
grandcomMsgResponse	form	GrandcomMsgResponse	No
clickatellMsgResponse	form	ClickatellMessageResponse	No
SMPPMsgResponse	form	SMPPMsgResponse	No
error	form	string	No
ResponseStatus	form	ResponseStatus	No

**GrandcomMsgResponse** Parameters:
Name	Parameter	Data Type	Required
messages	form	List<GrandcomResponseMsg>	No
error	form	string	No
ResponseStatus	form	ResponseStatus	No

**GrandcomResponseMsg** Parameters:
Name	Parameter	Data Type	Required
apiMessageId	form	string	No
accepted	form	bool	No
to	form	string	No
error	form	string	No
hasError	form	bool	No
msg	form	GrandcomMessage	No

**GrandcomMessage** Parameters:
Name	Parameter	Data Type	Required
channel	form	string	No
to	form	string	No
content	form	string	No
clientMessageId	form	string	No

**ClickatellMessageResponse** Parameters:
Name	Parameter	Data Type	Required
messages	form	List<ClickatellResponsesMsg>	No
error	form	string	No
ResponseStatus	form	ResponseStatus	No

**ClickatellResponsesMsg** Parameters:
Name	Parameter	Data Type	Required
apiMessageId	form	string	No
accepted	form	bool	No
to	form	string	No
error	form	string	No
msg	form	ClickatellMessage	No

**ClickatellMessage** Parameters:
Name	Parameter	Data Type	Required
channel	form	string	No
to	form	string	No
content	form	string	No
clientMessageId	form	string	No

**SMPPMsgResponse** Parameters:
Name	Parameter	Data Type	Required
messages	form	List<SMPPResponseMsg>	No
error	form	string	No
ResponseStatus	form	ResponseStatus	No

**SMPPResponseMsg** Parameters:
Name	Parameter	Data Type	Required
apiMessageId	form	string	No
accepted	form	bool	No
to	form	string	No
error	form	string	No
msg	form	SMPPMessage	No

**SMPPMessage** Parameters:
Name	Parameter	Data Type	Required
channel	form	string	No
to	form	string	No
content	form	string	No
clientMessageId	form	string	No

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/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

{"grandcomMsgResponse":{"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"}}},"clickatellMsgResponse":{"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"}}},"SMPPMsgResponse":{"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"}}},"error":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}