# Alibaba Cloud Cloud Call Center API

> Alibaba Cloud Cloud Call Center API on Apizie: 238 endpoints (Invoke AbortCampaign to stop the predictive outbound calling Activity corresponding to the specified…, Call this operation to accept a chat, Adds a blacklist tag to a specified phone number. You can use this feature with your Interactive Voice…, Invoke AddCases to add an outbound call list to a predictive dialing activity identified by a specified ID…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://www.apizie.tech/v1/cloud:aliyun-ccc/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-ccc`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/ccc
- Page: https://www.apizie.tech/api/cloud/aliyun-ccc
- OpenAPI: https://www.apizie.tech/api/cloud/aliyun-ccc/openapi.json

Alibaba Cloud OpenAPI for Cloud Call Center (ccc, version 2020-07-01). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Invoke AbortCampaign to stop the predictive outbound calling Activity corresponding to the specified…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/abort-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| CampaignId | string | yes | Predictive outbound calling Activity ID |

### Call this operation to accept a chat
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/accept-chat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| JobId | string | yes | The job ID |

### Adds a blacklist tag to a specified phone number. You can use this feature with your Interactive Voice…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-blacklist-call-tagging` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The ID of the Cloud Contact Center instance |
| Number | string | yes | The phone number |
| JobId | string | no | The call ID. If the phone number is encrypted and contains asterisks (*), specify the JobId. This parameter is not required for… |

### Invoke AddCases to add an outbound call list to a predictive dialing activity identified by a specified ID…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-cases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| CampaignId | string | yes | The predictive outbound call activity ID |
| CaseList | string | no | The list of outbound call cases (JSON-encoded) |

### Submits feedback and ratings for AI features
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-feedback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| TaskId | string | no | The AI task ID |
| TaskName | string | no | The task type. Valid values: Abstract:fields: field extraction. Abstract:keywords: hotwords. Abstract:title_summary: summary |
| Feedback | string | no | The user feedback data |
| Rating | integer | no | The rating. Valid values: thumbsDown: thumbs down. thumbsUp: thumbs up |

### Adds one or more phone numbers to a skill group by calling AddNumbersToSkillGroup
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-numbers-to-skill-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| SkillGroupId | string | yes | The skill group ID |
| NumberList | string | no | The list of phone numbers. Ensure that the phone numbers already exist in the current instance |
| InstNumberGroupIdList | string | no | The list of phone number group IDs |

### You can invoke AddPersonalNumbersToUser to add one or more personal outbound numbers to a specified agent…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-personal-numbers-to-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | yes | Agent ID |
| NumberList | string | yes | List of numbers to be added. The numbers must be attachable to the agent corresponding to UserId. If you are unsure which numbers the… |

### You can invoke AddPhoneNumberToSkillGroups to associate a phone number with one or more skill groups under a…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-phone-number-to-skill-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| Number | string | yes | Phone number |
| SkillGroupIdList | string | yes | List of skill group IDs |

### You can invoke AddPhoneNumbers to add one or more phone numbers to a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-phone-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ContactFlowId | string | no | ID of the IVR contact flow to attach. This parameter is valid only when the number usage includes inbound calls. It is optional and… |
| Usage | string | yes | Usage of the phone number. Note: If the provided number is a 400 number, the usage must be set to Inbound |
| NumberList | string | no | List of phone numbers to add |
| NumberGroupId | string | no | Number group ID. You can view number grouping information in the Cloud Contact Center console. This parameter is optional and defaults to… |

### Adds a property to the schema of a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-schema-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| SchemaId | string | yes | schema id |
| Property | string | no | The property (JSON-encoded) |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### You can invoke AddSkillGroupsToUser to add one or more skill groups to a specified agent under a specified…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-skill-groups-to-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | yes | Agent ID |
| SkillLevelList | string | yes | A JSON-formatted string representing an array of skill levels for skill groups. Each array element is an object containing two fields:… |

### Use AddTicketTask to add a signature and assign an assignee
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-ticket-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| TicketId | string | yes | The ticket ID |
| TaskId | string | yes | The ticket flow node ID |
| Assignee | string | yes | The assignee for the signature |
| Comment | string | yes | Comments |
| InstanceId | string | yes | The instance ID |
| Position | string | no | The position to add the signature. Before: Before the current handler. After: After the current handler |

### You can invoke AddUsersToSkillGroup to add one or more agents to the same skill group
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/add-users-to-skill-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| SkillGroupId | string | yes | Skill group ID |
| UserSkillLevelList | string | yes | A list of agent skill levels in the skill group, formatted as a JSON array string. Each array element is an object containing two fields:… |

### Analyze the specified text-based conversation content and extract summary-related information, such as the…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/analyze-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Cloud Contact Center instance ID |
| ContactId | string | no | Call ID |
| TaskListJson | string | no | List of Task Types for analysis. Valid values include: title: title summary: summary keywords: keywords fields: fields Currently, only… |
| FieldListJson | string | no | When the TaskListJson parameter is set to "fields", this parameter specifies the field content to fetch |

### You can invoke AnswerCall to answer the call associated with a specified call ID under a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/answer-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| UserId | string | no | The agent ID |
| DeviceId | string | no | The device ID. This parameter is meaningless and can be filled with any value |
| JobId | string | yes | The call ID |

### Appends outbound call cases to a specified predictive outbound campaign under a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/append-cases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| CampaignId | string | yes | The ID of the predictive outbound campaign |
| body | string | no | The list of outbound call cases in the request body (JSON-encoded) |

### You can invoke BargeInCall to forcibly insert into an ongoing call associated with a specified call ID under…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/barge-in-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | Agent ID initiating the force insert |
| DeviceId | string | no | Device ID. This parameter is meaningless and can be filled in with any value |
| JobId | string | yes | Call ID |
| BargedUserId | string | yes | Agent ID whose call was barged in on |
| TimeoutSeconds | integer | no | Timeout for force insert, in seconds. If the force insert operation does not succeed within the specified time, it is canceled. Normally,… |

### Directly transfer a call to another agent, a skill group queue, or an external number. Direct transfer is…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/blind-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | The agent ID that initiates a direct transfer |
| DeviceId | string | no | Device ID. This parameter is meaningless and can be filled with any value |
| Transferor | string | no | The transfer initiator. When the scenario involves directly transferring to an external number, the number specified by this parameter is… |
| Transferee | string | yes | The transfer recipient, which can be either an agent ID or a skill group ID |
| TimeoutSeconds | integer | no | Timeout duration for the direct transfer, in seconds. If the transferee does not answer within the specified time, the call is… |
| JobId | string | yes | The call ID |
| CallPriority | integer | no | The queue priority when transferring to a skill group. Valid values are 0–9, where 0 is the highest priority and 9 is the lowest |
| StrategyName | string | no | The policy name for agent assignment when transferring to a skill group queue |
| StrategyParams | string | no | The parameters for the agent assignment policy when transferring to a skill group queue |
| TransfereeType | string | no | Destination type for the transfer. Valid values are AGENT, SKILL_GROUP, IVR, and EXTERNAL_NUMBER. If this parameter is not specified, the… |
| ContactFlowVariables | string | no | Variables passed to the contact flow. This field is optional. The variables configured here can be retrieved and used in the IVR flow. The… |
| RoutingType | string | no | The call routing type. Valid values are Automatic or Manual. If this parameter is empty, the system defaults to Automatic routing, which… |
| Tags | string | no | Ingest endpoint data, primarily used for extension purposes. Regular users do not need to concern themselves with this field |
| QueuingTimeoutSeconds | integer | no | The queuing timeout duration in seconds when the transfer target is a skill group queue |
| QueuingOverflowThreshold | integer | no | The queuing overflow threshold when the transfer target is a skill group queue. The default value is 0, which means no overflow occurs |
| SkillGroupId | string | no | Skill group ID |

### You can invoke the CancelAttendedTransfer API to cancel an attended transfer. You can call this API at any…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/cancel-attended-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| UserId | string | no | The agent ID |
| DeviceId | string | no | The Device ID. This parameter is meaningless and can be filled with any value |
| JobId | string | yes | The call ID |

### Changes an agent's status to invisible. This is equivalent to the outbound-only mode
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/change-visibility` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The ID of the Cloud Connect Center instance |
| UserId | string | no | The ID of the agent |
| Invisible | string | no | Specifies whether to set the agent's status to invisible |

### You can invoke ChangeWorkMode to change the agent's work mode
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/change-work-mode` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | Agent ID. If not specified, the agent mapped to the current Resource Access Management (RAM) user is used by default |
| DeviceId | string | no | Device ID, which is the identity ID of a browser-based Web Real-Time Communication (WebRTC) softphone or a physical phone device. Only one… |
| WorkMode | string | yes | Work mode |
| SignedSkillGroupIdList | string | no | List of skill groups to sign in to. When changing the work mode to off-site mode, you can use this parameter to specify the list of skill… |
| Mobile | string | no | The agent's personal phone number, which is used in off-site mode. The agent can use this number to answer calls in off-site mode |

### Checks whether the current time is a working hour, considering holidays and special workdays
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/check-business-hours` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| Time | integer | no | The 13-digit timestamp. If this parameter is not specified, the current time is used by default |
| InstanceId | string | yes | The instance ID |

### Call the `ClaimCall` API to assign a call to an agent
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/claim-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| UserId | string | no | The ID of the agent claiming the call |
| JobId | string | yes | The ID of the call |
| SkillGroupId | string | no | The ID of the skill group that the call is assigned to |
| CandidateUserListJson | string | no | A JSON string that lists the agents and their corresponding skill groups eligible to claim the call |
| Tags | string | no | A unique business identifier for scheduling purposes. Subsequent event notifications include this identifier |

### You can call ClaimChat to claim the chat for a specified Job ID in a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/claim-chat` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| SkillGroupId | string | yes | Filter by skill group ID |
| JobId | string | yes | The ID of the call |

### You can invoke CoachCall to coach a specified agent in a specified call (identified by a call ID) under a…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/coach-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | Agent ID initiating the coaching |
| DeviceId | string | no | Device ID. This field is meaningless and can be filled with any value |
| JobId | string | yes | Call ID |
| CoachedUserId | string | yes | Agent ID being coached |
| TimeoutSeconds | integer | no | Coaching timeout. If the coaching session is not established within the specified time, the coaching operation is canceled. This field is… |

### Commits a contact flow
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/commit-contact-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ContactFlowId | string | yes | The contact flow ID |
| Definition | string | yes | The definition of the Interactive Voice Response (IVR) |
| Description | string | yes | The version description |
| DraftId | string | yes | The draft ID. This is the ID of the draft version that corresponds to the current contact flow |

### You can invoke CompleteAttendedTransfer to complete a consultative transfer
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/complete-attended-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | The agent ID initiating the consultation transfer |
| DeviceId | string | no | Device ID. This parameter is meaningless and can be filled with any value |
| JobId | string | yes | Call ID |

### You can invoke CreateAudioFile to create an audio resource under a specified instance. The created audio…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-audio-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| Name | string | yes | Display name of the audio, containing 1 to 32 characters |
| AudioFileName | string | yes | Audio file name, containing 1 to 32 characters |
| OssFileKey | string | yes | Key of the OSS file, returned by the GetAudioFileUploadParameters API |
| Usage | string | no | Usage of the audio file. The default value is General (used in scenarios such as IVR). Other optional values include HoldMusic (hold music… |

### Use the CreateCallSummary operation to create a call summary
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-call-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| CustomerId | string | no | Customer ID |
| Context | string | no | Summary information |
| ContactId | string | no | The ID of the session |
| InstanceId | string | yes | Instance ID |

### You can invoke CreateCallTags to create multiple call tags under a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-call-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| CallTagNameList | string | yes | A JSON-formatted string representing an array of call tag names. Each array element is a call tag name to be created. The length of each… |

### Creates a predictive dialing campaign under a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| CaseList | string | no | The list of contacts for the predictive dialing campaign. This parameter cannot be used together with CaseFileKey, which is used for… |
| QueueId | string | yes | The ID of the skill group associated with the predictive dialing campaign |
| Name | string | yes | The name of the predictive dialing campaign |
| CaseFileKey | string | no | The key of the Object Storage Service (OSS) object that stores the contact file for the predictive dialing campaign. You can obtain the… |
| ContactFlowId | string | yes | The ID of the contact flow associated with the predictive dialing campaign |
| StartTime | string | yes | The start time of the predictive dialing campaign. The value is a UNIX timestamp in milliseconds |
| EndTime | string | yes | The end time of the predictive dialing campaign. The value is a UNIX timestamp in milliseconds |
| CallableTime | string | yes | The callable time period for the predictive dialing campaign. The value is a JSON object that contains two properties: beginTime and… |
| StrategyType | string | yes | The strategy mode of the predictive dialing campaign |
| StrategyParameters | string | yes | The strategy parameters of the predictive dialing campaign. Example for the PID strategy:… |
| MaxAttemptCount | integer | yes | The maximum number of call attempts for the predictive dialing campaign. This parameter specifies the maximum number of times a failed… |
| MinAttemptInterval | integer | yes | The minimum retry interval for the predictive dialing campaign. This parameter specifies the minimum interval between retry attempts for… |
| Simulation | string | no | Specifies whether the campaign is a simulated campaign for testing purposes. Regular customers do not need to pay attention to this… |
| SimulationParameters | string | no | The simulation parameters for testing purposes. Regular customers do not need to pay attention to this parameter |
| ExecutingUntilTimeout | string | no | Specifies whether to keep the campaign in the executing state until it expires. Default value: false. If this parameter is set to false,… |
| FlashSmsParameters | string | no | The flash message parameters |
| NumberList | string | no | The list of caller numbers (JSON-encoded) |
| InstGroupId | string | no | The ID of the number group |

### Retrieves the upload URL for chat message media files
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-chat-media-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| MimeType | string | yes | media id |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The Cloud Call Center instance ID |

### Creates an IVR flow
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-contact-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| Name | string | yes | Contact flow name |
| Definition | string | yes | IVR content |
| Description | string | yes | Version description |
| Type | string | yes | Flow type. Main flow: MAIN_FLOW Child flow: SUB_FLOW Survey flow: SURVEY_FLOW |

### Invoke CreateInstance to create a Cloud Contact Center instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| Name | string | yes | Instance name. The length must be between 4 and 32 characters |
| Description | string | no | Description of the instance. The length must not exceed 256 characters |
| DomainName | string | yes | Second-level domain name of the Cloud Contact Center instance, which serves as the instance ID and is globally unique. It must be 4 to 48… |
| NumberList | string | no | List of phone numbers for the Cloud Contact Center instance to be created. The current account must have usage rights to these numbers,… |
| AdminRamIdList | string | yes | List of RAM IDs to be assigned as administrators of this Cloud Contact Center instance. After successful creation, the RAM IDs in this… |

### Creates a schema in a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| Id | string | no | schema id |
| Description | string | no | The description |
| Properties | string | no | The list of properties (JSON-encoded) |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### You can call CreateSkillGroup to create a skill group under a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-skill-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| Name | string | yes | The skill group name. It must be 1 to 64 characters in length, can contain digits, letters, underscores (_), and hyphens (-), and must… |
| DisplayName | string | yes | Display name of the skill group. It must be 1 to 64 characters in length |
| Description | string | no | Description of the skill group. This parameter is optional. If not specified, it defaults to empty |
| MediaType | string | no | Media type. The default value is AUDIO. Other valid values include CHAT and VIDEO |

### Use CreateTicket to create a ticket
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| TemplateId | string | no | Ticket template ID |
| CustomerId | string | no | Customer ID, the customer ID in Cloud Contact Center customer profiles |
| Title | string | no | Ticket title |
| Source | string | no | Ticket source |
| ContactId | string | no | The ID of the call |
| Context | string | no | Ticket field information |

### Call the CreateUser operation to create a new agent in a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/create-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| LoginName | string | yes | The logon name of the agent. It must be 4 to 64 characters in length and can contain uppercase letters, lowercase letters, digits, periods… |
| DisplayName | string | yes | The display name of the agent. It must be 1 to 128 characters in length |
| Mobile | string | no | The personal phone number of the agent. This number is used in OFF_SITE mode. The agent can use this number to answer calls in OFF_SITE mode |
| Email | string | yes | The email address of the agent. After the agent is created, an email is sent to this address. The email contains the logon URL for Cloud… |
| WorkMode | string | no | The work mode |
| RoleId | string | yes | The role ID. The format is Role\@InstanceID. The following roles are supported: Admin (administrator), Manager (skill group leader), and… |
| SkillLevelList | string | no | A list of skill levels for skill groups. This is a string in the format of a JSON array. The array can contain up to 100 elements. Each… |
| ResetPassword | string | no | Specifies whether the agent must reset the password upon the first logon. If set to true, the agent is prompted to reset the password when… |
| DisplayId | string | no | The agent's ID number. Set this as needed |
| AvatarUrl | string | no | The URL of the agent's profile picture |
| Nickname | string | no | The agent's nickname |
| NeedEmailNotification | string | no | Specifies whether to send an email notification. true: Send false: Do not send |

### You can invoke DeleteAudioFile to delete the audio file associated with a specified audio resource ID under…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-audio-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| AudioResourceId | string | yes | Audio resource ID, which is the UUID of the audio file |

### You can invoke DeleteCallTag to delete a phone number tag under a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-call-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| TagName | string | yes | The phone number tag name. Ensure that the tag you specify has already been created |

### Deletes a specified contact flow
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-contact-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ContactFlowId | string | yes | The contact flow ID |
| Force | string | no | Specifies whether the contact flow is force deleted |

### You can invoke DeleteCustomCallTagging to delete the inbound number tag associated with a specified number…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-custom-call-tagging` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Number | string | yes | The number associated with the inbound call tag |

### Deletes a single document from a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| SchemaId | string | yes | schema id |
| DocumentId | string | yes | The document ID |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### Deletes documents from a specified instance in batches
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| SchemaId | string | yes | schema id |
| DocumentIds | string | no | The list of document IDs (JSON-encoded) |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### Deletes a specified Cloud Call Center instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### Deletes a schema from the specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| SchemaId | string | yes | schema id |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### Deletes a property in a specified schema
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-schema-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| SchemaId | string | yes | schema id |
| PropertyName | string | yes | The property name |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### Invoke DeleteSkillGroup to delete the skill group associated with the specified skill group ID under the…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-skill-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| SkillGroupId | string | yes | Skill group ID |
| Force | string | no | Whether to force delete. If the skill group is associated with a number or agent, you must enable the force delete flag to successfully… |

### Deletes a specified ticket
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| TicketId | string | no | The ticket ID |
| InstanceId | string | yes | The instance ID |

### Deletes a specified ticket template
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/delete-ticket-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| TemplateId | string | no | The ID of the ticket template |
| InstanceId | string | no | The ID of the instance |

### Disables a field in a specified schema
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/disable-schema-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| SchemaId | string | yes | schema id |
| PropertyName | string | yes | The name of the field |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### Use the DisableTicketTemplate operation to disable a ticket template. A disabled template cannot be selected…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/disable-ticket-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| TemplateId | string | no | The ticket template ID |
| InstanceId | string | yes | The instance ID |

### Revoke contact flow editing and discard the associated draft
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/discard-editing-contact-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ContactFlowId | string | yes | Contact flow ID |
| DraftId | string | yes | Draft ID |

### Enables a property in a specified schema
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/enable-schema-property` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| SchemaId | string | yes | schema id |
| PropertyName | string | yes | The property name |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### The EnableTicketTemplate operation publishes a ticket template. Published ticket templates can be used to…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/enable-ticket-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| TemplateId | string | no | The ID of the ticket template |
| InstanceId | string | yes | The instance ID |

### You can invoke EndConference to make the specified agent exit the call associated with the specified call ID…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/end-conference` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | Agent ID to leave the meeting. Optional. If not specified, defaults to the agent mapped to the current RAM account |
| JobId | string | yes | Call ID |

### Exports the IVR contact flow of a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/export-contact-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| FlowId | string | yes | The ID of the IVR contact flow |
| RequestId | string | no | The ID of the request |
| InstanceId | string | yes | The instance ID |

### Exports the list of do-not-call numbers filtered by the specified search conditions for a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/export-do-not-call-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| SearchPattern | string | no | Specifies the keyword to perform a fuzzy match based on the phone number or remark. This parameter is optional. Default value: empty. An… |
| Scope | string | no | The application scope. Valid values: SYSTEM and INSTANCE. SYSTEM indicates system-level do-not-call, and INSTANCE indicates… |

### Use the FinishTicketTask operation to process tickets
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/finish-ticket-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| TicketId | string | no | Ticket ID |
| TaskId | string | no | Node ID |
| Comment | string | yes | Processing comments |
| InstanceId | string | yes | Instance ID |

### Retrieves the information about an audio file for a specified audio resource ID in a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-audio-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AudioResourceId | string | yes | The audio resource ID, which is the unique identifier of the audio file |

### Invoke GetAudioFileDownloadUrl to obtain the OSS download link for a specified audio resource under a…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-audio-file-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| AudioResourceId | string | yes | Audio resource ID, which uniquely identifies an audio file |

### Invoke the GetAudioFileUploadParameters API to obtain audio file upload parameters. Before creating an audio…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-audio-file-upload-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| AudioFileName | string | yes | Audio file name |

### Retrieves the details of a call specified by call ID for a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-call-detail-record` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| ContactId | string | yes | The call ID |
| InstanceId | string | yes | The instance ID |

### Gets a predictive outbound campaign by its ID from a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-campaign` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| CampaignId | string | yes | The ID of the campaign |

### Invoke GetCaseFileUploadUrl to obtain the OSS upload parameters for a predictive outbound calling list file…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-case-file-upload-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| FileName | string | yes | The file name of the predictive outbound calling Activity list. The name must consist of uppercase and lowercase English letters, and the… |

### Retrieves the access URL for a media file in a chat message
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-chat-media-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| MediaId | string | yes | media id |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### Use GetChatRoutingProfile to retrieve the chat routing configuration
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-chat-routing-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |

### Retrieves a specified contact flow
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-contact-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ContactFlowId | string | yes | The contact flow ID |
| DraftId | string | yes | The draft ID, which is the ID of the editable draft version corresponding to the current contact flow |

### Call GetConversationDetail to obtain the conversation details for the call corresponding to the specified…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-conversation-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ContactId | string | yes | The ID of the conversation |
| AgentId | string | no | Agent ID |

### Invoke GetDoNotCallFileUploadParameters to obtain the upload parameters for a do-not-call file. When…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-do-not-call-file-upload-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| FileName | string | yes | Name of the file containing prohibited outbound call numbers |

### Retrieves the upload parameters required to import a document
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-document-upload-parameters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| FileName | string | yes | The file name |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### Retrieve early-media audio recordings for a call in a specified Cloud Contact Center instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-early-media-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Cloud Contact Center instance ID |
| ContactId | string | yes | Call ID |

### Invoke GetHistoricalCallerReport to retrieve the historical inbound call report for a specified calling…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-historical-caller-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| CallingNumber | string | yes | Calling number |
| StopTime | integer | yes | End time of the query, formatted as a UNIX timestamp in milliseconds |
| StartTime | integer | yes | Start time of the query, formatted as a UNIX timestamp in milliseconds |

### Retrieves the historical data report for a predictive dialing campaign with a specified ID under a specified…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-historical-campaign-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| CampaignId | string | yes | The ID of the predictive dialing campaign |

### You can invoke GetHistoricalInstanceReport to obtain the historical data report for a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-historical-instance-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| StartTime | integer | no | The start time of the Historical Data to retrieve, in UNIX timestamp format with millisecond precision. This parameter is optional. The… |
| EndTime | integer | no | The end time of the Historical Data to retrieve, in UNIX timestamp format with millisecond precision. This parameter is optional. The… |
| MediaType | string | no | Media Type. The default value is Audio. Other valid values include Chat and Video |

### Queries the details of a Cloud Call Center instance by instance ID
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-instance` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |

### You can call GetInstanceTrendingReport to retrieve the trend report for a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-instance-trending-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| StartTime | integer | no | Start UNIX timestamp. The default value is the start time of the current day. The earliest allowed time is 180 days before the current… |
| EndTime | integer | no | End UNIX timestamp. The default value is the current time. The format is a Unix timestamp in milliseconds |
| MediaType | string | no | Media type. The default value is Audio. Other valid values include Chat and Video |

### Retrieve the IVR tracking summary
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-ivr-tracking-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| ContactId | string | yes | The call ID |
| InstanceId | string | yes | Instance ID |

### Invoke GetLoginDetails to obtain the agent's logon information, including basic agent information, server…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-login-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | Agent ID. This parameter is optional. If not specified, the agent mapped to the current RAM account is used by default |
| ChatDeviceId | string | no | Chat Device ID |

### You can invoke GetMonoRecording to obtain the single-track recording of a specified call under a specified…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-mono-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ContactId | string | yes | Call ID |
| ExpireSeconds | integer | no | Expiration time, in seconds |

### You can invoke GetMultiChannelRecording to obtain the multi-track recording of a specified call under a…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-multi-channel-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ContactId | string | yes | Call ID |

### Invoke the GetNumberLocation API to obtain number location information
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-number-location` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| Number | string | yes | The number to query |

### You can invoke GetRealtimeCampaignStats to retrieve real-time agent status data for a predictive outbound…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-realtime-campaign-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| QueueId | string | yes | The predictive outbound dialing activity ID |

### You can invoke GetRealtimeInstanceStates to obtain the real-time status of a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-realtime-instance-states` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| MediaType | string | no | Media type. The default is audio (AUDIO) |

### Retrieves the schema and its field definitions in a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| SchemaId | string | yes | schema id |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### You can invoke GetSkillGroup to obtain information about the skill group corresponding to a specified skill…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-skill-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| SkillGroupId | string | yes | Skill group ID, in the format: skill group name\@instance ID |

### Retrieves the content of a session summary template
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-summary-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| TemplateId | string | yes | The template ID |
| InstanceId | string | yes | The instance ID |

### Queries the details of a specified ticket
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| TicketId | string | yes | The ticket ID |

### Retrieves ticket status statistics
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-ticket-summary-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| State | string | no | The ticket status. Valid values: Processing: The ticket is being processed. Withdrawal: The ticket has been withdrawn. Rejected: The… |
| CategoryId | string | no | The ticket category ID |
| StartTime | integer | no | The start time used to filter tickets based on their creation time. The value is a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time used to filter tickets based on their creation time. The value is a UNIX timestamp in milliseconds |
| Creator | string | no | The ID of the creator |
| Assignee | string | no | The ID of the assignee, which can be an agent ID or a skill group ID |
| AssigneeType | string | no | The assignee type. Valid values: Agent: The assignee is an agent. SkillGroup: The assignee is a skill group |
| Participant | string | no | The ID of the participant |
| PageNumber | integer | no | The page number. Default value: 1 |
| PageSize | integer | no | The number of entries per page. Valid values: 1 to 100 |

### Retrieves the definition information of a ticket template
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-ticket-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| TemplateId | string | no | The template ID |
| InstanceId | string | yes | The instance ID |
| TemplateVersion | string | no | The template version |

### Call GetTurnCredentials to get the connection credentials for a Cloud Contact Center Point of Presence…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-turn-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| UserId | string | no | The ID of the agent. This parameter is optional. If you do not specify this parameter, the agent mapped to the current RAM user is used by… |

### Call GetTurnServerList to get a list of front-end access points for Alibaba Cloud Contact Center. Connecting…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-turn-server-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |

### Obtain the parameters related to offline quality inspection audio files. Normally, if the Customer has…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-upload-audio-data-params` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | no | Cloud Contact Center instance ID |
| ContactId | string | yes | Call ID |

### You can invoke GetUser to obtain the agent information corresponding to a specified agent ID under a…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | Agent ID. This parameter is optional. You must specify either UserId or Extension |
| Extension | string | no | Agent extension number. This parameter is optional. You must specify either UserId or Extension |

### Call GetVisitorLoginDetails to retrieve login, server address, and authentication information for network…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-visitor-login-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | no | Instance ID |
| VisitorId | string | yes | Visitor ID |
| ChatDeviceId | string | yes | Chat device ID |
| Token | string | no | Channel token for network services |

### You can invoke GetVoicemailRecording to obtain the voicemail recording of a specified call under a specified…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/get-voicemail-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ContactId | string | yes | Call ID. Ensure that this call ID has a voicemail message; otherwise, the return result will contain no data |

### You can invoke HoldCall to hold the call associated with a specified call ID under a specified instance.…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/hold-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | Agent ID |
| DeviceId | string | no | A unique ID provided by the agent endpoint to represent an agent workbench. An agent can have multiple workbenches of different types,… |
| JobId | string | yes | Call job ID |
| ChannelId | string | yes | Channel ID to be held |
| Music | string | no | Name of the hold music. This parameter is optional and defaults to empty |

### Imports one or more admins to a specified instance. The caller must have the `AliyunCCCFullAccess`…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/import-admins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| RamIdList | string | yes | A list of UIDs for Alibaba Cloud RAM accounts. The value must be a string-encoded JSON array. The array supports up to 20 UIDs |

### Imports an IVR contact flow into a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/import-contact-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| FlowPackageData | string | yes | The data |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### Imports your organization’s telephone line numbers. Before performing the first import, contact Cloud…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/import-corp-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| NumberList | string | yes | The list of numbers |
| TagList | string | no | The business tags |
| Province | string | no | The province |
| City | string | no | The city |
| Provider | string | yes | The line information |
| CorpName | string | no | The enterprise name |

### Imports one or more do-not-call numbers to a specified instance. The import methods include manual entry and…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/import-do-not-call-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| NumberList | string | no | The list of do-not-call numbers, in the format of a JSON array character string, where each array element is a do-not-call number |
| Remark | string | no | The remarks for the do-not-call numbers |
| FilePath | string | no | The key of the Object Storage Service (OSS) file. You can obtain the key from the response of the GetDoNotCallFileUploadParameters… |

### Imports documents to a specified instance in batches
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/import-documents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| SchemaId | string | yes | schema id |
| OssFileKey | string | yes | The key of the OSS file |
| RequestId | string | no | The request ID |
| InstanceId | string | yes | The instance ID |

### Import existing RAM users as contact center agents
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/import-ram-users` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| RoleId | string | yes | Role ID. This is the agent's role in the instance after successful import. Roles include administrator, skill group leader, and agent |
| SkillLevelList | string | no | Skill level list for the skill group. This is a JSON array string. Each array element is an object with two fields: skillGroupId and… |
| RamIdList | string | yes | List of RAM user IDs to add |
| WorkMode | string | yes | Work mode |

### Consultation transfer refers to transferring a call to another agent, a skill group queue, or an external…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/initiate-attended-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | The agent ID initiating the consultation transfer |
| DeviceId | string | no | Device ID. This parameter is meaningless and can be filled with any value |
| Transferor | string | no | The party initiating the transfer. When transferring to an external number, this parameter specifies the caller number. This parameter is… |
| Transferee | string | yes | The transferee, which can be an agent ID or a skill group ID |
| TimeoutSeconds | integer | no | Timeout duration for the consultation transfer, in seconds. If the transferee does not answer within the specified time, the call is… |
| JobId | string | yes | The call ID |
| CallPriority | integer | no | The queuing priority when transferring to a skill group queue. Valid values range from 0 to 9, where 0 is the highest priority and 9 is… |
| StrategyName | string | no | The policy name for agent assignment when transferring to a skill group queue |
| StrategyParams | string | no | The policy parameters for agent assignment when transferring to a skill group queue |
| TransfereeType | string | no | The destination type for the transfer. Valid values are AGENT, SKILL_GROUP, and EXTERNAL. If this parameter is not provided, the system… |
| RoutingType | string | no | The call assignment type. Valid values are Automatic or Manual. If this parameter is empty, the default value is Automatic, which is also… |
| Tags | string | no | Ingest endpoint data, primarily used for extension requirements. Regular users do not need to concern themselves with this |
| QueuingTimeoutSeconds | integer | no | The queuing timeout period in seconds when the transfer target is a skill group queue |
| QueuingOverflowThreshold | integer | no | The queuing overflow threshold when the transfer target is a skill group queue. The default value is 0, which means no overflow occurs |

### You can invoke InterceptCall to forcibly disconnect the call associated with a specified call ID under a…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/intercept-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | 实例 ID |
| UserId | string | no | 发起强拆的坐席 |
| DeviceId | string | no | Device ID. This parameter is meaningless and can be filled in with any value |
| JobId | string | yes | The call ID |
| InterceptedUserId | string | yes | The agent ID that is forcibly disconnected |
| TimeoutSeconds | integer | no | 强拆超时时间，经过指定的时间强拆仍未成功，则取消强拆，正常情况下，强拆操作会马上成功，设置超时时间是为了防止异常发生，此字段选填，默认 30，单位秒 |

### You can invoke LaunchAuthentication to temporarily transfer a call into a specified IVR flow. After invoking…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/launch-authentication` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | The agent ID that initiates identity verification |
| DeviceId | string | no | Device ID. This parameter is meaningless and can be filled in with any value |
| JobId | string | yes | The call ID |
| ContactFlowId | string | yes | The contact flow ID for the IVR identity verification flow |
| ContactFlowVariables | string | no | Variables passed to the contact flow. This parameter is optional. The configured variables can be retrieved and used within the IVR flow.… |

### Invoke LaunchSurvey to send a satisfaction survey. This operation causes the agent to hang up. If it is a…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/launch-survey` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UserId | string | no | The agent ID that initiates the satisfaction survey |
| DeviceId | string | no | Device ID. This parameter has no effect and can be filled with any value |
| JobId | string | yes | The call ID |
| ContactFlowId | string | no | The contact flow ID of the IVR satisfaction survey flow. Ensure that the specified contact flow ID corresponds to an active satisfaction… |
| ContactFlowVariables | string | no | Variables passed to the contact flow. The variables configured here can be retrieved and used in the IVR flow. The format is a JSON string… |
| SurveyChannel | string | no | The channel for collecting satisfaction feedback. This parameter is optional and defaults to Voice Satisfaction |
| SmsMetadataId | string | no | The configuration ID for text message satisfaction. This parameter is required only when the collection channel is SMS. It is optional and… |
| SurveyTemplateId | string | no | The ID of the satisfaction survey template |
| SurveyTemplateVariables | string | no | Satisfaction survey configuration |

### Invoke ListAgentStateLogs to obtain the status log list of a specified agent under a specified instance.…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-agent-state-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| StartTime | integer | no | Start UNIX timestamp. The default value is the start time of the current day. The earliest allowed value is 180 days before the current… |
| EndTime | integer | no | End UNIX timestamp. The default value is the current time. The time difference between EndTime and StartTime must not exceed 7 days. The… |
| AgentId | string | yes | Agent ID |
| InstanceId | string | yes | Instance ID |

### You can invoke ListAttempts to obtain the list of contact dialing records for a specified predictive…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-attempts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| CampaignId | string | yes | Predictive outbound dialing Activity ID |
| StartTime | integer | no | Start Time. This parameter is optional. If not specified, it defaults to the Start Time of the predictive outbound dialing Activity. The… |
| EndTime | integer | no | End Time. This parameter is optional. If not specified, it defaults to the End Time of the predictive outbound dialing Activity. The… |
| QueueId | string | no | Filter by skill group ID. This parameter is optional and defaults to empty, which means no filtering is applied |
| CaseId | string | yes | System-generated contact ID. Customers do not need to concern themselves with this value |
| AttemptId | string | no | Call record ID, which has the same value as the call ID |
| ContactId | string | no | Filter by call ID. This parameter is optional and defaults to empty |
| AgentId | string | no | Filter by agent ID. This parameter is optional and defaults to empty |
| Caller | string | no | Filter by caller number. This parameter is optional and defaults to empty |
| Callee | string | no | Filter by called number. Optional. Default is empty |
| PageNumber | integer | yes | Page number. The product of PageNumber and PageSize must not exceed 10 000 |
| PageSize | integer | yes | Page size. The product of PageNumber and PageSize must not exceed 10 000 |
| Criteria | string | no | Extended query conditions in JSON format. Currently supports caseIds for batch queries |

### Lists the audio files of a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-audio-files` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| PageNumber | integer | yes | The page number. Valid values: 1 to 100 |
| PageSize | integer | yes | The number of entries per page. Valid values: 1 to 100 |
| Status | string | no | The status of the audio file. Valid values: Converting: The audio file is being converted. Completed: The audio file has been converted.… |
| Usage | string | no | The usage of the audio file. Default value: General (used for scenarios such as IVR). Another valid value is HoldMusic (used as hold music) |

### Queries the blacklist tag status of specified numbers in a batch
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-blacklist-call-taggings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The ID of the Cloud Contact Center instance |
| NumberList | string | yes | A list of numbers to query for their blacklist tag status. The jobId field is required if a number is encrypted (contains \*) |

### You can invoke ListBriefSkillGroups to obtain the list of skill group summary information under a specified…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-brief-skill-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| SearchPattern | string | no | Perform fuzzy matching based on the skill group name or display name. This parameter is optional and defaults to empty, which means no… |
| PageNumber | integer | yes | The page number for paging, ranging from 1 to 100 |
| PageSize | integer | yes | The page size for paging, ranging from 1 to 100 |
| MediaType | string | no | The media type. The default value is AUDIO. Other valid values include CHAT and VIDEO |

### You can invoke ListCallDetailRecords to obtain a list of call details filtered by specified search…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-call-detail-records` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| PageNumber | integer | yes | Page number for paging, ranging from 1 to 100 |
| PageSize | integer | yes | Page size, ranging from 1 to 100 |
| StartTime | integer | no | Start time of the historical data to retrieve. The default value is 00:00:00 of the current day, in UNIX timestamp format with millisecond… |
| EndTime | integer | no | End time of the historical data to retrieve. The default value is the current time, in UNIX timestamp format with millisecond precision |
| ContactType | string | no | Filter by call type |
| ContactDisposition | string | no | Filter by disposition type. Note: Disposition reasons such as voicemail, transfer to agent failed, queuing timeout, queuing overflow, and… |
| ContactId | string | no | Query the record of a specific call by specifying a contactId. The contactId can be obtained from the softphone software development kit… |
| AgentId | string | no | Filter by agent ID |
| SkillGroupId | string | no | Filter by skill group ID |
| SortOrder | string | no | Sorting order. This parameter is optional and defaults to descending |
| InstanceId | string | yes | Instance ID |
| OrderByField | string | no | Sorting field. Optional. Default value is startTime (call start time) |
| Criteria | string | no | Perform a fuzzy query based on the calling or called number. The value must be a JSON string containing only one field, phoneNumber, which… |
| CallingNumber | string | no | Filter by calling number |
| CalledNumber | string | no | Filter by called number |
| SatisfactionList | string | no | Filter by satisfaction List. Separate multiple satisfaction Results with commas |
| SatisfactionSurveyChannel | string | no | Filter by satisfaction survey channel |
| SatisfactionDescriptionList | string | no | Filter by satisfaction description list. The description content is Custom by the Customer |
| EarlyMediaStateList | string | no | Filter by a list of reasons for failed connection |
| ContactDispositionList | string | no | Filter by hang-up reason list |
| ContactTypeList | string | no | Filter by contact type list |

### Retrieves a list of call detail records that match the specified filter criteria for a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-call-detail-records-v2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| PageNumber | integer | yes | The page number. Valid values: 1 to 100 |
| PageSize | integer | yes | The number of entries per page. Valid values: 1 to 100 |
| StartTime | integer | no | The start time of the historical data to retrieve. The default value is 00:00 of the current day. The value is a UNIX timestamp. Unit:… |
| EndTime | integer | no | The end time of the historical data to retrieve. The default value is the current time. The value is a UNIX timestamp. Unit: milliseconds |
| SortOrder | string | no | The sort order. Default value: DESC. Valid values: ASC: ascending order. DESC: descending order |
| InstanceId | string | yes | The instance ID of the call center |
| OrderByField | string | no | The field by which to sort the results. This parameter is optional. Default value: startTime (call start time). Valid values: startTime:… |
| SearchPattern | string | no | The custom query text that follows the Lucene query syntax. The following table describes the supported query fields and query types:… |
| MediaType | string | no | The media type. Valid values: AUDIO: voice call. VIDEO: video call. CHAT: message. ALL: all types |
| ContactIdList | string | no | The list of call IDs |
| ContactTypeList | string | no | Filters results by call type. Valid values: OUTBOUND: outbound call. BACK2BACK: back-to-back call. PRIVACY_DIAL: encrypted call. INTERNAL:… |
| ContactDispositionList | string | no | Filters results by hangup cause. Valid values: AbandonedInQueue: Abandoned while queuing. NoAnswer: Customer did not answer.… |
| EarlyMediaStateList | string | no | Filters results by the reason for unanswered calls. Valid values: NoAnswer: No answer. OutOfService: Out of service. NotExist: Number does… |
| SatisfactionSurveyChannel | string | no | The satisfaction survey channel. Valid values: IVR: voice-based satisfaction survey. SMS: SMS-based satisfaction survey. CHAT:… |
| SatisfactionRateList | string | no | Filters results by satisfaction rating. Separate multiple satisfaction ratings with commas (,). Valid values: -2: Not sent. -1: Not rated.… |
| SatisfactionDescriptionList | string | no | Filters results by satisfaction description. The description content is defined by the customer |
| SkillGroupIdList | string | no | The list of skill group IDs to which the agent belongs |
| AgentId | string | no | The ID of the agent |
| FirstAgentId | string | no | The ID of the first agent who participated in the call |
| CallingNumber | string | no | The calling number |
| CalledNumber | string | no | The called number |
| Number | string | no | The phone number |
| Broker | string | no | The intermediate number. The number must be an available outbound number under the instance. In a back-to-back call, this number is used… |
| AccessChannelTypeList | string | no | The list of visitor channel types. Valid values: Web: web page. DingTalkServiceWindow: DingTalk service window. AliMe: chatbot.… |
| ReleaseInitiatorList | string | no | The party that hung up |
| ReleaseReasonList | string | no | The hangup reason |
| AnalyticsReportReady | string | no | Indicates whether the AI post-call analytics report is ready |

### Retrieves call summaries
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-call-summaries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| ContactIdList | string | no | The list of call IDs (JSON-encoded) |
| InstanceId | string | yes | The instance ID |

### You can invoke ListCallTags to obtain all number tags under a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-call-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| PageNumber | integer | yes | Paging ordinal number, ranging from 1 to 100 |
| PageSize | integer | yes | The page size, ranging from 1 to 100 |

### Retrieves the trend report for a predictive outbound campaign specified by ID under a specific instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-campaign-trending-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| CampaignId | string | yes | The ID of the predictive outbound campaign |
| StartTime | integer | no | The start time. This parameter is optional. Default value: the start time of the predictive outbound campaign. The value is a UNIX… |
| EndTime | integer | no | The end time. This parameter is optional. Default value: the end time of the predictive outbound campaign. The value is a UNIX timestamp… |

### Queries the predictive dialing campaigns of a specified instance
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-campaigns` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| State | string | no | Filters predictive dialing campaigns by status. This parameter is optional and empty by default |
| Name | string | no | Filters predictive dialing campaigns by name. Fuzzy match is not supported. This parameter is optional and empty by default, which means… |
| PlanedStartTimeFrom | string | no | Specifies the planned start time of the campaign. This parameter is optional. By default, all time ranges are queried |
| PlanedStartTimeTo | string | no | Specifies the planned end time of the campaign. This parameter is optional. By default, all time ranges are queried |
| ActualStartTimeFrom | string | no | Specifies the actual start time of the campaign. This parameter is optional. By default, all time ranges are queried |
| ActualStartTimeTo | string | no | Specifies the actual end time of the campaign. This parameter is optional. By default, all time ranges are queried |
| PageNumber | integer | yes | The page number. Valid values: 1 to 100 |
| PageSize | integer | yes | The number of entries per page. Valid values: 1 to 100 |
| QueueId | string | no | Filters predictive dialing campaigns by skill group ID. This parameter is optional and empty by default, which means no filtering is applied |

### Invoke ListCases to obtain the execution details list of the outbound contact list for the predictive…
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-cases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| CampaignId | string | yes | Predictive outbound dialing activity ID |
| PhoneNumber | string | no | Filters by phone number. Fuzzy Matching is not supported. This parameter is not Required and defaults to empty |
| PageNumber | integer | yes | The paging ordinal number, ranging from 1 to 100 |
| PageSize | integer | yes | Page size, ranging from 1 to 100 |
| State | string | no | Pending (to be dialed) Executing (dialing in progress) Connected (contact succeeded) Failed (contact failed) Aborted (call stopped or… |

### You can use ListCategories to retrieve category information
`POST https://www.apizie.tech/v1/cloud:aliyun-ccc/list-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://ccc.cn-hangzhou.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| Type | string | no | The category type |
| CategoryId | string | no | The ID of the ticket category. Specify this parameter to return information about the subcategories of the specified category. If you… |

…and 118 more. See the OpenAPI spec.

## Example
```
curl "https://www.apizie.tech/v1/cloud:aliyun-ccc/abort-campaign" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Cloud Call Center API?
Create a free Apizie key, then send POST https://www.apizie.tech/v1/cloud:aliyun-ccc/abort-campaign with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Cloud Call Center API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Cloud Call Center itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Cloud Call Center API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-ccc.

### What is the status of the Alibaba Cloud Cloud Call Center API?
Needs your own provider key (bring your own key)