Evo Voice

<back to all web services

SendMessage

Requires Authentication
Required role:User
The following routes are available for this service:
POST/sessions/{sessionId}/messages
All Verbs/messages
import java.math.*
import java.util.*
import net.servicestack.client.*


open class SendMessage
{
    /**
    * 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")
    var sessionId:String? = null

    /**
    * 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")
    var endpointId:String? = null

    /**
    * 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")
    var toAddress:String? = null

    /**
    * The body of the message
    */
    @ApiMember(Description="The body of the message")
    var body:String? = null
}

open class MessageInfo
{
    var id:String? = null
    var accountId:String? = null
    var customerId:String? = null
    var endpointId:String? = null
    var endpointDisplayName:String? = null
    var date:String? = null
    var direction:MessageDirections? = null
    var otherAddress:String? = null
    var sender:String? = null
    var text:String? = null
    var isUnread:Boolean? = null
}

enum class MessageDirections
{
    Incoming,
    Outgoing,
}

Kotlin SendMessage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: 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
}