POST/domain-dialin-config
A POST request to /domain-dialin-config creates a new pinless_dialin and pin_dialin config.
The pin_dialin config requires a phone_number. While, the pinless_dialin config can be done with or without a phone_number. When associating a phone number in pinless_dialin, a SIP interconnect is also created, so you can receive calls on both the number and the sip interconnect. However, if a phone_number is not passed, only the SIP interconnect is created.
If a phone_number is already assigned to pinless_dialin or pin_dialin, the API returns error. Use the update API to update an existing configuration. Since, a phone_number can either be assigned to a pinless_dialing or to pin_dialin, not to both. To reassign a number between the pinless and pin dialin, you will first need to delete the config and then create a new config.
Example request
Create config
Body params
The phone number to configure for pinless_dialin or pin_dialin. If the same number is used by any other config then the API will fail. Required for pinless_dialin, optional for pin_dialin.
friendly name for the configuration.
The HMAC signature used to verify the webhook called to "room_creation_api". (only for pinless_dialin type)
The API to request when a call is received on configured phoneNumber or sip_uri. (only for pinless_dialin type). flow is described here
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.
The timeout configuration for the dialin config.
If room_creation_api does not respond within the timeout period, this message will be played to the caller.
configuration when the call is received on phone number (only for pin_dialin).
The message to play when call first connects.
Response Body Parameters
A unique, opaque ID for this object. You can use this ID in API calls, and in paginated list operations.
describes the type of configuration. It can be pinless_dialin or pin_dialin.
the configuration object passed to the POST API that creates the dialin config.
The phone number to configure for pinless_dialin or pin_dialin. If the same number is used by any other config then the API will fail. Required for pinless_dialin, optional for pin_dialin.
friendly name for the configuration.
The HMAC signature used to verify the webhook called to "room_creation_api". (only for pinless_dialin type)
The API to request when a call is received on configured phoneNumber or sip_uri. (only for pinless_dialin type). flow is described here
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.
The timeout configuration for the dialin config.
If room_creation_api does not respond within the timeout period, this message will be played to the caller.
configuration when the call is received on phone number (only for pin_dialin).
The message to play when call first connects.
Example requests
Body params
The phone number to configure for pinless_dialin or pin_dialin. If the same number is used by any other config then the API will fail. Required for pinless_dialin, optional for pin_dialin.
friendly name for the configuration.
The HMAC signature used to verify the webhook called to "room_creation_api". (only for pinless_dialin type)
The API to request when a call is received on configured phoneNumber or sip_uri. (only for pinless_dialin type). flow is described here
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.
The timeout configuration for the dialin config.
If room_creation_api does not respond within the timeout period, this message will be played to the caller.
configuration when the call is received on phone number (only for pin_dialin).
The message to play when call first connects.
Response Body Parameters
A unique, opaque ID for this object. You can use this ID in API calls, and in paginated list operations.
describes the type of configuration. It can be pinless_dialin or pin_dialin.
the configuration object passed to the POST API that creates the dialin config.
The phone number to configure for pinless_dialin or pin_dialin. If the same number is used by any other config then the API will fail. Required for pinless_dialin, optional for pin_dialin.
friendly name for the configuration.
The HMAC signature used to verify the webhook called to "room_creation_api". (only for pinless_dialin type)
The API to request when a call is received on configured phoneNumber or sip_uri. (only for pinless_dialin type). flow is described here
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.
The timeout configuration for the dialin config.
If room_creation_api does not respond within the timeout period, this message will be played to the caller.
configuration when the call is received on phone number (only for pin_dialin).
The message to play when call first connects.