Trendsic Platform Service

<back to all web services

ContactCommunicationsByHeaderRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET/v1/Communications/{ConversationHeaderId}
"use strict";
export class ContactCommunication {
    /** @param {{ContactId?:number,ContactName?:string,AgentId?:number,AgentName?:string,DateCreated?:string,Message?:string,MessageType?:string,IsAgentMessage?:boolean,Sender?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContactId;
    /** @type {string} */
    ContactName;
    /** @type {number} */
    AgentId;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    Message;
    /** @type {string} */
    MessageType;
    /** @type {boolean} */
    IsAgentMessage;
    /** @type {string} */
    Sender;
}
export class ContactCommunicationsResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Communications?:ContactCommunication[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ContactCommunication[]} */
    Communications = [];
}
export class ContactCommunicationsByHeaderRequest {
    /** @param {{ConversationHeaderId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ConversationHeaderId;
}

JavaScript ContactCommunicationsByHeaderRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/Communications/{ConversationHeaderId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Communications":[{"ContactId":0,"ContactName":"String","AgentId":0,"AgentName":"String","DateCreated":"0001-01-01T00:00:00.0000000","Message":"String","MessageType":"String","IsAgentMessage":false,"Sender":"String"}]}