Evo Voice

<back to all web services

ListConversations

Requires Authentication
The following routes are available for this service:
GET/conversations


export class NodeParameterMap
{
    [key:string] : NodeParameter;

    public constructor(init?: Partial<NodeParameterMap>) { (Object as any).assign(this, init); }
}


export enum MessageDirections
{
    Incoming = 'Incoming',
    Outgoing = 'Outgoing',
}

export class MessageInfo
{
    public id?: string;
    public accountId?: string;
    public customerId?: string;
    public endpointId?: string;
    public endpointDisplayName?: string;
    public date?: string;
    public direction?: MessageDirections;
    public otherAddress?: string;
    public sender?: string;
    public text?: string;
    public isUnread?: boolean;

    public constructor(init?: Partial<MessageInfo>) { (Object as any).assign(this, init); }
}

export class ConversationInfo
{
    public id?: string;
    public endpointId?: string;
    public otherAddress?: string;
    public mostRecentMessage?: MessageInfo;

    public constructor(init?: Partial<ConversationInfo>) { (Object as any).assign(this, init); }
}

export class ListConversationsResponse
{
    public conversations?: ConversationInfo[];

    public constructor(init?: Partial<ListConversationsResponse>) { (Object as any).assign(this, init); }
}

export class ListConversations
{
    /**
    * The IDs of the account whose conversations you want to retrieve
    */
    // @ApiMember(Description="The IDs of the account whose conversations you want to retrieve")
    public accountIds?: string[];

    /**
    * The list of endpoint IDs whose conversations you want to retrieve
    */
    // @ApiMember(Description="The list of endpoint IDs whose conversations you want to retrieve")
    public endpointIds?: string[];

    /**
    * The list of customer IDs whose conversations you want to retrieve
    */
    // @ApiMember(Description="The list of customer IDs whose conversations you want to retrieve")
    public customerIds?: string[];

    /**
    * The start date for the conversations you want to retrieve
    */
    // @ApiMember(Description="The start date for the conversations you want to retrieve")
    public afterDate?: string;

    public constructor(init?: Partial<ListConversations>) { (Object as any).assign(this, init); }
}

TypeScript ListConversations 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 /conversations HTTP/1.1 
Host: evovoice.io 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"conversations":[{"id":"String","endpointId":"String","otherAddress":"String","mostRecentMessage":{"id":"String","accountId":"String","customerId":"String","endpointId":"String","endpointDisplayName":"String","date":"String","direction":"Incoming","otherAddress":"String","sender":"String","text":"String","isUnread":false}}]}