Update the missed call settings for a voice menu key
Update the missed call settings for a voice menu key
Path Parameters
id string required
The ID of the number to update the missed call settings for
key string required
Possible values: [1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 0
, star
, pound
]
The key to update
application/json
Request Body required
setting string required
Possible values: [hangup
, voicemail
, forward
]
The unanswered option setting
recordingId string nullable
The ID of the recording that is used for the unanswered option, if applicable
forwardTarget object nullable
Responses
- 204
- 400
- 401
- 403
- 404
Successfully updated the missed call settings
Invalid request body
application/json
Schema
Example (from schema)
Schema
errors object[]
{
"errors": [
{
"code": "ERROR_CODE",
"message": "An error occurred while calling the endpoint",
"detail": "View more info at developers.rinkel.com"
}
]
}
Unauthorized
Forbidden
The number was not found
PUT /numbers/:id/dial-plan/v1/voice-menu/:key/missed-calls
Authorization
name: x-rinkel-api-keytype: apiKeyin: header
Request
Request
curl / cURL
curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/voice-menu/:key/missed-calls' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
"setting": "hangup",
"recordingId": null,
"forwardTarget": null
}'
nodejs / axios
curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/voice-menu/:key/missed-calls' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
"setting": "hangup",
"recordingId": null,
"forwardTarget": null
}'
php / axios
curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/voice-menu/:key/missed-calls' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
"setting": "hangup",
"recordingId": null,
"forwardTarget": null
}'
python / requests
curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/voice-menu/:key/missed-calls' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
"setting": "hangup",
"recordingId": null,
"forwardTarget": null
}'
ruby / cURL
curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/voice-menu/:key/missed-calls' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
"setting": "hangup",
"recordingId": null,
"forwardTarget": null
}'
java / unirest
curl -L -X PUT 'https://api.rinkel.com/v1/numbers/:id/dial-plan/v1/voice-menu/:key/missed-calls' \
-H 'Content-Type: application/json' \
-H 'x-rinkel-api-key: <API_KEY_VALUE>' \
--data-raw '{
"setting": "hangup",
"recordingId": null,
"forwardTarget": null
}'