# Alibaba Cloud Outbound Bot API

> Alibaba Cloud Outbound Bot API on Apizie: 176 endpoints (Creates outbound call jobs in batches, Asynchronously creates outbound jobs, Cancels jobs that are pending or in progress. This operation cannot cancel jobs that are already in a call, Changes the resource group, …) 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-outboundbot/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

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

Alibaba Cloud OpenAPI for Outbound Bot (outboundbot, version 2019-12-26). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Creates outbound call jobs in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/assign-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| JobGroupId | string | yes | The job group ID |
| StrategyJson | string | no | The execution strategy for the job group. `repeatBy`: The recurrence type. Valid values: `Once` (runs once), `Day` (repeats daily), `Week`… |
| RosterType | string | no | The roster type. If you create jobs by calling this API, you can omit this parameter. The default value is `json`. If you upload a contact… |
| JobDataParsingTaskId | string | no | The ID of the data parsing task for the outbound call job. You can omit this parameter if you create jobs by calling this API. If you… |
| IsAsynchrony | string | no | Specifies whether the task is asynchronous. You can omit this parameter if you create jobs by calling this API. The default value is `false` |
| CallingNumber | string | no | These numbers are displayed as the caller ID to the contact. If unspecified, all available calling numbers are used (JSON-encoded) |
| JobsJson | string | no | This parameter is required. The job data, a JSON array where each object represents a contact. For formatting details, see the example.… |

### Asynchronously creates outbound jobs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/assign-jobs-async` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| JobGroupId | string | yes | The ID of the job group |
| StrategyJson | string | no | A JSON string that defines the job group execution strategy. This object has the following properties: `repeatBy` Specifies the repetition… |
| CallingNumber | string | no | The list of calling numbers to be displayed to callees. If you omit this parameter, the system uses all available calling numbers by… |
| JobsJson | string | no | A JSON array containing job data. For the required format, see the example. Each JSON object in the array represents a job for a single… |

### Cancels jobs that are pending or in progress. This operation cannot cancel jobs that are already in a call
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/cancel-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| All | string | yes | Specifies whether to cancel all jobs |
| ScenarioId | string | no | A filter condition. The scenario ID. Obtain this ID by calling the DescribeJobGroup operation |
| JobGroupId | string | no | A filter condition. The task group ID |
| JobId | string | no | A filter condition. The job ID. The JobId parameter is required when the All parameter is set to false (JSON-encoded) |
| JobReferenceId | string | no | A filter condition. The reference ID of the job. This is the ReferenceId that you specified when you uploaded the contact list… |

### Changes the resource group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/change-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| ResourceId | string | yes | The resource group ID |
| NewResourceGroupId | string | yes | The new resource group ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| PromptJson | string | no | The agent configuration in normal mode |
| Prompt | string | no | The agent configuration in professional mode |
| AgentProfileTemplateId | string | yes | The agent profile template ID (unique value) |
| Model | string | yes | The model ID (unique value) |
| ModelConfig | string | no | [Deprecated] The model configuration |
| ScriptId | string | yes | The scenario ID |
| LabelsJson | string | no | The label descriptions |
| VariablesJson | string | no | The variable configuration |
| Scenario | string | no | The scenario |
| Description | string | no | The description |
| AppIp | string | no | The app_ip (system field). This parameter is optional |
| InstructionJson | string | no | The instruction configuration |
| FaqCategoryIds | string | no | The FAQ category IDs |

### Creates an annotation task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-annotation-mission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| AnnotationMissionDataSourceType | integer | no | The data type of the annotation task. 1: outbound call |
| ScriptId | string | no | The outbound call scenario ID |
| InstanceId | string | no | The instance ID |
| Finished | string | no | Specifies whether the business ended normally. This parameter takes effect only when SessionEndReasonFilterList is not specified. true:… |
| SessionEndReasonFilterList | string | no | The call result status filter conditions. This parameter has the same function as SessionEndReasonFilterListJsonString. Specify either one… |
| SessionEndReasonFilterListJsonString | string | no | The call result status filter conditions. This parameter has the same function as SessionEndReasonFilterList. Specify either one of them.… |
| ExcludeOtherSession | string | no | Specifies whether to exclude call records that have been annotated by other tasks. Default value: false |
| ConversationTimeStartFilter | integer | no | The start time for the call time filter |
| ConversationTimeEndFilter | integer | no | The end time for the call time filter |
| SamplingType | integer | no | The sampling type. 1: full 2: percentage 3: custom quantity |
| SamplingRate | integer | no | The sampling ratio. This parameter takes effect only when SamplingType is set to 2. This parameter is required in that case. Otherwise,… |
| SamplingCount | integer | no | The custom sampling quantity. This parameter takes effect only when SamplingType is set to 3. This parameter is required in that case.… |
| AnnotationMissionName | string | no | The name of the annotation task |
| AnnotationMissionDebugDataSourceList | string | no | The annotation data source list. This parameter has the same function as AnnotationMissionDebugDataSourceListJsonString. Specify either… |
| AnnotationMissionDebugDataSourceListJsonString | string | no | The debug data in JSON format. This parameter has the same function as AnnotationMissionDebugDataSourceList. Specify either one of them.… |
| ChatbotId | string | no | The robot ID. You can obtain this value from the DescribeScript operation |
| AgentId | string | no | The agent ID. You can obtain this value from the DescribeInstance operation |
| AgentKey | string | no | The business space key. You can obtain this value from the DescribeInstance operation |

### [Deprecated] Creates outbound jobs in batches
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-batch-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| BatchJobName | string | yes | The name of the batch job |
| BatchJobDescription | string | no | The description of the batch job |
| ScenarioId | string | no | The scenario ID |
| ScriptId | string | no | The script ID |
| StrategyJson | string | no | The JSON string of the job execution strategy. This parameter is required |
| JobFilePath | string | no | The URL to download the Excel file for the batch job. You can obtain this parameter from the Folder response parameter of the… |
| Submitted | string | yes | Specifies whether the job is submitted. Valid values: true: The job is saved as a draft. false: The job is submitted |
| CallingNumber | string | no | The list of calling numbers (JSON-encoded) |

### Copy an existing task group to reinitiate an outbound task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-batch-repeat-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| Name | string | yes | Job name |
| Description | string | no | Job group description |
| ScriptId | string | no | Script ID |
| SourceGroupId | string | yes | Job group ID |
| FilterStatus | string | no | Job group status |
| StrategyJson | string | no | Job execution policy |
| RecallStrategyJson | string | no | Redial policy JSON |
| CallingNumber | string | no | Calling number (JSON-encoded) |
| RingingDuration | integer | no | Ringing duration |
| Priority | string | no | Job priority |
| MinConcurrency | integer | no | Minimum concurrency |
| FlashSmsExtras | string | no | Configuration parameters for flash SMS push, in JSON format, including configuration information for third-party flash SMS. Template ID:… |
| RecallCallingNumber | string | no | Redial calling number list (JSON-encoded) |

### Creates an intent for a small-model scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-beebot-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The scenario ID |
| IntentDefinition | string | yes | The description of the intent (JSON-encoded) |

### Creates a user utterance template for an intent in a small model scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-beebot-intent-lgf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The scenario ID |
| LgfDefinition | string | yes | The LGF definition (JSON-encoded) |

### Creates a user utterance for an intent in a small model scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-beebot-intent-user-say` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The scenario ID |
| UserSayDefinition | string | yes | The definition of the user utterance (JSON-encoded) |

### Creates a custom script template for a specified script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-custom-script-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| ScriptId | string | no | The script ID |
| PromptJson | string | no | The agent configuration in JSON format |
| Prompt | string | no | The prompt in professional mode |
| Model | string | no | The ID of the model used to create the template |
| LabelsJson | string | no | The label descriptions in JSON array format |
| Name | string | no | The name of the custom scenario |
| Description | string | no | The description of the custom scenario |

### This legacy canvas API creates a dialogue flow
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-dialogue-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| DialogueName | string | yes | The dialogue flow name |
| ScriptId | string | yes | The script ID |
| DialogueFlowType | string | yes | The type of the dialogue flow. Use `MainFlow` for a main flow or `SubFlow` for a subflow |

### Creates a URL for a download center task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-download-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| DownloadTaskId | string | yes | The download task ID. This parameter is obtained from the TaskId response parameter of the ListDownloadTasks operation |
| FileId | string | yes | The file ID. This parameter is obtained from the FileId response parameter of the ListDownloadTasks operation |

### Creates a global question in a legacy canvas
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-global-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The script ID |
| GlobalQuestionName | string | yes | The name of the global question |
| GlobalQuestionType | string | yes | The type of the global question |
| Questions | string | yes | The questions that trigger the global question |
| Answers | string | yes | The answers to the global question |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceName | string | yes | The name of the instance |
| InstanceDescription | string | no | The description of the instance |
| MaxConcurrentConversation | integer | yes | The maximum number of concurrent conversations for the instance |
| NluServiceType | string | no | The service type. If you do not specify this parameter, the default value is Managed. DialogStudio: Conversation Engine 3.0. Authorized: A… |
| ResourceGroupId | string | no | The ID of the resource group. You can call the ListResourceGroups operation to obtain this ID. For more information, see the Resource… |
| CallingNumber | string | no | The list of calling numbers. This parameter is optional (JSON-encoded) |

### Binds a number to a business instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-instance-bind-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| Number | string | no | The number to bind (required). For the list of numbers, see the Number parameter returned by the ListAllTenantBindNumberBinding API |
| InstanceList | string | no | List of outbound calling instance IDs. Modifying this parameter overwrites previous parameters. Setting this parameter to empty clears the… |

### Creates an intent in a legacy canvas script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The script ID |
| IntentName | string | yes | The name of the intent. This name must be unique within the script |
| IntentDescription | string | no | A description of the intent |
| Utterances | string | yes | A JSON-formatted string containing an array of sample utterances that trigger this intent |
| Keywords | string | no | A JSON-formatted string containing an array of keywords that help identify the intent |

### Creates a job data parsing task
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-job-data-parsing-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| JobFilePath | string | yes | Path to the file that contains the job data. This value is the Folder parameter returned by the GetJobDataUploadParams operation |
| InstanceId | string | yes | Instance ID |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| JobGroupName | string | yes | The name of the job |
| JobGroupDescription | string | no | The description of the job |
| ScenarioId | string | no | [Deprecated] |
| ScriptId | string | no | The scenario ID |
| StrategyJson | string | no | The execution strategy of the job. repeatBy: the repetition type. Valid values: Once (no repetition), Week (weekly repetition), and Month… |
| RecallStrategyJson | string | no | The redial strategy in JSON format. The default value of the parameters in the JSON object is false. emptyNumberIgnore: specifies whether… |
| CallingNumber | string | no | The list of caller numbers. If not specified, all numbers bound to the instance are selected by default (JSON-encoded) |
| RingingDuration | integer | no | The optimal ringing duration. Default value: 25 |
| Priority | string | no | The priority of the job group. Valid values: Urgent: urgent job. Daily: daily job |
| MinConcurrency | integer | no | The guaranteed concurrency. When the job starts, a minimum of N concurrent calls are guaranteed. The sum of guaranteed concurrency for… |
| FlashSmsExtras | string | no | The configuration parameters for flash SMS push in JSON format, including the configuration information of third-party flash SMS.… |
| RecallCallingNumber | string | no | The list of caller numbers for redialing (JSON-encoded) |

### Creates an export task for an outbound job group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-job-group-export-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| JobGroupId | string | no | Job group ID. Required |
| Option | string | no | Parameters that control task execution for the import (JSON-encoded) |

### Creates a phone number and associates it with the current tenant
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| TrunkId | string | yes | The unique identifier of the SIP trunk |
| Numbers | string | yes | The list of phone numbers to create and associate. A maximum of 100 phone numbers can be specified in a single request (JSON-encoded) |

### Create a scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ScriptName | string | yes | Script name |
| ScriptDescription | string | no | Script description |
| Industry | string | yes | Industry |
| Scene | string | yes | Scenario |
| ChatbotId | string | no | If the NluServiceType of the instance is Authorized or Provided, specify the ID of the chatbot instance to which the script needs to be… |
| AsrConfig | string | no | ASR configuration. Parameter definitions: appKey: Alibaba Cloud account appKey. maxEndSilence: Voice endpoint detection duration.… |
| TtsConfig | string | no | TTS configuration. Parameter definitions: voice: Speaker. volume: Volume. Value range: 0 to 100. Default value: 50. speechRate: Speech… |
| ScriptContent | string | no | For notification instances, pass in the script list. Deprecated (JSON-encoded) |
| ScriptWaveform | string | no | For notification instances, pass in the script voice list. Deprecated (JSON-encoded) |
| MiniPlaybackEnable | string | no | Connective phrase configuration switch (applicable to small models) |
| NewBargeInEnable | string | no | Graceful interruption configuration switch (applicable to small models) |
| LongWaitEnable | string | no | Intelligent sentence segmentation configuration switch (applicable to small models) |
| EmotionEnable | string | no | Emotion detection configuration switch (applicable to small models) |
| AgentKey | string | no | Robot workspace access Key |
| AgentLlm | string | no | Is the robot workspace a Large Language Model (LLM) workspace? |
| AgentId | integer | no | Robot workspace ID |
| NluEngine | string | no | NLU engine (applicable only to Large Language Model (LLM) scenarios). This field is empty for non-LLM scenarios. Prompts - Large Language… |
| NluAccessType | string | no | NLU access method (applicable only to Large Language Model (LLM) scenarios). Enumeration: Managed - Access using an Alibaba public… |
| ScriptNluProfileJsonString | string | no | If nluEngine is SSE_FUNCTION, you must pass in the corresponding configuration. Function Compute service pattern configuration fcRegion:… |

### Creates a recording for the broadcast script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-script-waveform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| ScriptId | string | yes | Scenario ID |
| ScriptContent | string | yes | The text of the script |
| FileId | string | yes | The ID of the recording file. Obtain this ID from the Folder parameter of the GetJobDataUploadParams operation |
| FileName | string | yes | The name of the recording file |

### Creates a tag for use in the legacy canvas
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| ScriptId | string | yes | The ID of the script |
| TagName | string | yes | The tag name |
| TagGroup | string | yes | The tag group name |

### Creates an asynchronous task to export outbound call history
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-task-export-task` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| TaskCreateTimeGte | integer | no | The start time for the task creation time search |
| TaskCreateTimeLte | integer | no | The end time for the task creation time search |
| JobGroupId | string | no | The job group ID |
| HasAnswered | string | no | Specifies whether the call was answered |
| HasHangUpByRejection | string | no | Specifies whether the call was hung up due to rejection |
| HasReachedEndOfFlow | string | no | Specifies whether the conversation reached the end of the flow |
| JobGroupNameQuery | string | no | The job name |
| JobId | string | no | The job ID |
| CalledNumber | string | no | The called number |
| UserIdMatch | string | no | The user ID |
| TaskId | string | no | The task ID |
| ActualTimeGte | integer | no | The start time for the dial time search, inclusive |
| ActualTimeLte | integer | no | The end time for the dial time search, inclusive |
| RecordingDurationGte | integer | no | The minimum ringing duration for the search |
| RecordingDurationLte | integer | no | The maximum ringing duration for the search |
| PageIndex | integer | no | The page number. Pages start from 0 |
| PageSize | integer | no | The number of entries per page |
| OtherId | string | no | The other ID |
| SortBy | string | no | The sort order. Valid values: asc: ascending order. desc: descending order. This is the default value |
| SortOrder | string | no | The sort type. asr indicates ascending order, and desc indicates descending order |
| CallDurationGte | integer | no | The minimum call duration for the search, in milliseconds |
| CallDurationLte | integer | no | The maximum call duration for the search, in milliseconds |
| JobStatusStringList | string | no | The job statuses. Separate multiple values with commas. Valid values: Scheduling: The job is being scheduled. Executing: The job is being… |
| TaskStatusStringList | string | no | The call statuses. Separate multiple values with commas. Note: The Succeeded status is subdivided into specific causes. The general… |
| ScriptNameQuery | string | no | The scenario name |
| CallingNumber | string | no | The calling number |

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

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

### Creates a cloned voice
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/create-voice-clone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| FileId | string | yes | The Folder field returned after a file is uploaded by calling the GetJobDataUploadParams operation |
| VoiceName | string | yes | The name of the cloned voice. The names of enabled voices within the same instance must be unique |
| Model | string | no | The model used for voice cloning |

### Deletes a foundation model robot
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-agent-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| AgentProfileIds | string | no | The collection of agent configuration IDs (JSON-encoded) |
| AppIp | string | no | The app_ip (system field, optional) |

### Clears the number attribution database. This operation is deprecated
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-all-number-district-info` (byok)

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

### Delete an intent in a small-model scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-beebot-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ScriptId | string | yes | Scenario ID |
| IntentId | integer | yes | Intent ID |

### Deletes utterance templates for intents in small model scenarios
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-beebot-intent-lgf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ScriptId | string | yes | Scenario ID |
| IntentId | integer | yes | Intent ID |
| LgfId | integer | yes | Utterance Template ID |

### Delete user queries for intents in the small-model scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-beebot-intent-user-say` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ScriptId | string | yes | Scenario ID |
| IntentId | string | yes | Intent ID |
| UserSayId | string | yes | User Say ID |

### You can delete a do-not-call list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-contact-block-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| ContactBlockListId | string | yes | Contact block list ID |
| Operator | string | no | Operator information |
| InstanceId | string | yes | Instance ID |

### Deletes the global outbound calling policy whitelist
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-contact-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| ContactWhiteListId | string | yes | Contact whitelist ID |
| Operator | string | no | Operator information |
| InstanceId | string | yes | Instance ID |

### Deletes a specified custom script template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-custom-script-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| AgentProfileId | string | no | The ID of the custom scenario template |

### Deletes a dialogue flow. This is a legacy canvas API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-dialogue-flow` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| ScriptId | string | yes | The ID of the script |
| DialogueFlowId | string | yes | The ID of the dialogue flow |

### Deletes a global question from a legacy canvas script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-global-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The script ID |
| GlobalQuestionId | string | yes | The global question ID. You can call the ListGlobalQuestions operation to obtain the ID |

### Deletes an Intelligent Outbound Calling instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-instance` (byok)

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

### Deletes an intent. This is a legacy API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| ScriptId | string | yes | The ID of the script that contains the intent |
| IntentId | string | yes | The ID of the intent to delete |

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| JobGroupId | string | yes | The ID of the job group |

### Deletes an outbound call number. This operation is deprecated
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-outbound-call-number` (byok)

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

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

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| ScriptId | string | yes | The ID of the script to delete |

### Deletes uploaded recordings in a small model scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-script-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID to which the recordings belong |
| ScriptId | string | yes | The ID of the scenario to which the recordings belong |
| UuidsJson | string | no | The list of recording IDs. If this parameter is left empty, all recordings are selected by default. You can obtain recording IDs by… |

### Delete a script recording
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-script-waveform` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ScriptId | string | yes | Scenario ID |
| ScriptWaveformId | string | yes | Deleted recording ID |

### Deletes a specified cloned voice. Before deletion, the system checks whether the voice is still referenced…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/delete-voice-clone` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| VoiceId | string | yes | The ID of the cloned voice to delete |

### Retrieves the intent in a small model scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-beebot-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The scenario ID |
| IntentId | integer | yes | The intent ID |

### Retrieves performance statistics for task labels
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-dialogue-node-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| JobGroupId | string | yes | Task group ID |
| Limit | integer | yes | Limit for displaying statistics |

### Queries the label hit statistics of a job group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-ds-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| JobGroupId | string | yes | The job group ID |

### Retrieves the details of a global question in a legacy canvas script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-global-question` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| ScriptId | string | yes | The ID of the script |
| GlobalQuestionId | string | yes | The ID of the global question |

### Retrieves the execution status of jobs in a job group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-group-executing-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| JobGroupId | string | yes | The job group ID |

### Queries the details of an outbound robot instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-instance` (byok)

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

### Retrieves the details of an intent. This is a legacy Canvas API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| ScriptId | string | yes | The ID of the script |
| IntentId | string | yes | The ID of the intent |

### Queries the performance statistics of intents for a task group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-intent-statistics` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| JobGroupId | string | yes | Job group ID |
| Limit | integer | no | Number of statistics to display (required) |

### Retrieves the conversation data of a job
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| JobId | string | yes | The job ID |
| WithScript | string | no | Specifies whether to return the task scenario information |

### Retrieves the parsing progress of an uploaded job file
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-job-data-parsing-task-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| JobDataParsingTaskId | string | yes | The job data analytics node ID. This parameter value is obtained from the CreateJobDataParsingTask operation |
| InstanceId | string | yes | The instance ID |

### Queries outbound robot task data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-job-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| JobGroupId | string | yes | The job group ID |
| BriefTypes | string | no | The filter conditions. This parameter is deprecated (JSON-encoded) |

### Retrieves the progress of a task group export task. This operation is deprecated. Use ListDownloadTasks…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-job-group-export-task-progress` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| TaskId | string | no | The task ID |

### Retrieves the details of a script
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-script` (byok)

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

### Returns a scene voice configuration in the legacy canvas scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-script-voice-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The scene ID |
| ScriptVoiceConfigId | string | yes | The scene voice configuration ID |

### Query the text-to-speech (TTS) configuration information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-ttsconfig` (byok)

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

### Previews text-to-speech (TTS) audio
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-ttsdemo` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | no | The scenario ID |
| Voice | string | no | The voice information, such as aixia, siyue, or xiaoyun. For the complete list of voices, refer to the voice list below. Because the Voice… |
| Text | string | yes | The text content |
| SpeechRate | integer | no | The speech rate. Valid values: integers from -500 to 500. Default value: 0. A value greater than 0 increases the pitch. A value less than… |
| Volume | integer | no | The volume. Valid values: integers from 0 to 100. Default value: 50. A value greater than 50 increases the volume. A value less than 50… |
| SampleRate | integer | no | The sample rate |
| PitchRate | integer | no | The intonation |
| AppKey | string | no | The speech service type. When ali is used as the custom service, this field stores the appKey of the interactive voice response product… |
| SecretKey | string | no | The AccessKey secret of the namespace. When the engine is xunfei, you must enter the AccessKey secret |
| AccessKey | string | no | The AccessKey ID of the namespace. When the engine is xunfei, you must enter the AccessKey ID |
| Engine | string | no | The storage engine. Valid values: ali, volc, and xunfei. To use traditional voices, CosyVoice, or Alibaba Cloud as the custom service,… |
| NlsServiceType | string | no | The service type. Managed: the default service (public service) for the outbound robot product. Authorized: the interactive voice response… |
| AliCustomizedVoice | string | no | The Alibaba Cloud custom voice, which is the voice invocation ID |
| ExtParams | string | no | The extended parameters. When Engine is set to dock, you must enter the configuration ID |

### Queries statistics about tag hits. This is a legacy canvas API
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-tag-hits-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| JobGroupId | string | yes | The job group ID |

### Queries the list of number binding instances under a tenant
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/describe-tenant-bind-number` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| Number | string | no | The bound number (required). Queries the binding status of the specified number across all instances. Obtain the number from the response… |

### This robot dialogue interface handles CC callback outbound calls. (Deprecated)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/dialogue` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| CallId | string | yes | Call ID |
| CallType | string | yes | Call type, typically Outbound |
| ScenarioId | string | no | Scenario ID |
| TaskId | string | no | Task ID |
| Utterance | string | yes | User utterance |
| ActionKey | string | no | Action to perform for outbound calls. Hangup ends the call |
| ActionParams | string | no | Parameters required to perform the action. (Deprecated) |
| CallingNumber | string | yes | Calling number |
| CalledNumber | string | yes | Called number |
| ScriptId | string | no | Scenario ID |

### Downloads call recordings
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/download-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| TaskId | string | yes | The call ID |
| NeedVoiceSliceRecording | string | no | Specifies whether to query segmented recordings |
| SwapChannels | string | no | Specifies whether to swap the left and right audio channels. Default value: false |

### Download script recordings by retrieving their URLs. This operation is intended for small model scenarios
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/download-script-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| ScriptId | string | yes | Recording scenario ID |
| Uuid | string | yes | Unique recording ID |

### Copies a new script from an existing script (for the legacy canvas only)
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/duplicate-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| SourceScriptId | string | yes | The ID of the source scenario |
| Name | string | yes | The name of the new scenario |

### Exports a scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/export-script` (byok)

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

### GenerateUploadUrl
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/generate-upload-url` (byok)

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

### Retrieve the delay before audio playback begins after a call is answered
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-after-answer-delay-playback` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| EntryId | string | yes | Instance ID |
| StrategyLevel | integer | no | Policy level (required) 2: Instance |

### Retrieves the agent configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-agent-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| AgentProfileId | string | yes | The agent profile ID. You can obtain the agent profile ID of a created scenario from the ChatbotId response parameter of DescribeScript |
| AppIp | string | no | The app IP address. This is a system field and is optional |

### Retrieves an agent profile template
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-agent-profile-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| AgentProfileTemplateId | string | yes | ID of the agent profile template |
| AppIp | string | no | IP address of the application. This is a system field and is optional |

### null
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-annotation-mission-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| AnnotationMissionId | string | no | The ID of the annotation task |

### Retrieves the list of annotation tags
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-annotation-mission-tag-info-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The instance ID. If this parameter is not specified, the default tags of the tenant are returned |
| PageIndex | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Retrieves information such as the Automatic Speech Recognition (ASR) model list and hotword list. This…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-asr-server-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| EntryId | string | no | Instance ID |
| StrategyLevel | integer | no | Policy level |

### Retrieves the result of an asynchronous outbound call task upload
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-assign-jobs-async-result` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| AsyncTaskId | string | yes | The ID of the asynchronous task |

### Retrieves the global outbound calling time periods in the outbound system
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-base-strategy-period` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| EntryId | string | yes | The instance ID |
| StrategyLevel | integer | no | The policy level. Default value: 2. Valid values: 0: System. 1: Tenant. 2: Instance |

### Retrieves the remaining concurrency for the caller's account
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-concurrent-conversation-quota` (byok)

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

### Retrieves the outbound call blocklist
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-contact-block-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| CountTotalRow | string | no | Specifies whether to display the total number of entries |
| InstanceId | string | yes | The instance ID |
| SearchPattern | string | no | The search criteria for the outbound call blocklist |

### Queries the global outbound whitelist
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-contact-white-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| CountTotalRow | string | no | Specifies whether to return the total number of entries |
| InstanceId | string | yes | The instance ID |
| SearchPattern | string | no | The search condition for the outbound whitelist |

### Retrieves the current concurrency of an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-current-concurrency` (byok)

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

### A query-based feature toggle that disables outbound calls to nonexistent numbers in the global dimension
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-empty-number-no-more-calls-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| EntryId | string | yes | Instance ID |
| StrategyLevel | integer | no | Strategy level. Set to 2 for business instances. 0: System 1: Tenant 2: Instance |

### Retrieves the parameters for uploading job data
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-job-data-upload-params` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| FileName | string | yes | File name |
| UniqueId | string | no | Unique business ID (prevents duplicate file names; the system automatically adds one if left blank) |
| Path | string | no | Relative path for file storage |
| BusiType | string | no | Business type |

### Retrieves the maximum number of daily call attempts allowed for a specified called number
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-max-attempts-per-day` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| EntryId | string | yes | The instance ID |
| StrategyLevel | integer | no | The policy level. The default value is 2 for a business instance. 0: System 1: Tenant 2: Instance |

### Retrieves the download URL for a number library template. This operation is deprecated
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-number-district-info-template-download-url` (byok)

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

### Retrieves the public key of an asymmetric encryption algorithm
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-public-key` (byok)

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

### Queries the current concurrency list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-realtime-concurrency-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| JobGroupId | string | no | The job group ID |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Summary information for outbound call instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-summary-info` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceIdList | string | no | List of instance IDs (JSON-encoded) |

### Retrieves a task by UUID
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-task-by-uuid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| TaskId | string | yes | The task ID |
| WithConversations | string | no | Specifies whether to include conversation information. Default value: false |

### Retrieve the application version information
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/get-version` (byok)

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

### Import a scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/import-script` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| SignatureUrl | string | yes | URL of the scenario JSON file to import. This value is the Folder parameter returned by the GetJobDataUploadParams operation |
| NluEngine | string | no | NLU engine. Applies only to Large Language Model (LLM) scenarios. Valid values: Prompts: LLM scenario. Empty: Non-LLM scenario |

### InflightTaskTimeout
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/inflight-task-timeout` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| TaskId | string | yes | Task ID |
| InstanceOwnerId | integer | no | Alibaba Cloud account ID of the instance owner |

### Retrieves the publication history of an agent configuration in a Large Language Model (LLM) scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-agent-profiles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | no | The scenario ID |
| AppIp | string | no | The IP address of the application. This is an optional system field |

### Queries the numbers bound to a tenant
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-all-tenant-bind-number-binding` (byok)

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

### Retrieves a list of annotation tasks
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-annotation-mission` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| AnnotationMissionId | string | no | The ID of the annotation task |
| AnnotationMissionName | string | no | The name of the annotation task |
| AnnotationStatusListFilter | string | no | The annotation status filter. This parameter is deprecated (JSON-encoded) |
| AnnotationStatusListStringFilter | string | no | The annotation status filter. The format is [1]. You can select multiple filter conditions. The valid values are as follows: 1: In… |
| CreateTimeStartFilter | integer | no | The start time for the annotation task creation filter |
| CreateTimeEndFilter | integer | no | The end time for the annotation task creation filter |
| PageIndex | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| InstanceId | string | no | The instance ID |

### Lists annotation mission sessions
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-annotation-mission-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| AnnotationMissionId | string | no | The annotation mission ID |
| AnnotationMissionSessionId | string | no | The annotation mission chat instance ID. Obtained by calling the SaveAnnotationMissionSessionList operation |
| PageIndex | integer | no | The page number |
| PageSize | integer | no | The number of entries to return on each page |
| Environment | integer | no | The environment. Default value: 2. Valid values: 0: NONE. 1: Private cloud. 2: Public cloud |
| IncludeStatusListJsonString | string | no | The list of included statuses. The format is [1]. Specify the actual enum values in the array. Valid values: 1: Correct recognition. 2:… |

### Lists API plugins
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-api-plugins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| UuidsJson | string | no | API plugin unique identifiers |
| PageNumber | integer | yes | Page number |
| PageSize | integer | yes | Number of entries per page |

### Queries the list of intents in small model scenarios
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-beebot-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The scenario ID |
| IntentName | string | no | The intent name. The intent code, which is a unique identifier |
| PageNumber | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |

### Queries the utterance templates for Chatbot intents in small model scenarios
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-beebot-intent-lgf` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The scenario ID |
| IntentId | string | yes | The intent ID |
| LgfText | string | no | The utterance template for the intent |
| PageNumber | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |

### Lists user utterances for intents in small model scenarios
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-beebot-intent-user-say` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The scenario ID |
| IntentId | string | yes | The intent ID |
| Content | string | no | The keyword in the utterance content |
| PageNumber | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |

### Queries a list of Chatbot instances in the public cloud edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-chatbot-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| PageNumber | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page. The value of this parameter must be less than or equal to 50 |
| AgentKey | string | no | The access key of the chatbot workspace. You can obtain the value by calling the ListChatbotAgents operation. If you leave this parameter… |

### Queries the custom script templates of a specified instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-custom-script-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | no | The instance ID |
| PageNumber | integer | no | The page number for paging. Default value: 1 |
| PageSize | integer | no | The number of entries to return on each page for paging. Default value: 10 |

### Queries the dialogue flows of a script in the legacy canvas
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-dialogue-flows` (byok)

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

### Queries the download center list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-download-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| PageNumber | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |
| InstanceId | string | no | The instance ID |

### You can call the ListFlashSmsTemplates operation to query flash SMS templates
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-flash-sms-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| ProviderId | string | yes | The ID of the flash SMS provider. Uincall: Beijing Uincall Communication Co., Ltd. ShangHaiTianNan: Shanghai Tiannan HeDao: Galacos |
| ConfigId | string | yes | The ID of the flash SMS configuration |

### Queries the list of key questions. This is a legacy canvas interface
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-global-questions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The scenario ID |
| PageNumber | integer | yes | The page number |
| PageSize | integer | yes | The number of entries to display on each page |

### Queries a list of outbound robot instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-instances` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| ResourceGroupId | string | no | The resource group ID. You can obtain the source API from the Resource Management documentation. Related link:… |
| Tag | string | no | The tags of the outbound robot instances. You can obtain the tags by calling the ListResourceTags operation (JSON-encoded) |
| Name | string | no | The name of the outbound robot instance |
| PageNumber | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |

### Queries intents in the annotation center list
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-intentions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| BotId | string | no | The robot ID. You can obtain this value from the DescribeScript operation, which corresponds to the ChatbotId parameter |
| UserNick | string | no | The intent name. Supports fuzzy match by keyword as a filter condition |
| PageIndex | integer | no | The page number |
| PageSize | integer | no | The number of entries per page |
| IntentId | integer | no | The intent ID |
| Environment | integer | no | The environment. Valid values: 1: private cloud 2: public cloud |
| AnnotationMissionDataSourceType | integer | no | This parameter is required. Select a value based on the scenario.> The annotation data source. Valid values: 1: outbound call 2: navigation |
| ScriptId | string | no | The scenario ID |
| InstanceId | string | no | The instance ID |

### Retrieves intents from the legacy canvas interface
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-intents` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The script ID |
| Keyword | string | no | A keyword to filter intents |
| PageNumber | integer | yes | The number of the page to return |
| PageSize | integer | yes | The number of entries to return on each page |

### Queries the list of outbound job groups
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-job-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| StartTime | integer | no | The start time to filter job groups by creation time. Use a UNIX timestamp in milliseconds |
| EndTime | integer | no | The end time to filter job groups by creation time. Use a UNIX timestamp in milliseconds |
| PageNumber | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |
| AsyncQuery | string | no | Specifies whether to asynchronously obtain the query results |
| SearchText | string | no | The search keyword |
| JobGroupStatusFilter | string | no | The filter condition. Filters by job status. You can specify multiple statuses separated by commas. The logical OR operator is used. Valid… |
| OnlyMinConcurrencyEnabled | string | no | Specifies whether to query tasks with a valid minimum concurrency guarantee |

### Retrieves the list of outbound job groups asynchronously. When the Async parameter is specified in a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-job-groups-async` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| AsyncTaskId | string | yes | The ID of the asynchronous task returned by the ListJobGroup operation when the Async parameter is specified. You can use this ID to… |

### Queries multiple jobs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-jobs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| JobId | string | yes | The list of job IDs. Note: A maximum of 99 job IDs can be specified (JSON-encoded) |

### Lists jobs by job group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-jobs-by-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID |
| JobGroupId | string | yes | Job group ID |
| JobStatus | string | no | Job status |
| JobFailureReason | string | no | Job failure reason |
| PageNumber | integer | yes | Page number |
| PageSize | integer | yes | Number of entries per page |

### List outbound call numbers
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-outbound-call-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | ID of the instance |
| PageNumber | integer | yes | Page number |
| PageSize | integer | yes | Number of entries to return on each page |

### Lists tags for business resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-resource-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| PageNumber | integer | yes | Page number |
| PageSize | integer | yes | The number of entries to return |
| ResourceType | string | yes | Resource type |

### Queries the publish history list for small model outbound calls
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-script-publish-histories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID |
| ScriptId | string | yes | The scenario ID |
| PageNumber | integer | yes | The page number |
| PageSize | integer | yes | The number of entries per page |

### Query the list of recording files. Use this operation in small model scenarios
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-script-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | Instance ID of the recording |
| ScriptId | string | yes | Scenario ID of the recording |
| UuidsJson | string | no | Recording ID list This is a list of unique recording IDs. If left blank, all recordings display |
| StatesJson | string | no | Recording status Validating: 1 Validation failed: 2 Processing: 3 Processing failed: 4 Reviewing: 5 Review failed: 6 Publish failed: 7… |
| Search | string | no | Search criteria: Search by recording name or content |
| PageNumber | integer | yes | Page number |
| PageSize | integer | yes | Number of entries per page |
| RefIdsJson | string | no | Recording ID list (JSON format), same as UuidsJson |

### Retrieves the variables currently used in the scenario
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-script-variables` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The instance ID (also known as the business ID) |
| ScriptId | string | yes | The scenario ID |
| Sandbox | string | no | Specifies whether the environment is a test environment. true: Test environment. false: Production environment after release. Default… |

### Lists the audio in a legacy canvas scene
`POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/list-script-voice-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://outboundbot.cn-shanghai.aliyuncs.com |
| InstanceId | string | yes | The ID of the instance |
| ScriptId | string | yes | The ID of the script |
| PageNumber | integer | yes | The page number of the page to return |
| PageSize | integer | yes | The number of entries to return on each page |

…and 56 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/assign-jobs" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Outbound Bot API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-outboundbot/assign-jobs with the header x-api-key. Every endpoint returns { project, data, timestamp }.

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

### Can AI agents use the Alibaba Cloud Outbound Bot 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-outboundbot.

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