| Required role: | User |
| POST | /sessions/{sessionId}/messages | ||
|---|---|---|---|
| All Verbs | /messages |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SessionId | path | string | No | The ID of the session you want to post a message to. Specify either this or EndpointId+ToAddress |
| EndpointId | body | string | No | 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 |
| ToAddress | body | string | No | The address of the party you want to send a message to, e.g. +15556667777. Not used if SessionId is specified |
| Body | body | string | No | The body of the message |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| AccountId | form | string | No | |
| CustomerId | form | string | No | |
| EndpointId | form | string | No | |
| EndpointDisplayName | form | string | No | |
| Date | form | string | No | |
| Direction | form | MessageDirections | No | |
| OtherAddress | form | string | No | |
| Sender | form | string | No | |
| Text | form | string | No | |
| IsUnread | form | bool | No |
| Incoming | |
| Outgoing |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}