> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.jambonz.org/reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.jambonz.org/_mcp/server.

# API Reference

## Docs

- [About the REST API](https://docs.jambonz.org/reference/introduction.md)
- [Websocket API](https://docs.jambonz.org/reference/websocket-api/call-control/overview.md): Control live calls in real time with the jambonz WebSocket API. Learn the message format, connection lifecycle, and event handling.
- [session:new](https://docs.jambonz.org/reference/websocket-api/call-control/session-new.md)
- [session:redirect](https://docs.jambonz.org/reference/websocket-api/call-control/session-redirect.md)
- [session:reconnect](https://docs.jambonz.org/reference/websocket-api/call-control/session-reconnect.md)
- [call:status](https://docs.jambonz.org/reference/websocket-api/call-control/call-status.md)
- [verb:hook](https://docs.jambonz.org/reference/websocket-api/call-control/verb-hook.md)
- [verb:status](https://docs.jambonz.org/reference/websocket-api/call-control/verb-status.md)
- [llm:event](https://docs.jambonz.org/reference/websocket-api/call-control/llm-event.md)
- [llm:tool-call](https://docs.jambonz.org/reference/websocket-api/call-control/llm-tool-call.md)
- [tts:tokens-result](https://docs.jambonz.org/reference/websocket-api/call-control/tts-tokens-result.md)
- [tts:streaming-event](https://docs.jambonz.org/reference/websocket-api/call-control/tts-streaming-event.md)
- [dial:confirm](https://docs.jambonz.org/reference/websocket-api/call-control/dial-confirm.md)
- [ack](https://docs.jambonz.org/reference/websocket-api/call-control/ack.md)
- [command](https://docs.jambonz.org/reference/websocket-api/call-control/command.md)
- [llm:tool-output](https://docs.jambonz.org/reference/websocket-api/call-control/llm-tool-output.md)
- [llm:tool-update](https://docs.jambonz.org/reference/websocket-api/call-control/llm-update.md)
- [tts:tokens](https://docs.jambonz.org/reference/websocket-api/call-control/tts-tokens.md)
- [tts:flush](https://docs.jambonz.org/reference/websocket-api/call-control/tts-flush.md)
- [tts:clear](https://docs.jambonz.org/reference/websocket-api/call-control/tts-clear.md)

## API Docs

- REST Call Control > Calls [list calls](https://docs.jambonz.org/reference/rest-call-control/calls/list-calls.md)
- REST Call Control > Calls [create a call](https://docs.jambonz.org/reference/rest-call-control/calls/create-call.md)
- REST Call Control > Calls [retrieve a call](https://docs.jambonz.org/reference/rest-call-control/calls/get-call.md)
- REST Call Control > Calls [update a call](https://docs.jambonz.org/reference/rest-call-control/calls/update-call.md)
- REST Call Control > Calls [delete a call](https://docs.jambonz.org/reference/rest-call-control/calls/delete-call.md)
- REST Call Control > Calls [get call count](https://docs.jambonz.org/reference/rest-call-control/calls/get-call-count.md)
- REST Call Control > Conferences [list conferences](https://docs.jambonz.org/reference/rest-call-control/conferences/list-conferences.md)
- REST Call Control > Conferences [start a conference listen fork](https://docs.jambonz.org/reference/rest-call-control/conferences/start-conference-listen.md)
- REST Call Control > Conferences [stop a conference listen fork](https://docs.jambonz.org/reference/rest-call-control/conferences/stop-conference-listen.md)
- REST Call Control > Queues [retrieve active queues for an account](https://docs.jambonz.org/reference/rest-call-control/queues/list-queues.md)
- REST Platform Management > Users [create a new user](https://docs.jambonz.org/reference/rest-platform-management/users/create-user.md)
- REST Platform Management > Users [retrieve user information](https://docs.jambonz.org/reference/rest-platform-management/users/get-user.md)
- REST Platform Management > Users [update user information](https://docs.jambonz.org/reference/rest-platform-management/users/update-user.md)
- REST Platform Management > Users [delete a user](https://docs.jambonz.org/reference/rest-platform-management/users/delete-user.md)
- REST Platform Management > Settings [list MS Teams tenants](https://docs.jambonz.org/reference/rest-platform-management/settings/list-ms-teams-tenants.md)
- REST Platform Management > Settings [provision a customer tenant for MS Teams](https://docs.jambonz.org/reference/rest-platform-management/settings/create-ms-teams-tenant.md)
- REST Platform Management > Settings [retrieve an MS Teams tenant](https://docs.jambonz.org/reference/rest-platform-management/settings/get-tenant.md)
- REST Platform Management > Settings [update an MS Teams tenant](https://docs.jambonz.org/reference/rest-platform-management/settings/put-tenant.md)
- REST Platform Management > Settings [delete an MS Teams tenant](https://docs.jambonz.org/reference/rest-platform-management/settings/delete-tenant.md)
- REST Platform Management > Accounts [check if a limited-availability entity such as a subdomain, email or phone number is already in use](https://docs.jambonz.org/reference/rest-platform-management/accounts/check-availability.md)
- REST Platform Management > Accounts [list accounts](https://docs.jambonz.org/reference/rest-platform-management/accounts/list-accounts.md)
- REST Platform Management > Accounts [create an account](https://docs.jambonz.org/reference/rest-platform-management/accounts/create-account.md)
- REST Platform Management > Accounts [retrieve account](https://docs.jambonz.org/reference/rest-platform-management/accounts/get-account.md)
- REST Platform Management > Accounts [update account](https://docs.jambonz.org/reference/rest-platform-management/accounts/update-account.md)
- REST Platform Management > Accounts [delete an account](https://docs.jambonz.org/reference/rest-platform-management/accounts/delete-account.md)
- REST Platform Management > Accounts [get webhook signing secret, regenerating if requested](https://docs.jambonz.org/reference/rest-platform-management/accounts/get-webhook-secret.md)
- REST Platform Management > Accounts [add or change the sip realm](https://docs.jambonz.org/reference/rest-platform-management/accounts/create-sip-realm.md)
- REST Platform Management > Accounts [retrieve call capacity and other limits from the account](https://docs.jambonz.org/reference/rest-platform-management/accounts/get-account-limits.md)
- REST Platform Management > Accounts [create a limit for an account](https://docs.jambonz.org/reference/rest-platform-management/accounts/add-limit-for-account.md)
- REST Platform Management > Accounts [get all api keys for an account](https://docs.jambonz.org/reference/rest-platform-management/accounts/get-account-api-keys.md)
- REST Platform Management > Accounts [create an API key for an account](https://docs.jambonz.org/reference/rest-platform-management/accounts/create-api-key.md)
- REST Platform Management > Clients [retrieve online sip users for an account](https://docs.jambonz.org/reference/rest-platform-management/clients/list-registered-sip-users.md)
- REST Platform Management > Clients [retrieve online sip users for an account by list of sip username](https://docs.jambonz.org/reference/rest-platform-management/clients/list-registered-sip-users-by-username.md)
- REST Platform Management > Clients [retrieve registered client registration](https://docs.jambonz.org/reference/rest-platform-management/clients/get-registered-client.md)
- REST Platform Management > Clients [List Clients](https://docs.jambonz.org/reference/rest-platform-management/clients/get-clients.md)
- REST Platform Management > Clients [Create a new client](https://docs.jambonz.org/reference/rest-platform-management/clients/create-client.md)
- REST Platform Management > Clients [Get a client](https://docs.jambonz.org/reference/rest-platform-management/clients/get-client.md)
- REST Platform Management > Clients [Update a client](https://docs.jambonz.org/reference/rest-platform-management/clients/update-client.md)
- REST Platform Management > Clients [delete a client](https://docs.jambonz.org/reference/rest-platform-management/clients/delete-client.md)
- REST Platform Management > Applications [retrieve webhook](https://docs.jambonz.org/reference/rest-platform-management/applications/get-webhook.md)
- REST Platform Management > Applications [list applications](https://docs.jambonz.org/reference/rest-platform-management/applications/list-applications.md)
- REST Platform Management > Applications [create application](https://docs.jambonz.org/reference/rest-platform-management/applications/create-application.md)
- REST Platform Management > Applications [retrieve an application](https://docs.jambonz.org/reference/rest-platform-management/applications/retrieve-an-application.md)
- REST Platform Management > Applications [update application](https://docs.jambonz.org/reference/rest-platform-management/applications/update-application.md)
- REST Platform Management > Applications [delete an application](https://docs.jambonz.org/reference/rest-platform-management/applications/delete-application.md)
- REST Platform Management > Applications [Get App Env Schema](https://docs.jambonz.org/reference/rest-platform-management/applications/get-app-env-schema.md)
- REST Platform Management > Recent Calls [retrieve recent calls for an account](https://docs.jambonz.org/reference/rest-platform-management/recent-calls/list-recent-calls.md)
- REST Platform Management > Recent Calls [retrieve jaeger trace detail for a call](https://docs.jambonz.org/reference/rest-platform-management/recent-calls/get-recent-call-trace.md)
- REST Platform Management > Recent Calls [retrieve recording for a call](https://docs.jambonz.org/reference/rest-platform-management/recent-calls/get-recent-call-recording.md)
- REST Platform Management > Recent Calls [retrieve pcap for a call](https://docs.jambonz.org/reference/rest-platform-management/recent-calls/get-recent-call-trace-by-account.md)
- REST Platform Management > Alerts [retrieve alerts for an account](https://docs.jambonz.org/reference/rest-platform-management/alerts/list-alerts-by-account.md)
- REST Platform Management > Alerts [list alert hooks](https://docs.jambonz.org/reference/rest-platform-management/alerts/list-alert-hooks.md)
- REST Platform Management > Alerts [create an alert hook](https://docs.jambonz.org/reference/rest-platform-management/alerts/create-alert-hook.md)
- REST Platform Management > Alerts [send a test alert](https://docs.jambonz.org/reference/rest-platform-management/alerts/test-alert-hooks.md)
- REST Platform Management > Alerts [get alert hook capabilities](https://docs.jambonz.org/reference/rest-platform-management/alerts/get-alert-hook-capabilities.md)
- REST Platform Management > Alerts [retrieve an alert hook](https://docs.jambonz.org/reference/rest-platform-management/alerts/get-alert-hook.md)
- REST Platform Management > Alerts [update an alert hook](https://docs.jambonz.org/reference/rest-platform-management/alerts/update-alert-hook.md)
- REST Platform Management > Alerts [delete an alert hook](https://docs.jambonz.org/reference/rest-platform-management/alerts/delete-alert-hook.md)
- REST Platform Management > Carriers [retrieve public IP addresses of the jambonz SBCs](https://docs.jambonz.org/reference/rest-platform-management/carriers/list-sbcs.md)
- REST Platform Management > Carriers [retrieve voip carrier](https://docs.jambonz.org/reference/rest-platform-management/carriers/get-voip-carrier.md)
- REST Platform Management > Carriers [update voip carrier](https://docs.jambonz.org/reference/rest-platform-management/carriers/update-voip-carrier.md)
- REST Platform Management > Carriers [delete a voip carrier](https://docs.jambonz.org/reference/rest-platform-management/carriers/delete-voip-carrier.md)
- REST Platform Management > Carriers [list sip gateways](https://docs.jambonz.org/reference/rest-platform-management/carriers/list-sip-gateways.md)
- REST Platform Management > Carriers [create sip gateway](https://docs.jambonz.org/reference/rest-platform-management/carriers/create-sip-gateway.md)
- REST Platform Management > Carriers [retrieve sip gateway](https://docs.jambonz.org/reference/rest-platform-management/carriers/get-sip-gateway.md)
- REST Platform Management > Carriers [update sip gateway](https://docs.jambonz.org/reference/rest-platform-management/carriers/update-sip-gateway.md)
- REST Platform Management > Carriers [delete a sip gateway](https://docs.jambonz.org/reference/rest-platform-management/carriers/delete-sip-gateway.md)
- REST Platform Management > Carriers [get all carriers availlble to the account](https://docs.jambonz.org/reference/rest-platform-management/carriers/get-service-provider-carriers.md)
- REST Platform Management > Carriers [create a carrier as a service provider](https://docs.jambonz.org/reference/rest-platform-management/carriers/create-carrier-for-service-provider.md)
- REST Platform Management > Carriers [get all carriers for an account](https://docs.jambonz.org/reference/rest-platform-management/carriers/get-account-carriers.md)
- REST Platform Management > Carriers [create a carrier for an account](https://docs.jambonz.org/reference/rest-platform-management/carriers/create-carrier-for-account.md)
- REST Platform Management > Carriers [add a carrier to a service provider using a template](https://docs.jambonz.org/reference/rest-platform-management/carriers/create-voip-carrier-from-template-by-sp.md)
- REST Platform Management > Speech [retrieve all speech credentials for an account](https://docs.jambonz.org/reference/rest-platform-management/speech/list-speech-credentials.md)
- REST Platform Management > Speech [add a speech credential](https://docs.jambonz.org/reference/rest-platform-management/speech/create-speech-credential.md)
- REST Platform Management > Speech [get a specific speech credential](https://docs.jambonz.org/reference/rest-platform-management/speech/get-speech-credential-by-account.md)
- REST Platform Management > Speech [update a speech credential](https://docs.jambonz.org/reference/rest-platform-management/speech/update-speech-credential-by-account.md)
- REST Platform Management > Speech [delete a speech credential](https://docs.jambonz.org/reference/rest-platform-management/speech/delete-speech-credential-by-account.md)
- REST Platform Management > Speech [get supported languages, voices and models](https://docs.jambonz.org/reference/rest-platform-management/speech/supported-languages-and-voices-by-account.md)
- REST Platform Management > Speech [test a speech credential](https://docs.jambonz.org/reference/rest-platform-management/speech/test-speech-credential-by-account.md)
- REST Platform Management > Speech [get TTS from provider](https://docs.jambonz.org/reference/rest-platform-management/speech/synthesize.md)
- REST Platform Management > Speech [list google custom voices](https://docs.jambonz.org/reference/rest-platform-management/speech/list-google-custom-voices.md)
- REST Platform Management > Speech [create a Google custom voice](https://docs.jambonz.org/reference/rest-platform-management/speech/create-google-custom-voice.md)
- REST Platform Management > Speech [retrieve google custom voice](https://docs.jambonz.org/reference/rest-platform-management/speech/get-google-custom-voice.md)
- REST Platform Management > Speech [update google custom voice](https://docs.jambonz.org/reference/rest-platform-management/speech/update-google-custom-voice.md)
- REST Platform Management > Speech [delete a google custom voice](https://docs.jambonz.org/reference/rest-platform-management/speech/delete-google-custom-voice.md)
- REST Platform Management > Speech [create a speech credential for a service provider](https://docs.jambonz.org/reference/rest-platform-management/speech/add-speech-credential-for-seervice-provider.md)
- REST Platform Management > Phone Numbers [list phone numbers](https://docs.jambonz.org/reference/rest-platform-management/phone-numbers/list-provisioned-phone-numbers.md)
- REST Platform Management > Phone Numbers [provision a phone number into inventory from a Voip Carrier](https://docs.jambonz.org/reference/rest-platform-management/phone-numbers/provision-phone-number.md)
- REST Platform Management > Phone Numbers [retrieve phone number](https://docs.jambonz.org/reference/rest-platform-management/phone-numbers/get-phone-number.md)
- REST Platform Management > Phone Numbers [update phone number](https://docs.jambonz.org/reference/rest-platform-management/phone-numbers/update-phone-number.md)
- REST Platform Management > Phone Numbers [delete a phone number](https://docs.jambonz.org/reference/rest-platform-management/phone-numbers/delete-phone-number.md)
- REST Platform Management > Call Routing [list least cost routings](https://docs.jambonz.org/reference/rest-platform-management/call-routing/list-least-cost-routings.md)
- REST Platform Management > Call Routing [create a Least Cost Routing](https://docs.jambonz.org/reference/rest-platform-management/call-routing/create-lcr.md)
- REST Platform Management > Call Routing [retrieve least cost routing](https://docs.jambonz.org/reference/rest-platform-management/call-routing/get-least-cost-routing.md)
- REST Platform Management > Call Routing [update least cost routing](https://docs.jambonz.org/reference/rest-platform-management/call-routing/update-least-cost-routing.md)
- REST Platform Management > Call Routing [delete a least cost routing](https://docs.jambonz.org/reference/rest-platform-management/call-routing/delete-least-cost-routing.md)
- REST Platform Management > Call Routing [Create least cost routing routes and carrier set entries](https://docs.jambonz.org/reference/rest-platform-management/call-routing/create-least-cost-routing-routes-and-carrier-entries.md)
- REST Platform Management > Call Routing [update least cost routing routes and carrier set entries](https://docs.jambonz.org/reference/rest-platform-management/call-routing/update-least-cost-routing-routes-and-carrier-entries.md)
- REST Platform Management > Call Routing [list least cost routings routes](https://docs.jambonz.org/reference/rest-platform-management/call-routing/list-least-cost-routing-routes.md)
- REST Platform Management > Call Routing [create a Least Cost Routing Routes](https://docs.jambonz.org/reference/rest-platform-management/call-routing/create-lcr-routes.md)
- REST Platform Management > Call Routing [retrieve least cost routing route](https://docs.jambonz.org/reference/rest-platform-management/call-routing/get-least-cost-routing-route.md)
- REST Platform Management > Call Routing [update least cost routing route](https://docs.jambonz.org/reference/rest-platform-management/call-routing/update-least-cost-routing-route.md)
- REST Platform Management > Call Routing [delete a least cost routing route](https://docs.jambonz.org/reference/rest-platform-management/call-routing/delete-least-cost-routing-route.md)
- REST Platform Management > Call Routing [create a Least Cost Routing Carrier Set Entry](https://docs.jambonz.org/reference/rest-platform-management/call-routing/create-lcr-carrier-set-entry.md)
- REST Platform Management > Call Routing [retrieve least cost routing carrier set entry](https://docs.jambonz.org/reference/rest-platform-management/call-routing/get-least-cost-routing-carrier-set-entry.md)
- REST Platform Management > Call Routing [update least cost routing carrier set entry](https://docs.jambonz.org/reference/rest-platform-management/call-routing/update-least-cost-routing-carrier-set-entry.md)
- REST Platform Management > Call Routing [delete a least cost routing carrier set entry](https://docs.jambonz.org/reference/rest-platform-management/call-routing/delete-least-cost-routing-carrier-set-entry.md)
- REST Platform Management > Call Routing [get all Least Cost Routings for a service provider](https://docs.jambonz.org/reference/rest-platform-management/call-routing/get-service-provider-lcrs.md)
- REST Platform Management > Call Routing [create a Lest cost routing for a service provider](https://docs.jambonz.org/reference/rest-platform-management/call-routing/create-lcr-for-service-provider.md)
- REST Platform Management > Service Providers [list service providers](https://docs.jambonz.org/reference/rest-platform-management/service-providers/list-service-providers.md)
- REST Platform Management > Service Providers [create service provider](https://docs.jambonz.org/reference/rest-platform-management/service-providers/create-service-provider.md)
- REST Platform Management > Service Providers [retrieve service provider](https://docs.jambonz.org/reference/rest-platform-management/service-providers/get-service-provider.md)
- REST Platform Management > Service Providers [update service provider](https://docs.jambonz.org/reference/rest-platform-management/service-providers/update-service-provider.md)
- REST Platform Management > Service Providers [delete a service provider](https://docs.jambonz.org/reference/rest-platform-management/service-providers/delete-service-provider.md)
- REST Platform Management > Service Providers [get all accounts for a service provider](https://docs.jambonz.org/reference/rest-platform-management/service-providers/get-service-provider-accounts.md)
- REST Platform Management > Service Providers [retrieve call capacity and other limits from the service provider](https://docs.jambonz.org/reference/rest-platform-management/service-providers/get-service-provider-limits.md)
- REST Platform Management > Service Providers [create a limit for a service provider](https://docs.jambonz.org/reference/rest-platform-management/service-providers/add-limit-for-service-provider.md)
- Webhooks [New Call](https://docs.jambonz.org/reference/webhooks/call-hook-get.md)
- Webhooks [Client Authentication](https://docs.jambonz.org/reference/webhooks/registration-hook-post.md)
- Webhooks [New Client Tool Request](https://docs.jambonz.org/reference/webhooks/tool-hook-post.md)
- Websocket API > Call Control [callControl](https://docs.jambonz.org/reference/websocket-api/call-control/call-control.md)
- Websocket API > Llm [llm](https://docs.jambonz.org/reference/websocket-api/llm/llm.md)
- Websocket API > TTS [tts](https://docs.jambonz.org/reference/websocket-api/tts/tts.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.jambonz.org/openapi.json)
- [OpenAPI YAML](https://docs.jambonz.org/openapi.yaml)


## AsyncAPI Specification

The raw AsyncAPI 2.6.0 specification for the WebSocket channels is available at:
- [AsyncAPI JSON](https://docs.jambonz.org/asyncapi.json)
- [AsyncAPI YAML](https://docs.jambonz.org/asyncapi.yaml)