anchorOverview

For field names, required values, and the complete conversation lifecycle, see the BYoVA over WebSocket guide and its published AsyncAPI schemas.

anchorConnection and authentication

anchorAudio and response sequencing

anchorVoice and barge-in

• Send START_OF_INPUT when the partner detects caller speech and END_OF_INPUT when its endpointing logic considers the speech complete.
• Without barge-in, expect the next caller-audio stream after FINAL; speech spoken while the prompt plays is not delivered to the partner.
• For caller interruption, enable prompts[].is_barge_in_enabled and report detected speech with START_OF_INPUT.
• Do not wait for a literal BARGE_IN event; the WebSocket contract uses the prompt setting and input-boundary events.

anchorDTMF

• Process dtmf_input as one ordered collection, not one request per key press.
• Confirm input_mode accepts DTMF and input_handling_config.dtmf_config sets the intended length, terminator, and inter-digit timeout.
• Check that collection ends on the configured terminator, maximum length, or inter-digit timeout.
• Use START_OF_DTMF as the Webex-to-partner DTMF event; do not treat it as a partner output event.

anchorErrors and session cleanup

Handle schema-defined errors such as unauthorized, bad_request, unsupported_media, upstream_error, rate_limit, and timeout. Avoid tight retry loops for rate limits and do not replay an already-started conversation unless the platform contract explicitly supports it.

On SESSION_END, transfer, protocol error, or transport failure, release conversation state and close the session. Keep bearer tokens, raw audio, transcripts, and other sensitive content out of error details and routine diagnostic logs.

anchorEnd-to-end checklist

• The authenticated secure WebSocket handshake succeeds.
• SESSION_START initializes one conversation on one connection.
• Caller audio is decoded with the encoding and sample rate supplied by Webex.
• Speech boundaries are reported to Webex.
• Audio fragments follow the current media profile and are sent without artificial pacing.
• For the next caller input, input_mode is correct and input_handling_config supplies any needed DTMF collection settings or speech timers.
• Exactly one FINAL closes each logical reply.
• Barge-in and non-barge-in timing match the configured prompt behavior.
• DTMF digits are collected and processed in order.
• PING receives a matching PONG.
• Exit events release state and close the session.

anchorReferences

• BYoVA over WebSocket
• Published BYoVA WebSocket AsyncAPI schemas
• Java WebSocket JSON sample