Update the voice-menu settings for a key

Path Parameters

id string required

The ID of the number to update the voice menu key 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

enabled boolean required

Whether the key is enabled in the voice menu

action string required

Possible values: [forward, voicemail, hangup]

What should happen when the key is pressed

recordingId string nullable

The ID of the recording to play when the key is pressed

forwardTargets object[] nullable

The call forwarding targets, either a user or a phone number

Array [

oneOf

MOD1

MOD2

user string

enabled boolean

]

Responses

Successfully updated the key settings

Invalid request body

application/json

Schema

Example (from schema)

Schema

errors object[]

Array [

code string

Human readable error code

message string

Human readable error message

detail string

Human readable error detail

]

{
  "errors": [
    {
      "code": "ERROR_CODE",
      "message": "An error occurred while calling the endpoint",
      "detail": "View more info at developers.rinkel.com"
    }
  ]
}

Update the voice-menu settings for a key​

Update the voice-menu settings for a key