Required role: | User |
POST | /sessions/{sessionId}/messages | ||
---|---|---|---|
All Verbs | /messages |
namespace Voice.Api.Messaging
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type MessageDirections =
| Incoming = 0
| Outgoing = 1
[<AllowNullLiteral>]
type MessageInfo() =
member val Id:String = null with get,set
member val AccountId:String = null with get,set
member val CustomerId:String = null with get,set
member val EndpointId:String = null with get,set
member val EndpointDisplayName:String = null with get,set
member val Date:String = null with get,set
member val Direction:MessageDirections = new MessageDirections() with get,set
member val OtherAddress:String = null with get,set
member val Sender:String = null with get,set
member val Text:String = null with get,set
member val IsUnread:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type SendMessage() =
///<summary>
///The ID of the session you want to post a message to. Specify either this or EndpointId+ToAddress
///</summary>
[<ApiMember(Description="The ID of the session you want to post a message to. Specify either this or EndpointId+ToAddress")>]
member val SessionId:String = null with get,set
///<summary>
///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
///</summary>
[<ApiMember(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")>]
member val EndpointId:String = null with get,set
///<summary>
///The address of the party you want to send a message to, e.g. +15556667777. Not used if SessionId is specified
///</summary>
[<ApiMember(Description="The address of the party you want to send a message to, e.g. +15556667777. Not used if SessionId is specified")>]
member val ToAddress:String = null with get,set
///<summary>
///The body of the message
///</summary>
[<ApiMember(Description="The body of the message")>]
member val Body:String = null with get,set
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>