Required role: | User |
POST | /sessions/{sessionId}/messages | ||
---|---|---|---|
All Verbs | /messages |
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
class MessageDirections(str, Enum):
INCOMING = 'Incoming'
OUTGOING = 'Outgoing'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MessageInfo:
id: Optional[str] = None
account_id: Optional[str] = None
customer_id: Optional[str] = None
endpoint_id: Optional[str] = None
endpoint_display_name: Optional[str] = None
date: Optional[str] = None
direction: Optional[MessageDirections] = None
other_address: Optional[str] = None
sender: Optional[str] = None
text: Optional[str] = None
is_unread: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendMessage:
# @ApiMember(Description="The ID of the session you want to post a message to. Specify either this or EndpointId+ToAddress")
session_id: Optional[str] = None
"""
The ID of the session you want to post a message to. Specify either this or EndpointId+ToAddress
"""
# @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")
endpoint_id: Optional[str] = None
"""
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 address of the party you want to send a message to, e.g. +15556667777. Not used if SessionId is specified")
to_address: Optional[str] = None
"""
The address of the party you want to send a message to, e.g. +15556667777. Not used if SessionId is specified
"""
# @ApiMember(Description="The body of the message")
body: Optional[str] = None
"""
The body of the message
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 }