Skip to main content

Update the call forwarding queue settings for a voice menu key

PUT 

https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/voice-menu/:key/queue

Update the call forwarding queue settings for a voice menu key

Request

Path Parameters

    id stringrequired

    The ID of the number to update the call forwarding queue settings for

    key stringrequired

    Possible values: [1, 2, 3, 4, 5, 6, 7, 8, 9, 0, star, pound]

    The key to update

Bodyrequired

    enabledbooleanrequired

    Whether or not the queue is enabled

    Example: true
    maxTimeintegerrequired

    The maximum time in seconds a call can be in the queue

    Possible values: [60, 120, 180, 240, 300, 600, 900, 1200, 1500, 1800]

    Example: 60
    musicOnHoldIdstringnullable

    The ID of the music on hold to be played, null to disable

    Example: 65438adbfe329346cc4af2f9
    announcementRecordingIdstringnullable

    The ID of the recording that is configured as join announcement, null to disable

    Example: 654367fa9ee46392f4b84247

Responses

Successfully updated the queue settings

Authorization: x-rinkel-api-key

name: x-rinkel-api-keytype: apiKeyin: header
curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/voice-menu/:key/queue' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <x-rinkel-api-key>' \
-d '{
"enabled": true,
"maxTime": 60,
"musicOnHoldId": "65438adbfe329346cc4af2f9",
"announcementRecordingId": "654367fa9ee46392f4b84247"
}'
Request Collapse all
Base URL
https://api.rinkel.com/v1
Auth
Parameters
— pathrequired
— pathrequired
Body required
{
  "enabled": true,
  "maxTime": 60,
  "musicOnHoldId": "65438adbfe329346cc4af2f9",
  "announcementRecordingId": "654367fa9ee46392f4b84247"
}
ResponseClear

Click the Send API Request button above and see the response here!