Skip to main content
POST
/
domain-dialin-config
create new config
curl --request POST \
  --url https://api.daily.co/v1/domain-dialin-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  }
}
'
{
  "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"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

the configuration object passed to the POST API that creates the dialin config.

​
type
enum<string>
required

The type of dial-in configuration to create.

Available options:
pin_dialin,
pinless_dialin
​
phone_number
string
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.

Example:

"+12555599999"

​
name_prefix
string

friendly name for the configuration.

Example:

"my-identifier-prefix"

​
hmac
string

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

Example:

"9jyatvPWQfBymCGDOYPYKF/TRZXR+08Gj4bvPF78pH0="

​
room_creation_api
string

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

Example:

"https://mydomain.com/api/create-room"

​
hold_music_url
string

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:

"https://mydomain.com/hold-music.mp3"

​
timeout_config
object

The timeout configuration for the dialin config.

​
ivr_greeting
object

configuration when the call is received on phone number (only for pin_dialin).

Response

The final dialin config for the id.

​
id
string

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

Example:

"0cb313e1-211f-4be0-833d-8c7305b19902"

​
type
enum<string>

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

Available options:
pinless_dialin,
pin_dialin
Example:

"pinless_dialin"

​
config
object

the configuration object passed to the POST API that creates the dialin config.