Create your Telephony setup

PUT/v1/provisioning/tenants/{tenant_id}

Connect your PBX as a trunk and create your Telephony setup. `tenant_id` is your setup ID — the `_id` from Get your account.

Auth

Authentication required.

Parameters

Name	In	Required	Type	Description
tenant_id	path	Yes	string	Your setup ID — the `_id` returned by `GET /me`.

Request body

Required	Content-Type	Shape
Yes	application/json	object { bot, pbx, transfer_targets, outbound, inbound, transfer_policy }

Name	Type	Required	Description
bot	object	Yes	Send `{}`. Which agent answers is set per number, when you bind an agent to it.
pbx	object	Yes	Your trunk: where your PBX is and how it connects.
pbx.mode	enum(register \| ip)	No	`register`: we register to your PBX with a username and password. `ip` (Fixed IP): your PBX sends to us from the addresses in `source_ips`.
pbx.transport	enum(udp \| tls)	No	Default "udp". TLS is the only alternative to UDP; there is no TCP.
pbx.address	string	No	Your PBX as `host` or `host:port`, e.g. `pbx.example.com:5060`.
pbx.source_ips	array<string>	No	IP addresses or CIDR ranges your PBX sends from. Required for Fixed IP; send `[]` for register.
pbx.auth	object	No	Register mode only: how we sign in to your PBX.
pbx.auth.username	string	Yes, if pbx.auth is sent	1–64 characters.
pbx.auth.password	stringwrite-only	No	Sent once and stored as a secret; never returned. Required when you create a register trunk; leave it out on update to keep the stored one.
pbx.auth.registrar	string	Yes, if pbx.auth is sent	Where we register, as `host` or `host:port`.
pbx.auth.auth_username	string	No	Up to 64 characters. Optional. The identity your PBX answers the digest challenge with, when it is not `username`.
pbx.auth.expires	integer	No	60–3600, default 3600.
transfer_targets	object	Yes	Name → number for transfers your agents make by name. Send `{}` for none.
outbound	object \| null	Yes	Outbound calling. `null` for an inbound-only setup.
outbound.enabled	boolean	No	—
outbound.default_path	enum(pbx \| pstn)	No	Which way calls leave: through your trunk or the phone network.
outbound.caller_id	object	No	The number calls present, per path.
outbound.caller_id.pbx	string	No	—
outbound.caller_id.pstn	string	No	—
inbound	object	Yes	Limits on incoming calls. Send `{}` for the defaults.
inbound.limits	object	No	—
inbound.limits.max_concurrent_calls	integer	No	At least 1.
inbound.budget	object	No	—
inbound.budget.daily_minute_limit	integer	No	At least 1.
inbound.budget.daily_session_limit	integer	No	At least 1.
inbound.max_session_seconds	integer	No	At least 1.
transfer_policy	object \| null	No	Whether agents may transfer calls to outside numbers.
transfer_policy.external	object	No	—
transfer_policy.external.enabled	boolean	No	—
transfer_policy.external.destination_patterns	array<string>	No	Regular expressions an outside number must match.

Examples

{
  "bot": {},
  "pbx": {
    "mode": "register",
    "transport": "udp",
    "address": "pbx.example.com:5060",
    "source_ips": [],
    "auth": {
      "username": "acme-trunk",
      "password": "<trunk password>",
      "registrar": "pbx.example.com:5060"
    }
  },
  "transfer_targets": {},
  "outbound": null,
  "inbound": {}
}

Fixed IP trunk

{
  "bot": {},
  "pbx": {
    "mode": "ip",
    "transport": "udp",
    "address": "pbx.example.com:5060",
    "source_ips": [
      "203.0.113.10"
    ]
  },
  "transfer_targets": {},
  "outbound": null,
  "inbound": {}
}

Responses

Status	Description	Content-Type	Shape
200	Successful Response	application/json	unknown
422	Validation Error	application/json	HTTPValidationError