POST /api/v2/customivrs

Creates a new custom IVR for a target.

Added on June 15, 2022 for API v2.

Rate limit: 1200 per minute.

Servers

https://dialpad.com/
https://sandbox.dialpad.com/

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
`name`	String	No	[single-line only] The name of the new IVR. Max 100 characters.
`description`	String	No	[single-line only] The description of the new IVR. Max 256 characters.
`ivr_type`	String	Yes	Type of IVR. Possible values: `"HOLD_CALLBACK_INVALID_NUMBER"` `"HOLD_POSITION_ZERO"` `"HOLD_MUSIC"` `"CLOSED"` `"NEXT_TARGET"` `"HOLD_INTERRUPT"` `"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"` `"HOLD_ESCAPE_VM_EIGHT"` `"HOLD_ESCAPE_VM_THREE"` `"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"` `"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"` `"HOLD_ESCAPE_VM_FIVE"` `"HOLD_CALLBACK_KEYPAD"` `"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"` `"VM_UNAVAILABLE"` `"MENU_OPTION"`
`target_id`	Integer	Yes	The ID of the target to which you want to assign this IVR.
`target_type`	String	Yes	The type of the target to which you want to assign this IVR. Possible values: `"coachingteam"` `"callcenter"` `"department"` `"office"` `"user"`
`file`	String	Yes	An MP3 audio file. The file needs to be Base64-encoded.

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.