Evo Voice

<back to all web services

SendMessage

Requires Authentication
Required role:User
The following routes are available for this service:
POST/sessions/{sessionId}/messages
All Verbs/messages
"use strict";
/** @typedef {'Incoming'|'Outgoing'} */
export var MessageDirections;
(function (MessageDirections) {
    MessageDirections["Incoming"] = "Incoming"
    MessageDirections["Outgoing"] = "Outgoing"
})(MessageDirections || (MessageDirections = {}));
export class MessageInfo {
    /** @param {{id?:string,accountId?:string,customerId?:string,endpointId?:string,endpointDisplayName?:string,date?:string,direction?:MessageDirections,otherAddress?:string,sender?:string,text?:string,isUnread?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    accountId;
    /** @type {string} */
    customerId;
    /** @type {string} */
    endpointId;
    /** @type {string} */
    endpointDisplayName;
    /** @type {string} */
    date;
    /** @type {MessageDirections} */
    direction;
    /** @type {string} */
    otherAddress;
    /** @type {string} */
    sender;
    /** @type {string} */
    text;
    /** @type {boolean} */
    isUnread;
}
export class SendMessage {
    /** @param {{sessionId?:string,endpointId?:string,toAddress?:string,body?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The ID of the session you want to post a message to. Specify either this or EndpointId+ToAddress */
    sessionId;
    /**
     * @type {string}
     * @description The ID of the endpoint you want to post a message to. Typically the ID of a phone number endpoint. Not used if SessionId is specified */
    endpointId;
    /**
     * @type {string}
     * @description The address of the party you want to send a message to, e.g. +15556667777. Not used if SessionId is specified */
    toAddress;
    /**
     * @type {string}
     * @description The body of the message */
    body;
}

JavaScript SendMessage DTOs

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

HTTP + JSV

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

POST /sessions/{sessionId}/messages HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	sessionId: String,
	endpointId: String,
	toAddress: String,
	body: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	accountId: String,
	customerId: String,
	endpointId: String,
	endpointDisplayName: String,
	date: String,
	direction: Incoming,
	otherAddress: String,
	sender: String,
	text: String,
	isUnread: False
}