Files
next-static-site/markdown/docs/ws/verb-status.md
Dave Horton 4d9a0f844c Feature/0.7.6 dh (#44)
* reset yarn lock

* ws docs

* answering machine detection spec

* amd updates

* 0.7.6 release notes and articles

* update transcribe options

Co-authored-by: kitajchuk <bk@kitajchuk.com>
2022-08-27 13:04:12 +02:00

1.1 KiB

verb:status

jambonz => websocket server

A verb:status message is sent by jambonz to the websocket server when a verb has just started or completed executing.

Note: verb:status messages are only sent when the app has provided an id property on verbs it includes in a command message.

property type meaning required
type string "verb: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 error details yes
data.id string verb id yes
data.verb string name of verb yes
data.status string 'begin' or 'end' yes
{
  "type": "verb:status",
  "msgid": "1cvh3MNHh1xrJaHmnitqA1",
  "call_sid": "9fb35c28-9688-4531-943c-e280b04f3adf",
  "data": {
    "id": "ueydf3",
    "verb": "say",
    "status": "begin"
  }
}

  Prev: verb:hook Next: jambonz:error