For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Community Sign Up

Home Guides Verbs API Reference Self-Hosting Client SDKs Tutorials Changelog

Home Guides Verbs API Reference Self-Hosting Client SDKs Tutorials Changelog

- Introduction
REST Call Control
REST Platform Management
Webhooks
Websocket API

Introduction
list calls
create a call
retrieve a call
update a call
delete a call
get call count
list conferences
start a conference listen fork
stop a conference listen fork
retrieve active queues for an account
create a new user
retrieve user information
update user information
delete a user
list MS Teams tenants
provision a customer tenant for MS Teams
retrieve an MS Teams tenant
update an MS Teams tenant
delete an MS Teams tenant
check if a limited-availability entity such as a subdomain, email or phone number is already in use
list accounts
create an account
retrieve account
update account
delete an account
get webhook signing secret, regenerating if requested
add or change the sip realm
retrieve call capacity and other limits from the account
create a limit for an account
get all api keys for an account
create an API key for an account
retrieve online sip users for an account
retrieve online sip users for an account by list of sip username
retrieve registered client registration
List Clients
Create a new client
Get a client
Update a client
delete a client
retrieve webhook
list applications
create application
retrieve an application
update application
delete an application
Get App Env Schema
retrieve recent calls for an account
retrieve jaeger trace detail for a call
retrieve recording for a call
retrieve pcap for a call
retrieve pcap for a call
retrieve recent calls for an account
retrieve jaeger trace detail for a call
retrieve alerts for an account
retrieve public IP addresses of the jambonz SBCs
retrieve voip carrier
update voip carrier
delete a voip carrier
list sip gateways
create sip gateway
retrieve sip gateway
update sip gateway
delete a sip gateway
get all carriers availlble to the account
create a carrier as a service provider
get all carriers for an account
create a carrier for an account
add a carrier to a service provider using a template
retrieve all speech credentials for an account
add a speech credential
get a specific speech credential
update a speech credential
delete a speech credential
get supported languages, voices and models
test a speech credential
get TTS from provider
list google custom voices
create a Google custom voice
retrieve google custom voice
update google custom voice
delete a google custom voice
create a speech credential for a service provider
get a specific speech credential
update a speech credential
delete a speech credential
get supported languages, voices and models
test a speech credential
list phone numbers
provision a phone number into inventory from a Voip Carrier
retrieve phone number
update phone number
delete a phone number
list least cost routings
create a Least Cost Routing
retrieve least cost routing
update least cost routing
delete a least cost routing
Create least cost routing routes and carrier set entries
update least cost routing routes and carrier set entries
list least cost routings routes
create a Least Cost Routing Routes
retrieve least cost routing route
update least cost routing route
delete a least cost routing route
list least cost routings routes
create a Least Cost Routing Carrier Set Entry
retrieve least cost routing carrier set entry
update least cost routing carrier set entry
delete a least cost routing carrier set entry
get all Least Cost Routings for a service provider
create a Lest cost routing for a service provider
list service providers
create service provider
retrieve service provider
update service provider
delete a service provider
get all accounts for a service provider
retrieve call capacity and other limits from the service provider
create a limit for a service provider
New Call
New Call
Client Authentication
New Client Tool Request
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
callControl
llm
tts

Community Sign Up

Websocket API Llm

llm

WSS

///llm

Handshake

URL	/llm
Method	GET
Status	101 Switching Protocols

Messages

The LLM channel handles communication related to large language models

Was this page helpful?

Handshake

WSS

///llm

Send

sendLlmToolOutputobjectRequired

Send the output of a tool call back to jambonz

OR

sendLlmUpdateobjectRequired

Send an update to an ongoing LLM interaction

Receive

receiveLlmToolCallobjectRequired

Receive a tool call request from an LLM

OR

receiveLlmEventobjectRequired

Receive an event notification from an LLM