> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# dialpad-contact-center
> Contact Center Operations
**Server path:** `/dialpad-contact-center` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| --------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| [`dialpad_contact_center_callcenters_create`](#dialpad_contact_center_callcenters_create) | Call Centers -- Create |
| [`dialpad_contact_center_callcenters_delete`](#dialpad_contact_center_callcenters_delete) | Call Centers -- Delete |
| [`dialpad_contact_center_callcenters_get`](#dialpad_contact_center_callcenters_get) | Call Centers -- Get |
| [`dialpad_contact_center_callcenters_listall`](#dialpad_contact_center_callcenters_listall) | Call Centers -- List |
| [`dialpad_contact_center_callcenters_operators_delete`](#dialpad_contact_center_callcenters_operators_delete) | Operator -- Remove |
| [`dialpad_contact_center_callcenters_operators_dutystatus`](#dialpad_contact_center_callcenters_operators_dutystatus) | Operator -- Update Duty Status |
| [`dialpad_contact_center_callcenters_operators_get`](#dialpad_contact_center_callcenters_operators_get) | Operators -- List |
| [`dialpad_contact_center_callcenters_operators_get_dutystatus`](#dialpad_contact_center_callcenters_operators_get_dutystatus) | Operator -- Get Duty Status |
| [`dialpad_contact_center_callcenters_operators_get_skilllevel`](#dialpad_contact_center_callcenters_operators_get_skilllevel) | Operator -- Get Skill Level |
| [`dialpad_contact_center_callcenters_operators_post`](#dialpad_contact_center_callcenters_operators_post) | Operator -- Add |
| [`dialpad_contact_center_callcenters_operators_skilllevel`](#dialpad_contact_center_callcenters_operators_skilllevel) | Operator -- Update Skill Level |
| [`dialpad_contact_center_callcenters_status`](#dialpad_contact_center_callcenters_status) | Call Centers -- Status |
| [`dialpad_contact_center_callcenters_update`](#dialpad_contact_center_callcenters_update) | Call Centers -- Update |
| [`dialpad_contact_center_callrouters_create`](#dialpad_contact_center_callrouters_create) | Call Router -- Create |
| [`dialpad_contact_center_callrouters_delete`](#dialpad_contact_center_callrouters_delete) | Call Router -- Delete |
| [`dialpad_contact_center_callrouters_get`](#dialpad_contact_center_callrouters_get) | Call Router -- Get |
| [`dialpad_contact_center_callrouters_list`](#dialpad_contact_center_callrouters_list) | Call Router -- List |
| [`dialpad_contact_center_callrouters_update`](#dialpad_contact_center_callrouters_update) | Call Router -- Update |
| [`dialpad_contact_center_custom_ivrs_get`](#dialpad_contact_center_custom_ivrs_get) | Custom IVR -- Get |
| [`dialpad_contact_center_dispositions_create`](#dialpad_contact_center_dispositions_create) | Dispositions -- Create |
| [`dialpad_contact_center_dispositions_delete`](#dialpad_contact_center_dispositions_delete) | Dispositions -- Delete |
| [`dialpad_contact_center_dispositions_get`](#dialpad_contact_center_dispositions_get) | Dispositions -- Get |
| [`dialpad_contact_center_dispositions_list`](#dialpad_contact_center_dispositions_list) | Dispositions -- List |
| [`dialpad_contact_center_dispositions_update`](#dialpad_contact_center_dispositions_update) | Dispositions -- Update |
| [`dialpad_contact_center_ivr_create`](#dialpad_contact_center_ivr_create) | Custom IVR -- Create |
| [`dialpad_contact_center_ivr_delete`](#dialpad_contact_center_ivr_delete) | Custom IVR -- Delete |
| [`dialpad_contact_center_ivr_details_update`](#dialpad_contact_center_ivr_details_update) | Custom IVR -- Update |
| [`dialpad_contact_center_ivr_update`](#dialpad_contact_center_ivr_update) | Custom IVR -- Assign |
| [`dialpad_contact_center_numbers_assign_call_router_number_post`](#dialpad_contact_center_numbers_assign_call_router_number_post) | Dialpad Number -- Assign |
| [`dialpad_contact_center_scorecards_export_create`](#dialpad_contact_center_scorecards_export_create) | Scorecards export -- Initiate Processing |
| [`dialpad_contact_center_scorecards_export_get`](#dialpad_contact_center_scorecards_export_get) | Scorecards export -- Get Result |
| [`dialpad_contact_center_scorecards_get`](#dialpad_contact_center_scorecards_get) | Scorecards -- Get |
| [`dialpad_contact_center_scorecards_list`](#dialpad_contact_center_scorecards_list) | Scorecards -- List |
| [`dialpad_contact_center_wfm_metrics_activity_get`](#dialpad_contact_center_wfm_metrics_activity_get) | Activity Metrics |
| [`dialpad_contact_center_wfm_metrics_agent_get`](#dialpad_contact_center_wfm_metrics_agent_get) | Agent Metrics |
***
## dialpad\_contact\_center\_callcenters\_create
Call Centers -- Create
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `advanced_settings` | object | No | — | Advanced Settings | |
| `alerts` | object | No | — | The alerts value | |
| `friday_hours` | string\[] | No | — | The Friday hours of operation. Default value is \["08:00", "18:00"]. | |
| `group_description` | string | null | No | — | The description of the call center. Max 256 characters. |
| `hold_queue` | object | No | — | Hold Queue | |
| `hours_on` | boolean | null | No | — | The time frame when the call center wants to receive calls. Default value is false, which means the call center will always take calls (24/7). |
| `monday_hours` | string\[] | No | — | The Monday hours of operation. To specify when hours\_on is set to True. e.g. \["08:00", "12:00", "14:00", "18:00"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is \["08:00", "18:00"]. | |
| `name` | string | Yes | — | \[single-line only] The name of the call center. Max 100 characters. | |
| `office_id` | integer | Yes | — | The id of the office to which the call center belongs.. | |
| `ring_seconds` | integer | null | No | — | The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds. |
| `routing_options` | object | No | — | Routing Options | |
| `saturday_hours` | string\[] | No | — | The Saturday hours of operation. Default is empty array. | |
| `sunday_hours` | string\[] | No | — | The Sunday hours of operation. Default is empty array. | |
| `thursday_hours` | string\[] | No | — | The Thursday hours of operation. Default value is \["08:00", "18:00"]. | |
| `tuesday_hours` | string\[] | No | — | The Tuesday hours of operation. Default value is \["08:00", "18:00"]. | |
| `voice_intelligence` | object | No | — | Voice Intelligence | |
| `wednesday_hours` | string\[] | No | — | The Wednesday hours of operation. Default value is \["08:00", "18:00"]. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"advanced_settings": {
"type": "object",
"description": "Advanced Settings",
"properties": {
"auto_call_recording": {
"type": "object",
"description": "Auto Call Recording"
},
"max_wrap_up_seconds": {
"type": "integer",
"description": "Include a post-call wrap-up time before agents can receive their next call. Default is 0."
}
}
},
"alerts": {
"type": "object",
"description": "The alerts value",
"properties": {
"cc_service_level": {
"type": "integer",
"description": "Alert supervisors when the service level drops below how many percent. Default is 95%."
},
"cc_service_level_seconds": {
"type": "integer",
"description": "Inbound calls should be answered within how many seconds. Default is 60."
}
}
},
"friday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Friday hours of operation. Default value is [\"08:00\", \"18:00\"]."
},
"group_description": {
"type": [
"string",
"null"
],
"description": "The description of the call center. Max 256 characters."
},
"hold_queue": {
"type": "object",
"description": "Hold Queue",
"properties": {
"allow_queue_callback": {
"type": "boolean",
"description": "Whether or not to allow callers to request a callback. Default is False."
},
"announce_estimated_wait_time": {
"type": "boolean",
"description": "Whether or not to let callers know their estimated wait time. Default is True."
},
"announce_position": {
"type": "boolean",
"description": "Whether or not to let callers know their place in the queue. This option is not available when a maximum queue wait time of less than 2 minutes is selected. Default is True."
},
"announcement_interval_seconds": {
"type": "integer",
"description": "Hold announcement interval wait time. Default is 2 min."
},
"estimated_wait_time_max": {
"type": "integer",
"description": "Maximum estimated wait time to announce in minutes. Default is 30 minutes."
},
"max_hold_count": {
"type": "integer",
"description": "If all operators are busy on other calls, send callers to a hold queue. This is to specify your queue size. Choose from 1-1000. Default is 50."
},
"max_hold_seconds": {
"type": "integer",
"description": "Maximum queue wait time in seconds. Choose from 30s to 18000s (3 hours). Default is 900s (15 min)."
},
"queue_callback_dtmf": {
"type": "string",
"description": "Allow callers to request a callback when the queue has more than queue_callback_threshold number of calls by pressing one of the followings: [0,1,2,3,4,5,6,7,8,9,*,#]. Default is 9."
},
"queue_callback_threshold": {
"type": "integer",
"description": "Allow callers to request a callback when the queue has more than this number of calls. Default is 5."
},
"queue_escape_dtmf": {
"type": "string",
"description": "Allow callers to exit the hold queue to voicemail by pressing one of the followings: [0,1,2,3,4,5,6,7,8,9,*,#]. Default is *."
},
"stay_in_queue_after_closing": {
"type": "boolean",
"description": "Whether or not to allow existing calls to stay in queue after the call center has closed. Default is False."
},
"unattended_queue": {
"type": "boolean",
"description": "Whether or not to allow callers to be placed in your hold queue when no agents are available. Default is False."
}
}
},
"hours_on": {
"type": [
"boolean",
"null"
],
"description": "The time frame when the call center wants to receive calls. Default value is false, which means the call center will always take calls (24/7)."
},
"monday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Monday hours of operation. To specify when hours_on is set to True. e.g. [\"08:00\", \"12:00\", \"14:00\", \"18:00\"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [\"08:00\", \"18:00\"]."
},
"name": {
"type": "string",
"description": "[single-line only] The name of the call center. Max 100 characters."
},
"office_id": {
"type": "integer",
"description": "The id of the office to which the call center belongs.."
},
"ring_seconds": {
"type": [
"integer",
"null"
],
"description": "The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds."
},
"routing_options": {
"type": "object",
"description": "Routing Options",
"properties": {
"closed": {
"type": "object",
"description": "The closed value"
},
"open": {
"type": "object",
"description": "The open value"
}
},
"required": [
"closed",
"open"
]
},
"saturday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Saturday hours of operation. Default is empty array."
},
"sunday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Sunday hours of operation. Default is empty array."
},
"thursday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Thursday hours of operation. Default value is [\"08:00\", \"18:00\"]."
},
"tuesday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Tuesday hours of operation. Default value is [\"08:00\", \"18:00\"]."
},
"voice_intelligence": {
"type": "object",
"description": "Voice Intelligence",
"properties": {
"allow_pause": {
"type": "boolean",
"description": "Allow individual users to start and stop Vi during calls. Default is True."
},
"auto_start": {
"type": "boolean",
"description": "Auto start Vi for this call center. Default is True."
}
}
},
"wednesday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Wednesday hours of operation. Default value is [\"08:00\", \"18:00\"]."
}
},
"required": [
"PCID",
"name",
"office_id"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_delete
Call Centers -- Delete
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------- |
| `id` | integer | Yes | — | The call center's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The call center's id."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_get
Call Centers -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------- |
| `id` | integer | Yes | — | The call center's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The call center's id."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_listall
Call Centers -- List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
| `office_id` | integer | No | — | search call center by office. |
| `name_search` | string | No | — | search call centers by name or search by the substring of the name. If input example is 'Cool', output example can be a list of call centers whose name contains the string 'Cool' - \['Cool call center 1', 'Cool call center 2049'] |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
},
"office_id": {
"type": "integer",
"description": "search call center by office."
},
"name_search": {
"type": "string",
"description": "search call centers by name or search by the substring of the name. If input example is 'Cool', output example can be a list of call centers whose name contains the string 'Cool' - ['Cool call center 1', 'Cool call center 2049']"
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_operators\_delete
Operator -- Remove
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------------------------- |
| `id` | integer | Yes | — | The call center's id. |
| `user_id` | integer | Yes | — | ID of the operator to remove. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The call center's id."
},
"user_id": {
"type": "integer",
"description": "ID of the operator to remove."
}
},
"required": [
"PCID",
"id",
"user_id"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_operators\_dutystatus
Operator -- Update Duty Status
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------- | ------- | -------- | ------- | ---------------------------------------------------------- | -------------------------------------------------- |
| `id` | integer | Yes | — | The operator's user id. | |
| `duty_status_reason` | string | null | No | — | \[single-line only] A description of this status. |
| `on_duty` | boolean | Yes | — | True if this status message indicates an "on-duty" status. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The operator's user id."
},
"duty_status_reason": {
"type": [
"string",
"null"
],
"description": "[single-line only] A description of this status."
},
"on_duty": {
"type": "boolean",
"description": "True if this status message indicates an \"on-duty\" status."
}
},
"required": [
"PCID",
"id",
"on_duty"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_operators\_get
Operators -- List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------- |
| `id` | integer | Yes | — | The call center's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The call center's id."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_operators\_get\_dutystatus
Operator -- Get Duty Status
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------------------- |
| `id` | integer | Yes | — | The operator's user id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The operator's user id."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_operators\_get\_skilllevel
Operator -- Get Skill Level
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | -------------------- |
| `call_center_id` | integer | Yes | — | The call center's ID |
| `user_id` | integer | Yes | — | The operator's ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"call_center_id": {
"type": "integer",
"description": "The call center's ID"
},
"user_id": {
"type": "integer",
"description": "The operator's ID"
}
},
"required": [
"PCID",
"call_center_id",
"user_id"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_operators\_post
Operator -- Add
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------------- | ------- | -------- | ------- | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The call center's id. | |
| `keep_paid_numbers` | boolean | null | No | — | Whether or not to keep phone numbers when switching to a support license. Note: Phone numbers require additional number licenses under a support license. |
| `license_type` | string | null | No | — | The type of license to assign to the new operator if a license is required. (`agents` or `lite_support_agents`). Defaults to `agents` |
| `role` | string | null | No | — | The role the user should assume. |
| `skill_level` | integer | null | No | — | Skill level of the operator. Integer value in range 1 - 100. Default 100. |
| `user_id` | integer | Yes | — | The ID of the user. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The call center's id."
},
"keep_paid_numbers": {
"type": [
"boolean",
"null"
],
"description": "Whether or not to keep phone numbers when switching to a support license. Note: Phone numbers require additional number licenses under a support license."
},
"license_type": {
"type": [
"string",
"null"
],
"description": "The type of license to assign to the new operator if a license is required. (`agents` or `lite_support_agents`). Defaults to `agents`",
"enum": [
"agents",
"lite_support_agents"
]
},
"role": {
"type": [
"string",
"null"
],
"description": "The role the user should assume.",
"enum": [
"admin",
"operator",
"supervisor"
]
},
"skill_level": {
"type": [
"integer",
"null"
],
"description": "Skill level of the operator. Integer value in range 1 - 100. Default 100."
},
"user_id": {
"type": "integer",
"description": "The ID of the user."
}
},
"required": [
"PCID",
"id",
"user_id"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_operators\_skilllevel
Operator -- Update Skill Level
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------ |
| `call_center_id` | integer | Yes | — | The call center's ID |
| `user_id` | integer | Yes | — | The operator's ID |
| `skill_level` | integer | Yes | — | New skill level to set the operator in the call center. It must be an integer value between 0 and 100. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"call_center_id": {
"type": "integer",
"description": "The call center's ID"
},
"user_id": {
"type": "integer",
"description": "The operator's ID"
},
"skill_level": {
"type": "integer",
"description": "New skill level to set the operator in the call center. It must be an integer value between 0 and 100."
}
},
"required": [
"PCID",
"call_center_id",
"user_id",
"skill_level"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_status
Call Centers -- Status
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------- |
| `id` | integer | Yes | — | The call center's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The call center's id."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_callcenters\_update
Call Centers -- Update
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The call center's id. | |
| `advanced_settings` | object | No | — | Advanced Settings | |
| `alerts` | object | No | — | The alerts value | |
| `friday_hours` | string\[] | No | — | The Friday hours of operation. Default value is \["08:00", "18:00"]. | |
| `group_description` | string | null | No | — | The description of the call center. Max 256 characters. |
| `hold_queue` | object | No | — | Hold Queue | |
| `hours_on` | boolean | null | No | — | The time frame when the call center wants to receive calls. Default value is false, which means the call center will always take calls (24/7). |
| `monday_hours` | string\[] | No | — | The Monday hours of operation. To specify when hours\_on is set to True. e.g. \["08:00", "12:00", "14:00", "18:00"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is \["08:00", "18:00"]. | |
| `name` | string | null | No | — | \[single-line only] The name of the call center. Max 100 characters. |
| `ring_seconds` | integer | null | No | — | The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds. |
| `routing_options` | object | No | — | Routing Options | |
| `saturday_hours` | string\[] | No | — | The Saturday hours of operation. Default is empty array. | |
| `sunday_hours` | string\[] | No | — | The Sunday hours of operation. Default is empty array. | |
| `thursday_hours` | string\[] | No | — | The Thursday hours of operation. Default value is \["08:00", "18:00"]. | |
| `tuesday_hours` | string\[] | No | — | The Tuesday hours of operation. Default value is \["08:00", "18:00"]. | |
| `voice_intelligence` | object | No | — | Voice Intelligence | |
| `wednesday_hours` | string\[] | No | — | The Wednesday hours of operation. Default value is \["08:00", "18:00"]. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The call center's id."
},
"advanced_settings": {
"type": "object",
"description": "Advanced Settings",
"properties": {
"auto_call_recording": {
"type": "object",
"description": "Auto Call Recording"
},
"max_wrap_up_seconds": {
"type": "integer",
"description": "Include a post-call wrap-up time before agents can receive their next call. Default is 0."
}
}
},
"alerts": {
"type": "object",
"description": "The alerts value",
"properties": {
"cc_service_level": {
"type": "integer",
"description": "Alert supervisors when the service level drops below how many percent. Default is 95%."
},
"cc_service_level_seconds": {
"type": "integer",
"description": "Inbound calls should be answered within how many seconds. Default is 60."
}
}
},
"friday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Friday hours of operation. Default value is [\"08:00\", \"18:00\"]."
},
"group_description": {
"type": [
"string",
"null"
],
"description": "The description of the call center. Max 256 characters."
},
"hold_queue": {
"type": "object",
"description": "Hold Queue",
"properties": {
"allow_queue_callback": {
"type": "boolean",
"description": "Whether or not to allow callers to request a callback. Default is False."
},
"announce_estimated_wait_time": {
"type": "boolean",
"description": "Whether or not to let callers know their estimated wait time. Default is True."
},
"announce_position": {
"type": "boolean",
"description": "Whether or not to let callers know their place in the queue. This option is not available when a maximum queue wait time of less than 2 minutes is selected. Default is True."
},
"announcement_interval_seconds": {
"type": "integer",
"description": "Hold announcement interval wait time. Default is 2 min."
},
"estimated_wait_time_max": {
"type": "integer",
"description": "Maximum estimated wait time to announce in minutes. Default is 30 minutes."
},
"max_hold_count": {
"type": "integer",
"description": "If all operators are busy on other calls, send callers to a hold queue. This is to specify your queue size. Choose from 1-1000. Default is 50."
},
"max_hold_seconds": {
"type": "integer",
"description": "Maximum queue wait time in seconds. Choose from 30s to 18000s (3 hours). Default is 900s (15 min)."
},
"queue_callback_dtmf": {
"type": "string",
"description": "Allow callers to request a callback when the queue has more than queue_callback_threshold number of calls by pressing one of the followings: [0,1,2,3,4,5,6,7,8,9,*,#]. Default is 9."
},
"queue_callback_threshold": {
"type": "integer",
"description": "Allow callers to request a callback when the queue has more than this number of calls. Default is 5."
},
"queue_escape_dtmf": {
"type": "string",
"description": "Allow callers to exit the hold queue to voicemail by pressing one of the followings: [0,1,2,3,4,5,6,7,8,9,*,#]. Default is *."
},
"stay_in_queue_after_closing": {
"type": "boolean",
"description": "Whether or not to allow existing calls to stay in queue after the call center has closed. Default is False."
},
"unattended_queue": {
"type": "boolean",
"description": "Whether or not to allow callers to be placed in your hold queue when no agents are available. Default is False."
}
}
},
"hours_on": {
"type": [
"boolean",
"null"
],
"description": "The time frame when the call center wants to receive calls. Default value is false, which means the call center will always take calls (24/7)."
},
"monday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Monday hours of operation. To specify when hours_on is set to True. e.g. [\"08:00\", \"12:00\", \"14:00\", \"18:00\"] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [\"08:00\", \"18:00\"]."
},
"name": {
"type": [
"string",
"null"
],
"description": "[single-line only] The name of the call center. Max 100 characters."
},
"ring_seconds": {
"type": [
"integer",
"null"
],
"description": "The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds."
},
"routing_options": {
"type": "object",
"description": "Routing Options",
"properties": {
"closed": {
"type": "object",
"description": "The closed value"
},
"open": {
"type": "object",
"description": "The open value"
}
},
"required": [
"closed",
"open"
]
},
"saturday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Saturday hours of operation. Default is empty array."
},
"sunday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Sunday hours of operation. Default is empty array."
},
"thursday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Thursday hours of operation. Default value is [\"08:00\", \"18:00\"]."
},
"tuesday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Tuesday hours of operation. Default value is [\"08:00\", \"18:00\"]."
},
"voice_intelligence": {
"type": "object",
"description": "Voice Intelligence",
"properties": {
"allow_pause": {
"type": "boolean",
"description": "Allow individual users to start and stop Vi during calls. Default is True."
},
"auto_start": {
"type": "boolean",
"description": "Auto start Vi for this call center. Default is True."
}
}
},
"wednesday_hours": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Wednesday hours of operation. Default value is [\"08:00\", \"18:00\"]."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_callrouters\_create
Call Router -- Create
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| --------------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| `default_target_id` | integer | Yes | — | The ID of the target that should be used as a fallback destination for calls if the call router is disabled or fails. | |
| `default_target_type` | string | Yes | — | The entity type of the default target. | |
| `enabled` | boolean | null | No | — | If set to False, the call router will skip the routing url and instead forward calls straight to the default target. |
| `name` | string | Yes | — | \[single-line only] A human-readable display name for the router. | |
| `office_id` | integer | Yes | — | The ID of the office to which this router belongs. | |
| `routing_url` | string | Yes | — | The URL that should be used to drive call routing decisions. | |
| `secret` | string | null | No | — | \[single-line only] The call router's signature secret. This is a plain text string that you should generate with a minimum length of 32 characters. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"default_target_id": {
"type": "integer",
"description": "The ID of the target that should be used as a fallback destination for calls if the call router is disabled or fails."
},
"default_target_type": {
"type": "string",
"description": "The entity type of the default target.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
},
"enabled": {
"type": [
"boolean",
"null"
],
"description": "If set to False, the call router will skip the routing url and instead forward calls straight to the default target."
},
"name": {
"type": "string",
"description": "[single-line only] A human-readable display name for the router."
},
"office_id": {
"type": "integer",
"description": "The ID of the office to which this router belongs."
},
"routing_url": {
"type": "string",
"description": "The URL that should be used to drive call routing decisions."
},
"secret": {
"type": [
"string",
"null"
],
"description": "[single-line only] The call router's signature secret. This is a plain text string that you should generate with a minimum length of 32 characters."
}
},
"required": [
"PCID",
"default_target_id",
"default_target_type",
"name",
"office_id",
"routing_url"
]
}
```
***
## dialpad\_contact\_center\_callrouters\_delete
Call Router -- Delete
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------ |
| `id` | string | Yes | — | The API call router's ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The API call router's ID"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_callrouters\_get
Call Router -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | ------------------------ |
| `id` | integer | Yes | — | The API call router's ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The API call router's ID"
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_callrouters\_list
Call Router -- List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
| `office_id` | integer | No | — | The office's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
},
"office_id": {
"type": "integer",
"description": "The office's id."
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_contact\_center\_callrouters\_update
Call Router -- Update
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| --------------------- | ------- | -------- | ------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | string | Yes | — | The API call router's ID | |
| `default_target_id` | integer | null | No | — | The ID of the target that should be used as a fallback destination for calls if the call router is disabled or fails. |
| `default_target_type` | string | null | No | — | The entity type of the default target. |
| `enabled` | boolean | null | No | — | If set to False, the call router will skip the routing url and instead forward calls straight to the default target. |
| `name` | string | null | No | — | \[single-line only] A human-readable display name for the router. |
| `office_id` | integer | null | No | — | The ID of the office to which this router belongs. |
| `reset_error_count` | boolean | null | No | — | Sets the auto-disablement routing error count back to zero. Call routers maintain a count of the number of errors that have occurred within the past hour, and automatically become disabled when that count exceeds 10. Setting enabled to true via the API will not reset that count, which means that the router will likely become disabled again after one more error. In most cases, this will be useful for testing fixes in your routing API, but in some circumstances it may be desirable to reset that counter. |
| `routing_url` | string | null | No | — | The URL that should be used to drive call routing decisions. |
| `secret` | string | null | No | — | \[single-line only] The call router's signature secret. This is a plain text string that you should generate with a minimum length of 32 characters. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The API call router's ID"
},
"default_target_id": {
"type": [
"integer",
"null"
],
"description": "The ID of the target that should be used as a fallback destination for calls if the call router is disabled or fails."
},
"default_target_type": {
"type": [
"string",
"null"
],
"description": "The entity type of the default target.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
},
"enabled": {
"type": [
"boolean",
"null"
],
"description": "If set to False, the call router will skip the routing url and instead forward calls straight to the default target."
},
"name": {
"type": [
"string",
"null"
],
"description": "[single-line only] A human-readable display name for the router."
},
"office_id": {
"type": [
"integer",
"null"
],
"description": "The ID of the office to which this router belongs."
},
"reset_error_count": {
"type": [
"boolean",
"null"
],
"description": "Sets the auto-disablement routing error count back to zero. Call routers maintain a count of the number of errors that have occurred within the past hour, and automatically become disabled when that count exceeds 10. Setting enabled to true via the API will not reset that count, which means that the router will likely become disabled again after one more error. In most cases, this will be useful for testing fixes in your routing API, but in some circumstances it may be desirable to reset that counter."
},
"routing_url": {
"type": [
"string",
"null"
],
"description": "The URL that should be used to drive call routing decisions."
},
"secret": {
"type": [
"string",
"null"
],
"description": "[single-line only] The call router's signature secret. This is a plain text string that you should generate with a minimum length of 32 characters."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_custom\_ivrs\_get
Custom IVR -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
| `target_type` | string | Yes | — | Target's type. |
| `target_id` | integer | Yes | — | The target's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
},
"target_type": {
"type": "string",
"description": "Target's type.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
},
"target_id": {
"type": "integer",
"description": "The target's id."
}
},
"required": [
"PCID",
"target_type",
"target_id"
]
}
```
***
## dialpad\_contact\_center\_dispositions\_create
Dispositions -- Create
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------- | -------- | ------- | -------------------------------------------------------- |
| `dispositions` | object | No | — | The dispositions. |
| `name` | string | Yes | — | \[single-line only] The name of the parent disposition. |
| `office_id` | integer | Yes | — | The ID of the office assigned to the dispositions. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"dispositions": {
"type": "object",
"description": "The dispositions."
},
"name": {
"type": "string",
"description": "[single-line only] The name of the parent disposition."
},
"office_id": {
"type": "integer",
"description": "The ID of the office assigned to the dispositions."
}
},
"required": [
"PCID",
"name",
"office_id"
]
}
```
***
## dialpad\_contact\_center\_dispositions\_delete
Dispositions -- Delete
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------------- |
| `id` | integer | Yes | — | The id of the dispositions. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id of the dispositions."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_dispositions\_get
Dispositions -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------- | -------- | ------- | --------------------- |
| `id` | integer | Yes | — | The disposition's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The disposition's id."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_dispositions\_list
Dispositions -- List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
| `target_id` | integer | No | — | The target's id. |
| `target_type` | string | No | — | The target's type. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
},
"target_id": {
"type": "integer",
"description": "The target's id."
},
"target_type": {
"type": "string",
"description": "The target's type.",
"enum": [
"callcenter",
"coachinggroup",
"coachingteam",
"office",
"unknown"
]
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_contact\_center\_dispositions\_update
Dispositions -- Update
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| -------------- | ------- | -------- | ------- | --------------------------- | ---------------------------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The id of the dispositions. | |
| `action` | string | null | No | — | The action will determine whether to add or remove the specified target from the dispositions. |
| `dispositions` | object | No | — | The dispositions. | |
| `name` | string | null | No | — | \[single-line only] The name of the parent disposition. |
| `target_id` | integer | null | No | — | The target id for the dispositions. |
| `target_type` | string | null | No | — | The target type for the dispositions. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id of the dispositions."
},
"action": {
"type": [
"string",
"null"
],
"description": "The action will determine whether to add or remove the specified target from the dispositions.",
"enum": [
"add_target",
"remove_target"
]
},
"dispositions": {
"type": "object",
"description": "The dispositions."
},
"name": {
"type": [
"string",
"null"
],
"description": "[single-line only] The name of the parent disposition."
},
"target_id": {
"type": [
"integer",
"null"
],
"description": "The target id for the dispositions."
},
"target_type": {
"type": [
"string",
"null"
],
"description": "The target type for the dispositions.",
"enum": [
"callcenter",
"coachinggroup",
"coachingteam",
"unknown"
]
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_ivr\_create
Custom IVR -- Create
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `description` | string | null | No | — | \[single-line only] The description of the new IVR. Max 256 characters. |
| `file` | string | Yes | — | An MP3 audio file. The file needs to be Base64-encoded. | |
| `ivr_type` | string | Yes | — | Type of IVR. | |
| `name` | string | null | No | — | \[single-line only] The name of the new IVR. Max 100 characters. |
| `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. | |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": [
"string",
"null"
],
"description": "[single-line only] The description of the new IVR. Max 256 characters."
},
"file": {
"type": "string",
"description": "An MP3 audio file. The file needs to be Base64-encoded."
},
"ivr_type": {
"type": "string",
"description": "Type of IVR.",
"enum": [
"ADMIN_AUTO_RECORDING",
"ASK_FIRST_OPERATOR_NOT_AVAILABLE",
"AUTO_RECORDING",
"CALLAI_AUTO_RECORDING",
"CALLAI_AUTO_RECORDING_INBOUND",
"CALLAI_AUTO_RECORDING_OUTBOUND",
"CALLAI_TOGGLE_DISABLED",
"CALLAI_TOGGLE_ENABLED",
"CG_AUTO_RECORDING",
"CLOSED",
"CLOSED_DEPARTMENT_INTRO",
"CLOSED_MENU",
"CLOSED_MENU_OPTION",
"CSAT_INTRO",
"CSAT_OUTRO",
"CSAT_PREAMBLE",
"CSAT_QUESTION",
"DEPARTMENT_INTRO",
"GREETING",
"HOLD_AGENT_READY",
"HOLD_APPREC",
"HOLD_CALLBACK_ACCEPT",
"HOLD_CALLBACK_ACCEPTED",
"HOLD_CALLBACK_CONFIRM",
"HOLD_CALLBACK_CONFIRM_NUMBER",
"HOLD_CALLBACK_DIFFERENT_NUMBER",
"HOLD_CALLBACK_DIRECT",
"HOLD_CALLBACK_FULFILLED",
"HOLD_CALLBACK_INVALID_NUMBER",
"HOLD_CALLBACK_KEYPAD",
"HOLD_CALLBACK_REJECT",
"HOLD_CALLBACK_REJECTED",
"HOLD_CALLBACK_REQUEST",
"HOLD_CALLBACK_REQUESTED",
"HOLD_CALLBACK_SAME_NUMBER",
"HOLD_CALLBACK_TRY_AGAIN",
"HOLD_CALLBACK_UNDIALABLE",
"HOLD_ESCAPE_VM_EIGHT",
"HOLD_ESCAPE_VM_FIVE",
"HOLD_ESCAPE_VM_FOUR",
"HOLD_ESCAPE_VM_NINE",
"HOLD_ESCAPE_VM_ONE",
"HOLD_ESCAPE_VM_POUND",
"HOLD_ESCAPE_VM_SEVEN",
"HOLD_ESCAPE_VM_SIX",
"HOLD_ESCAPE_VM_STAR",
"HOLD_ESCAPE_VM_TEN",
"HOLD_ESCAPE_VM_THREE",
"HOLD_ESCAPE_VM_TWO",
"HOLD_ESCAPE_VM_ZERO",
"HOLD_ESTIMATED_WAIT_TIME",
"HOLD_INTERRUPT",
"HOLD_INTRO",
"HOLD_MUSIC",
"HOLD_POSITION_EIGHT",
"HOLD_POSITION_FIVE",
"HOLD_POSITION_FOUR",
"HOLD_POSITION_MORE",
"HOLD_POSITION_NINE",
"HOLD_POSITION_ONE",
"HOLD_POSITION_SEVEN",
"HOLD_POSITION_SIX",
"HOLD_POSITION_TEN",
"HOLD_POSITION_THREE",
"HOLD_POSITION_TWO",
"HOLD_POSITION_ZERO",
"HOLD_WAIT",
"INCOMING_CALL_FROM_GROUP",
"MENU",
"MENU_OPTION",
"NEXT_TARGET",
"POWER_DIALER_CALL_GREETING",
"POWER_DIALER_VM_DROP",
"PREFERRED_OPERATOR_PROMPT",
"VM_DROP_MESSAGE",
"VM_UNAVAILABLE",
"VM_UNAVAILABLE_CLOSED"
]
},
"name": {
"type": [
"string",
"null"
],
"description": "[single-line only] The name of the new IVR. Max 100 characters."
},
"target_id": {
"type": "integer",
"description": "The ID of the target to which you want to assign this IVR."
},
"target_type": {
"type": "string",
"description": "The type of the target to which you want to assign this IVR.",
"enum": [
"callcenter",
"coachingteam",
"department",
"office",
"user"
]
}
},
"required": [
"PCID",
"file",
"ivr_type",
"target_id",
"target_type"
]
}
```
***
## dialpad\_contact\_center\_ivr\_delete
Custom IVR -- Delete
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `target_type` | string | Yes | — | Target's type of the custom ivr to be updated. | |
| `target_id` | integer | Yes | — | The id of the target. | |
| `ivr_type` | string | Yes | — | Type of ivr you want to update. | |
| `ivr_id` | integer | Yes | — | The id of the ivr that you want to use for the ivr type. | |
| `select_option` | string | null | No | — | For call center auto call recording only. Set ivr for inbound or outbound. Default is both. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"target_type": {
"type": "string",
"description": "Target's type of the custom ivr to be updated.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
},
"target_id": {
"type": "integer",
"description": "The id of the target."
},
"ivr_type": {
"type": "string",
"description": "Type of ivr you want to update.",
"enum": [
"ADMIN_AUTO_RECORDING",
"ASK_FIRST_OPERATOR_NOT_AVAILABLE",
"AUTO_RECORDING",
"CALLAI_AUTO_RECORDING",
"CALLAI_AUTO_RECORDING_INBOUND",
"CALLAI_AUTO_RECORDING_OUTBOUND",
"CALLAI_TOGGLE_DISABLED",
"CALLAI_TOGGLE_ENABLED",
"CG_AUTO_RECORDING",
"CLOSED",
"CLOSED_DEPARTMENT_INTRO",
"CLOSED_MENU",
"CLOSED_MENU_OPTION",
"CSAT_INTRO",
"CSAT_OUTRO",
"CSAT_PREAMBLE",
"CSAT_QUESTION",
"DEPARTMENT_INTRO",
"GREETING",
"HOLD_AGENT_READY",
"HOLD_APPREC",
"HOLD_CALLBACK_ACCEPT",
"HOLD_CALLBACK_ACCEPTED",
"HOLD_CALLBACK_CONFIRM",
"HOLD_CALLBACK_CONFIRM_NUMBER",
"HOLD_CALLBACK_DIFFERENT_NUMBER",
"HOLD_CALLBACK_DIRECT",
"HOLD_CALLBACK_FULFILLED",
"HOLD_CALLBACK_INVALID_NUMBER",
"HOLD_CALLBACK_KEYPAD",
"HOLD_CALLBACK_REJECT",
"HOLD_CALLBACK_REJECTED",
"HOLD_CALLBACK_REQUEST",
"HOLD_CALLBACK_REQUESTED",
"HOLD_CALLBACK_SAME_NUMBER",
"HOLD_CALLBACK_TRY_AGAIN",
"HOLD_CALLBACK_UNDIALABLE",
"HOLD_ESCAPE_VM_EIGHT",
"HOLD_ESCAPE_VM_FIVE",
"HOLD_ESCAPE_VM_FOUR",
"HOLD_ESCAPE_VM_NINE",
"HOLD_ESCAPE_VM_ONE",
"HOLD_ESCAPE_VM_POUND",
"HOLD_ESCAPE_VM_SEVEN",
"HOLD_ESCAPE_VM_SIX",
"HOLD_ESCAPE_VM_STAR",
"HOLD_ESCAPE_VM_TEN",
"HOLD_ESCAPE_VM_THREE",
"HOLD_ESCAPE_VM_TWO",
"HOLD_ESCAPE_VM_ZERO",
"HOLD_ESTIMATED_WAIT_TIME",
"HOLD_INTERRUPT",
"HOLD_INTRO",
"HOLD_MUSIC",
"HOLD_POSITION_EIGHT",
"HOLD_POSITION_FIVE",
"HOLD_POSITION_FOUR",
"HOLD_POSITION_MORE",
"HOLD_POSITION_NINE",
"HOLD_POSITION_ONE",
"HOLD_POSITION_SEVEN",
"HOLD_POSITION_SIX",
"HOLD_POSITION_TEN",
"HOLD_POSITION_THREE",
"HOLD_POSITION_TWO",
"HOLD_POSITION_ZERO",
"HOLD_WAIT",
"INCOMING_CALL_FROM_GROUP",
"MENU",
"MENU_OPTION",
"NEXT_TARGET",
"POWER_DIALER_CALL_GREETING",
"POWER_DIALER_VM_DROP",
"PREFERRED_OPERATOR_PROMPT",
"VM_DROP_MESSAGE",
"VM_UNAVAILABLE",
"VM_UNAVAILABLE_CLOSED"
]
},
"ivr_id": {
"type": "integer",
"description": "The id of the ivr that you want to use for the ivr type."
},
"select_option": {
"type": [
"string",
"null"
],
"description": "For call center auto call recording only. Set ivr for inbound or outbound. Default is both.",
"enum": [
"inbound",
"outbound"
]
}
},
"required": [
"PCID",
"target_type",
"target_id",
"ivr_type",
"ivr_id"
]
}
```
***
## dialpad\_contact\_center\_ivr\_details\_update
Custom IVR -- Update
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ------------- | ------ | -------- | ------- | --------------------------------------- | ------------------------------------------------ |
| `ivr_id` | string | Yes | — | The ID of the custom ivr to be updated. | |
| `description` | string | null | No | — | \[single-line only] The description of the IVR. |
| `name` | string | null | No | — | \[single-line only] The name of this IVR. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ivr_id": {
"type": "string",
"description": "The ID of the custom ivr to be updated."
},
"description": {
"type": [
"string",
"null"
],
"description": "[single-line only] The description of the IVR."
},
"name": {
"type": [
"string",
"null"
],
"description": "[single-line only] The name of this IVR."
}
},
"required": [
"PCID",
"ivr_id"
]
}
```
***
## dialpad\_contact\_center\_ivr\_update
Custom IVR -- Assign
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| `target_type` | string | Yes | — | Target's type. | |
| `target_id` | integer | Yes | — | The target's id. | |
| `ivr_type` | string | Yes | — | Type of ivr you want to update | |
| `ivr_id` | integer | Yes | — | The id of the ivr that you want to use for the ivr type. | |
| `select_option` | string | null | No | — | For call center auto call recording only. Set ivr for inbound or outbound. Default is both. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"target_type": {
"type": "string",
"description": "Target's type.",
"enum": [
"callcenter",
"callrouter",
"channel",
"coachinggroup",
"coachingteam",
"department",
"office",
"room",
"staffgroup",
"unknown",
"user"
]
},
"target_id": {
"type": "integer",
"description": "The target's id."
},
"ivr_type": {
"type": "string",
"description": "Type of ivr you want to update",
"enum": [
"ADMIN_AUTO_RECORDING",
"ASK_FIRST_OPERATOR_NOT_AVAILABLE",
"AUTO_RECORDING",
"CALLAI_AUTO_RECORDING",
"CALLAI_AUTO_RECORDING_INBOUND",
"CALLAI_AUTO_RECORDING_OUTBOUND",
"CALLAI_TOGGLE_DISABLED",
"CALLAI_TOGGLE_ENABLED",
"CG_AUTO_RECORDING",
"CLOSED",
"CLOSED_DEPARTMENT_INTRO",
"CLOSED_MENU",
"CLOSED_MENU_OPTION",
"CSAT_INTRO",
"CSAT_OUTRO",
"CSAT_PREAMBLE",
"CSAT_QUESTION",
"DEPARTMENT_INTRO",
"GREETING",
"HOLD_AGENT_READY",
"HOLD_APPREC",
"HOLD_CALLBACK_ACCEPT",
"HOLD_CALLBACK_ACCEPTED",
"HOLD_CALLBACK_CONFIRM",
"HOLD_CALLBACK_CONFIRM_NUMBER",
"HOLD_CALLBACK_DIFFERENT_NUMBER",
"HOLD_CALLBACK_DIRECT",
"HOLD_CALLBACK_FULFILLED",
"HOLD_CALLBACK_INVALID_NUMBER",
"HOLD_CALLBACK_KEYPAD",
"HOLD_CALLBACK_REJECT",
"HOLD_CALLBACK_REJECTED",
"HOLD_CALLBACK_REQUEST",
"HOLD_CALLBACK_REQUESTED",
"HOLD_CALLBACK_SAME_NUMBER",
"HOLD_CALLBACK_TRY_AGAIN",
"HOLD_CALLBACK_UNDIALABLE",
"HOLD_ESCAPE_VM_EIGHT",
"HOLD_ESCAPE_VM_FIVE",
"HOLD_ESCAPE_VM_FOUR",
"HOLD_ESCAPE_VM_NINE",
"HOLD_ESCAPE_VM_ONE",
"HOLD_ESCAPE_VM_POUND",
"HOLD_ESCAPE_VM_SEVEN",
"HOLD_ESCAPE_VM_SIX",
"HOLD_ESCAPE_VM_STAR",
"HOLD_ESCAPE_VM_TEN",
"HOLD_ESCAPE_VM_THREE",
"HOLD_ESCAPE_VM_TWO",
"HOLD_ESCAPE_VM_ZERO",
"HOLD_ESTIMATED_WAIT_TIME",
"HOLD_INTERRUPT",
"HOLD_INTRO",
"HOLD_MUSIC",
"HOLD_POSITION_EIGHT",
"HOLD_POSITION_FIVE",
"HOLD_POSITION_FOUR",
"HOLD_POSITION_MORE",
"HOLD_POSITION_NINE",
"HOLD_POSITION_ONE",
"HOLD_POSITION_SEVEN",
"HOLD_POSITION_SIX",
"HOLD_POSITION_TEN",
"HOLD_POSITION_THREE",
"HOLD_POSITION_TWO",
"HOLD_POSITION_ZERO",
"HOLD_WAIT",
"INCOMING_CALL_FROM_GROUP",
"MENU",
"MENU_OPTION",
"NEXT_TARGET",
"POWER_DIALER_CALL_GREETING",
"POWER_DIALER_VM_DROP",
"PREFERRED_OPERATOR_PROMPT",
"VM_DROP_MESSAGE",
"VM_UNAVAILABLE",
"VM_UNAVAILABLE_CLOSED"
]
},
"ivr_id": {
"type": "integer",
"description": "The id of the ivr that you want to use for the ivr type."
},
"select_option": {
"type": [
"string",
"null"
],
"description": "For call center auto call recording only. Set ivr for inbound or outbound. Default is both.",
"enum": [
"inbound",
"outbound"
]
}
},
"required": [
"PCID",
"target_type",
"target_id",
"ivr_type",
"ivr_id"
]
}
```
***
## dialpad\_contact\_center\_numbers\_assign\_call\_router\_number\_post
Dialpad Number -- Assign
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ----------- | ------- | -------- | ------- | ------------------------ | ------------------------------------------------------------------------- |
| `id` | integer | Yes | — | The API call router's ID | |
| `area_code` | string | null | No | — | An area code in which to find an available phone number for assignment. |
| `number` | string | null | No | — | A phone number to assign. (e164-formatted) |
| `primary` | boolean | null | No | — | A boolean indicating whether this should become the primary phone number. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The API call router's ID"
},
"area_code": {
"type": [
"string",
"null"
],
"description": "An area code in which to find an available phone number for assignment."
},
"number": {
"type": [
"string",
"null"
],
"description": "A phone number to assign. (e164-formatted)"
},
"primary": {
"type": [
"boolean",
"null"
],
"description": "A boolean indicating whether this should become the primary phone number."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_scorecards\_export\_create
Scorecards export -- Initiate Processing
**Parameters:**
| Parameter | Type | Required | Default | Description | |
| ----------------------- | ---------- | -------- | ------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `days_ago_end` | integer | null | No | — | End of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days\_ago\_start to specify a range. |
| `days_ago_start` | integer | null | No | — | Start of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days\_ago\_end to specify a range. |
| `graded_days_ago_end` | integer | null | No | — | End of the graded date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with graded\_days\_ago\_start to specify a range. |
| `graded_days_ago_start` | integer | null | No | — | Start of the graded date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with graded\_days\_ago\_end to specify a range. |
| `scorecard_grader_id` | integer | null | No | — | The scorecard grader's id. |
| `scorecard_ids` | integer\[] | No | — | The scorecard ids. | |
| `scorecards_type` | string | Yes | — | The type of scorecards statistics to be returned. | |
| `send_to` | string | null | No | — | The email to send the results to. |
| `target_id` | integer | null | No | — | The target's id. |
| `target_type` | string | null | No | — | The target's type. |
| `timezone` | string | null | No | — | Timezone using a tz database name. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"days_ago_end": {
"type": [
"integer",
"null"
],
"description": "End of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days_ago_start to specify a range."
},
"days_ago_start": {
"type": [
"integer",
"null"
],
"description": "Start of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days_ago_end to specify a range."
},
"graded_days_ago_end": {
"type": [
"integer",
"null"
],
"description": "End of the graded date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with graded_days_ago_start to specify a range."
},
"graded_days_ago_start": {
"type": [
"integer",
"null"
],
"description": "Start of the graded date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with graded_days_ago_end to specify a range."
},
"scorecard_grader_id": {
"type": [
"integer",
"null"
],
"description": "The scorecard grader's id."
},
"scorecard_ids": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
},
"description": "The scorecard ids."
},
"scorecards_type": {
"type": "string",
"description": "The type of scorecards statistics to be returned.",
"enum": [
"scorecard_export_agent_leaderboard",
"scorecard_export_calls",
"scorecard_export_calls_questions",
"scorecard_export_leaderboard",
"scorecard_export_teamgroup_leaderboard"
]
},
"send_to": {
"type": [
"string",
"null"
],
"description": "The email to send the results to."
},
"target_id": {
"type": [
"integer",
"null"
],
"description": "The target's id."
},
"target_type": {
"type": [
"string",
"null"
],
"description": "The target's type.",
"enum": [
"callcenter",
"coachingteam",
"office",
"unknown",
"user"
]
},
"timezone": {
"type": [
"string",
"null"
],
"description": "Timezone using a tz database name."
}
},
"required": [
"PCID",
"scorecards_type"
]
}
```
***
## dialpad\_contact\_center\_scorecards\_export\_get
Scorecards export -- Get Result
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------- |
| `id` | string | Yes | — | Request ID returned by a POST /scorecards/export request. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Request ID returned by a POST /scorecards/export request."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_scorecards\_get
Scorecards -- Get
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------- |
| `id` | string | Yes | — | The scorecard's id. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The scorecard's id."
}
},
"required": [
"PCID",
"id"
]
}
```
***
## dialpad\_contact\_center\_scorecards\_list
Scorecards -- List
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | No | — | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
| `state` | string | No | — | The scorecard's state. |
| `target_id` | integer | No | — | The target's id. |
| `target_type` | string | No | — | The target's type. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
},
"state": {
"type": "string",
"description": "The scorecard's state.",
"enum": [
"active",
"archived",
"draft"
]
},
"target_id": {
"type": "integer",
"description": "The target's id."
},
"target_type": {
"type": "string",
"description": "The target's type.",
"enum": [
"callcenter",
"coachingteam",
"office",
"unknown"
]
}
},
"required": [
"PCID"
]
}
```
***
## dialpad\_contact\_center\_wfm\_metrics\_activity\_get
Activity Metrics
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------ |
| `ids` | string | No | — | (optional) Comma-separated Dialpad user IDs of agents |
| `emails` | string | No | — | (optional) Comma-separated email addresses of agents |
| `cursor` | string | No | — | Include the cursor returned in a previous request to get the next page of data |
| `end` | string | Yes | — | UTC ISO 8601 timestamp (exclusive, e.g., 2025-02-23T00:00:00Z) |
| `start` | string | Yes | — | UTC ISO 8601 timestamp (inclusive, e.g., 2025-02-17T00:00:00Z) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "string",
"description": "(optional) Comma-separated Dialpad user IDs of agents"
},
"emails": {
"type": "string",
"description": "(optional) Comma-separated email addresses of agents"
},
"cursor": {
"type": "string",
"description": "Include the cursor returned in a previous request to get the next page of data"
},
"end": {
"type": "string",
"description": "UTC ISO 8601 timestamp (exclusive, e.g., 2025-02-23T00:00:00Z)"
},
"start": {
"type": "string",
"description": "UTC ISO 8601 timestamp (inclusive, e.g., 2025-02-17T00:00:00Z)"
}
},
"required": [
"PCID",
"end",
"start"
]
}
```
***
## dialpad\_contact\_center\_wfm\_metrics\_agent\_get
Agent Metrics
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------ |
| `ids` | string | No | — | (optional) Comma-separated Dialpad user IDs of agents |
| `emails` | string | No | — | (optional) Comma-separated email addresses of agents |
| `cursor` | string | No | — | Include the cursor returned in a previous request to get the next page of data |
| `end` | string | Yes | — | UTC ISO 8601 timestamp (exclusive, e.g., 2025-02-23T00:00:00Z) |
| `start` | string | Yes | — | UTC ISO 8601 timestamp (inclusive, e.g., 2025-02-17T00:00:00Z) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ids": {
"type": "string",
"description": "(optional) Comma-separated Dialpad user IDs of agents"
},
"emails": {
"type": "string",
"description": "(optional) Comma-separated email addresses of agents"
},
"cursor": {
"type": "string",
"description": "Include the cursor returned in a previous request to get the next page of data"
},
"end": {
"type": "string",
"description": "UTC ISO 8601 timestamp (exclusive, e.g., 2025-02-23T00:00:00Z)"
},
"start": {
"type": "string",
"description": "UTC ISO 8601 timestamp (inclusive, e.g., 2025-02-17T00:00:00Z)"
}
},
"required": [
"PCID",
"end",
"start"
]
}
```