Required role: | User |
POST | /sessions/{sessionId}/messages | ||
---|---|---|---|
All Verbs | /messages |
import Foundation
import ServiceStack
public class SendMessage : Codable
{
/**
* The ID of the session you want to post a message to. Specify either this or EndpointId+ToAddress
*/
// @ApiMember(Description="The ID of the session you want to post a message to. Specify either this or EndpointId+ToAddress")
public var sessionId:String
/**
* 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
*/
// @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")
public var endpointId:String
/**
* The address of the party you want to send a message to, e.g. +15556667777. Not used if SessionId is specified
*/
// @ApiMember(Description="The address of the party you want to send a message to, e.g. +15556667777. Not used if SessionId is specified")
public var toAddress:String
/**
* The body of the message
*/
// @ApiMember(Description="The body of the message")
public var body:String
required public init(){}
}
public class MessageInfo : Codable
{
public var id:String
public var accountId:String
public var customerId:String
public var endpointId:String
public var endpointDisplayName:String
public var date:String
public var direction:MessageDirections
public var otherAddress:String
public var sender:String
public var text:String
public var isUnread:Bool
required public init(){}
}
public enum MessageDirections : String, Codable
{
case Incoming
case Outgoing
}
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>