| POST | /v1/messaging/test |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RuleKey | body | string | No | |
| BranchId | body | Guid | No | |
| LineId | body | Guid? | No | |
| StepIds | body | List<string> | No | |
| ToPhone | body | string | No | |
| Remember | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| Sent | form | List<MessagingTestSend> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StepId | form | string | No | |
| Status | form | string | No | |
| Output | form | string | No | |
| Body | form | string | No | |
| Segments | form | int | No | |
| SmsMessageId | form | long | 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 /v1/messaging/test HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
RuleKey: String,
BranchId: 00000000000000000000000000000000,
LineId: 00000000000000000000000000000000,
StepIds:
[
String
],
ToPhone: String,
Remember: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
Sent:
[
{
StepId: String,
Status: String,
Output: String,
Body: String,
Segments: 0,
SmsMessageId: 0
}
]
}