| Requires any of the roles: | Client, Admin, Partner |
| POST | /channel_sms_messages |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCodesId | body | long | Yes | |
| Reference | body | string | No | |
| TenantsId | body | int | Yes | |
| ChannelMessagesId | body | long | Yes | |
| Recipients | body | string | Yes | |
| TemplatesId | body | int | Yes | |
| TemplateText | body | string | Yes | |
| DateCreated | body | DateTimeOffset | Yes | |
| DateSent | body | DateTimeOffset? | No | |
| RetryCount | body | int | Yes | |
| MessageGuid | body | Guid | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCodesId | form | long | No | |
| Reference | form | string | No | |
| TenantsId | form | int | No | |
| ChannelMessagesId | form | long | No | |
| Recipients | form | string | No | |
| TemplatesId | form | int | No | |
| TemplateText | form | string | No | |
| DateCreated | form | DateTimeOffset | No | |
| DateSent | form | DateTimeOffset? | No | |
| RetryCount | form | int | No | |
| MessageGuid | form | Guid | No | |
| ResponseStatus | form | ResponseStatus | 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 /channel_sms_messages HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
StatusCodesId: 0,
Reference: String,
TenantsId: 0,
ChannelMessagesId: 0,
Recipients: String,
TemplatesId: 0,
TemplateText: String,
DateCreated: 0001-01-01T00:00:00.0000000+00:00,
DateSent: 0001-01-01T00:00:00.0000000+00:00,
RetryCount: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
StatusCodesId: 0,
Reference: String,
TenantsId: 0,
ChannelMessagesId: 0,
Recipients: String,
TemplatesId: 0,
TemplateText: String,
DateCreated: 0001-01-01T00:00:00.0000000+00:00,
DateSent: 0001-01-01T00:00:00.0000000+00:00,
RetryCount: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}