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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<MessagingTestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
  <LineId>00000000-0000-0000-0000-000000000000</LineId>
  <Remember>false</Remember>
  <RuleKey>String</RuleKey>
  <StepIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StepIds>
  <ToPhone>String</ToPhone>
</MessagingTestRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessagingTestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Sent>
    <MessagingTestSend>
      <Body>String</Body>
      <Output>String</Output>
      <Segments>0</Segments>
      <SmsMessageId>0</SmsMessageId>
      <Status>String</Status>
      <StepId>String</StepId>
    </MessagingTestSend>
  </Sent>
</MessagingTestResponse>