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 |
| DescribeTTSDemo | TTS preview | Previews text-to-speech (TTS) audio. |
Instance management
|
API |
Title |
Description |
| ListChatbotInstances | Query the list of Chatbot agents in the Alibaba Cloud public cloud version | Lists the instances of the Yunxiao Mi chatbot service in Alibaba Cloud. |
Scenario management
|
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 | Submit IVR call failure record – Deprecated | CC sends the call failure reason to the outbound calling system. This operation is deprecated. |
| CreateBatchJobs | Batch Create Outbound Call Jobs – Deprecated | Deprecated. Do not use this operation to batch-create outbound calling jobs. |
| 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. |
Outbound task group management
|
API |
Title |
Description |
| AssignJobs | Create outbound call jobs in batch | Creates outbound call jobs in batches. |
| AssignJobsAsync | Asynchronously create an outbound call job | Asynchronously creates outbound 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. |
| CreateAgentProfile | Create Agent Configuration | You can create an intelligent configuration. |
| CreateAnnotationMission | Create annotation task | Creates an annotation task. |
| CreateBatchRepeatJob | Copy a task group to reinitiate an outbound call | Copy an existing task group to reinitiate an outbound task. |
| CreateBeebotIntent | [Small Model API] Create a Beemind Bot Intent | Creates an intent for 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. |
| CreateBeebotIntentUserSay | [Small Model API] Create User Utterances for a Beembot Intent | Creates a user utterance for an intent in a small model scenario. |
| CreateDialogueFlow | Create Conversation Flow – Legacy Canvas API | This legacy canvas API creates a dialogue flow. |
| CreateDownloadUrl | Create download file URL | Creates a URL for a download center task. |
| CreateGlobalQuestion | [Legacy Canvas API] Create Global Question | Creates a global question in a legacy canvas. |
| CreateInstance | Create a business instance | Creates an outbound call instance. |
| CreateInstanceBindNumber | Attach a number to an instance | Binds a number to a business instance. |
| CreateIntent | [Legacy Canvas API] Create Intent | Creates an intent in a legacy canvas script. |
| CreateJobDataParsingTask | Create a Data Parsing job | Creates a job data parsing task. |
| CreateJobGroup | Create an outbound task group | Creates a job group. |
| CreateJobGroupExportTask | Create an outbound job group export task | Creates an export task for an outbound job group. |
| CreateScript | Create Scenario | Create a scenario. |
| CreateTag | Create Label – For Use in Legacy Canvas | Creates a tag for use in the legacy canvas. |
| CreateTaskExportTask | Export outbound call history | Creates an asynchronous task to export outbound call history. |
| CreateTenantKey | Create an asymmetric key pair | Creates a key. |
| DeleteBeebotIntent | [Small Model API] Delete Beemind Bot Intent | Delete an intent in a 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. |
| DeleteBeebotIntentUserSay | [Small Model API] Delete Beemind Intent User Utterances | Delete user queries for intents in the small-model scenario. |
| DeleteContactBlockList | Delete a Do-Not-Call List | You can delete a do-not-call list. |
| DeleteContactWhiteList | Delete outbound call whitelist | Deletes the global outbound calling policy whitelist. |
| DeleteDialogueFlow | Delete Conversation Flow – Legacy Canvas API | Deletes a dialogue flow. This is a legacy canvas API. |
| DeleteGlobalQuestion | [Legacy Canvas API] Delete Global Question | Deletes a global question from a legacy canvas script. |
| DeleteInstance | Delete Business Instance | Deletes an Intelligent Outbound Calling instance. |
| DeleteIntent | Delete Intent – Legacy Canvas API | Deletes an intent. This is a legacy API. |
| DeleteJobGroup | Delete a job | Deletes a job group. |
| DeleteScript | Delete a script | Deletes a specified script. |
| DeleteScriptRecording | Delete recordings in a small model scenario | Deletes uploaded recordings in a small model scenario. |
| DescribeBeebotIntent | [Get Small Model API] Obtain the intent of the XiaoMi chatbot. | Retrieves the intent in the small model scenario. |
| DescribeDialogueNodeStatistics | Query dialogue node data statistics | Retrieves performance statistics for task labels. |
| DescribeDsReports | Retrieve job group label hit statistics | Queries the label hit statistics of a job group. |
| DescribeGlobalQuestion | [Legacy Canvas API] Returns data of a global question | Retrieves the details of a global question in a legacy canvas script. |
| DescribeGroupExecutingInfo | Return job execution status | Returns the execution status of tasks in a task group. |
| DescribeInstance | Query business instance information | Queries the information of an outbound robot business instance. |
| DescribeIntent | Retrieve an Intent – Legacy Canvas API | Retrieves the details of an intent. This is a legacy Canvas API. |
| DescribeIntentStatistics | Query intent statistics information | Queries the performance statistics of intents for a task group. |
| DescribeJob | Return conversation data of a job | Returns the conversation data of a job. |
| DescribeJobDataParsingTaskProgress | Return progress information of a job | Retrieves the parsing progress of an uploaded job file. |
| DescribeJobGroup | Query outbound call task group | Retrieves data for intelligent outbound call job groups. |
| DescribeScript | Return information about a scenario | Returns information about a script. |
| DescribeScriptVoiceConfig | Return a scene voice configuration - legacy canvas API (deprecated) | Returns a scene voice configuration in the legacy canvas scenario. |
| DescribeTagHitsSummary | Query tag statistics—Legacy canvas API | Queries statistics about tag hits. This is a legacy canvas API. |
| DescribeTenantBindNumber | Query number binding status under a tenant | Queries the list of number binding instances under a tenant. |
| Dialogue | Converse with the robot | This robot dialogue interface handles CC callback outbound calls. (Deprecated) |
| DownloadRecording | Download call recording | Downloads a call recording. |
| DownloadScriptRecording | [Small Model API] Download Recording (Obtain Recording URL) | Download script recordings by retrieving their URLs. This operation is intended for small model scenarios. |
| DuplicateScript | Copy script - legacy canvas operation (deprecated) | Copies a new script from an existing script (for the legacy canvas only). |
| ExportScript | Create an export scenario job | Exports a scenario. |
| 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. |
| GetAgentProfile | Retrieve agent configuration | Retrieves the configuration of an agent. |
| GetAnnotationMissionSummary | Retrieve annotation task statistics information | null. |
| GetAssignJobsAsyncResult | Obtain the Result of Asynchronously Creating an Outbound Call Job | Retrieves the result of an asynchronous outbound call task upload. |
| GetBaseStrategyPeriod | Obtain global outbound calling time segments | Retrieve the global outbound time periods for the outbound calling system. |
| GetConcurrentConversationQuota | Obtain the remaining concurrency under the caller's account | Retrieves the remaining concurrency for the caller's account. |
| GetContactBlockList | Retrieve outbound call blocklist | Retrieves the outbound call blocklist. |
| GetContactWhiteList | Retrieve outbound call whitelist | Retrieves the global outbound call policy whitelist. |
| GetCurrentConcurrency | Obtain the current concurrency of the instance | Retrieves the current concurrency of an instance. |
| GetJobDataUploadParams | Obtain job data upload parameters | Retrieves the parameters for uploading job data. |
| GetMaxAttemptsPerDay | Query the daily call limit for the called number | Retrieves the maximum number of daily call attempts allowed for a specified called number. |
| GetPublicKey | Retrieve asymmetric encryption public key | Retrieves the public key of an asymmetric encryption algorithm. |
| GetRealtimeConcurrencyReport | Query the current concurrency list | Queries the current concurrency list. |
| GetSummaryInfo | Overview of Outbound Call Instances | Summary information for outbound call instances. |
| GetTaskByUuid | Obtain a job by job ID | Retrieve a task by its UUID. |
| ImportScript | Import scenario | Import a scenario. |
| ListAllTenantBindNumberBinding | List of numbers attached to the tenant | Lists the phone numbers bound to the tenant. |
| ListAnnotationMission | Retrieve annotation task list | Retrieves a list of annotation tasks. |
| ListAnnotationMissionSession | List annotation task chat instances | Queries the list of annotation task chat instances. |
| ListApiPlugins | Query the API plugin list | Lists API plugins. |
| ListBeebotIntent | List XiaoMi Bot Intents (Small Model API) | Lists intents for small-model scenarios. |
| ListBeebotIntentLgf | 【Small Model API】List XiaoMi Bot Intent Utterance Templates | Lists the utterance templates for a specified intent in a scenario. |
| ListBeebotIntentUserSay | [Small Model API] List User Utterances for XiaoMi Bot | Lists user utterances for intents in small model scenarios. |
| ListDialogueFlows | [Legacy canvas API] Query the conversation flow list under a scenario | Queries the dialogue flows of a script in the legacy canvas. |
| ListDownloadTasks | Job Download List | Queries the list of download tasks in Download Hub. |
| ListFlashSmsTemplates | Retrieve Flash SMS Templates | You can call the ListFlashSmsTemplates operation to query flash SMS templates. |
| ListGlobalQuestions | [Legacy Canvas API] Query the List of Global Questions | Queries the list of key questions. This is a legacy canvas interface. |
| ListInstances | Query service instance list | Queries the list of Outbound Bot service instances. |
| ListIntentions | Query intents in annotation center list | Queries intents in the annotation center list. |
| ListIntents | Query Intent List – Legacy Canvas API | Retrieves intents from the legacy canvas interface. |
| ListJobGroups | Query job list | Retrieves the list of outbound call task groups. |
| ListJobGroupsAsync | Asynchronously query task group list | Asynchronously retrieves the list of outbound call task groups. When the Async parameter is specified in the ListJobGroup operation, use this operation to retrieve the results of the asynchronous ListJobGroup call. |
| ListJobs | Query multiple jobs | Queries multiple jobs. |
| ListJobsByGroup | Query jobs by job group | Lists jobs by job group. |
| ListOutboundCallNumbers | Query the list of outbound call numbers | List outbound call numbers. |
| ListResourceTags | Query Instance Resource Tags | Lists tags for business resources. |
| ListScriptPublishHistories | Query the publish history list of outbound call small model scenarios | Retrieves the publication history of the small model for outbound calls. |
| ListScriptRecording | 【Small Model API】Query Recording File List | Query the list of recording files. Use this operation in small model scenarios. |
| ListScripts | Query script list | Queries the list of scripts. |
| ListScriptVariables | Retrieve configured variables in a scenario | Retrieves the variables currently used in a scenario. |
| ListScriptVoiceConfigs | [Legacy canvas API] Query scenario voice configuration List | Lists the audio in a legacy canvas scene. |
| ListTags | Query Tags under a Script – Legacy Canvas API | Queries the tags of a script. This is a legacy canvas API. |
| ModifyAgentProfile | Modify Agent Configuration | Modify the agent configuration. |
| ModifyAnnotationMission | Modify an annotation task | Modifies the status and name of an annotation task. |
| ModifyBeebotIntent | [Small Model API] Modify Beemind Bot Intent | Modify the intent for a small-model scenario. |
| ModifyBeebotIntentLgf | [Small Model API] Modify the Beebot intent utterance template | Modifies the intent utterance template for a small model scenario. |
| ModifyBeebotIntentUserSay | [Small Model API] Modify Beebot intent user utterances | Modifies a user utterance for an intent in a Beebot scenario. |
| ModifyDialogueFlow | Modify dialog flow - legacy canvas operation (deprecated) | Modifies a dialog flow. This is a legacy canvas operation. |
| ModifyGlobalQuestion | [Legacy Canvas API] Modify a Global Question | Modifies a global question in the legacy canvas. |
| ModifyInstance | Modify a business instance | Modifies an Outbound Bot instance. |
| ModifyIntent | Modify Intent – Legacy Canvas API | Modifies an intent in the legacy canvas. This is a legacy API. |
| ModifyJobGroup | Modify job data | Modify an intelligent outbound call task group. |
| ModifyScript | Modify script information | Modify script information. |
| ModifyScriptVoiceConfig | [Legacy canvas API] Modify scenario voice configuration | Modifies the voice configuration of a script in a legacy canvas. |
| ModifyTagGroups | Modify Tag Group – Legacy Canvas API | Modifies tag groups for the legacy canvas interface. |
| QueryJobs | Query job list | Queries a list of jobs. |
| QueryJobsWithResult | Query tasks by task result | Queries tasks based on task results. |
| QueryScriptsByStatus | Query scenario information by scenario status | Queries scenario information by status. |
| ResumeJobs | Restart a paused job | Resumes paused jobs. |
| RollbackScript | Roll back a published scenario (small models only) | Roll back a published small model scenario. |
| SaveAfterAnswerDelayPlayback | Save delayed playback time after answer | Saves the delayed playback time after a call is answered. |
| SaveAnnotationMissionSessionList | Save annotated chat instance list | Saves a list of annotated chat instances. |
| SaveAnnotationMissionTagInfoList | Save annotation tag mapping relationships | Saves instance tag information in batches. |
| SaveBaseStrategyPeriod | Edit Global Callable Time Segments | Modifies the global outbound call time window in system administration. |
| SaveContactBlockList | Save Do Not Call List | Adds contacts to the instance's blocklist. |
| SaveContactWhiteList | Save the outbound call whitelist | Saves an outbound call whitelist. |
| SaveMaxAttemptsPerDay | Save the daily call limit for the called number | Sets the maximum number of daily outbound call attempts to a specific number. |
| SearchTask | Search Job | Search for tasks. |
| 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. |
| SubmitScriptReview | Submit a scenario for publish review | Submit the scenario for release review. |
| SuspendCall | Stop calls based on the list data. | Suspends outbound calls for a list of phone numbers. |
| SuspendCallWithFile | Stop calling based on file data | Suspends outbound calls using data from a file. |
| SuspendJobs | Pause Job | You can pause the job. |
| TagResources | Add tags to instance resources | Adds tags to instance resources. |
| TerminateCall | Stop Call | Terminates a call during an active session. |
| UntagResources | Delete resource tags | Remove tags from resources. |
| WithdrawScriptReview | Withdraw script review | Withdraws a script review. |
Is this page helpful?