POST
TypeScript client

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

Organization id (UUID). Discover ids via the list organizations endpoint or the agent context.

sessionId
string<uuid>
required

Socket session UUID returned when opening a provider WebSocket session.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Body

application/json
bodyBase64
string
required

a string at most 1398104 character(s) long

Required string length: 1 - 1398104
binary
boolean
required

Whether the decoded message is binary; false sends a UTF-8 text message.

idempotencyKey
string
required

a string at most 128 character(s) long

Required string length: 8 - 128

Response

Success

id
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
sequence
number
required
direction
enum<string>
required
Available options:
outbound,
inbound
status
enum<string>
required
Available options:
pending,
dispatched,
sent,
received
bodyBase64
string
required
binary
boolean
required