| POST | /v1/messaging/test |
|---|
export class MessagingTestSend
{
public StepId: string;
public Status: string;
public Output: string;
public Body: string;
public Segments: number;
public SmsMessageId: number;
public constructor(init?: Partial<MessagingTestSend>) { (Object as any).assign(this, init); }
}
export class MessagingTestResponse
{
public ResponseStatus: ResponseStatus;
public Sent: MessagingTestSend[] = [];
public constructor(init?: Partial<MessagingTestResponse>) { (Object as any).assign(this, init); }
}
export class MessagingTestRequest
{
public RuleKey: string;
public BranchId: string;
public LineId?: string;
public StepIds: string[] = [];
public ToPhone: string;
public Remember: boolean;
public constructor(init?: Partial<MessagingTestRequest>) { (Object as any).assign(this, init); }
}
TypeScript MessagingTestRequest DTOs
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
}
]
}