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

verb:status

Was this page helpful?
Edit this page
Previous

llm:event

Next
Built with

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: The notifyEvents attribute of the session config defaults to false. This must be set to true in order for verb:status messages to be enabled, and they will only be sent where the app has provided an id property on verbs it includes in a command message.

propertytypemeaningrequired
typestring “verb: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
dataobjecterror detailsyes
data.idstringverb idyes
data.verbstringname of verbyes
data.statusstring’begin’ or ‘end’yes
1{
2 "type": "verb:status",
3 "msgid": "1cvh3MNHh1xrJaHmnitqA1",
4 "call_sid": "9fb35c28-9688-4531-943c-e280b04f3adf",
5 "data": {
6 "id": "ueydf3",
7 "verb": "say",
8 "status": "begin"
9 }
10}