TypeScript client
Provider gateway
Send provider socket message
Queue a text or binary message on an existing provider WebSocket session. Reuse the idempotency key when retrying the same message.
POST
TypeScript client
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Organization id (UUID). Discover ids via the list organizations endpoint or the agent context.
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
Response
Success
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}$Available options:
outbound, inbound Available options:
pending, dispatched, sent, received