v2

latestOpenAPI 3.0.32026-07-266076394.0 KB

domain-dialin-config

/domain-dialin-config

List all the pinless_dialin and pin_dialin configs for the domain, with pagination

get/domain-dialin-config

Query parameters

limitinteger

ending_beforestring

starting_afterstring

phone_numberstring

phone_numbersstring

a comma separated list of phone numbers to filter by. The filter will match any phone number that contains the provided numbers as a substring (partial match).

sip_usernamestring

The sip username associated with this dialin config (only the username part of the sip uri)

name_prefixstring

typestring

The type of dialin config. It can be pinless_dialin or pin_dialin.

Response

200

total_countinteger

Example response

{
  "total_count": 3,
  "data": [
    {
      "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"
        }
      }
    }
  ]
}