API overview
Updated at:
API standards and multilingual preset SDKs
The OpenAPI of this product (OutboundBot/2019-12-26) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
System management
|
API |
Title |
Description |
| SaveBaseStrategyPeriod | Edit Global Callable Time Segments | Modifies the global outbound call time window in system administration. |
| SaveMaxAttemptsPerDay | Save the daily call limit for the called number | Sets the maximum number of daily outbound call attempts to a specific number. |
| SaveContactWhiteList | Save the outbound call whitelist | Saves an outbound call whitelist. |
| SaveContactBlockList | Save Do Not Call List | Adds contacts to the instance's blocklist. |
| SaveAfterAnswerDelayPlayback | Save delayed playback time after answer | Saves the delayed playback time after a call is answered. |
| GetMaxAttemptsPerDay | Query the daily call limit for the called number | Retrieves the maximum number of daily call attempts allowed for a specified called number. |
| GetContactWhiteList | Retrieve the outbound whitelist | Queries the global outbound whitelist. |
| GetContactBlockList | Retrieve the outbound call blocklist | Retrieves the outbound call blocklist. |
| GetBaseStrategyPeriod | Retrieve global outbound calling time periods | Retrieves the global outbound calling time periods in the outbound system. |
| GetAfterAnswerDelayPlayback | Query the delay time for audio playback after the call is answered | Retrieve the delay before audio playback begins after a call is answered. |
| DeleteContactWhiteList | Delete outbound call whitelist | Deletes the global outbound calling policy whitelist. |
| DeleteContactBlockList | Delete a Do-Not-Call List | You can delete a do-not-call list. |
Instance management
|
API |
Title |
Description |
| DeleteInstance | Delete Business Instance | Deletes an Intelligent Outbound Calling instance. |
| CreateInstance | Create a business instance | Creates an outbound call instance. |
| GetSummaryInfo | Overview of Outbound Call Instances | Summary information for outbound call instances. |
| ModifyInstance | Modify an outbound robot instance | Modifies an outbound robot instance. |
| DescribeInstance | Query outbound robot instance details | Queries the details of an outbound robot instance. |
| ListInstances | List outbound robot instances | Queries a list of outbound robot instances. |
| ListResourceTags | Query Instance Resource Tags | Lists tags for business resources. |
| TagResources | Add tags to instance resources | Adds tags to instance resources. |
| UntagResources | Delete resource tags | Remove tags from resources. |
Scenario management
|
API |
Title |
Description |
| DeleteScript | Delete a script | Deletes a specified script. |
| CreateScript | Create Scenario | Create a scenario. |
| ListScriptVariables | Retrieve configured variables in a scenario | Retrieves the variables currently used in the scenario. |
| ModifyAgentProfile | Modify agent configuration | Modifies the agent configuration. |
| ListApiPlugins | Query the API plugin list | Lists API plugins. |
| ImportScript | Import scenario | Import a scenario. |
| GetAgentProfile | Retrieve agent configuration | Retrieves the agent configuration. |
| DeleteScriptRecording | Delete recordings in a small model scenario | Deletes uploaded recordings in a small model scenario. |
| CreateAgentProfile | Create agent configuration | Creates an agent configuration. |
| RollbackScript | Roll back a published scenario (small models only) | Roll back a published small model scenario. |
| ListScriptPublishHistories | [Small model API] query the publish history list for outbound small model scenarios | Queries the publish history list for small model outbound calls. |
| ModifyScript | Modify script information | Modify script information. |
| SubmitScriptReview | Submit a scenario for publish review | Submit the scenario for release review. |
| WithdrawScriptReview | Withdraw script review | Withdraws a script review. |
| QueryScriptsByStatus | Query scenario information by status | Queries scenario information based on the scenario status. |
| DescribeScript | Retrieve script details | Retrieves the details of a script. |
| ExportScript | Create an export scenario job | Exports a scenario. |
| ListScripts | Query scripts | Queries the list of scripts. |
Outbound task group management
|
API |
Title |
Description |
| DescribeGroupExecutingInfo | Retrieve job execution status | Retrieves the execution status of jobs in a job group. |
| DescribeDsReports | Retrieve job group label hit statistics | Queries the label hit statistics of a job group. |
| CreateBatchRepeatJob | Copy a task group to reinitiate an outbound call | Copy an existing task group to reinitiate an outbound task. |
| ListFlashSmsTemplates | Retrieve Flash SMS Templates | You can call the ListFlashSmsTemplates operation to query flash SMS templates. |
| GetJobDataUploadParams | Obtain job data upload parameters | Retrieves the parameters for uploading job data. |
| CreateDownloadUrl | Create download file URL | Creates a URL for a download center task. |
| ListDownloadTasks | List download tasks | Queries the download center list. |
| ListJobsByGroup | Query jobs by job group | Lists jobs by job group. |
| CreateJobGroupExportTask | Create an outbound job group export task | Creates an export task for an outbound job group. |
| DeleteJobGroup | Delete a job | Deletes a job group. |
| ListJobGroupsAsync | Asynchronously query job groups | Retrieves the list of outbound job groups asynchronously. When the Async parameter is specified in a ListJobGroup call, use this operation to retrieve the asynchronous results of the ListJobGroup operation. |
| ListJobGroups | List job groups | Queries the list of outbound job groups. |
| ModifyJobGroup | Update job group data | Modifies an outbound robot job group. |
| DescribeJobGroup | Query outbound robot task groups | Queries outbound robot task data. |
| CreateJobGroup | Create outbound job group | Creates a job group. |
Outbound task management
|
API |
Title |
Description |
| CreateTenantKey | Create an asymmetric key pair | Creates a key. |
| GetPublicKey | Retrieve asymmetric encryption public key | Retrieves the public key of an asymmetric encryption algorithm. |
| SearchTask | Search tasks | Queries tasks. |
| QueryJobsWithResult | Query tasks based on task results | Queries tasks based on task results. |
| GetTaskByUuid | Retrieve a task by task ID | Retrieves a task by UUID. |
| GetAssignJobsAsyncResult | Obtain the Result of Asynchronously Creating an Outbound Call Job | Retrieves the result of an asynchronous outbound call task upload. |
| CreateTaskExportTask | Export outbound call history | Creates an asynchronous task to export outbound call history. |
| CreateJobDataParsingTask | Create a Data Parsing job | Creates a job data parsing task. |
| AssignJobsAsync | Asynchronously create an outbound call job | Asynchronously creates outbound jobs. |
| AssignJobs | Create outbound call jobs in batch | Creates outbound call jobs in batches. |
| SuspendJobs | Pause Job | You can pause the job. |
| ResumeJobs | Restart a paused job | Resumes paused jobs. |
| CancelJobs | Cancel a job that is about to be executed or is currently executing | Cancels jobs that are pending or in progress. This operation cannot cancel jobs that are already in a call. |
| QueryJobs | List jobs | Queries a list of jobs. |
| ListJobs | Query multiple jobs | Queries multiple jobs. |
| DescribeJobDataParsingTaskProgress | Return progress information of a job | Retrieves the parsing progress of an uploaded job file. |
| DescribeJob | Retrieve conversation data for a job | Returns the conversation data of a job. |
| StartJob | Create a job | This API initiates a call directly, bypassing the outbound call scheduling system. It is available only to users on the whitelist. |
Call recording
|
API |
Title |
Description |
| ListScriptRecording | 【Small Model API】Query Recording File List | Query the list of recording files. Use this operation in small model scenarios. |
| DownloadScriptRecording | [Small Model API] Download Recording (Obtain Recording URL) | Download script recordings by retrieving their URLs. This operation is intended for small model scenarios. |
| DownloadRecording | Download call recordings | Downloads call recordings. |
Conversational outbound calls
|
API |
Title |
Description |
| TerminateCall | Stop Call | Terminates a call during an active session. |
| SuspendCallWithFile | Stop calling based on file data | Suspends outbound calls using data from a file. |
| SuspendCall | Stop calls based on the list data. | Suspends outbound calls for a list of phone numbers. |
| Dialogue | Converse with the robot | This robot dialogue interface handles CC callback outbound calls. (Deprecated) |
| DescribeDialogueNodeStatistics | Query dialogue node data statistics | Retrieves performance statistics for task labels. |
Scenario voice configuration
|
API |
Title |
Description |
| DescribeTTSDemo | TTS preview | Previews text-to-speech (TTS) audio. |
Number management
|
API |
Title |
Description |
| ListSipTrunks | List SIP trunks | Queries the list of SIP trunks. |
| CreateNumber | Create a phone number | Creates a phone number and associates it with the current tenant. |
| ListOutboundCallNumbers | Query the list of outbound call numbers | List outbound call numbers. |
| CreateInstanceBindNumber | Attach a number to an instance | Binds a number to a business instance. |
| DescribeTenantBindNumber | Query number binding status under a tenant | Queries the list of number binding instances under a tenant. |
| ListAllTenantBindNumberBinding | List numbers bound to a tenant | Queries the numbers bound to a tenant. |
Annotation
|
API |
Title |
Description |
| ModifyAnnotationMission | Modify an annotation task | Modifies the status and name of an annotation task. |
| ListIntentions | Query intents in annotation center list | Queries intents in the annotation center list. |
| SaveAnnotationMissionTagInfoList | Save annotation tag mapping relationships | Saves instance tag information in batches. |
| GetAnnotationMissionTagInfoList | Retrieve annotation tags | Retrieves the list of annotation tags. |
| SaveAnnotationMissionSessionList | Save the list of annotated chat instances | Saves the list of annotated chat instances. |
| ListAnnotationMissionSession | List annotation mission chat instances | Lists annotation mission sessions. |
| GetAnnotationMissionSummary | Retrieve annotation task statistics information | null. |
| ListAnnotationMission | List annotation tasks | Retrieves a list of annotation tasks. |
| CreateAnnotationMission | Create annotation task | Creates an annotation task. |
Intent management (small model API)
|
API |
Title |
Description |
| DescribeBeebotIntent | Retrieve chatbot intent | Retrieves the intent in a small model scenario. |
| DescribeIntentStatistics | Query intent statistics information | Queries the performance statistics of intents for a task group. |
| ListBeebotIntentLgf | List utterance templates for chatbot intents in small model scenarios | Queries the utterance templates for Chatbot intents in small model scenarios. |
| ListBeebotIntentUserSay | List chatbot user utterances | Lists user utterances for intents in small model scenarios. |
| DeleteBeebotIntentUserSay | [Small Model API] Delete Beemind Intent User Utterances | Delete user queries for intents in the small-model scenario. |
| DeleteBeebotIntentLgf | [Small Model API] Delete an utterance template for a Beemind bot intent | Deletes utterance templates for intents in small model scenarios. |
| DeleteBeebotIntent | [Small Model API] Delete Beemind Bot Intent | Delete an intent in a small-model scenario. |
| ModifyBeebotIntentUserSay | [Small Model API] Modify Beebot intent user utterances | Modifies a user utterance for an intent in a Beebot scenario. |
| ModifyBeebotIntentLgf | [Small Model API] Modify the Beebot intent utterance template | Modifies the intent utterance template for a small model scenario. |
| ModifyBeebotIntent | [Small Model API] Modify Beemind Bot Intent | Modify the intent for a small-model scenario. |
| CreateBeebotIntentUserSay | [Small Model API] Create User Utterances for a Beembot Intent | Creates a user utterance for an intent in a small model scenario. |
| CreateBeebotIntentLgf | [Small Model API] Create an intent utterance template for a Beembot | Creates a user utterance template for an intent in a small model scenario. |
| CreateBeebotIntent | [Small Model API] Create a Beemind Bot Intent | Creates an intent for a small-model scenario. |
| ListBeebotIntent | List chatbot intents in small model scenarios | Queries the list of intents in small model scenarios. |
Concurrency
|
API |
Title |
Description |
| GetCurrentConcurrency | Obtain the current concurrency of the instance | Retrieves the current concurrency of an instance. |
| GetRealtimeConcurrencyReport | Query current concurrency list | Queries the current concurrency list. |
| GetConcurrentConversationQuota | Obtain the remaining concurrency under the caller's account | Retrieves the remaining concurrency for the caller's account. |
Legacy canvas only (deprecated)
|
API |
Title |
Description |
| CreateDialogueFlow | Create Conversation Flow – Legacy Canvas API | This legacy canvas API creates a dialogue flow. |
| DeleteDialogueFlow | Delete Conversation Flow – Legacy Canvas API | Deletes a dialogue flow. This is a legacy canvas API. |
| ModifyDialogueFlow | Modify dialog flow - legacy canvas operation (deprecated) | Modifies a dialog flow. This is a legacy canvas operation. |
| ListDialogueFlows | [Legacy canvas API] Query the conversation flow list under a scenario | Queries the dialogue flows of a script in the legacy canvas. |
| ListTags | Query Tags under a Script – Legacy Canvas API | Queries the tags of a script. This is a legacy canvas API. |
| CreateTag | Create Label – For Use in Legacy Canvas | Creates a tag for use in the legacy canvas. |
| DescribeTagHitsSummary | Query tag statistics—Legacy canvas API | Queries statistics about tag hits. This is a legacy canvas API. |
| ModifyTagGroups | Modify Tag Group – Legacy Canvas API | Modifies tag groups for the legacy canvas interface. |
| DeleteIntent | Delete Intent – Legacy Canvas API | Deletes an intent. This is a legacy API. |
| ModifyIntent | Modify Intent – Legacy Canvas API | Modifies an intent in the legacy canvas. This is a legacy API. |
| DescribeIntent | Retrieve an Intent – Legacy Canvas API | Retrieves the details of an intent. This is a legacy Canvas API. |
| ListIntents | Query Intent List – Legacy Canvas API | Retrieves intents from the legacy canvas interface. |
| ListGlobalQuestions | [Legacy Canvas API] Query the List of Global Questions | Queries the list of key questions. This is a legacy canvas interface. |
| DuplicateScript | Copy script - legacy canvas operation (deprecated) | Copies a new script from an existing script (for the legacy canvas only). |
| CreateGlobalQuestion | [Legacy Canvas API] Create Global Question | Creates a global question in a legacy canvas. |
| ModifyScriptVoiceConfig | [Legacy canvas API] Modify scenario voice configuration | Modifies the voice configuration of a script in a legacy canvas. |
| ModifyGlobalQuestion | [Legacy Canvas API] Modify a Global Question | Modifies a global question in the legacy canvas. |
| DescribeScriptVoiceConfig | Return a scene voice configuration - legacy canvas API (deprecated) | Returns a scene voice configuration in the legacy canvas scenario. |
| CreateIntent | [Legacy Canvas API] Create Intent | Creates an intent in a legacy canvas script. |
| ListScriptVoiceConfigs | [Legacy canvas API] Query scenario voice configuration List | Lists the audio in a legacy canvas scene. |
| DeleteGlobalQuestion | [Legacy Canvas API] Delete Global Question | Deletes a global question from a legacy canvas script. |
| DescribeGlobalQuestion | [Legacy Canvas API] Returns data of a global question | Retrieves the details of a global question in a legacy canvas script. |
Other
|
API |
Title |
Description |
| ListChatbotInstances | List chatbot instances in the public cloud edition | Queries a list of Chatbot instances in the public cloud edition. |
| CreateCustomScriptTemplate | Create a custom scenario template | Creates a custom script template for a specified script. |
| CreateVoiceClone | Create a cloned voice | Creates a cloned voice. |
| DeleteCustomScriptTemplate | Delete a custom scenario template | Deletes a specified custom script template. |
| DeleteVoiceClone | Delete a cloned voice | Deletes a specified cloned voice. Before deletion, the system checks whether the voice is still referenced by scenarios under the instance. Deletion fails if the voice is referenced. |
| ListCustomScriptTemplates | List custom scenario templates | Queries the custom script templates of a specified instance. |
| ListVoiceClone | List cloned voices | Performs a paged query to retrieve the list of cloned voices for an instance by using paging. |
| ModifyVoiceClone | Modify a cloned voice | Modifies the name or status of a cloned voice. |
| SubmitScriptPreReviewResult | Submit script pre-review results | Submits the pre-review approval or rejection result for a script review record under a specified instance for a whitelisted tenant, and returns the updated script information. |
Deprecated
|
API |
Title |
Description |
| ListTagResources | [Deprecated] query resource tag relationships | Queries resource tag relationships. |
| PublishScript | [Deprecated] Publish script | Publishing a scenario |
| GetVersion | Obtain Application Version information | Retrieve the application version information. |
| TaskPreparing | [Deprecated] prepare a node for execution | Prepares a node for execution. |
| InflightTaskTimeout | Job timeout | InflightTaskTimeout |
| PublishScriptForDebug | Publish script to debug environment | Publishes the debug version of a script. |
| ListAgentProfiles | Obtain the agent configuration list (Deprecated) | Retrieves the publication history of an agent configuration in a Large Language Model (LLM) scenario. |
| GetAgentProfileTemplate | Obtain agent configuration template (deprecated) | Retrieves an agent profile template. |
| DeleteAgentProfiles | Delete agent configurations (deprecated) | Deletes a foundation model robot. |
| ModifyOutboundCallNumber | Modify outbound call number - deprecated | Modifies an outbound call number. This operation is deprecated. |
| ModifyTTSConfig | Modify the TTS configuration of a legacy canvas scenario (dedicated to legacy canvas, deprecated) | Update the text-to-speech (TTS) configuration for an existing canvas scenario. |
| SubmitRecording | Submit Call Recordings to Outbound Calls – Deprecated | Submits a recording of an outbound call. This operation is deprecated. |
| GetAsrServerInfo | [Deprecated] Obtain information such as the ASR model list and hotword list | Retrieves information such as the Automatic Speech Recognition (ASR) model list and hotword list. This operation is deprecated. |
| DescribeJobGroupExportTaskProgress | [Deprecated] Retrieve Task Group Export Job Progress | Retrieves the progress of a task group export task. This operation is deprecated. Use ListDownloadTasks instead. |
| RecordFailure | Record IVR call failure (deprecated) | **[Deprecated]** Submits the cause of a call failure to the outbound call business system. |
| CreateBatchJobs | Create outbound jobs in batches (deprecated) | **[Deprecated]** Creates outbound jobs in batches. |
| GetNumberDistrictInfoTemplateDownloadUrl | [Deprecated] retrieve the download URL for a number location template | Retrieves the download URL for a number library template. This operation is deprecated. |
| SaveEffectiveDays | Save the Validity Period of the Basic Policy – Deprecated | Saves the validity period of a basic policy. This operation is deprecated. |
| DeleteAllNumberDistrictInfo | [Deprecated] delete all number attribution information | Clears the number attribution database. This operation is deprecated. |
| UploadScriptRecording | [Deprecated] upload script recording | Uploads a recording file. |
| GetEmptyNumberNoMoreCallsInfo | [Deprecated] Query the Toggle for the nonexistent number no-more-calls feature at the global dimension | A query-based feature toggle that disables outbound calls to nonexistent numbers in the global dimension. |
| ModifyEmptyNumberNoMoreCallsInfo | [Deprecated] Save the toggle for the feature that stops outbound calls to nonexistent numbers at the global dimension | Enables or disables the global no-call feature for nonexistent numbers. |
| ModifyBatchJobs | Modify a job group (including jobs) – Deprecated | Modifies batch jobs. This operation is deprecated. |
| DeleteOutboundCallNumber | Delete an outbound call number - deprecated | Deletes an outbound call number. This operation is deprecated. |
| QueryScriptWaveforms | [Deprecated] Query the list of scenario audio recording files on the legacy canvas | This legacy canvas interface retrieves the list of recorded speech transcripts. |
| DescribeTTSConfig | [Deprecated] Query TTS configuration information | Query the text-to-speech (TTS) configuration information. |
| ChangeResourceGroup | [Deprecated] change resource group | Changes the resource group. |
| DeleteScriptWaveform | [Deprecated] Delete script recording | Delete a script recording. |
| SubmitBatchJobs | Submit a job group in draft status for execution - deprecated | Submits a job group in draft status for execution. This operation is deprecated. |
| CreateScriptWaveform | [Deprecated] Create a scene audio recording in the legacy canvas | Creates a recording for the broadcast script. |
Is this page helpful?