LlmSmartCall-Artificial Intelligence Cloud Call Service(AICCS)-阿里云帮助中心

Intelligent outbound call based on an LLM.

Operation description

Each API invocation supports adding only one called number. If you have multiple called numbers, invoke the API multiple times.
Before initiating an intelligent call based on an LLM, ensure that you have created an LLM application in the Application Management interface and have successfully requested a real number in the Voice Service Number Management interface.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

aiccs:LlmSmartCall

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CalledNumber	string	Yes	Called number that receives the intelligent outbound call.	137****0000
CallerNumber	string	No	Caller number. This parameter is required and supports only numbers from the Chinese mainland. View available numbers in the Voice Service Number Management interface.	132****2054
ApplicationCode	string	Yes	LLM application code. View it in the Application Management interface.	F32******
StartWordParam	object	No	Start-word variables. Go to the LLM Application Management interface and click Details to view the start-word variables of your created LLM application.	{ "name": "小明", "address": "浙江省杭州市" }
PromptParam	object	No	Prompt variable. Go to the Application Management interface and click Details to view the prompt variables you created.	{ "style": "温柔" }
OutId	string	No	An ID reserved for the caller. This ID will be returned to the caller through a receipt message. Length: 1–15 bytes.	222356****
BizParam	object	No	Business parameters. These parameters are passed to the customer model when invoking the customer model.	biz_params = { "user_prompt_params": "{\"city\":\"北京\"}" }
Extension	string	No	The extension number of the X number, up to 5 digits. Important Fill this field only in AXN extension mode. If no extension number exists, do not fill it.	123
SessionTimeout	integer	No	Maximum call duration. The call is automatically disconnected after timeout. Unit: seconds. Note Maximum value: 3600 s. Minimum value: 600 s.	1200
TtsVoiceCode	string	No	The voice code used for TTS playback. Note If no value is set, the voice code configured in the LLM application is used by default. You can use the ListAvailableTts API to view all available voice codes.	V65******
TtsSpeed	integer	No	Voice speed during TTS playback. Note Value range: -200 to 200. Default value is 0. If this parameter is not set, the voice speed configured in the LLM application is used by default.	50
TtsVolume	integer	No	The volume for TTS playback. Note Value range: 0–100. Default value is 0. If no value is set, the volume configured in the LLM application is used by default.	10
CustomerLineCode	string	No	Customer-provided ingest endpoint encoding. Note If you use your own line, contact Alibaba Cloud support to enable this feature. The line encoding is provided by Alibaba Cloud support. Do not set this parameter if you do not have one.	SELF_xxxxx_A_NET

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	D6A51251-F7C4-596A-9F45-3C3219A5450D
Code	string	Request status code. A return value of "OK" indicates that the request succeeded.	OK
Message	string	Description of the status code.	OK
CallId	string	Unique receipt ID for this call.	125165515*^11195613**

Examples

Success response

JSON format

{
  "RequestId": "D6A51251-F7C4-596A-9F45-3C3219A5450D",
  "Code": "OK",
  "Message": "OK",
  "CallId": "125165515***^11195613****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ModelStatus.Invalid	Model state invalid.	Invalid model state.
400	MissingParameter.CallerNumber	Parameter "CallerNumber" which is mandatory for the request is not provided.	The request required parameter "CallerNumber" was not provided ".
400	InvalidParameter.ApplicationCode	The specified parameter "ApplicationCode" is invalid.	The parameter ApplicationCode is invalid.
400	ModelNotExist	The model does not exist.	The model does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.