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
namespace Voice.Api.Messaging

open System
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

F# 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
}