Sign in

v2

latestOpenAPI 3.0.32026-07-266076394.0 KB
domain-dialin-config

create new config

create a new pinless_dialin or pin_dialin config

post/domain-dialin-config

Request body

type'pin_dialin' | 'pinless_dialin' required

The type of dial-in configuration to create.

phone_numberstring required

The phone number to configure for pinless_dialin or pin_dialin, in E.164 format (e.g. "+18058700061"). If the same number is used by any other config then the API will fail. Required for pinless_dialin, optional for pin_dialin.

name_prefixstring

friendly name for the configuration.

hmacstring

The HMAC signature used to verify the webhook called to "room_creation_api". (only for pinless_dialin type)

room_creation_apistring

The API to request when a call is received on configured phoneNumber or sip_uri. (only for pinless_dialin type). flow is described here

hold_music_urlstring

The URL to the hold music to play when the call is received, (only for pinless_dialin type). The hold music must be a publicly accessible URL in MP3 format. The hold music must be less than 10MB in size and less than 60 seconds in duration. In pinless_dialin, the hold music will be played twice.

Example request

{
  "phone_number": "+12555599999",
  "name_prefix": "my-identifier-prefix",
  "hmac": "9jyatvPWQfBymCGDOYPYKF/TRZXR+08Gj4bvPF78pH0=",
  "room_creation_api": "https://mydomain.com/api/create-room",
  "hold_music_url": "https://mydomain.com/hold-music.mp3",
  "timeout_config": {
    "message": "No Agents are available right now, please try again later"
  },
  "ivr_greeting": {
    "message": "Please enter the dialin code for the meeting, it is in the meeting invite"
  }
}

Response

The final dialin config for the id.

idstring

A unique, opaque ID for this object. You can use this ID in API calls, and in paginated list operations.

type'pinless_dialin' | 'pin_dialin'

describes the type of configuration. It can be pinless_dialin or pin_dialin.

Example response

{
  "id": "0cb313e1-211f-4be0-833d-8c7305b19902",
  "type": "pinless_dialin",
  "config": {
    "phone_number": "+12555599999",
    "name_prefix": "my-identifier-prefix",
    "hmac": "9jyatvPWQfBymCGDOYPYKF/TRZXR+08Gj4bvPF78pH0=",
    "room_creation_api": "https://mydomain.com/api/create-room",
    "hold_music_url": "https://mydomain.com/hold-music.mp3",
    "timeout_config": {
      "message": "No Agents are available right now, please try again later"
    },
    "ivr_greeting": {
      "message": "Please enter the dialin code for the meeting, it is in the meeting invite"
    }
  }
}