All pages

Docs

Tenants and connection secrets

How to create tenants (the businesses that take calls) in the dashboard, choose their agent, reissue connection secrets, and disable or delete them.

View as Markdown

A tenant is a business that actually receives calls. Create one for each of your customers and choose the agent it uses. Tenants in the left menu lists the tenants in the current environment. Creating and changing require the developer role or above.

Create a tenant#

  1. Under Tenants, press + Create tenant.
  2. Fill in the settings below and press Create.
  3. Copy the connection secret that appears and store it somewhere safe.
Setting What
Customer ID (required) The customer's ID in your service (external_id in the API). Up to 100 letters, digits and . _ : -. It can't be changed later
Name The business name, shown in lists and call records
Agent The agent used when this tenant receives a call. Its latest version is always used

The connection secret is shown only once, when the tenant is created. You can't see it again after closing. It's the string you pass when connecting a phone or web call to voicast (<Parameter name="secret"> for phone calls; see Phone).

Edit a tenant#

  1. Press Edit on the tenant in the Tenants list.
  2. Change the name, agent, status or pronunciations and press Save.

The edit dialog also lets you:

Add pronunciations#

You can add pronunciations used only in this tenant's calls, such as the name of the shop or company. When one agent serves many tenants and greets callers with {{tenant_name}}, this keeps the name from being misread.

  1. In the edit dialog, press + Add pronunciation under Pronunciations.
  2. Enter the word as written (for example 医療法人社団 東壽会) and its reading in hiragana or katakana (for example いりょうほうじんしゃだん とうじゅかい), then press Save.
Field Description
Word Up to 100 characters. Each word only once
Reading Hiragana or katakana (up to 100 characters including ー, spaces and 、)

You can add up to 20. For the same word, the tenant's pronunciation takes precedence over the agent's (Agents). Changes apply from the next call.

Stop taking calls#

Set Status to Disabled in the edit dialog and press Save to stop accepting calls for this tenant. Set it back to Active to accept them again.

Reissue the connection secret#

Reissue the secret if it may have leaked.

  1. Press Reissue connection secret at the bottom left of the edit dialog.
  2. Press Reissue connection secret in the confirmation dialog.
  3. Copy the new secret that appears.

The old secret keeps working for 24 hours. Update your service's configuration to the new secret within that time.

Delete a tenant#

  1. Press Remove at the bottom left of the edit dialog.
  2. Press Remove in the confirmation dialog.
  • Calls using this tenant's connection secret stop being answered immediately. Its SIP credentials are deleted too.
  • Existing call records are kept.
  • You can create a tenant with the same customer ID again.