Required role: | User |
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;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<SendMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Sessions">
<Body>String</Body>
<EndpointId>String</EndpointId>
<SessionId>String</SessionId>
<ToAddress>String</ToAddress>
</SendMessage>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <MessageInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Messaging"> <AccountId>String</AccountId> <CustomerId>String</CustomerId> <Date>String</Date> <Direction>Incoming</Direction> <EndpointDisplayName>String</EndpointDisplayName> <EndpointId>String</EndpointId> <Id>String</Id> <IsUnread>false</IsUnread> <OtherAddress>String</OtherAddress> <Sender>String</Sender> <Text>String</Text> </MessageInfo>