# Alibaba Cloud Voice Messaging Service API

> Alibaba Cloud Voice Messaging Service API on Apizie: 156 endpoints (Associates service instances with real numbers in batches, Initiates outbound robocall tasks in a batch. You can set up to 100 numbers in a task, Call the CancelCall operation to cancel incoming and outgoing calls initiated by ClickToDial, Cancels a robocall task that has not been started, …) 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-dyvmsapi/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Voice Messaging Service (dyvmsapi, version 2017-05-25). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Associates service instances with real numbers in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/add-virtual-number-relation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| ProdCode | string | no | The product name. Default value: dyvms |
| CorpNameList | string | no | The list of company names. Separate multiple company names with commas (,) |
| NumberList | string | yes | The list of real numbers. Separate multiple numbers with commas (,). You can log on to the Voice Messaging console… |
| RouteType | integer | yes | The routing type. Valid values: 0: Home location priority. 1: Random |
| PhoneNum | string | yes | Instance ID of the service instance. You can log on to the Voice Messaging console (https://dyvms.console.aliyun.com/virtual/list) and… |

### Initiates outbound robocall tasks in a batch. You can set up to 100 numbers in a task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/batch-robot-smart-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| CalledShowNumber | string | yes | The number displayed to called parties, which must be a number you purchased. You can view the numbers you purchased in the Voice… |
| CorpName | string | no | The company name, which must be the same as the company name specified on the qualification management page… |
| CalledNumber | string | yes | The called number. Only mobile phone numbers in the Chinese mainland are supported. You can set up to 1,000 called numbers and separate… |
| DialogId | string | yes | The ID of the robot or communication script that is used to initiate a call. You can obtain the communication script ID from the… |
| EarlyMediaAsr | string | no | The speech recognition identifier of early media. The default value is false, which means that the speech recognition identifier of early… |
| TaskName | string | yes | The task name. The task name can be up to 30 characters in length |
| ScheduleTime | integer | no | The preset call time. This value is a UNIX timestamp. Unit: milliseconds. This parameter is required only when ScheduleCall is set to true |
| ScheduleCall | string | no | Specifies whether the call is scheduled. If you set this parameter to true, the ScheduleTime parameter is required |
| TtsParam | string | no | The variable value of the TTS template, in the JSON format. The variable value must correspond to a number. The TtsParam parameter must be… |
| TtsParamHead | string | no | The call tasks with variables, in the JSON format. The parameter value is a list of variable names. The TtsParamHead parameter must be… |
| IsSelfLine | string | no | Specifies whether to call the self-managed line. Default value: false |

### Call the CancelCall operation to cancel incoming and outgoing calls initiated by ClickToDial
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cancel-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| CallId | string | yes | The unique receipt ID for this call. Obtain it from the return information of the ClickToDial… |

### Cancels a robocall task that has not been started
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cancel-order-robot-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| TaskId | integer | yes | The unique ID of the robocall task. You can call the https://help.aliyun.com/document_detail/393531.html operation to obtain the ID of the… |

### Stops an intelligent voice task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cancel-robot-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| TaskId | integer | no | The unique task ID of the robot call task. You can call the https://help.aliyun.com/document_detail/393531.html operation to obtain the… |

### Monitors agent statuses
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-agent-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Offset | integer | no | The offset. Default value: 0. Maximum value: 10000 |
| Limit | integer | no | The number of records to query. Default value: 10. Maximum value: 100 |

### Queries the details of the agent status
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-agent-status-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Cno | string | yes | The ID of the agent |

### Binds an agent phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-bind-client-tel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Cno | string | yes | The agent ID |
| Tel | string | yes | The phone number |
| IsBind | integer | no | Specifies whether to bind the phone number. Valid values: 1: Yes. 0: No |
| IsReserveTel | integer | no | Specifies whether to synchronize the phone number as a backup mobile phone. Valid values: 1: Yes. 0: No |

### Queries the details of outbound call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-cdr-ob-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| MainUniqueId | string | yes | The unique identifier of the call record |
| HiddenType | integer | no | Specifies whether to hide phone numbers. Valid values: 0: do not hide. 1: hide the middle four digits. 2: hide the last eight digits. 3:… |

### Creates an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-create-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Cno | integer | yes | The ID of the agent. The ID must be 4 to 11 characters in length, contain only digits, and be unique |
| Name | string | yes | The name of the agent. The name can be up to 20 characters in length and can contain only letters, digits, underscores (_), and Chinese… |
| AreaCode | string | yes | The area code |
| Password | string | yes | The password of the agent. The password is encrypted by using AES and is 8 characters in length by default. If password security settings… |
| Role | integer | no | The role of the agent. Valid values: 0: regular agent 1: supervisor Default value: 0 |
| Active | integer | no | The activation status of the agent. Valid values: 0: disabled 1: enabled Default value: 1 |
| Qnos | string | no | The queue numbers associated with the agent (JSON-encoded) |
| HiddenTel | integer | no | The number masking type. Valid values: 0: do not mask 1: follow global masking rules Default value: 0 |
| WrapupTime | integer | no | The wrap-up time after an outbound call. Valid values: 0 to 300. Unit: seconds. Default value: 30 |
| CrmId | integer | no | The CRM ID. This ID can be used as a unique identifier when integrating with a third-party CRM system |
| ClidType | integer | no | The outbound caller ID type. Valid values: 0: all 2: specified by agent 3: smart caller ID Default value: 0 |
| ClidRule | integer | no | The outbound caller ID rule. Default value: 1. If ClidType is set to 0, valid values are 1 for random and 2 for round-robin. If ClidType… |
| AssignType | integer | no | The number type. Valid values: 0: phone number 1: dynamic number group Default value: 0 |
| DynamicTelGroupName | string | no | The name of the dynamic number group. This parameter is required if AssignType is set to 1 |
| Clid | string | no | The outbound caller IDs. This parameter is required if ClidType is not set to 0 (JSON-encoded) |
| ClidDefault | string | no | The default outbound caller IDs. You can configure this parameter if ClidType is set to 3 and ClidRule is set to 1 (JSON-encoded) |
| ClidArea | string | no | The region-based outbound caller ID configuration. This parameter takes effect if ClidType is set to 3 and ClidRule is set to 2. For more… |
| RecurrentselectionType | integer | no | The round-robin mode. Valid values: 1: daily round-robin 2: per-call round-robin This parameter takes effect only if the outbound caller… |
| RecurrentselectionValue | integer | no | The round-robin value. This parameter takes effect only if the outbound caller ID type is set to all and the outbound caller ID rule is… |
| Permission | string | yes | permission (JSON-encoded) |
| Type | integer | no | The agent type. Valid values: 1: Omnichannel. 2: Call center. 3: Online customer service. Default value: 2 |
| WechatMiniProgramRtc | integer | no | Specifies whether to enable the RTC feature for WeChat mini programs. Valid values: 1: Enabled. 0: Disabled. Default value: Disabled |
| ObClidDefaultType | integer | no | The default number type. Valid values: 0: Number. 1: Dynamic number group. Default value: 0 |
| DynamicTelGroupIdDefault | integer | no | The default dynamic outbound call group ID. This parameter is required when ObClidDefaultType is set to 1 |
| ServeArea | string | no | The agent service areas. This parameter is an array of area codes used to configure the service areas for agents. It can be used in the… |
| CloudNumberEnabled | integer | no | Specifies whether to enable outbound calls by using cloud numbers. Valid values: 0: Disabled. 1: Enabled |
| CloudNumberModes | string | no | The four cloud number call modes. The array length is 4, which corresponds to the enabling status of the four cloud number outbound call… |
| ObHangupSms | integer | no | Specifies whether to enable the outbound call hang-up SMS feature. Valid values: 0: Disabled. 1: Enabled. When enabled, if an agent… |
| PauseLogin | integer | no | Specifies whether to allow busy logon. When disabled, agents are not allowed to log on in the busy state. Valid values: 0: Disabled. 1:… |

### Adds a pause state
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-create-enterprise-pause` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| PauseStatus | string | yes | The description of the pause state. The description cannot exceed 4 characters |
| IsRest | string | yes | Specifies whether the state is a rest state. Valid values: 0: No. 1: Yes |
| IsDefault | integer | yes | Specifies whether the state is the default state. Valid values: 0: No. 1: Yes |

### Creates a phone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-create-exten` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| ExtenNumber | string | yes | The phone number. It must be 3 to 6 digits in length and unique |
| Password | string | yes | The password of the phone. For password rules, refer to the enterprise configuration |
| AreaCode | string | yes | The area code of the phone. It must be 3 to 4 digits in length and start with 0 |
| Type | integer | yes | The type of the phone. Valid values: 1: IP phone. 2: Softphone |
| Allow | integer | yes | The voice codec. Valid values for IP phones: 1, 2, 3, 4, and 5. Valid values for softphones: 5 and 6. 1: g729 (deprecated). 2: g729, alaw,… |
| IsDirect | integer | no | Specifies whether to allow direct outbound calls. Valid values: 1: allowed. 0: not allowed. If the phone type is IP phone, you can enable… |
| JittBuffer | integer | no | Specifies whether to enable the network jitter buffer. Valid values: 0: disabled. 1: enabled. Default value: 0. When this feature is… |

### Creates a queue
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-create-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Qno | string | yes | The queue number. It must be a unique 4-digit number |
| Name | string | yes | The queue name. It can contain only Chinese characters, letters, digits, and underscores, and can be up to 20 characters in length |
| MaxWait | integer | no | The maximum number of waiting calls. Valid values: 0 to 999. A value of 0 indicates no limit. Default value: 5 |
| MemberTimeout | integer | no | The agent timeout period in seconds. Valid values: 20 to 60. Default value: 25 |
| QueueTimeout | integer | no | The queue timeout period in seconds. Valid values: 30 to 600. Default value: 600 |
| Strategy | integer | no | The call routing strategy. Valid values: 1: Sequential. 2: Round-robin. 3: Average. 4: Random. 5: Skill priority. 6: Longest cumulative… |
| Weight | integer | no | The queue priority. Valid values: 1 to 10. Default value: 1. If an agent belongs to multiple queues, calls from the queue with a higher… |
| WrapupTime | integer | no | The wrap-up time in seconds. Valid values: 3 to 300. During the wrap-up period, the agent does not receive new calls. Default value: 15 |
| ServiceLevel | integer | no | The service level threshold in seconds. Valid values: 10 to 30. Calls answered within this time are considered to have a high service… |
| JoinEmpty | integer | no | Specifies whether to allow joining the queue when it is empty. Valid values: 1: Busy. 2: On a call. 4: Ringing. 8: Invalid. 16: Wrap-up.… |
| QueueMembers | string | no | The agents in the queue and their skill levels. Valid skill levels: 1 to 10, where 1 indicates the highest priority. Cno represents the… |
| IbAllowed | integer | no | Specifies whether to allow inbound calls to the queue. Valid values: 0: No. 1: Yes. Default value: 1 |
| SayCno | integer | no | Specifies whether to announce the agent number. Valid values: 0: No. 1: Yes. Default value: 0 |
| VipSupport | integer | no | Specifies whether to prioritize VIP customers. Valid values: 0: Not supported. 1: Supported. Default value: 0 |
| MaxPauseClientFlag | integer | no | Specifies whether to enable the limit on the maximum number of concurrent busy agents. Valid values: 0: Disable. 1: Enable. Default value: 0 |
| MaxPauseClientType | integer | no | The limit type for the maximum number of concurrent busy agents. Valid values: 0: Percentage. 1: Absolute value. Default value: 0 |
| MaxPauseClientValue | integer | no | The limit value for the maximum number of concurrent busy agents. If the limit type is set to percentage, the maximum value is 100.… |
| ChatStrategy | integer | no | The online chat routing strategy. Valid values: 2: Round-robin. 4: Random. 5: Skill priority. Default value: 2 |
| ChatMaxWait | integer | no | The maximum number of waiting online chat sessions. Default value: 20 |
| ChatLocation | integer | no | The threshold for pushing the online chat queue position. A push notification is sent when the queue position is less than this value.… |

### Deletes an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-delete-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Cno | integer | yes | The agent ID. The value must be 4 to 11 characters in length and contain only digits |

### Deletes a phone
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-delete-exten` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| ExtenNumber | string | yes | The phone number. It must be 3 to 6 digits in length |

### Queries inbound call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-describe-cdr-ib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| MainUniqueId | string | yes | The unique identifier of the call record |
| HiddenType | integer | no | Specifies whether to hide phone numbers. Valid values: 0: Do not hide. 1: Hide the middle four digits. 2: Hide the last eight digits. 3:… |

### Queries the details of inbound call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-describe-cdr-ib-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| MainUniqueId | string | no | The unique identifier of the call record |

### Queries outbound call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-describe-cdr-ob` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| MainUniqueId | string | yes | The unique identifier of the call record |
| HiddenType | integer | no | Specifies whether to mask phone numbers. Valid values: 0: Do not mask. 1: Mask the middle four digits. 2: Mask the last eight digits. 3:… |

### Queries the details of outbound call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-describe-cdr-ob-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| MainUniqueId | string | no | The unique identifier of the call record |

### Queries the details of an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-describe-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Cno | string | yes | The agent number |

### Queries the details of a queue
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-describe-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Qno | string | yes | The queue number |

### Retrieves the URL of a call recording
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-describe-record-file-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| MainUniqueId | string | yes | The unique identifier of the call record |
| RecordSide | integer | no | Specifies the recording side. If this parameter is not specified, an MP3 recording is retrieved. If this parameter is specified, a WAV… |
| Timeout | integer | no | The timeout period for retrieving the recording URL, in seconds. Default value: 3600. Valid values: 3600 to 86400 |
| Download | integer | no | Specifies the action for the recording. Valid values: 0: playback. 1: download. Default value: 1 |
| RecordType | string | no | The type of the recording. Valid values: record: call recording. voicemail: voice mail. Default value: record |

### Queries the details of customer inbound call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-detail-cdr-ib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| MainUniqueId | string | yes | The unique identifier of the call record |
| HiddenType | integer | no | Specifies the number masking type. Valid values: 0: No masking. 1: Middle four digits. 2: Last eight digits. 3: All digits. 4: Last four… |

### Queries a list of customer incoming call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-cdr-ib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| StartTime | integer | no | The start time. The value is a UNIX timestamp accurate to seconds. Default value: the first day of the current month |
| StartTimeEnd | integer | no | The end of the start time range. The value is a UNIX timestamp accurate to seconds. The time span between the start time and end time… |
| BridgeTime | integer | no | The time when the call is answered. The value is a UNIX timestamp accurate to seconds |
| BridgeTimeEnd | integer | no | The end of the answer time range. The value is a UNIX timestamp accurate to seconds |
| EndTime | integer | no | The end time. The value is a UNIX timestamp accurate to seconds |
| EndTimeEnd | integer | no | The end of the end time range. The value is a UNIX timestamp accurate to seconds |
| HiddenType | integer | no | Specifies whether to mask the phone number. Valid values: 0: Do not mask. 1: Mask the middle four digits. 2: Mask the last eight digits.… |
| BridgeDuration | integer | no | The minimum call duration for the range query. This parameter must be used together with BridgeDurationEnd |
| BridgeDurationEnd | integer | no | The maximum call duration for the range query |
| TotalDuration | integer | no | The minimum total duration for the range query. This parameter must be used together with TotalDurationEnd |
| TotalDurationEnd | integer | no | The maximum total duration for the range query |
| Cnos | string | no | The ID of the agent |
| Qnos | string | no | The ID of the queue |
| Statuses | integer | no | The answer status. Valid values: 1: Answered by an agent. 2: Not answered by an agent. 3: Answered by the system. 4: Not answered by the… |
| MainUniqueId | string | no | The unique ID of the call record |
| ScrollSearch | string | no | Specifies whether to use scroll search. Valid values: true and false. Default value: false |
| ScrollId | string | no | The ID for scroll search. This parameter must be used together with ScrollSearch. You do not need to specify this parameter for the first… |
| Offset | integer | no | The offset. Valid values: 0 to 99990. Default value: 0. Note: The sum of Limit and Offset cannot exceed 100,000 |
| Limit | integer | no | The number of entries to return. Valid values: 10 to 100. Default value: 10. Note: The sum of Limit and Offset cannot exceed 100,000 |
| FirstCallCno | string | no | The ID of the agent who handled the first call |
| FirstCallQno | string | no | The ID of the queue that handled the first call |
| FirstCallNumber | string | no | The phone number of the agent who handled the first call |
| ClientNumber | string | no | The phone number of the agent |
| CustomerNumber | string | no | The phone number of the customer |

### Queries a list of agent answer records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-cdr-ib-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| StartTime | integer | no | The start time. The value is a timestamp accurate to seconds. Default value: the first day of the current month |
| StartTimeEnd | integer | no | The upper bound of the start time. The value is a timestamp accurate to seconds. The time span between the start time and the end time… |
| BridgeTime | integer | no | The answer time. The value is a timestamp accurate to seconds |
| BridgeTimeEnd | integer | no | The upper bound of the answer time. The value is a timestamp accurate to seconds |
| EndTime | integer | no | The end time. The value is a timestamp accurate to seconds |
| EndTimeEnd | integer | no | The upper bound of the end time. The value is a timestamp accurate to seconds |
| HiddenType | integer | no | Specifies whether to mask phone numbers. Valid values: 0: Do not mask. 1: Mask the middle four digits. 2: Mask the last eight digits. 3:… |
| ClientNumber | string | no | The agent phone number |
| BridgeDuration | integer | no | The minimum call duration for range queries. Use this parameter together with BridgeDurationEnd |
| BridgeDurationEnd | integer | no | The maximum call duration for range queries |
| AgentAnswerInTime | integer | no | Specifies whether the call was answered promptly. Valid values: 0: No. 1: Yes. Default value: all |
| MainUniqueId | string | no | The unique identifier of the call record |
| CustomerNumber | string | no | The customer phone number |
| HotlineName | string | no | The hotline alias |
| ScrollId | string | no | The scroll ID. Use this parameter together with scrollSearch. You do not need to specify this parameter for the first query. For… |
| Offset | integer | no | The offset. Valid values: 0 to 99990. Default value: 0. Note: The sum of Limit and Offset cannot exceed 100,000 |
| Limit | integer | no | The number of entries to return. Valid values: 10 to 100. Default value: 10. Note: The sum of Limit and Offset cannot exceed 100,000 |
| Qno | string | no | The queue number |
| Cno | string | no | The agent ID |

### Queries the list of inbound call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-cdr-ibs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| HiddenType | integer | no | Specifies whether to hide phone numbers. Valid values: 0: do not hide 1: hide the middle four digits 2: hide the last eight digits 3: hide… |
| Qno | string | no | The queue number |
| CustomerNumber | string | no | The customer number |
| Cno | string | no | The agent ID |
| Status | integer | no | The answer status. Valid values: 0: all 1: answered by agent 2: agent called but not answered 3: answered by system 4: not answered by… |
| MainUniqueId | string | no | The unique identifier of the call record |
| ClientNumber | string | no | The agent phone number |
| QueueAnswerInTime | integer | no | Specifies whether the queue was answered in a timely manner. Valid values: 0: no 1: yes 2: - |
| StartTime | integer | no | The start time. The timestamp is accurate to seconds. Default value: the first day of the current month |
| EndTime | integer | no | The end time. The timestamp is accurate to seconds. The time span between the start time and the end time cannot exceed one month. Default… |
| Offset | integer | no | The offset. Valid values: 0 to 99990. Default value: 0. Note: The sum of limit and offset cannot exceed 100,000 |
| Limit | integer | no | The number of entries to return. Valid values: 10 to 100. Default value: 10. Note: The sum of limit and offset cannot exceed 100,000 |

### Queries a list of outbound call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-cdr-ob` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| StartTime | integer | no | The start time. The timestamp is accurate to seconds. Default value: the first day of the current month |
| StartTimeEnd | integer | no | The end of the start time range for the query. The timestamp is accurate to seconds. The time span between the start time and the end time… |
| BridgeTime | integer | no | The time when the call is answered. The timestamp is accurate to seconds |
| BridgeTimeEnd | integer | no | The end of the answer time range for the query. The timestamp is accurate to seconds |
| EndTime | integer | no | The end time. The timestamp is accurate to seconds |
| EndTimeEnd | integer | no | The end of the end time range for the query. The timestamp is accurate to seconds |
| HiddenType | integer | no | Specifies whether to mask the phone number. Valid values: 0: Do not mask. 1: Mask the middle four digits. 2: Mask the last eight digits.… |
| BridgeDuration | integer | no | The minimum value of the call duration range for the query. This parameter is used together with BridgeDurationEnd |
| BridgeDurationEnd | integer | no | The maximum value of the call duration range for the query |
| TotalDuration | integer | no | The minimum value of the total duration range for the query. This parameter is used together with TotalDurationEnd |
| TotalDurationEnd | integer | no | The maximum value of the total duration range for the query |
| Cnos | string | no | The ID of the agent |
| Qnos | string | no | The outbound call group |
| ClientNumber | string | no | The phone number of the agent |
| CustomerNumber | string | no | The phone number of the customer |
| CallType | integer | no | The type of the call. Valid values: 4: Preview outbound call. 6: Active outbound call. Default value: all |
| LeftClid | string | no | The caller ID number |
| Xnumber | string | no | The number of the service instance |
| Status | integer | no | The answer status. Valid values: 1: The customer did not answer. 2: The agent did not answer. 3: The customer answered. 4: The agent… |
| MainUniqueId | string | no | The unique identifier of the call record |
| TaskName | string | no | The name of the call task |
| Offset | integer | no | The offset. Valid values: 0 to 99990. Default value: 0. Note: The sum of Limit and Offset cannot exceed 100,000 |
| Limit | integer | no | The number of entries to return. Valid values: 10 to 100. Default value: 10. Note: The sum of Limit and Offset cannot exceed 100,000 |
| ScrollSearch | string | no | Specifies whether to use scroll search. Valid values: true: Use scroll search. false: Do not use scroll search. Default value: false |
| ScrollId | string | no | The ID for scroll search. This parameter is used together with ScrollSearch. You do not need to specify this parameter for the first… |

### Queries a list of outbound call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-cdr-obs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| HiddenType | integer | no | Specifies whether to mask phone numbers. Valid values: 0: Do not mask. 1: Mask the middle four digits. 2: Mask the last eight digits. 3:… |
| CustomerNumber | string | no | The phone number of the customer |
| Cno | string | no | The ID of the agent. The value must be 4 to 11 digits in length |
| Hotline | string | no | The hotline number |
| Status | integer | no | The answer status of the call. Valid values: 0: All. 1: Not answered by the customer. 2: Not answered by the agent. 3: Answered by both… |
| Mark | integer | no | The mark of the call. Valid values: Empty: All. 1: Voicemail. 2: Transfer. 3: Consultation. 4: Three-way call. 5: Fax received. 6:… |
| Province | string | no | The province of the customer |
| City | string | no | The city of the customer |
| MainUniqueId | string | no | The unique identifier of the call record |
| RequestUniqueId | string | no | The unique identifier of the request |
| ClientNumber | string | no | The phone number of the agent |
| QueueAnswerInTime | integer | no | Specifies whether the call was answered in the queue within the specified time. Valid values: 0: No. 1: Yes. 2: Not applicable |
| Evaluation | integer | no | Specifies whether the customer was invited to evaluate the service. Valid values: 0: No. 1: Yes. 2: Not applicable |
| IdType | integer | no | The type of the business ID. Valid values: 1: Ticket. 2: Business record |
| AssociatedId | integer | no | The business ID |
| StartTime | integer | no | The start time. The value must be a UNIX timestamp accurate to seconds. Default value: the first day of the current month |
| EndTime | integer | no | The end time. The value must be a UNIX timestamp accurate to seconds. The time span between the start time and the end time cannot exceed… |
| Offset | integer | no | The offset. Valid values: 0 to 99990. Default value: 0. Note: The sum of Limit and Offset cannot exceed 100,000 |
| Limit | integer | no | The number of entries to return. Valid values: 10 to 100. Default value: 10. Note: The sum of Limit and Offset cannot exceed 100,000 |

### Queries the list of agents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-clients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Qno | string | no | The queue number |
| Active | integer | no | Specifies whether the agent is activated. Valid values: 1: Activated. 0: Not activated |
| Clid | string | no | The outbound caller ID |
| BindTel | string | no | The bound phone number |
| StartTime | integer | no | The start time of the creation time range. The value is a UNIX timestamp in seconds |
| EndTime | integer | no | The end time of the creation time range. The value is a UNIX timestamp in seconds |
| UpdateStartTime | integer | no | The start time of the update time range. The value is a UNIX timestamp in seconds |
| UpdateEndTime | integer | no | The end time of the update time range. The value is a UNIX timestamp in seconds |
| Offset | integer | no | The offset. Default value: 0. Maximum value: 10000 |
| Limit | integer | no | The maximum number of records to return. Default value: 10. Maximum value: 100 |

### Queries the list of pause statuses
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-enterprise-pauses` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |

### Queries a list of phones
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-extens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| AreaCode | string | no | The area code of the phone. It must be a 3- to 4-digit number starting with 0 |
| Type | integer | no | The type of the phone. Valid values: 1: IP phone. 2: Softphone |
| Offset | integer | no | The offset. Valid values: 0 to 10000. Default value: 0 |
| Limit | integer | no | The number of entries to return. Valid values: 10 to 100. Default value: 10 |

### Queries the list of IVR nodes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-ivr-nodes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| IvrName | string | yes | The name of the IVR |

### Queries the IVR list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-ivrs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |

### Queries the list of queues
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-list-queues` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Offset | integer | no | The offset. Default value: 0. Maximum value: 10000 |
| Limit | integer | no | The number of entries to return. Default value: 10. Maximum value: 100 |

### Queries inbound call statistics
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-stat-ib` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Date | string | yes | The synchronization date. Format: yyyyMMdd |
| DateEnd | string | no | The end synchronization date. Format: yyyyMMdd. Default value: the value of Date. The maximum time range for a query is 6 months |
| Hotlines | string | no | The hotline numbers to query. Default value: all hotline numbers |
| Fields | string | no | The fields to display. Default value: all fields |
| StatisticMethod | integer | no | The statistical method. Valid values: 2: aggregate statistics. 3: time-based statistics. Default value: 2. Note: For time-based… |
| StartHour | integer | no | The start hour for the query. Valid values: 0 to 23. Default value: 0 |
| EndHour | integer | no | The end hour for the query. Valid values: 0 to 23. Default value: 23 |
| StartMinute | integer | no | The start minute for the query. Valid values: 0, 15, 30, and 45. Default value: 0 |
| EndMinute | integer | no | The end minute for the query. Valid values: 0, 15, 30, 45, and 59. Default value: 59. Note: The start time composed of StartHour and… |

### Updates an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/clink-update-client` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Cno | integer | yes | The unique agent ID. The ID must be 4 to 11 digits in length |
| Name | string | no | The agent name. The name can contain only Chinese characters, letters, digits, and underscores (_), and can be up to 20 characters in length |
| AreaCode | string | no | The area code |
| Password | string | no | The agent password. The password is encrypted by using AES and is 8 characters in length by default. If password security settings are… |
| Role | integer | no | The agent role. Valid values: 0: regular agent 1: supervisor |
| Active | integer | no | The activation status. Valid values: 0: disabled 1: enabled |
| Qnos | string | no | The queue numbers (JSON-encoded) |
| HiddenTel | integer | no | The phone number masking type. Valid values: 0: do not mask 1: follow global settings |
| IbWrapupType | integer | no | The inbound wrap-up type. Valid values: 1: queue 2: agent |
| IbWrapupTime | integer | no | The inbound wrap-up time. This is the after-call processing time for an agent after an inbound call ends. During this period, the agent… |
| WrapupTime | integer | no | The wrap-up time. This is the after-call processing time for an agent after an outbound call ends. Valid values: 0 to 300. Unit: seconds |
| CrmId | integer | no | The CRM ID. This ID can be used as a unique identifier when integrating with a third-party CRM system |
| ClidType | integer | no | The caller ID type. Valid values: 0: all 2: specified by agent 3: smart caller ID |
| AssignType | integer | no | The number type. Valid values: 0: number 1: dynamic number group Default value: 0 |
| DynamicTelGroupName | string | no | The dynamic number group name. This parameter is required when AssignType is set to 1 |
| ClidRule | integer | no | The caller ID rule. Valid values when ClidType is set to 0: 1: random 2: round-robin Valid values when ClidType is set to 3: 1: dynamic 2:… |
| Clid | string | no | The available caller IDs. This parameter is required when the caller ID type is not set to all (JSON-encoded) |
| ClidDefault | string | no | The default caller IDs. This parameter is supported when ClidType is set to 3 and ClidRule is set to 1 (JSON-encoded) |
| ClidArea | string | no | The region-based caller ID configuration. This parameter takes effect when ClidType is set to 3 and ClidRule is set to 2. For specific… |
| RecurrentselectionType | integer | no | The round-robin mode. This parameter takes effect when the caller ID type is set to all and the caller ID rule is set to round-robin.… |
| RecurrentselectionValue | integer | no | The round-robin value. This parameter takes effect when the caller ID type is set to all and the caller ID rule is set to round-robin.… |
| Permission | string | yes | permission (JSON-encoded) |
| WechatMiniProgramRtc | integer | no | Specifies whether to enable RTC for WeChat mini programs. Valid values: 1: Enabled. 0: Disabled. Default value: 0 |
| ObClidDefaultType | integer | no | The default number type. Valid values: 0: Number. 1: Dynamic number group. Default value: 0 |
| DynamicTelGroupIdDefault | integer | no | The ID of the default dynamic outbound group. This parameter is required when ObClidDefaultType is set to 1 |
| ServeArea | string | no | The service areas of agents, represented as an array of area codes. You can configure the service areas for agents, which can be used in… |
| CloudNumberEnabled | integer | no | Specifies whether to enable outbound calls by using cloud numbers. Valid values: 0: Disabled. 1: Enabled |
| CloudNumberModes | string | no | The four call modes for cloud numbers. The array length is 4, which corresponds to the enabling status of the four outbound call modes for… |
| ObHangupSms | integer | no | Specifies whether to enable the hang-up SMS feature for outbound calls. Valid values: 0: Disabled. 1: Enabled. After this feature is… |
| PauseLogin | integer | no | Specifies whether to allow agents to log on in the busy state. If this feature is disabled, agents are not allowed to log on in the busy… |

### Sets an agent to online status
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-agent-login` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Cno | string | yes | The agent ID. The value is a positive integer of 3 to 10 digits |
| BindTel | string | yes | The bound phone number |
| BindType | integer | yes | The bind type. Valid values: - 1: Regular phone. - 2: Extension. - 3: WebRTC. Note: If the bind type is set to extension, the extension… |
| LoginStatus | integer | no | The logon status. Valid values: 1: Available. 2: Busy. Default value: 1 |
| PauseDescription | string | no | The description for the busy status |

### Offlines an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-agent-logout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Cno | string | yes | The agent ID. The value is a positive integer of 3 to 10 digits |
| RemoveBinding | integer | no | Specifies whether to unbind the phone. Valid values: 0: Do not unbind the phone. 1: Unbind the phone. Default value: 0 |
| IsKickout | integer | no | Specifies whether to send a kickout event to the agent. Valid values: 0: Do not send. 1: Send. Default value: 1 |
| IgnoreOffline | integer | no | Specifies whether to ignore duplicate offline errors. Valid values: 0: Do not ignore. 1: Ignore. Default value: 0 |

### Collects real-time call statistics for agents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-agent-monitor-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| Fields | string | no | The names of the statistics fields. Specify the field names used in queue real-time statistics. Separate multiple field names with commas… |
| Cnos | string | no | The agent IDs used to query statistics for specified agents. You can specify multiple agent IDs separated by commas (,). By default,… |
| IsUseGno | integer | no | Specifies whether to enable outbound group query. Valid values: 0: disabled (default). 1: enabled |
| Gno | string | no | The outbound group IDs used to query statistics for specified agents. You can specify multiple outbound group IDs separated by commas (,).… |
| Limit | integer | no | The number of entries to return. The value must be a positive integer. Default value: 10. Maximum value: 500 |
| Offset | integer | no | The starting position of the query. The value must be a positive integer. Default value: 0. This parameter is used together with Limit.… |
| StartHour | integer | no | The start hour of the statistical period. The value must be a positive integer from 0 to 23. Maximum value: 23 |
| EndHour | integer | no | The end hour of the statistical period. The value must be a positive integer from 1 to 24. Maximum value: 24 |
| IsNeedQueueName | string | no | Specifies whether to return the queue name. Valid values: 0: not required (default). 1: required |

### Sets the call-associated data for an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-agent-set-user-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Cno | string | yes | The ID of the agent. The value must be a positive integer of 3 to 10 digits |
| Direction | integer | yes | The direction of the call-associated data. Valid values: 1: Agent side. 2: Non-agent side |
| UserData | string | yes | The user data in JSON string format. The specified values are injected into channel variables. Format: JSON string {"key":"value"}. The… |

### Ends a call for an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-agent-unlink` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Cno | string | no | The ID of the agent. The value must be a positive integer of 3 to 10 digits. You must specify one of the Cno, UniqueId, and… |
| UniqueId | string | no | The unique ID of the call. You must specify one of the Cno, UniqueId, and RequestUniqueId parameters |
| RequestUniqueId | string | no | The unique ID of the request. You must specify one of the Cno, UniqueId, and RequestUniqueId parameters. Note: The hang-up feature based… |
| Side | integer | no | Specifies whether the call is disconnected on the agent side. Valid values: 1: Agent side. 2: Non-agent side. Default value: 1 |

### Retrieves agent workload report data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-agent-workload-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| StatisticMethod | integer | yes | The statistical method. Valid values: 0: by hour. 1: by day. 2: summary. 10: queue summary |
| TimeRangeType | integer | yes | The statistical report type. Valid values: 1: Daily report. 2: Weekly report. 3: Monthly report. 4: Custom time range |
| StartTime | string | yes | The start time of the statistical date range. Format: yyyy-MM-dd |
| EndTime | string | yes | The end time of the statistical date range. Format: yyyy-MM-dd |
| Cnos | string | no | The agent ID. Queries workload statistics for specified agents by agent ID. You can specify multiple agent IDs separated by commas (,). By… |
| Gnos | string | no | The outbound call ID. Queries workload statistics for specified agents by outbound call ID. By default, workload statistics for all agents… |
| Start | integer | no | The query start position. The value must be greater than or equal to 0. Default value: 0 |
| Limit | integer | no | The number of records to query. Maximum value: 1000. Default value: 10 |

### Assigns agents to an outbound call group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-assign-agent-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Gno | string | no | The outbound call group number. This parameter binds the outbound call group specified by Gno to the agents specified by Cnos. A single… |
| Cnos | string | no | The agent numbers. Separate multiple agent numbers with commas (,). You can specify up to 1,000 agent numbers at a time. An agent can… |

### Creates multiple agents in batches. A single batch can contain up to 100 agents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-batch-create-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Cno | string | yes | The starting agent ID. It must be a positive integer consisting of 3 to 10 digits |
| EndCno | string | yes | The ending agent ID. It must be a positive integer consisting of 3 to 10 digits. The maximum number of agents that can be created in a… |
| Name | string | yes | The name of the agent. The name must be URL-encoded in UTF-8 format |
| AreaCode | string | yes | The area code to which the agent belongs |
| Active | integer | no | Specifies whether the agent is activated. Valid values: 0: Not activated. 1: Activated. Default value: 1 |
| Power | integer | no | The role of the agent. Valid values: 1: Supervisor. 0: Regular agent. Default value: 0 |
| CallPower | integer | no | The call permissions of the agent. Valid values: 0: Unlimited. 1: Domestic long-distance calls. 2: Domestic local calls. 3: Internal… |
| Wrapup | integer | no | The wrap-up time. Unit: seconds. Default value: 10 |
| IsOb | integer | no | Specifies whether outbound calls are allowed. Valid values: 0: Not allowed. 1: Allowed. Default value: 1 |
| ObClidType | integer | no | The caller ID display rule. Valid values: 1: Default. 2: Random. 3: By area code. 4: Dynamic caller ID. Default value: 1 |
| ObClid | string | no | The pass-through number. You can specify an enterprise trunk number or a configured customer-facing caller ID number. This parameter is… |
| ObClidProperty | string | no | The caller ID display properties. Example value: {"isMatchCapital":0,"areaCodeRule":1}. When ObClidType is set to 4, isMatchCapital… |
| IbRecord | integer | no | Specifies whether to record inbound calls. Valid values: 0: Do not record. 1: Record. Default value: 1 |
| ObRecord | integer | no | Specifies whether to record outbound calls. Valid values: 0: Do not record. 1: Record. Default value: 1 |
| SkillIds | string | no | The IDs of the selected skills. You can specify multiple IDs separated by commas (,). Example: "1,2,3". If you specify SkillIds, you must… |
| SkillLevels | string | no | The levels of the selected skills. A smaller value indicates a higher skill level. Specify multiple levels separated by commas (,). The… |
| IsAsr | integer | no | Specifies whether to enable automatic speech recognition (ASR) transcription. Valid values: 0: Disabled. 1: Enabled. Default value: 0 |
| IsQualityCheck | integer | no | Specifies whether to enable agent quality check. Valid values: 0: Disabled. 1: Enabled. Default value: 1 |
| WebrtcUrlType | integer | no | The return address type for the WebRTC softphone. Valid values: 0: Enterprise default. 1: Public domain name. 2: Leased line domain name.… |
| Comment | string | no | The remarks |

### Retrieves the real-time status of agents in batches based on agent IDs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-batch-get-agent-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Cnos | string | yes | The list of agent IDs. Separate multiple agent IDs with commas (,). Example: cnos=2000,2001. A maximum of 100 agents are supported |

### Updates the basic information of multiple agents in a batch, excluding the skill information bound to the…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-batch-update-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Cnos | string | yes | The list of agent IDs. Separate multiple IDs with commas (,). You can update up to 100 agents at a time. Example: "0001,0002,00103". An… |
| Name | string | no | The name of the agent. The value must be URL-encoded in UTF-8 format |
| AreaCode | string | no | The area code of the agent |
| Active | integer | no | Specifies whether the agent is activated. Valid values: 0: Not activated. 1: Activated. Default value: 1 |
| AgentType | integer | no | The type of the agent. Valid values: 1: Phone agent. 2: Computer agent. Default value: 1 |
| Power | integer | no | The role of the agent. Valid values: 1: Supervisor. 0: Regular agent. Default value: 0 |
| CallPower | integer | no | The call permission of the agent. Valid values: 0: Unlimited. 1: Domestic long-distance calls. 2: Domestic local calls. 3: Internal calls.… |
| Wrapup | integer | no | The wrap-up time in seconds. Default value: 10 |
| IsOb | integer | no | Specifies whether outbound calls are allowed. Valid values: 0: Not allowed. 1: Allowed. Default value: 1 |
| ObClidType | integer | no | The caller ID display rule. Valid values: 1: Default. 2: Random. 3: By area code. 4: Dynamic caller ID. Default value: 1 |
| ObClid | string | no | The caller ID number. You can enter an enterprise trunk number or a configured customer-facing caller ID number. This parameter is… |
| IsRandom | string | no | Specifies whether to use a random caller ID. Valid values: 0: No. 1: Yes. This parameter is required when ObClidType is set to 4. Default… |
| IbRecord | integer | no | Specifies whether to record inbound calls. Valid values: 0: Do not record. 1: Record. Default value: 1 |
| ObRecord | integer | no | Specifies whether to record outbound calls. Valid values: 0: Do not record. 1: Record. Default value: 1 |
| IsAsr | integer | no | Specifies whether to enable automatic speech recognition (ASR) transcription. Valid values: 0: Disabled. 1: Enabled. Default value: 0 |
| IsQualityCheck | integer | no | Specifies whether to enable agent quality checks. Valid values: 0: Disabled. 1: Enabled. Default value: 1 |
| ObClidProperty | string | no | The caller ID properties. Example value: {"isMatchCapital":0,"areaCodeRule":1}. When ObClidType is set to 4, isMatchCapital specifies… |
| WebrtcUrlType | integer | no | The URL type for the WebRTC softphone. Valid values: 0: Enterprise default. 1: Public domain name. 2: Leased line domain name. 3: Public… |
| IsObRemember | string | no | Specifies whether to enable the outbound caller ID memory feature. Valid values: 0: Disabled. 1: Enabled. Default value: 1 |
| Comment | string | no | The remarks |
| PermitObPreviewTime | string | no | The time period during which outbound calls are allowed. Format: 08:00,20:00 |

### Creates an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-create-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Cno | string | yes | The agent number. The value must be a positive integer of 3 to 10 digits |
| Name | string | yes | The agent name. The value must be URL-encoded in UTF-8 format |
| AreaCode | string | yes | The area code of the agent |
| Active | integer | no | Specifies whether to activate the agent. Valid values: 0: not activated. 1: activated. Default value: 1 |
| Power | integer | no | The permission level of the agent. Valid values: 0: regular agent. 1: supervisor. Default value: 0 |
| CallPower | integer | no | The call permission of the agent. Valid values: 0: no restrictions. 1: domestic long-distance calls. 2: local calls within the city. 3:… |
| Wrapup | integer | no | The wrap-up time, in seconds. Default value: 10 |
| IsOb | integer | no | Specifies whether to allow outbound calls. Valid values: 0: not allowed. 1: allowed. Default value: 1 |
| ObClidType | integer | no | The caller ID display rule for outbound calls. Valid values: 1: default. 2: random. 3: by area code. 4: dynamic caller ID display. Default… |
| ObClid | string | no | The pass-through number. You can specify an enterprise trunk number or a preconfigured customer-side caller ID number. This parameter is… |
| ObClidProperty | string | no | The caller ID display properties. Example: {"isMatchCapital":0,"areaCodeRule":1,"isRandom":1}. This parameter takes effect when ObClidType… |
| IbRecord | integer | no | Specifies whether to record inbound calls. Valid values: 0: disabled. 1: enabled. Default value: 1 |
| ObRecord | integer | no | Specifies whether to record outbound calls. Valid values: 0: disabled. 1: enabled. Default value: 1 |
| SkillIds | string | no | The IDs of the skills assigned to the agent. You can specify multiple skill IDs separated by commas, for example, "1,2,3". If you specify… |
| SkillLevels | string | no | The levels of the assigned skills. A lower value indicates a higher skill level. Specify multiple levels separated by commas, in the same… |
| IsAsr | integer | no | Specifies whether to enable automatic speech recognition (ASR) transcription. Valid values: 0: disabled. 1: enabled. Default value: 0 |
| IsQualityCheck | integer | no | Specifies whether to enable agent quality inspection. Valid values: 0: disabled. 1: enabled. Default value: 1 |
| WebrtcUrlType | integer | no | The return address type for the WebRTC softphone. Valid values: 0: enterprise default. 1: public domain name. 2: dedicated line domain… |
| IsObRemember | string | no | Specifies whether to enable outbound caller ID memory. Valid values: 0: disabled. 1: enabled. Default value: 1 |
| Comment | string | no | The remarks |
| PermitObPreviewTime | string | no | The permitted time range for outbound calls. Format: 08:00,20:00 |

### Creates an outbound call group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-create-agent-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Gno | string | yes | The outbound call group number. The number must be unique within the same enterprise, 2 to 20 characters in length, start with a letter,… |
| GroupName | string | yes | The outbound call group name. The name cannot be empty, cannot exceed 50 characters in length, and must be URL-encoded in UTF-8 format |
| Comment | string | no | The description. The description cannot exceed 100 characters in length and must be URL-encoded in UTF-8 format |

### Uploads a recording file and creates an ASR transcription task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-create-asr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| CallType | integer | yes | The call type. Valid values: 1: inbound call, 2: web call, 4: preview outbound call, 5: predictive outbound call, 6: active outbound call,… |
| RecordFile | string | yes | The name of the recording file. Example: 7000002-20170320140327-1581-1500-record-sip-2-148998.366 |
| RecordType | string | yes | The type of the audio file. Valid values: record: recording, voicemail: voice mail |
| RecordSide | integer | yes | The type of the recording channel. Valid values: 0: mixed audio, 1: customer side in split recording, 2: agent side in split recording,… |
| UniqueId | string | yes | The unique ID of the secondary channel |
| MainUniqueId | string | yes | The unique ID of the primary channel |
| SupportMp3 | string | no | Specifies whether to use MP3 for transcription when the WAV file expires. Valid values: 0: not supported (default). 1: supported. If the… |

### Creates a time condition configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-create-enterprise-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| Name | string | yes | The name of the time condition. The name must be unique within the same call center |
| Priority | integer | yes | The priority of the time condition. The priority must be unique within the same call center. The value starts from 1. A smaller value… |
| Type | integer | yes | The condition type. Valid values: 1: configured by day of the week. 2: configured by fixed date |
| TimeType | integer | yes | The time type. Valid values: 1: continuous. 2: interval |
| FromDay | string | no | The start date. This parameter is required when Type is set to 2. Format: yyyy-MM-dd. Set this parameter to an empty string when Type is… |
| ToDay | string | no | The end date. This parameter is required when Type is set to 2. Format: yyyy-MM-dd. Set this parameter to an empty string when Type is set… |
| DayOfWeek | string | no | The days of the week. This parameter is required when Type is set to 1. Monday: 2, Tuesday: 3, Wednesday: 4, Thursday: 5, Friday: 6,… |
| StartTime | string | yes | The start time. Format: HH:mm. For example, 06:00. The value of StartTime cannot be later than the value of EndTime |
| EndTime | string | yes | The end time. Format: HH:mm. For example, 19:00. The value of StartTime cannot be later than the value of EndTime |

### Creates an extension
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-create-exten` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| Exten | string | yes | The extension number, which contains 3 to 11 digits |
| Password | string | yes | The password |
| CallPower | string | no | The call permission. Valid values: 0: No restriction. 1: Domestic long-distance calls. 2: Local calls. 3: Internal calls. Default value: 0 |
| IsOb | string | no | Specifies whether outbound calls are allowed. Valid values: 0: Not allowed. 1: Allowed. Default value: 1 |
| IsDirect | integer | no | Specifies whether off-hook outbound calls are allowed. Valid values: 0: Not allowed. 1: Allowed. Default value: 1 |
| IbRecord | integer | no | Specifies whether inbound calls are recorded. Valid values: 0: Not recorded. 1: Recorded. Default value: 1 |
| ObRecord | integer | no | Specifies whether outbound calls are recorded. Valid values: 0: Not recorded. 1: Recorded. Default value: 1 |
| AreaCode | string | yes | The area code |
| JitterBuffer | integer | no | Specifies whether the jitter buffer is enabled. Valid values: 0: Disabled. 1: Enabled. Default value: 0 |
| Type | integer | yes | The extension type. Valid values: 1: Registered to an IAD extension. 2: Registered to WebRTC. 3: Registered to a remote phone |
| Allow | string | no | The allowed voice codecs. Supported formats: 1: g729 2: g729,alaw,ulaw 3: alaw,ulaw,g729 4: alaw,ulaw 5: myopus,alaw,ulaw 6:… |
| IadName | string | no | The IAD gateway. This parameter takes effect only when the type is set to registered to an IAD extension |
| Property | string | no | The property |
| Denoise | string | no | Specifies whether noise reduction is enabled. Valid values: 0: Disabled. 1: Enabled. This parameter takes effect only when the type is set… |

### Creates a queue
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-create-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Queue | string | yes | The queue information (JSON-encoded) |
| QueueSkills | string | yes | The queue skills (JSON-encoded) |

### Adds a skill to a queue
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-create-queue-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console… |
| Qno | string | yes | The queue number |
| SkillId | integer | yes | The skill ID |
| SkillLevel | integer | yes | The skill level |

### Creates a skill
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-create-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console… |
| Name | string | yes | The skill name |
| Comment | string | no | The description |

### Creates an outbound call task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-create-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Name | string | yes | The name of the task. The name must be URL-encoded in UTF-8 format and be less than 50 characters in length |
| Description | string | no | The description of the task. The description must be URL-encoded in UTF-8 format and be less than 200 characters in length |
| Type | integer | yes | The type of the task. The task type cannot be modified after the task is created. Valid values: 1: predictive dialing task. 2: automatic… |
| TemplateName | string | no | The name of the task template. Task templates allow unified management of task parameters and simplify parameter passing in API… |
| AutoStart | integer | no | Specifies whether to enable scheduled start. Default value: disabled. Valid values: 0: disabled. 1: enabled. This parameter takes effect… |
| AutoStartDay | string | no | The scheduled start date. This parameter takes effect when autoStart is set to 1. If this parameter is not specified, the task is… |
| AutoStartTime | string | no | The scheduled start time. This parameter takes effect when autoStart is set to 1. If this parameter is not specified, the task is… |
| AutoStop | integer | no | Specifies whether to enable scheduled completion. Default value: disabled. Valid values: 0: disabled. 1: enabled. This parameter takes… |
| AutoStopDay | string | no | The scheduled completion date. This parameter takes effect when autoStop is set to 1. If this parameter is not specified, the task is… |
| AutoStopTime | string | no | The scheduled completion time. This parameter takes effect when autoStop is set to 1. If this parameter is not specified, the task is… |
| ForceEndFlag | integer | no | Specifies whether to force end the task upon scheduled completion. This parameter takes effect when autoStop is set to 1. Default value:… |
| AutoTaskType | integer | no | The auto task type. This parameter is used together with the scheduled start (autoStart) and scheduled completion (autoStop) parameters.… |
| AutoTriggerTimeStrategy | string | no | The time period for interval calling. This parameter is required when autoTaskType is set to 1. This parameter configures the time period… |
| AutoComplete | integer | no | Specifies whether to enable auto completion. Default value: enabled. Valid values: 1: enabled. After all phone numbers in the task are… |
| RetryStrategy | string | no | The retry policy. Basic pattern: - Data structure in JSON format:… |
| RetryStrategyTimeType | integer | no | The time type for the retry strategy. This parameter takes effect when a retry strategy is configured. Valid values: 1: based on the first… |
| RetryStrategyOnlyToday | integer | no | Specifies whether the task is valid only on the current day. Valid values: 0: disabled. 1: enabled. Deletes data pending retry and data… |
| CallPriorityStrategy | string | no | The call priority strategy. Data structure in JSON format: ```{"strategy":[{"sort":1,"type":"retryCall",… |
| CustomerClidsCategory | integer | no | The type of the caller ID displayed to the customer. Valid values: 1: landline. 2: mobile phone number. 4: caller ID pool. 5: caller ID… |
| CustomerClids | string | no | The list of caller IDs displayed to the customer. This parameter is required when customerClidsCategory is set to 1 or 2. Multiple caller… |
| CustomerClidType | integer | no | The caller ID rule for the customer side. This parameter takes effect when customerClidsCategory is set to 1 or 2. Default value: random.… |
| ClidProperty | string | no | The caller ID rule. This parameter takes effect when customerClidType is set to 2. The value is in JSON format and specifies the caller ID… |
| CustomerClidWeightFlag | integer | no | Specifies whether to enable the caller ID ratio configuration. This parameter takes effect when customerClidsCategory is set to 1. Default… |
| CustomerClidWeight | string | no | The content of the caller ID ratio configuration. This parameter takes effect when customerClidsCategory is set to 1 and… |
| CustomerClidsGroup | string | no | The name of the caller ID pool or the caller ID navigation ID displayed to the customer. This parameter is required when… |
| CustomerTimeout | integer | no | The customer timeout period. Unit: seconds. Default value: 30. Valid values: 5 to 60 |
| CallRouteStrategy | integer | no | The call routing strategy. Valid values: 1: direct connection to an agent. In this mode, the call is directly assigned to an agent after… |
| IvrId | integer | no | The ID of the IVR. You must specify either the ivrId or ivrName parameter. If both are specified, ivrId takes effect. When creating an… |
| IvrName | string | no | The name of the IVR. You must specify either ivrId or ivrName. If both are specified, ivrId takes effect. When creating an automatic… |
| Concurrency | integer | no | The maximum concurrency limit at the task level. The actual concurrency does not exceed this limit. When type is set to 1, setting this… |
| UserFields | string | no | The custom fields of the task. The value is in JSON array format. Each element in the array supports only one key-value pair. If multiple… |
| CallVariables | string | no | The agent channel variables. The value is in JSON array format. A maximum of 5 variables are supported. Default value: empty. Example:… |
| TimeStrategy | string | no | The do-not-call time period. Calls are prohibited during the specified time period. Parameter format: time condition ID. Multiple IDs are… |
| AutoDelete | integer | no | Specifies whether to automatically delete the earliest completed task when the number of tasks exceeds the maximum task limit. A value of… |
| CallGroupType | integer | no | The method to assign agents. Valid values: 1: agent ID list. 2: outbound call group. Default value: 1. This parameter cannot be modified… |
| Cnos | string | no | The list of agent IDs. This parameter is required when callGroupType is set to 1. Multiple agent IDs are supported and must be separated… |
| AgentGroup | string | no | The ID of the outbound call group. This parameter is required when callGroupType is set to 2. Note: An outbound call group can be bound to… |
| CallStrategy | string | no | The rule to allocate agents. Default value: 1. Valid values: 1: Random. 2: Sequential. 3: Longest time without an incoming call,… |
| AgentTimeout | integer | no | The agent timeout period in seconds. Default value: 10. Valid values: 5 to 60 |
| Wrapup | integer | no | The agent wrap-up time in seconds. Default value: 30. Valid values: 1 to 10800. The wrap-up time affects the number of calls made each… |
| MaxWaitTime | integer | no | The maximum allowed idle time for an agent in seconds. Default value: 40. Valid values: 10 to 600. During task execution, if the average… |
| MinAvailableAgentCount | integer | no | The minimum number of available agents. Default value: 10. Valid values: 1 to 10. If the number of available agents in the task is less… |
| Quotiety | number | no | The harassment rate. Default value: 1. Valid values: greater than 0 and less than or equal to 20. Decimals are supported and accurate to… |
| PredictAdjust | integer | no | The over-dial rate. Default value: 100. Valid values: 50 to 400 |
| CallLimitStrategy | string | no | The maximum number of calls an agent can answer per day. For usage instructions, see the following description. Format: JSON array.… |
| CustomerMoh | string | no | The hold music played to the customer after the customer answers the call and while waiting for an agent to answer. Default value: silent… |
| CustomerVoice | string | no | The prompt audio played to the customer after the customer answers the call and before the call is transferred to an agent. The system… |
| AnswerRate | integer | no | The initial expected customer answer rate. Default value: 50. Valid values: 1 to 100. During the warm-up phase, the call frequency is… |
| WarmUpDuration | integer | no | The task warm-up duration in seconds. Default value: 300. Valid values: 60 to 600 |
| IsRewarm | integer | no | Specifies whether to re-warm up the task after it is paused. Default value: 1. Valid values: 0: Disabled. 1: Enabled |

### Deletes an agent by agent ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-delete-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Cno | string | yes | The agent ID. The value is an integer of 3 to 10 digits |

### Deletes an outbound call group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-delete-agent-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| Gno | string | no | The outbound call group number. The outbound call group corresponding to this Gno value is deleted |

### Deletes a phone number associated with an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-delete-agent-tel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Cno | string | yes | The ID of the agent. The value must be 3 to 10 digits in length |
| Tel | string | yes | The phone number bound to the agent. For landlines, include the area code. For mobile phones, do not add a leading 0. For landlines with… |

### Deletes a time condition setting
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-delete-enterprise-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Id | integer | no | The time condition ID. You must specify either Id or Name. Both parameters cannot be empty at the same time |
| Name | string | no | The time condition name. You must specify either Id or Name. Both parameters cannot be empty at the same time |

### Deletes an extension by extension number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-delete-exten` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Exten | integer | yes | The extension number, which must be 3 to 11 digits in length |

### Deletes a queue
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-delete-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Qno | string | yes | The queue number |

### Removes a skill from a queue
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-delete-queue-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console… |
| Qno | string | yes | The queue number |
| SkillId | integer | yes | The skill ID |

### Deletes a skill
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-delete-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Id | integer | no | The skill ID. This parameter must be a positive integer. Either Id or Name must be specified, but they cannot both be empty. If both are… |
| Name | string | no | The skill name. Either Id or Name must be specified, but they cannot both be empty. If both are specified, Id takes precedence |

### Deletes predictive and automatic outbound call tasks. Only tasks in the initial or completed state can be…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-delete-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| TaskId | integer | yes | The ID of the outbound call task |

### Deletes phone numbers from a call task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-delete-task-tel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| TaskId | integer | yes | The task ID |
| FileId | integer | no | The batch ID |
| FileName | string | no | The batch name. If you delete by name, the most recently added batch is deleted |
| Status | integer | no | The phone number status. Valid values: 0: Not called. 1: Called |
| Tels | string | no | The phone numbers. Separate multiple numbers with commas (,). Numbers can be deleted even while the task is running. A maximum of 100,000… |

### Retrieves the details of a specific agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-get-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| Cno | string | yes | The agent work number. Queries the agent information corresponding to the specified work number |

### Retrieves the real-time status information of an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-get-agent-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Cno | string | yes | The agent number |

### Queries the attribution information of a phone number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-get-area-code` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| Tel | string | yes | The 11-digit mobile phone number. Only mobile phone numbers can be queried |

### Queries the task result of an ASR node and retrieves the data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-get-asr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| CallType | integer | yes | The call type. Valid values: 1: inbound call 2: web call 4: preview outbound call 5: predictive outbound call 6: caller outbound call 9:… |
| MainUniqueId | string | yes | The unique identifier of the main channel |
| All | string | no | Specifies whether to return conversation text from both sides sorted by beginTime. If this parameter is set to true, the conversation text… |

### Queries the information about a specified extension
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-get-exten` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Exten | string | yes | The extension number, which contains 3 to 11 digits |

### Queries the details of a specified agent's outbound call record based on the unique identifier of the call
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-get-ob-cdr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| UniqueId | string | yes | The unique identifier of the call, which corresponds to the uniqueId of the agent's outbound call record |

### Queries queue information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-get-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Qno | string | yes | The queue number |

### Call this operation to obtain a preview or download URL for a recording file based on its name
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-get-record-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| RecordType | string | no | The recording type. If you do not specify this parameter, the system automatically determines the type from the `RecordFile` name. Valid… |
| RecordFile | string | yes | The recording file name. Example: `7000101-20160815140025-01087120766-01087120766--record-sip-1-1471240825.87` |
| RecordFormat | integer | no | The recording file type. Valid values: `0` for MP3 (default) and `1` for WAV |
| CallType | integer | no | The call type. This parameter is required to retrieve `customer-side` or `agent-side` recordings when `separate-channel recording` is… |
| RecordSide | integer | no | Specifies the recording side for a `separate-channel recording`. This parameter is required to retrieve `customer-side` or `agent-side`… |
| Download | integer | no | Specifies whether to generate a download link. Set this to `1` for a download URL. If you set this to `0` or leave it empty, a preview URL… |

### Retrieves the configuration information of a specific task by task ID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-get-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| TaskId | integer | yes | The ID of the outbound call task |

### Imports phone numbers for an outbound call task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-import-task-tel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| Name | string | yes | The batch name |
| TaskId | integer | yes | The task ID |
| FileId | integer | no | The batch ID. If this parameter is specified, phone numbers are added to the existing batch |
| Priority | integer | no | The priority. Default value: 0. A larger value indicates a higher priority. Maximum value: 999999 |
| IsRepeat | integer | no | Specifies the deduplication mode. Default value: 1. Valid values: 0: no deduplication. 1: task-level deduplication. 2: imported number… |
| BridgeVoicePath | string | no | The voice variable value from the enterprise voice library. This value specifies the opening voice that is automatically played to both… |
| BridgeVoiceType | integer | no | The type of the opening voice that is automatically played to both parties when an agent answers the call. Default value: 3. Valid values:… |
| TaskTelList | string | yes | The list of task phone numbers. In CtiLinkTaskTel, only Tel is required. The maximum size is 8 MB. Note: To obtain import failure details,… |
| ImportTelAutoStart | integer | no | Specifies whether to automatically start the task. Default value: 0. Valid values: 0: Do not automatically start. 1: Automatically start |

### Interrupts the wait state of the current call if it is at a wait node in the interactive voice response…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-interrupt-ivr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| UniqueId | string | yes | The unique ID of the call and the channel |
| UserField | string | no | The custom field. The value is a JSON string |
| CheckName | string | no | The name of the variable used to retrieve the corresponding value from the channel variables |
| CheckValue | string | no | The expected value of the variable specified by CheckName. The wait state is interrupted only when the actual variable value matches this… |

### Queries a list of agent groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-agent-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Start | string | no | The index of the first entry to return. The value must be greater than or equal to `0`. The default value is `0` |
| Limit | string | no | The number of entries to return on each page. Valid values: `1` to `1000`. Default value: `10` |
| GroupName | string | no | The agent group name used to filter the query results |
| Gno | string | no | The agent group ID used to filter the query results |

### Retrieves agent phone information by agent work number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-agent-tel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console… |
| Cno | string | yes | The agent work number. The value must be 3 to 10 digits |
| Tel | string | no | The agent phone number |

### Queries the list of agents in a specified outbound call group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-assigned-agent-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console… |
| Gno | string | yes | The outbound call group number. The operation returns the list of agents bound to this group |
| Cno | string | no | The agent number used as a filter condition for the conditional query |
| Cname | string | no | The agent name used as a filter condition for the conditional query |

### Queries push logs of a user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-curl-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| Type | integer | no | The push type. Valid values: 1: inbound call push 2: inbound ringing push 3: outbound ringing push 4: webcall-to-agent ringing push 5:… |
| Result | integer | no | The push result. Valid values: 1: Succeeded. 0: Failed |
| Url | string | no | The push URL, which is the destination URL |
| StartTime | string | yes | The query start time. Format: "yyyy-MM-dd HH:mm:ss", accurate to seconds. StartTime and EndTime cannot span across months. Default value:… |
| EndTime | string | yes | The query end time. Format: "yyyy-MM-dd HH:mm:ss", accurate to seconds. StartTime and EndTime cannot span across months. Default value:… |
| Retry | integer | no | The number of retries. Default value: -2 |
| Start | string | no | The offset from which to start retrieving records. The value must be greater than or equal to 0. Default value: 0 |
| Limit | string | no | The number of records to retrieve. The value must be greater than 0 and cannot exceed 500. Default value: 10 |

### Queries the list of time condition settings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-enterprise-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Name | string | no | The name of the time condition. The name must be unique within the same call center |
| Type | integer | no | The type of the time condition. Valid values: 1: configured by day of the week. 2: configured by fixed time |
| Priority | integer | no | The priority of the time condition. The priority must be unique within the same call center. The value starts from 1. A smaller value… |

### Queries the list of extension information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-exten` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Exten | string | no | The extension number |
| CallPower | string | no | The call permission. Valid values: 0: No restriction. 1: Domestic long-distance calls. 2: Local calls. 3: Internal calls. Default value: 0 |
| IsOb | string | no | Specifies whether outbound calls are allowed. Valid values: 0: Not allowed. 1: Allowed. Default value: 1 |
| IbRecord | integer | no | Specifies whether inbound calls are recorded. Valid values: 0: Not recorded. 1: Recorded. Default value: 1 |
| ObRecord | integer | no | Specifies whether outbound calls are recorded. Valid values: 0: Not recorded. 1: Recorded. Default value: 1 |
| AreaCode | string | no | The area code |
| JitterBuffer | integer | no | The jitter buffer setting for network anti-jitter |
| Type | integer | no | The type of the extension. Valid values: 1: Registered to an IAD extension. 2: Registered to WebRTC. 3: Registered to a remote phone |
| IsBind | integer | no | Specifies whether the extension is bound to an agent. Valid values: 1: Bound. 0: Not bound |
| Limit | integer | no | The number of entries to return. The value must be a positive integer greater than 0 and less than or equal to 500. Default value: 10 |
| Offset | integer | no | The offset from which to start the query. The value must be a non-negative integer. Default value: 0 |

### Queries the list of online agents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-free-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |

### Queries the list of online agent information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-online-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| Qnos | string | no | The queue numbers. If you specify queue numbers, the monitoring information of the corresponding queues is returned. You can specify… |
| Cnos | string | no | The agent IDs. If you specify agent IDs, the monitoring information of the corresponding agents is returned. You can specify multiple… |
| StateCode | string | no | The agent status codes. You can specify multiple status codes separated by commas (,). Valid values: s1 (idle), s2 (busy), s3 (wrap-up),… |
| PauseType | string | no | The busy types used to filter monitoring data by agent busy type. You can specify multiple busy types separated by commas (,). If you do… |
| PauseDescription | string | no | The busy reasons used to filter monitoring data by agent busy reason. You can specify multiple busy reasons separated by commas (,). If… |

### Queries the list of queue information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-queue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Limit | integer | no | The number of entries to return. The value must be a positive integer greater than 0 and cannot exceed 500. Default value: 500 |
| Offset | integer | no | The start position of the query. The value must be a non-negative integer. Default value: 0 |
| Qno | string | no | The queue number |
| Description | string | no | The description |
| Order | integer | no | The sort order by creation time. Valid values: 0: ascending order. 1: descending order |
| StartTime | string | no | The start time of the creation time range. Example: "2019-10-11 00:00:00". Format: yyyy-MM-dd HH:mm:ss |
| EndTime | string | no | The end time of the creation time range. Example: "2019-10-11 23:59:59". Format: yyyy-MM-dd HH:mm:ss |

### Retrieves the skill information of a queue
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-queue-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console… |
| Qno | string | yes | The queue number |

### Queries the list of skills
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Name | string | no | The name of the skill |
| Comment | string | no | The description |
| Limit | string | no | The number of entries. Valid values: positive integers. Default value: 10. Maximum value: 500 |
| Offset | string | no | The starting entry. Valid values: positive integers. Default value: 0 |
| Order | integer | no | The sort order by creation time. Valid values: 0: ascending order. 1: descending order |

### Retrieves the list of call task batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-list-task-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| TaskId | integer | yes | The task ID |
| Status | integer | no | The batch status. Valid values: 0: not imported. 1: import completed. 2: loaded to cache. 3: calls completed |
| StartTime | string | no | The start time of the statistical period. Format: yyyy-MM-dd HH:mm:ss |
| EndTime | string | no | The end time of the statistical period. Format: yyyy-MM-dd HH:mm:ss. The maximum query range is one month |
| Start | integer | no | The query start position. The value must be greater than or equal to 0. Default value: 0 |
| Limit | integer | no | The number of records to query. Maximum value: 5000. Default value: 10 |

### Monitors a call task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-monitor-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| TaskId | integer | yes | The outbound call task ID |

### Retrieves report data for preview outbound call caller numbers
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-outbound-ob-clid-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| TimeRangeType | integer | yes | The time range type for the statistical report. Valid values: 1: daily report. 2: weekly report. 3: monthly report. 4: custom time range |
| StatisticMethod | integer | yes | The statistics method. Valid values: 0: by hour. 1: by day. 2: summary. 11: trunk group summary |
| AreaCodes | string | no | The area codes used to query preview outbound called number statistics for specified regions. Separate multiple area codes with commas… |
| StartTime | string | yes | The start time of the statistics date. Format: yyyy-MM-dd |
| EndTime | string | yes | The end time of the statistics date. Format: yyyy-MM-dd |
| StartHour | integer | no | The start hour of the statistics period. Valid values: 0 to 23. Default value: 0 |
| EndHour | integer | no | The end hour of the statistics period. Valid values: 0 to 23. Default value: 24 |
| Start | integer | no | The start position of the query. The value must be greater than or equal to 0. Default value: 0 |
| Limit | integer | no | The maximum number of entries to return. Maximum value: 1000. Default value: 10 |

### Retrieves the preview outbound call report
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-outbound-preview-ob-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| TimeRangeType | integer | yes | The statistics type that specifies the time range of the Statistical report. Valid values: 1: daily report. 2: weekly report. 3: monthly… |
| StatisticMethod | integer | yes | The statistics method. Valid values: 0: by hour. 1: by day. 2: summary |
| Cnos | string | yes | The agent IDs. Queries preview outbound call statistics for specified agents by agent ID. Separate multiple agent IDs with commas (,). By… |
| StartTime | string | yes | The start time of the statistics date range. Format: yyyy-MM-dd |
| EndTime | string | yes | The end time of the statistics date range. Format: yyyy-MM-dd |
| StartHour | integer | no | The start hour of the statistics period. Valid values: 0 to 23. Default value: 0 |
| EndHour | integer | no | The end hour of the statistics period. Valid values: 0 to 23. Default value: 24 |
| Start | integer | no | The start position of the query. The value must be greater than or equal to 0. Default value: 0 |
| Limit | integer | no | The maximum number of entries to return. Maximum value: 1000. Default value: 10 |

### Pauses a call task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-pause-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| TaskId | integer | yes | The ID of the outbound call task |
| PauseDuration | integer | no | The pause duration. Default value: 0 |

### Initiates an outbound call when the agent is online
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-previewoutcall` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| Cno | string | yes | The agent ID. The value is a 3- to 10-digit number |
| Tel | string | yes | The phone number of the customer to call. Include the area code for landline numbers. Do not add 0 before mobile numbers. When number… |
| Timeout | integer | no | The timeout period on the agent side, in seconds. Valid values: 5 to 60. Default value: 30 |
| DialTelTimeout | integer | no | The timeout period on the customer side, in seconds. Valid values: 5 to 60. Default value: 45 |
| CallVariables | string | no | The channel variables. Channel variables can be used in the following scenarios: 1. Event push: used as push fields. 2. Call records:… |
| RequestUniqueId | string | no | The unique ID of the request. If no value is passed in, the system generates one automatically. If the value is encrypted, URL-encode it… |
| BackupTels | string | no | The backup outbound numbers. When the primary number (Tel) fails to connect, the backup numbers are called. A maximum of five numbers are… |
| IsInvestigation | integer | no | Specifies whether to conduct a satisfaction survey. Valid values: 0: Do not conduct a satisfaction survey. 1: Conduct a satisfaction… |
| CdrIsAsr | integer | no | Specifies whether to perform automatic speech recognition (ASR) transcription on the call recording. Valid values: 0: Do not perform. 1:… |
| CrnId | string | no | The caller ID navigation identifier |
| ObClid | string | no | The enterprise trunk number or the preconfigured caller ID number displayed to the customer |
| ObClidAreaCode | string | no | The specified caller ID area code. Pass in an area code to display a caller ID number under the specified area code. If both ObClid and… |
| ObClidGroup | string | no | The caller ID number group displayed to the customer. To use ClidGroup, the account must support identifier-based routing. When this… |
| ClidList | string | no | The collection of caller ID numbers. Format example:… |

### Queries the detailed information list of agents
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-query-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Qno | string | no | The queue number. If this parameter is not empty, all agent records in the specified queue are queried |
| Cnos | string | no | Multiple agent numbers separated by commas. A maximum of 500 agents are supported |
| Start | integer | no | The start offset for the query. A positive integer greater than or equal to 0. Default value: 0 |
| Limit | integer | no | The number of records to query. A positive integer greater than 0. The maximum value is 1000. Default value: 10 |
| Active | integer | no | Specifies whether the agent is enabled. Valid values: 0: Disabled. 1: Enabled |
| Status | integer | no | Specifies whether the agent is online. Valid values: 0: Offline. 1: Online |
| Order | integer | no | The sort order based on creation time. Valid values: 0: ascending order. 1: descending order |
| WebrtcUrlType | integer | no | The type of the WebRTC softphone return address. Valid values: 0: enterprise default. 1: public domain name. 2: dedicated line domain… |
| StartTime | string | no | The start time of the creation time range. Example: "2019-10-11 00:00:00". Format: yyyy-MM-dd HH:mm:ss |
| EndTime | string | no | The end time of the creation time range. Example: "2019-10-11 23:59:59". Format: yyyy-MM-dd HH:mm:ss |
| ReturnQueue | integer | no | Specifies whether to return the queue information bound to the agent. Valid values: 0: Do not return. 1: Return. Default value: 1 |
| Name | string | no | The agent name used for searching. Fuzzy match is supported with both prefix and suffix |
| Comment | string | no | The agent comment used for searching. Prefix fuzzy match is supported |

### Retrieves agent IDs and names
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-query-agent-cno-and-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID |
| Cnos | string | no | A comma-separated list of up to 1,000 agent IDs. Example: 2000,20001 |

### Queries the information about the outbound call group to which an agent belongs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-query-agent-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Cno | string | yes | The agent ID |

### Queries agent skills by agent work number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-query-agent-skill` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console… |
| Cnos | string | yes | The agent work numbers. You can specify multiple work numbers separated by commas (,) |

### Queries inbound call records based on a conditional query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-query-ib-cdr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center. Before calling this operation, create a call center instance in the Cloud Contact Center console and obtain the… |
| UniqueId | string | no | The unique identifier of a call. If this parameter is not empty, all other parameters are ignored, and only the record matching this… |
| Status | integer | no | The call result. Parameter description: 1: answered by agent. 2: agent was called but did not answer. 3: answered by system. 4: not… |
| Province | string | no | The province to which the customer phone number belongs. Leave this parameter empty to query all provinces. Example: "Beijing". This… |
| City | string | no | The city to which the customer phone number belongs. Leave this parameter empty to query all cities. Example: "Chengdu". This parameter… |
| TimeRangeType | string | no | The type of time range to apply for the startTime and endTime parameters. This parameter takes effect only when both startTime and endTime… |
| StartTime | integer | no | The start time of the query. The value is a UNIX timestamp accurate to seconds. The startTime and endTime values must be within the same… |
| EndTime | integer | no | The end time of the query. The value is a UNIX timestamp accurate to seconds. The startTime and endTime values must be within the same… |
| Start | integer | no | The offset from which to start retrieving records. The value must be greater than or equal to 0. Default value: 0 |
| Limit | integer | no | The number of records to retrieve. The value must be greater than 0 and cannot exceed 1000. Default value: 10 |
| UserFieldkey | string | no | The key of a user-defined parameter for field-specific search. When this parameter is specified, userFieldValue must also be specified.… |
| UserFieldValue | string | no | The value of a user-defined parameter for field-specific search. When this parameter is specified, userFieldKey must also be specified.… |
| CustomerNumber | string | no | The phone number of the customer |
| Cno | string | no | The agent ID. You can specify multiple agent IDs separated by commas (,) |
| Qno | string | no | The queue number. Parameter description: -1: did not enter queue |
| LeaveQueueCode | integer | no | The reason for leaving the queue. Parameter description: 2: abandoned in queue. 3: timeout overflow in queue. 4: no agent available,… |
| JoinQueueCode | integer | no | The reason for not entering the queue. Parameter description: 4: no agent available, did not enter queue. 3: queue full, did not enter queue |
| CalleeNumber | string | no | The phone number of the agent |
| Hotline | string | no | The hotline number |

### Queries outbound call records of agents by using a conditional query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-query-ob-cdr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center. Before you call this operation, create a call center instance in the Cloud Call Center console and obtain the… |
| UniqueId | string | no | The unique ID of the call. If this parameter is not empty, other parameters become invalid, and only the record with the specified unique… |
| RequestUniqueId | string | no | The unique ID of the request. By default, records of the current month are queried. If the request unique ID does not belong to the… |
| CallType | integer | no | The call type. If this parameter is left empty, all call types are queried. Valid values: 4: preview outbound call 6: caller-initiated… |
| Status | integer | no | The call result. Parameter metric description: 30: the agent did not answer 31: the agent answered but did not call the customer 32: the… |
| Province | string | no | The province to which the customer's phone number belongs. If this parameter is left empty, all provinces are queried. Example: Sichuan.… |
| City | string | no | The city to which the customer's phone number belongs. If this parameter is left empty, all cities are queried. Example: Chengdu. This… |
| TimeRangeType | string | no | The time range type for the query. This parameter takes effect when StartTime and EndTime are not empty. Valid values: 1: call start time… |
| StartTime | integer | no | The start time of the query. The value is a UNIX timestamp accurate to seconds. The time range specified by StartTime and EndTime cannot… |
| EndTime | integer | no | The end time of the query. The value is a UNIX timestamp accurate to seconds. The time range specified by StartTime and EndTime cannot… |
| Start | integer | no | The starting index of the query. The value must be greater than or equal to 0. Default value: 0 |
| Limit | integer | no | The number of entries to return. The value must be greater than 0 and cannot exceed 1000. Default value: 10 |
| UserFieldkey | string | no | The key of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldValue. Only one field… |
| UserFieldValue | string | no | The value of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldkey. Only one field… |
| CustomerNumber | string | no | The customer phone number. You can specify one or more customer phone numbers. Separate multiple numbers with commas (,). You can specify… |
| Cno | string | no | The agent ID. An agent ID must be 3 to 10 characters in length. You can specify one or more agent IDs. Separate multiple IDs with commas… |
| Gno | string | no | The ID of the outbound call group to which the agent belongs. A group ID must be 2 to 20 characters in length. You can specify one or more… |
| AgentNumber | string | no | The agent number |
| AgentName | string | no | The name of the agent |
| Clid | string | no | The filter condition for the caller ID displayed to the customer |
| LeftDisplayNumber | string | no | The filter condition for the actual caller ID displayed to the customer. When a service instance is used for AXB outbound calls and the… |
| Order | integer | no | The sort order. Valid values: 0: sort by record creation time in ascending order 1: sort by record creation time in descending order 2:… |
| ReturnCount | integer | no | Specifies whether to return the total number of records. Valid values: 0: do not return the total count 1: return the total count Default… |
| DownGrade | integer | no | Specifies whether the call is downgraded. Valid values: 0: no 1: yes |
| IsRealAnswer | integer | no | Specifies whether the call is answered by a real person. Valid values: 1: yes 0: no |

### Queries predictive outbound call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-query-predictive-call-cdr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| TaskId | integer | no | The ID of the outbound call task |
| TaskFileId | integer | no | The ID of the batch |
| UniqueId | string | no | The unique identifier of the phone call. If this parameter is specified, other parameters are ignored and only the record with this unique… |
| RequestUniqueId | string | no | The unique ID of the request. By default, records of the current month are queried. If the request unique ID does not belong to the… |
| CustomerNumber | string | no | The customer phone number. Example: 18012345678 |
| Cno | string | no | The agent ID, which must be 3 to 10 digits in length |
| Gno | string | no | The outbound call group to which the agent belongs. A single group ID must be 2 to 20 characters in length. You can specify one or more… |
| Clid | string | no | The displayed caller ID number |
| DisplayNumber | string | no | The actual caller ID number displayed to the customer. When the AXB scenario is used for outbound calls, the actual caller ID number… |
| DownGrade | integer | no | Specifies whether the call is downgraded. Valid values: 0 (no) and 1 (yes) |
| Status | integer | no | The call result parameter. The metric description is as follows: 40 (predictive outbound call, customer did not answer), 41 (predictive… |
| Province | string | no | The province to which the customer phone number belongs. If this parameter is empty, all provinces are queried. Example: Sichuan. This… |
| City | string | no | The city to which the customer phone number belongs. If this parameter is empty, all cities are queried. Example: Chengdu. This parameter… |
| AgentName | string | no | The name of the agent |
| TimeRangeType | string | no | The effective type of the start and end time range for the query. This parameter takes effect when startTime and endTime are specified.… |
| StartTime | integer | no | The start time of the query. The value must be a UNIX timestamp accurate to seconds. The time range specified by startTime and endTime… |
| EndTime | integer | no | The end time of the query. The value must be a UNIX timestamp accurate to seconds. The time range specified by startTime and endTime… |
| Start | integer | no | The starting entry number for the query. The value must be greater than or equal to 0. Default value: 0 |
| Limit | integer | no | The number of entries to return. The value must be greater than 0 and cannot exceed 1000. Default value: 10 |
| UserFieldkey | string | no | The key of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldValue. Only one field… |
| UserFieldValue | string | no | The value of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldkey. Only one field… |
| IsRealAnswer | integer | no | Specifies whether the call is answered by a real person. Valid values: 1 (yes) and 0 (no) |

### Retrieves RASR information by uniqueId
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-query-rasr-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Artificial Intelligence Cloud Call Service console… |
| UniqueId | string | yes | The unique identifier of the call |

### Queries a list of call nodes. Supports conditional query
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-query-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Type | integer | yes | The task type. Valid values: 1: predictive outbound call task. 2: automatic outbound call task |
| Name | string | no | The task name. The value must be URL-encoded in UTF-8 format |
| Status | integer | no | The task status. Valid values: 0: initial. 1: running. 2: paused. 3: ended |
| AutoStart | integer | no | Specifies whether scheduled start is enabled. Valid values: 0: disabled. 1: enabled |
| AutoStop | integer | no | Specifies whether scheduled stop is enabled. Valid values: 0: disabled. 1: enabled |
| TimeType | integer | no | The time filter condition. Valid values: 1: task start time. 2: task end time. 3: task creation time |
| StartTime | string | no | The start time of the query. Format: "2019-10-11 00:00:00" |
| EndTime | string | no | The end time of the query. Format: "2019-10-11 23:59:59" |
| Start | integer | no | The offset from which to start fetching data. The value must be greater than or equal to 0. Default value: 0 |
| Limit | integer | no | The number of records to fetch. The value must be greater than 0 and cannot exceed 100. Default value: 10 |

### Queries WebCall call records
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-query-webcall-cdr` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, you must create a call center instance in the Cloud Call Center console and obtain the… |
| UniqueId | string | no | The unique ID of the call. If this parameter is not empty, other parameters are invalid, and only the record with the specified unique ID… |
| RequestUniqueId | string | no | The unique ID of the request. By default, records of the current month are queried. If the request unique ID does not belong to the… |
| Status | integer | no | The call result. Metric description of the parameter. Valid values: 20: WebCall, TTS synthesis failed. 21: WebCall, customer did not… |
| Province | string | no | The province to which the customer's phone number belongs. If this parameter is empty, all provinces are queried. Example: Sichuan. This… |
| City | string | no | The city to which the customer's phone number belongs. If this parameter is empty, all cities are queried. Example: Chengdu. This… |
| TimeRangeType | string | no | The effective type of the start and end time range for the query. This parameter takes effect when StartTime and EndTime are not empty.… |
| StartTime | integer | no | The start time of the query. The value must be a UNIX timestamp accurate to seconds. StartTime and EndTime cannot span across months. The… |
| EndTime | integer | no | The end time of the query. The value must be a UNIX timestamp accurate to seconds. StartTime and EndTime cannot span across months. The… |
| Start | integer | no | The starting index of the records to return. The value must be greater than or equal to 0. Default value: 0 |
| Limit | integer | no | The number of records to return. The value must be greater than 0 and cannot exceed 1000. Default value: 10 |
| UserFieldkey | string | no | The key of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldValue. Only one field… |
| UserFieldValue | string | no | The value of the custom user parameter for the query. If you specify this parameter, you must also specify UserFieldkey. Only one field… |
| CustomerNumber | string | no | The phone number of the customer |
| Cno | string | no | The ID of the agent |
| Gno | string | no | The outbound call group to which the agent belongs. A single outbound call group ID must be 2 to 20 characters in length. You can query… |
| CalleeNumber | string | no | The phone number of the agent |
| DisplayNumber | string | no | The actual caller ID number. When the AXB scenario is used for outbound calls, the actual caller ID number is the service instance |
| CalleeDisplayNumber | string | no | The actual display number for the second party |
| Clid | string | no | The caller ID number |
| CalleeClid | string | no | The caller ID number for the second party |
| ReturnCount | integer | no | Specifies whether to return the total number of records. Valid values: 0: Do not return. 1: Return. Default value: 1 |
| IsRealAnswer | integer | no | Specifies whether the call was answered by a human. Valid values: 1: Yes. 0: No |

### Manually starts an outbound call task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-start-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center instance. Before calling this operation, create a call center instance in the Cloud Contact Center console and… |
| TaskId | integer | yes | The ID of the outbound call task. Call CloudCreateTask first to create an outbound call task under the same EnterpriseId, and use the task… |

### Clears the bindng relationship between an outbound call group and an agent
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-unassign-agent-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The call center ID. Before calling this operation, create a call center instance in the Cloud Call Center console and obtain the instance… |
| Gno | string | yes | The outbound call group number. This operation dissociates the outbound call group corresponding to this Gno from the agent corresponding… |
| Cno | string | yes | The agent number. This operation dissociates the agent corresponding to this Cno from the outbound call group corresponding to the Gno |

### Update the agent's basic information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-update-agent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Cno | string | yes | The agent ID. The value must be a positive integer with 3 to 10 digits |
| Name | string | no | The agent's name, which must be URL-encoded in UTF-8 |
| AreaCode | string | no | The agent's area code |
| Active | integer | no | Specifies whether to activate the agent. Valid values: `0`: Inactive. `1`: Active. The default value is `1` |
| AgentType | integer | no | The agent type. Valid values: `1`: Phone agent. `2`: PC-based agent. The default value is `1` |
| Power | integer | no | The agent's role. Valid values: `1`: Supervisor. `0`: Standard agent. The default value is `0` |
| CallPower | integer | no | The call permissions. Valid values: `0`: Unrestricted. `1`: Domestic long-distance. `2`: Local city. `3`: Internal calls. The default… |
| Wrapup | integer | no | The wrap-up time, in seconds. The default value is 10 |
| IsOb | integer | no | Specifies whether outbound calls are allowed. Valid values: `0`: Not allowed. `1`: Allowed. The default value is `1` |
| ObClidType | integer | no | The outbound caller ID rule. Valid values: `1`: Default. `2`: Random. `3`: By area code. `4`: Dynamic. The default value is `1` |
| ObClid | string | no | The pass-through number. This can be a corporate trunk number or a pre-configured outbound caller ID. This parameter is required when… |
| IsRandom | string | no | Specifies whether to use a random outbound caller ID. Valid values: `0`: No. `1`: Yes. This parameter is required when `ObClidType` is set… |
| ObClidProperty | string | no | The properties of the outbound caller ID. Example: {"isMatchCapital":0,"areaCodeRule":1}. When ObClidType is `4`, isMatchCapital specifies… |
| IbRecord | integer | no | Specifies whether to record inbound calls. Valid values: `0`: Do not record. `1`: Record. The default value is `1` |
| ObRecord | integer | no | Specifies whether to record outbound calls. Valid values: `0`: Do not record. `1`: Record. The default value is `1` |
| SkillIds | string | no | A comma-separated list of skill IDs to assign to the agent. Example: "1,2,3". To remove all skills from the agent, set this value to "0".… |
| SkillLevels | string | no | A comma-separated list of levels for the skills specified in `SkillIds`. The order of levels must match the order of IDs. A smaller value… |
| IsAsr | integer | no | Specifies whether to enable ASR transcription. Valid values: `0`: Disable. `1`: Enable. The default value is `0` |
| IsQualityCheck | integer | no | Specifies whether to enable agent quality check. Valid values: `0`: Disable. `1`: Enable. The default value is `1` |
| WebrtcUrlType | integer | no | The URL type returned for the WebRTC softphone. Valid values: `0`: Corporate default. `1`: Public domain name. `2`: Leased line domain… |
| IsObRemember | string | no | Specifies whether to enable outbound caller ID memory. Valid values: `0`: Disable. `1`: Enable. The default value is `1` |
| Comment | string | no | A comment or description for the agent |
| PermitObPreviewTime | string | no | The time range during which outbound calls are permitted. Format: `HH:mm,HH:mm` |

### Modifies the basic information of an outbound call task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-update-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| TaskId | string | yes | The ID of the outbound call task |
| Name | string | no | The task name. The value must be URL-encoded in UTF-8 format and cannot exceed 50 characters in length |
| Description | string | no | The task description. The value must be URL-encoded in UTF-8 format and cannot exceed 200 characters in length |
| AutoStart | integer | no | Specifies whether to enable scheduled start. Valid values: 0: Disabled. 1: Enabled. Default value: 0. When the value is 1, the… |
| AutoStartDay | string | no | The scheduled start date. This parameter takes effect only when autoStart is set to 1. If this parameter is not specified, the task starts… |
| AutoStartTime | string | no | The scheduled start time. This parameter takes effect only when autoStart is set to 1. If this parameter is not specified, the task starts… |
| AutoStop | integer | no | Specifies whether to enable scheduled stop. Valid values: 0: Disabled. 1: Enabled. Default value: 0. When the value is 1, the autoStopDay… |
| AutoStopDay | string | no | The scheduled stop date. This parameter takes effect only when autoStop is set to 1. If this parameter is not specified, the task stops at… |
| AutoStopTime | string | no | The scheduled stop time. This parameter takes effect only when autoStop is set to 1. If this parameter is not specified, the task stops at… |
| ForceEndFlag | integer | no | Specifies whether to forcibly end the task at the scheduled stop time. This parameter takes effect only when autoStop is set to 1. Valid… |
| AutoTaskType | integer | no | The auto task type. Valid values: 0: Continuous calling. 1: Interval calling. Default value: 0. Use this parameter together with the… |
| AutoTriggerTimeStrategy | string | no | The interval calling time periods. This parameter is required when autoTaskType is set to 1. Specifies the time period configuration for… |
| AutoComplete | integer | no | Specifies whether to enable auto complete. Valid values: 0: Disabled. After all numbers in the task are called, the task is automatically… |
| RetryStrategy | string | no | The retry policy. Basic pattern: The data structure is in JSON format.… |
| RetryStrategyTimeType | integer | no | The time type for the retry strategy. This parameter takes effect when a retry strategy is configured. Valid values: 1: Based on the first… |
| RetryStrategyOnlyToday | integer | no | Specifies whether the task is effective only on the current day. Valid values: 0: Disabled. 1: Enabled. Deletes both pending retry data… |
| CallPriorityStrategy | string | no | The call priority strategy. The data structure is in JSON format. ```{"strategy":[{"sort":1,"type":"retryCall",… |
| CustomerClidsCategory | integer | no | The type of the caller ID displayed to the customer. Valid values: 1: landline number. 2: mobile number. 4: number pool. 5: caller ID… |
| CustomerClids | string | no | The list of caller IDs displayed to the customer. This parameter is required when customerClidsCategory is set to 1 or 2. Multiple values… |
| CustomerClidType | integer | no | The caller ID selection rule for the customer side. This parameter takes effect when customerClidsCategory is set to 1 or 2. Valid values:… |
| ClidProperty | string | no | The caller ID selection rule. This parameter takes effect when customerClidType is set to 2. The value is in JSON format and specifies the… |
| CustomerClidWeightFlag | integer | no | Specifies whether to enable the caller ID weight configuration. This parameter takes effect when customerClidsCategory is set to 1. Valid… |
| CustomerClidWeight | string | no | The caller ID weight configuration. This parameter takes effect when customerClidsCategory is set to 1 and customerClidWeightFlag is set… |
| CustomerClidsGroup | string | no | The name of the customer-side number pool or the caller ID routing identifier. This parameter is required when customerClidsCategory is… |
| CustomerTimeout | integer | no | The customer timeout period, in seconds. Default value: 30. Valid values: 5 to 60 |
| CallRouteStrategy | integer | no | The call routing strategy. Valid values: 1: Direct agent connection. After the customer answers, an agent is directly assigned. If no idle… |
| IvrId | integer | no | The ID of the IVR. Specify either the ivrId or ivrName parameter. If both are specified, ivrId takes precedence. When creating an… |
| IvrName | string | no | The name of the IVR. Specify either ivrId or ivrName. If both are specified, ivrId takes precedence. When creating an automatic outbound… |
| Concurrency | integer | no | The maximum number of concurrent calls at the task level. The actual concurrency does not exceed this limit. When type is set to 1, a… |
| UserFields | string | no | The task custom fields. The value is in JSON array format. Each element in the array supports only one key-value pair. If multiple pairs… |
| CallVariables | string | no | The agent channel variables. The value is in JSON array format. A maximum of 5 variables are supported. Default value: empty. Example:… |
| TimeStrategy | string | no | The call prohibition time periods during which calls are not allowed. Format: time condition IDs. Multiple IDs are supported and separated… |
| Cnos | string | no | The list of agent IDs. This parameter is required when callGroupType is set to 1. Multiple agent IDs are supported and separated by commas… |
| AgentGroup | string | no | The ID of the outbound call group. This parameter is required when callGroupType is set to 2. Note: An outbound call group can be bound to… |
| CallStrategy | string | no | The agent allocation rule. Valid values: 1: Random. 2: Sequential. 3: Longest idle since last call (the total duration from the end of the… |
| AgentTimeout | integer | no | The agent timeout period, in seconds. Default value: 10. Valid values: 5 to 60 |
| Wrapup | integer | no | The agent wrap-up time. Default value: 30 seconds. Valid values: 1 to 10800. The wrap-up time affects the number of calls per round. A… |
| MaxWaitTime | integer | no | The maximum agent wait time. Default value: 40 seconds. Minimum value: 10. Maximum value: 600. The maximum idle time allowed for agents.… |
| MinAvailableAgentCount | integer | no | The minimum number of available agents. Default value: 10. Valid values: 1 to 10. If the number of available agents in the task is less… |
| Quotiety | number | no | The harassment rate. Default value: 1. Valid values: greater than 0 and less than or equal to 20. Decimal values are supported with up to… |
| PredictAdjust | integer | no | The over-dial rate. Default value: 100. Valid values: 50 to 400 |
| CallLimitStrategy | string | no | The maximum number of calls an agent can answer per day. For more information, see the description below. JsonArray format:… |
| CustomerMoh | string | no | The customer-side hold music. The audio played to the customer while waiting for an agent to answer after the customer picks up. Default… |
| CustomerVoice | string | no | The customer-side prompt tone. The audio played to the customer after the customer picks up and before the call is transferred to an… |
| AnswerRate | integer | no | The initial estimated customer answer rate. Default value: 50. Valid values: 1 to 100. During the warm-up phase, the call frequency is… |
| WarmUpDuration | integer | no | The task warm-up duration. Default value: 300 seconds. Valid values: 60 to 600 |
| IsRewarm | integer | no | Specifies whether to re-warm-up after the task is paused. Valid values: 0 (disabled) and 1 (enabled). Default value: 1 (enabled) |

### This API operation lets a third-party platform send a call request to a hosted call center. The system calls…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/cloud-webcall` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| EnterpriseId | integer | yes | The ID of the call center |
| Tel | string | yes | The phone number. For landlines, include the area code. For mobile numbers, do not add the `0` prefix. For landlines with an extension,… |
| RequestUniqueId | string | no | A unique request ID, up to 300 bytes long. The system saves this ID to the `requestUniqueId` field in the call record, which you can use… |
| UserField | string | no | A user-defined field, up to 250 bytes long. This value is saved to the `userField` in the call record for later queries. This parameter… |
| Timeout | integer | no | The timeout for the customer call, in seconds. The value must be between 0 and 60, inclusive. The default is 30 |
| Amd | integer | no | Specifies whether to enable answering machine detection (AMD). Valid values: `1` (enable) and `0` (disable). The default is `0` |
| Delay | integer | no | The call initiation delay, in seconds. The value must be between 0 and 60, inclusive. The default is 0 |
| MultiTelDelay | integer | no | The delay, in seconds, between call attempts when `Tel` contains multiple numbers. The maximum value is 120. The default is 0 |
| MultiTelPush | integer | no | When calling multiple numbers, this parameter specifies whether to send a hang-up notification for each call attempt. Valid values: `0`… |
| Clid | string | no | The caller ID to display to the recipient. You can use an enterprise trunk number or a pre-configured caller ID |
| ClidGroup | string | no | To use this parameter, your account must support identifier-based routing. This parameter has a lower priority than `Clid` |
| ClidList | string | no | Specifies a set of caller IDs for the outbound call. The system selects an available number from this set based on the number scheduling… |
| ClidAreaCode | string | no | A caller ID from a specific region. This parameter has a lower priority than `Clid` |
| IvrId | integer | no | The ID of the IVR flow to enter after the call connects. If you do not specify this parameter, the system uses the IVR flow configured in… |
| CrnId | string | no | The caller ID navigation identifier |
| Vid | string | no | The language of the IVR prompt. Valid values: `1` (Mandarin), `2` (Cantonese), `4` (Biaobei TTS), and `5` (Mandarin - sweet female voice).… |
| Retry | integer | no | The number of retries. The maximum value is 5. To use this parameter, you must enable the webcall auto-retry feature for your enterprise… |
| RetryInterval | integer | no | The retry interval, in minutes. The value must be between 0 and 59, inclusive |
| ExpirTime | string | no | The request's expiration time, accurate to the second. Format: `YYYY-MM-DD HH:mm:ss` |

### Creates text-to-speech tasks, voice notification tasks, and voice verification code tasks for multiple…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/create-call-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| TaskName | string | no | The name of the call task |
| BizType | string | no | The templatetype of the voice template. Valid values: VMS_VOICE_TTS: text-to-speech template for voice notifications. VMS_VOICE_CODE:… |
| TemplateCode | string | no | The template code. Valid values: For a text-to-speech template for voice notifications, obtain the Template ID on the Text-to-Speech… |
| TemplateName | string | no | The template name. Valid values: For a text-to-speech template for voice notifications, obtain the Template Name on the Text-to-Speech… |
| ResourceType | string | no | The type of the calling number. Fixed value: LIST |
| Resource | string | no | The calling number. Specify the service instance ID. Only service instances with bound real numbers are supported. Call tasks cannot be… |
| DataType | string | no | The type of the called number. Valid values: LIST: the LIST format, which is used for text-to-speech templates or voice files without… |
| Data | string | no | The called numbers or called data that contains variable parameter values. If DataType is set to LIST, specify called numbers separated by… |
| FireTime | string | no | This parameter is not available |
| StopTime | string | no | This parameter is not available |
| ScheduleType | string | no | This parameter is not available |

### Initiates an outbound call task for an intelligent voice robot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/create-robot-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| TaskName | string | yes | The task name. Chinese and English characters are supported. The name cannot exceed 30 characters in length |
| DialogId | integer | yes | The robot ID, which is the script ID. This parameter specifies which robot script to use for initiating the call. You can log on to the… |
| CorpName | string | no | The company name. The name must be exactly the same as the Enterprise Name on the qualification management page |
| Caller | string | yes | The calling number for outbound calls. The number must be a purchased number. Separate multiple numbers with commas (,). You can log on to… |
| NumberStatusIdent | string | yes | Specifies whether to enable number status (early media) identification. Valid values: false (default): Disabled. true: Enabled. If this… |
| RetryType | integer | yes | Specifies whether to enable automatic redial. Valid values: 1: Enable redial. 0: Disable redial |
| RecallStateCodes | string | no | The call states that require a redial. Separate multiple states with commas (,). Valid values: 200010: powered off. 200011: out of… |
| RecallTimes | integer | no | The number of redial attempts |
| RecallInterval | integer | no | The redial interval. Unit: minutes. The value must be greater than 1. The maximum interval is 30 minutes |
| IsSelfLine | string | no | Specifies whether to use your own line. Valid values: false (default): Do not use your own line. true: Use your own line. If this… |

### Downgrades a video call to a voice call
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/degrade-video-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| CallId | string | no | The call ID. You can obtain the CallId from the response parameters of the SingleCallByVideo… |
| MediaType | string | no | The media type. Set the value to video |
| OutId | string | no | The ID reserved for the caller. This ID is returned to the caller in the receipt message. The value is a string that is 1 to 15 bytes in… |
| CalledNumber | string | yes | The phone number that receives the voice notification |

### Deletes a robocall task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/delete-robot-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| TaskId | integer | yes | The unique ID of the robocall task. You can call the [CreateRobotTask](~~CreateRobotTask~~) operation to obtain the task ID |

### Executes a call task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/execute-call-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| TaskId | integer | yes | The task ID. You can call the [CreateCallTask](~~CreateCallTask~~) operation to obtain the task ID |
| Status | string | yes | The task state. Valid values: RUNNING STOP CANCEL |
| FireTime | string | no | The time when the call task is executed, in the yyyy-MM-dd HH:mm:ss format. You can leave this parameter empty |

### You can obtain the call type during a call
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/get-call-media-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| CallId | string | no | Call ID. You can get this value from the response of the SingleCallByVideo… |
| CalledNumber | string | yes | Mobile phone number used in the call |

### Retrieves the qualification ID of a 400 number by the qualification application ticket number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/get-hotline-qualification-by-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| OrderId | string | yes | The ticket number. You can view the ticket number on the 400 Qualification page in the Voice Messaging console… |

### Obtains a temporary URL for a video or audio file to allow immediate viewing
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/get-temporary-file-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| VideoId | string | yes | The ID of the audio or video file. You can find this ID on the Voice Files (https://dyvms.console.aliyun.com/files/list/voiceFiles) or… |

### Obtains the token for authentication
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/get-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| TokenType | string | no | The token type |

### Initiates an interactive voice response (IVR) call to a specified number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/ivr-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| CalledShowNumber | string | yes | The calling number. The value must be a number you purchased. Each request supports only one calling number. In most cases, a calling… |
| CalledNumber | string | yes | The called number. Only phone numbers in the Chinese mainland are supported. Each request supports only one called number |
| StartCode | string | yes | The voice that is played when the call begins. If you use a voice notification file, this parameter specifies the voice ID. You can log on… |
| StartTtsParams | string | no | The variables in the TTS template, in the JSON format. This parameter is required when the StartCode parameter is set to the ID of a TTS… |
| PlayTimes | integer | no | The number of replay times. Valid values: 1 to 3 |
| ByeCode | string | no | The end voice. If you use a voice notification file, this parameter specifies the voice ID. You can log on to the Voice Messaging Service… |
| ByeTtsParams | string | no | The variables in the TTS template, in the JSON format. This parameter is required when the ByeCode parameter is set to the ID of a TTS… |
| Timeout | integer | no | The timeout period for the subscriber to press a key. Unit: milliseconds |
| OutId | string | no | The ID that is reserved for the caller of the operation. This ID is returned to the caller in a receipt message. The value is of the… |
| MenuKeyMap | string | no | The information about the key pressed by the subscriber (JSON-encoded) |

### Queries the status of voice call tasks, including the task ID, current task status, and template information…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/list-call-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| PageNumber | integer | no | The current page number. Default value: 1 |
| PageSize | integer | no | The number of tasks to display per page. Default value: 10 |
| TemplateName | string | no | The template name. If the template is a text-to-speech template for voice notifications, you can obtain the Template Name on the… |
| Status | string | no | Create task status. Valid values: INIT: Create task is created but not started. RELEASE: Create task is being parsed. RUNNING: Create task… |
| TaskName | string | no | The task name. You can view the task name on the Task Center page in the Voice Messaging Service console… |
| TaskId | string | no | The task ID. You can obtain the task ID by calling the CreateCallTask… |
| BizType | string | no | The node templatetype. Valid values: VMS_VOICE_TTS: text-to-speech template for voice notifications. VMS_VOICE_CODE: voice file template… |

### Queries the details of a specified call task by task ID after the call task is complete
`POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/list-call-task-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://dyvmsapi.aliyuncs.com |
| TaskId | integer | yes | The task ID. Obtain the task ID by calling the CreateCallTask… |
| CalledNum | string | no | The called number |
| Status | string | no | The task status. Valid values: SUCCESS: The outbound call succeeded. FAIL: The outbound call failed. INIT: The outbound call has not started |
| PageNumber | integer | no | The current page number. Default value: 1 |
| PageSize | integer | no | The number of tasks to display on each page. Default value: 10 |

…and 36 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/add-virtual-number-relation" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Voice Messaging Service API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-dyvmsapi/add-virtual-number-relation with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Voice Messaging Service 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-dyvmsapi.

### What is the status of the Alibaba Cloud Voice Messaging Service API?
Needs your own provider key (bring your own key)