TypeScript client
Provider gateway
Provider socket status
Check the state and settled charge of an existing provider WebSocket session without opening another session.
GET
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}$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:
reserved, queued, preparing, dispatched, completed, uncertain, failed, billing_hold