GET | /conversations |
---|
import Foundation
import ServiceStack
public class ListConversations : Codable
{
/**
* The IDs of the account whose conversations you want to retrieve
*/
// @ApiMember(Description="The IDs of the account whose conversations you want to retrieve")
public var accountIds:[String]
/**
* The list of endpoint IDs whose conversations you want to retrieve
*/
// @ApiMember(Description="The list of endpoint IDs whose conversations you want to retrieve")
public var endpointIds:[String]
/**
* The list of customer IDs whose conversations you want to retrieve
*/
// @ApiMember(Description="The list of customer IDs whose conversations you want to retrieve")
public var customerIds:[String]
/**
* The start date for the conversations you want to retrieve
*/
// @ApiMember(Description="The start date for the conversations you want to retrieve")
public var afterDate:String
required public init(){}
}
public class ListConversationsResponse : Codable
{
public var conversations:[ConversationInfo]
required public init(){}
}
public class ConversationInfo : Codable
{
public var id:String
public var endpointId:String
public var otherAddress:String
public var mostRecentMessage:MessageInfo
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.
GET /conversations HTTP/1.1 Host: team.evovoice.io Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ListConversationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Messaging"> <Conversations> <ConversationInfo> <EndpointId>String</EndpointId> <Id>String</Id> <MostRecentMessage> <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> </MostRecentMessage> <OtherAddress>String</OtherAddress> </ConversationInfo> </Conversations> </ListConversationsResponse>