For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CommunitySign Up
HomeGuidesVerbsAPI ReferenceSelf-HostingClient SDKsTutorialsChangelog
HomeGuidesVerbsAPI ReferenceSelf-HostingClient SDKsTutorialsChangelog
    • Introduction
  • REST Call Control
  • REST Platform Management
  • Webhooks
    • GETNew Call
    • POSTNew Call
    • POSTClient Authentication
    • POSTNew Client Tool Request
  • Websocket API
      • Overview
      • session:new
      • session:redirect
      • session:reconnect
      • call:status
      • verb:hook
      • verb:status
      • llm:event
      • llm:tool-call
      • tts:tokens-result
      • tts:streaming-event
      • dial:confirm
      • ack
      • command
      • llm:tool-output
      • llm:update
      • tts:tokens
      • tts:flush
      • tts:clear
      • WSScallControl
LogoLogo
CommunitySign Up
Websocket APICall Control

call:status

Was this page helpful?
Edit this page
Previous

verb:hook

Next
Built with

jambonz => websocket server

A call:status message is sent by jambonz to the websocket server any time the call status changes

propertytypemeaningrequired
typestring “call:status”indicates this is an error notification from jambonzyes
msgidstringunique message identifieryes
call_sidstringunique call identifieryes
b3stringopen telemetry span identifier for this call (only provided if otel tracing is enabled)no
dataobjectcurrent call informationyes
data.call_statusstringone of ‘trying’, ‘ringing’, ‘early-media’, ‘in-progress’, ‘completed’, ‘failed’, ‘no-answer’, ‘busy’, ‘queued’yes
1{
2 "type": "call:status",
3 "msgid": "eyvooFN3dRMpZ2ZxdRLvBm",
4 "call_sid": "b5e39996-bd2f-4bda-b928-355147186a2a",
5 "b3": "e72ef0d61bfb3e23c5e50c72496feb2e-6125806ded19bb18-1",
6 "data": {
7 "call_sid": "b5e39996-bd2f-4bda-b928-355147186a2a",
8 "direction": "inbound",
9 "from": "+441173185201",
10 "to": "+441303763875",
11 "call_id": "7ade3efb-7163-123b-e6ba-023fd61c5256",
12 "sip_status": 200,
13 "sip_reason": "OK",
14 "call_status": "completed",
15 "account_sid": "300be250-5a79-46bd-8393-45e7d26c2e34",
16 "trace_id": "654c5323d6f907233a1069136b8a330e",
17 "local_sip_address": "10.0.150.88:5070",
18 "defaults": {
19 "synthesizer": {
20 "vendor": "microsoft",
21 "language": "en-US",
22 "voice": "en-US-JennyNeural"
23 },
24 "recognizer": {
25 "vendor": "microsoft",
26 "language": "en-US"
27 }
28 }
29 }
30}