DELETE /api/v2/customivrs/{target_type}/{target_id}/{ivr_type}
Delete and un-assign an Ivr from a target.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Path parameters
| Name |
Type |
Required |
Description |
target_type |
String |
Yes |
Target's type of the custom ivr to be updated.
Valid values:
"room"
"callrouter"
"channel"
"coachingteam"
"staffgroup"
"callcenter"
"department"
"office"
"unknown"
"user"
"coachinggroup"
|
target_id |
Integer |
Yes |
The id of the target.
|
ivr_type |
String |
Yes |
Type of ivr you want to update.
Valid values:
"HOLD_CALLBACK_INVALID_NUMBER"
"HOLD_POSITION_ZERO"
"HOLD_MUSIC"
"HOLD_ESTIMATED_WAIT_TIME"
"CLOSED"
"NEXT_TARGET"
"HOLD_INTERRUPT"
"ADMIN_AUTO_RECORDING"
"HOLD_POSITION_ONE"
"HOLD_POSITION_SEVEN"
"CALLAI_AUTO_RECORDING"
"HOLD_AGENT_READY"
"HOLD_CALLBACK_REJECT"
"HOLD_POSITION_SIX"
"VM_DROP_MESSAGE"
"CG_AUTO_RECORDING"
"HOLD_CALLBACK_FULFILLED"
"HOLD_CALLBACK_ACCEPTED"
"HOLD_POSITION_EIGHT"
"MENU"
"HOLD_POSITION_MORE"
"VM_UNAVAILABLE_CLOSED"
"CLOSED_MENU_OPTION"
"POWER_DIALER_CALL_GREETING"
"HOLD_ESCAPE_VM_EIGHT"
"CALLAI_AUTO_RECORDING_INBOUND"
"HOLD_ESCAPE_VM_THREE"
"INCOMING_CALL_FROM_GROUP"
"HOLD_ESCAPE_VM_TWO"
"ASK_FIRST_OPERATOR_NOT_AVAILABLE"
"HOLD_CALLBACK_DIRECT"
"HOLD_POSITION_FOUR"
"AUTO_RECORDING"
"CLOSED_DEPARTMENT_INTRO"
"HOLD_CALLBACK_REJECTED"
"DEPARTMENT_INTRO"
"HOLD_POSITION_TEN"
"HOLD_ESCAPE_VM_ZERO"
"HOLD_CALLBACK_ACCEPT"
"HOLD_ESCAPE_VM_SEVEN"
"HOLD_CALLBACK_UNDIALABLE"
"HOLD_CALLBACK_REQUEST"
"HOLD_CALLBACK_SAME_NUMBER"
"HOLD_CALLBACK_DIFFERENT_NUMBER"
"HOLD_ESCAPE_VM_TEN"
"CLOSED_MENU"
"HOLD_WAIT"
"CALLAI_TOGGLE_ENABLED"
"HOLD_ESCAPE_VM_FOUR"
"CSAT_OUTRO"
"HOLD_ESCAPE_VM_NINE"
"GREETING"
"HOLD_CALLBACK_TRY_AGAIN"
"HOLD_APPREC"
"CSAT_PREAMBLE"
"HOLD_POSITION_FIVE"
"HOLD_CALLBACK_CONFIRM"
"PREFERRED_OPERATOR_PROMPT"
"HOLD_ESCAPE_VM_FIVE"
"HOLD_CALLBACK_KEYPAD"
"CALLAI_AUTO_RECORDING_OUTBOUND"
"HOLD_INTRO"
"HOLD_ESCAPE_VM_STAR"
"HOLD_POSITION_THREE"
"HOLD_ESCAPE_VM_SIX"
"HOLD_CALLBACK_CONFIRM_NUMBER"
"HOLD_POSITION_NINE"
"HOLD_POSITION_TWO"
"CSAT_INTRO"
"CSAT_QUESTION"
"HOLD_CALLBACK_REQUESTED"
"HOLD_ESCAPE_VM_ONE"
"HOLD_ESCAPE_VM_POUND"
"POWER_DIALER_VM_DROP"
"CALLAI_TOGGLE_DISABLED"
"VM_UNAVAILABLE"
"MENU_OPTION"
|
Request headers
| Name |
Type |
Required |
Description |
Content-Type |
String |
Yes |
The media type of the request body.
Default value: "application/json"
|
Request body fields
| Name |
Type |
Required |
Description |
ivr_id |
Integer |
Yes |
The id of the ivr that you want to use for the ivr type.
|
select_option |
Null |
No |
For call center auto call recording only. Set ivr for inbound or outbound. Default is both.
Valid values:
null
"inbound"
"outbound"
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.