| Requires any of the roles: | Client, Admin, Partner |
| POST | /communication/message/grandcom/sms | Sends an SMS to phone numbers provided. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Messages | body | List<GrandcomMessage> | Yes | Messages to be Sent |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| channel | form | string | No | |
| to | form | string | No | |
| content | form | string | No | |
| clientMessageId | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| messages | form | List<GrandcomResponseMsg> | No | |
| error | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| apiMessageId | form | string | No | |
| accepted | form | bool | No | |
| to | form | string | No | |
| error | form | string | No | |
| hasError | form | bool | No | |
| msg | form | GrandcomMessage | 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
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"}}}