| Requires any of the roles: | Client, Admin, Partner |
| POST | /communication/message/smpp/sms | Sends an SMS to phone numbers provided. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Messages | body | List<SMPPMessage> | 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<SMPPResponseMsg> | 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 | |
| msg | form | SMPPMessage | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /communication/message/smpp/sms HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Messages:
[
{
channel: String,
to: String,
content: String,
clientMessageId: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}