Sign in
Class 5 IVR

Read

Retrieve a single Class 5 IVR record by ID.

get/api/cp/class5/ivr/{id}

Path parameters

idinteger required

Id identifier

Response

Successful response

idinteger

Id

account_idinteger

Account Id (references account.id)

customer_idinteger

Customer Id

deststring

Dest

namestring

Name

invalid_filestring

Invalid File

filestring

File

key_0_destinationstring

Key 0 Destination

key_0_destination_typestring

Key 0 Destination Type

key_1_destinationstring

Key 1 Destination

key_1_destination_typestring

Key 1 Destination Type

key_2_destinationstring

Key 2 Destination

key_2_destination_typestring

Key 2 Destination Type

key_3_destinationstring

Key 3 Destination

key_3_destination_typestring

Key 3 Destination Type

key_4_destinationstring

Key 4 Destination

key_4_destination_typestring

Key 4 Destination Type

key_5_destinationstring

Key 5 Destination

key_5_destination_typestring

Key 5 Destination Type

key_6_destinationstring

Key 6 Destination

key_6_destination_typestring

Key 6 Destination Type

key_7_destinationstring

Key 7 Destination

key_7_destination_typestring

Key 7 Destination Type

key_8_destinationstring

Key 8 Destination

key_8_destination_typestring

Key 8 Destination Type

key_9_destinationstring

Key 9 Destination

key_9_destination_typestring

Key 9 Destination Type

key_plus_destinationstring

Key Plus Destination

key_plus_destination_typestring

Key Plus Destination Type

key_hash_destinationstring

Key Hash Destination

key_hash_destination_typestring

Key Hash Destination Type

pbx_serverstring

Pbx Server

direct_extension_dialinteger

Direct Extension Dial

Example response

{
  "id": 12345,
  "account_id": 1,
  "customer_id": 1,
  "dest": "example_dest",
  "name": "Example Name",
  "invalid_file": "example_invalid_file",
  "file": "example_file",
  "key_0_destination": "example_key_0_destination",
  "key_0_destination_type": "example_key_0_destination_type",
  "key_1_destination": "example_key_1_destination",
  "key_1_destination_type": "example_key_1_destination_type",
  "key_2_destination": "example_key_2_destination",
  "key_2_destination_type": "example_key_2_destination_type",
  "key_3_destination": "example_key_3_destination",
  "key_3_destination_type": "example_key_3_destination_type",
  "key_4_destination": "example_key_4_destination",
  "key_4_destination_type": "example_key_4_destination_type",
  "key_5_destination": "example_key_5_destination",
  "key_5_destination_type": "example_key_5_destination_type",
  "key_6_destination": "example_key_6_destination",
  "key_6_destination_type": "example_key_6_destination_type",
  "key_7_destination": "example_key_7_destination",
  "key_7_destination_type": "example_key_7_destination_type",
  "key_8_destination": "example_key_8_destination",
  "key_8_destination_type": "example_key_8_destination_type",
  "key_9_destination": "example_key_9_destination",
  "key_9_destination_type": "example_key_9_destination_type",
  "key_plus_destination": "example_key_plus_destination",
  "key_plus_destination_type": "example_key_plus_destination_type",
  "key_hash_destination": "example_key_hash_destination",
  "key_hash_destination_type": "example_key_hash_destination_type",
  "pbx_server": "example_pbx_server",
  "direct_extension_dial": 1
}

Changes