call:status
call:status
jambonz => websocket server
A call:status message is sent by jambonz to the websocket server any time the call status changes
| property | type | meaning | required |
|---|---|---|---|
| type | string “call:status” | indicates this is an error notification from jambonz | yes |
| msgid | string | unique message identifier | yes |
| call_sid | string | unique call identifier | yes |
| b3 | string | open telemetry span identifier for this call (only provided if otel tracing is enabled) | no |
| data | object | current call information | yes |
| data.call_status | string | one of ‘trying’, ‘ringing’, ‘early-media’, ‘in-progress’, ‘completed’, ‘failed’, ‘no-answer’, ‘busy’, ‘queued’ | yes |
| data.sip_reason | string | the reason phrase from the SIP status LINE (e.g. ‘OK’), not the RFC 3326 Reason header | no |
| data.sip_reason_header | string | the RFC 3326 Reason header of the SIP message that caused this status change, if it carried one (e.g. Q.850;cause=18). Carriers on ISDN/E1 PRI trunks put the authoritative disconnect cause here rather than in the status line. Parse tolerantly: the header is re-serialized in transit so optional whitespace around ; is normalized, and repeated headers arrive comma-separated (split outside quotes, as text="..." may contain a comma) | no |
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 "sip_reason_header": "Q.850;cause=16", 15 "call_status": "completed", 16 "account_sid": "300be250-5a79-46bd-8393-45e7d26c2e34", 17 "trace_id": "654c5323d6f907233a1069136b8a330e", 18 "local_sip_address": "10.0.150.88:5070", 19 "defaults": { 20 "synthesizer": { 21 "vendor": "microsoft", 22 "language": "en-US", 23 "voice": "en-US-JennyNeural" 24 }, 25 "recognizer": { 26 "vendor": "microsoft", 27 "language": "en-US" 28 } 29 } 30 } 31 }