# Alibaba Cloud Contact Center AI API

> Alibaba Cloud Contact Center AI API on Apizie: 14 endpoints (Analyzes conversations in audio files in real time. Applications send HTTPS requests to retrieve responses, Retrieves conversation analysis results including conversation summary, title generation, keywords, field…, Use the Tongyi Xiaomi CCAI Conversation Analysis AIO application to analyze image content, including…, You can perform conversation analysis by creating an offline asynchronous job. The application supports HTTP…, …) 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://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-contactcenterai`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/contactcenterai
- Page: https://zieapi.vercel.app/api/cloud/aliyun-contactcenterai
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-contactcenterai/openapi.json

Alibaba Cloud OpenAPI for Contact Center AI (contactcenterai, version 2024-06-03). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Analyzes conversations in audio files in real time. Applications send HTTPS requests to retrieve responses
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/analyze-audio-sync` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| appId | string | yes | The application ID |
| categoryTags | array | no | The list of tag categorizations |
| customPrompt | string | no | The custom instruction |
| fields | array | no | The structure of the fields |
| modelCode | string | no | The model code |
| responseFormatType | string | no | The format of the output. Valid values: jsonObject (JSON structure) and text (raw string) |
| resultTypes | array | no | The task types |
| serviceInspection | object | no | The structure for service quality inspection |
| stream | string | yes | Specifies whether to return the result in a stream. Set to true for streaming output, or false for a complete response |
| templateIds | array | no | The template IDs |
| transcription | object | no | The runtime parameters for audio |
| variables | array | no | The list of variables |

### Retrieves conversation analysis results including conversation summary, title generation, keywords, field…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/analyze-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| workspaceId | string | yes | The workspace ID |
| appId | string | yes | The application ID |
| categoryTags | array | no | The tag categorization list |
| customPrompt | string | no | The custom instruction. The instruction must contain ${dialogue} |
| dialogue | object | no | The list of dialogue content |
| examples | array | no | The list of instruction examples |
| fields | array | no | The list of fields to extract during information extraction |
| modelCode | string | no | The model code |
| responseFormatType | string | no | The output result format type. Valid values: jsonObject (JSON structure) and text (raw string) |
| resultTypes | array | yes | The instruction task types |
| sceneName | string | no | The scenario name |
| serviceInspection | object | no | The service quality inspection structure information |
| sourceCallerUid | string | no | Not required |
| stream | string | yes | Required. Specifies whether to use streaming output. Valid values: true (returns the answer in streaming mode) and false (returns the… |
| timeConstraintList | array | no | The time constraints that specify the time ranges the model should focus on or be limited to during analysis |
| userProfiles | array | no | The list of user profiles |

### Use the Tongyi Xiaomi CCAI Conversation Analysis AIO application to analyze image content, including…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/analyze-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| workspaceId | string | yes | Workspace ID |
| appId | string | yes | Application ID |
| imageUrls | array | no | List of image URLs |
| responseFormatType | string | no | The responseFormatType |
| resultTypes | array | no | List of task types |
| stream | string | yes | Required. Set to true to return results in streaming mode. Set to false to return the full result at once |

### You can perform conversation analysis by creating an offline asynchronous job. The application supports HTTP…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/create-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| workspaceId | string | yes | Workspace ID |
| appId | string | yes | Application ID |
| callBackUrl | string | no | Callback parameter after the job is completed |
| categoryTags | array | no | Tag categorization list |
| customPrompt | string | no | Custom instruction |
| dialogue | object | no | List of Conversation Content |
| examples | object | no | Instruction Sample |
| fields | array | no | Field structure information |
| modelCode | string | yes | Model code |
| responseFormatType | string | no | Output result format type: jsonObject for JSON structure, text for raw string |
| resultTypes | array | no | LLM processing types |
| serviceInspection | object | no | Service quality inspection structure information |
| taskType | string | yes | Task Type: audio - audio file, text - text |
| templateIds | array | no | List of template IDs |
| transcription | object | no | Runtime parameters for Audio jobs |
| variables | array | no | List of variables |

### Uploads a set of hotwords to the server and returns a vocabulary ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/create-vocab` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| audioModelCode | string | no | The speech-to-text model |
| description | string | no | The version description |
| name | string | yes | The name |
| wordWeightList | array | yes | The hotword group |
| workspaceId | string | yes | The workspace ID |

### Delete a vocabulary by its ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/delete-vocab` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| vocabularyId | string | yes | Vocabulary ID |
| workspaceId | string | yes | Workspace ID |

### Performs general image analysis
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/general-analyze-image` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| workspaceId | string | yes | Workspace ID |
| appId | string | yes | Application ID |
| customPrompt | string | no | Custom instruction |
| imageUrls | array | yes | List of image URLs |
| stream | string | no | Required. Set to true for streaming output or false for full output |
| templateIds | array | no | Template ID. If both template ID and customPrompt are provided, the template ID takes precedence |

### Retrieves the conversation analysis results of an offline task by task ID. The application supports HTTPS…
`GET https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/get-task-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| taskId | string | no | The task ID |
| requiredFieldList | string | no | The list of optional fields (JSON-encoded) |

### Retrieves vocabulary information by its ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/get-vocab` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| vocabularyId | string | yes | The vocabulary ID |
| workspaceId | string | yes | The workspace ID |

### List hot words in a specified workspace
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/list-vocab` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| workspaceId | string | yes | Workspace ID |

### Calls the Tongyi Xiaomi CCAI-Dialog Analysis AIO application to retrieve dialog summaries, extract key…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/run-completion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| workspaceId | string | yes | The ID of the sub-workspace |
| appId | string | yes | The ID of the application |
| Dialogue | object | yes | The structure of the dialog |
| Fields | array | no | The list of fields to extract during information extraction |
| ModelCode | string | no | The model specification |
| ServiceInspection | object | no | The structure of the service quality inspection |
| Stream | string | no | Specifies whether to enable Server-Sent Events (SSE) responses. Default value: false |
| TemplateIds | array | yes | The list of template IDs under the CCAI application |
| responseFormatType | string | no | The format type of the output result. Valid values: jsonObject: JSON structure. text: Raw string |
| variables | array | no | The list of variables |

### Calls the Tongyi Xiaomi CCAI-Dialog Analysis AIO application in the Message protocol format to retrieve…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/run-completion-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| workspaceId | string | yes | The ID of the sub-workspace |
| appId | string | yes | The ID of the application |
| Messages | array | yes | The list of messages in the model request |
| ModelCode | string | no | The model specification |
| Stream | string | no | Specifies whether to enable Server-Sent Events (SSE) responses. Valid values: true: Enables SSE responses. false: Disables SSE responses.… |
| responseFormatType | string | no | The responseFormatType |

### Updates a vocabulary's information based on its ID, including its name, description, words, and weights
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/update-vocab` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |
| description | string | no | Description |
| name | string | no | The name of the vocabulary |
| vocabularyId | string | yes | The vocabulary ID |
| wordWeightList | array | no | The words and their weights in the vocabulary |
| workspaceId | string | yes | The workspace ID |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://contactcenterai.cn-shanghai.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/analyze-audio-sync" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Contact Center AI API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-contactcenterai/analyze-audio-sync with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

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

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