Trendsic Platform Service

<back to all web services

MessagingTestRequest

Requires Authentication
The following routes are available for this service:
POST/v1/messaging/test
"use strict";
export class MessagingTestSend {
    /** @param {{StepId?:string,Status?:string,Output?:string,Body?:string,Segments?:number,SmsMessageId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StepId;
    /** @type {string} */
    Status;
    /** @type {string} */
    Output;
    /** @type {string} */
    Body;
    /** @type {number} */
    Segments;
    /** @type {number} */
    SmsMessageId;
}
export class MessagingTestResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Sent?:MessagingTestSend[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {MessagingTestSend[]} */
    Sent = [];
}
export class MessagingTestRequest {
    /** @param {{RuleKey?:string,BranchId?:string,LineId?:string,StepIds?:string[],ToPhone?:string,Remember?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RuleKey;
    /** @type {string} */
    BranchId;
    /** @type {?string} */
    LineId;
    /** @type {string[]} */
    StepIds = [];
    /** @type {string} */
    ToPhone;
    /** @type {boolean} */
    Remember;
}

JavaScript MessagingTestRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"RuleKey":"String","BranchId":"00000000000000000000000000000000","LineId":"00000000000000000000000000000000","StepIds":["String"],"ToPhone":"String","Remember":false}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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}]}