HangupOperate-阿里云帮助中心

Operation description

Before you hang up a call in Communication Intelligence Engine, ensure that a call has been initiated by a large model.
If a call has not been initiated, use the LlmSmartCall or LlmSmartCallEncrypt operation to do so.

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:HangupOperate

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CallId	string	Yes	The call ID. Obtain this ID from the response of the LlmSmartCall or LlmSmartCallEncrypt operation.	14777672**^13452272**
ImmediateHangup	boolean	No	Specifies whether to hang up the call immediately. Valid values: true (default): Hangs up the call immediately. false: Hangs up the call after the current playback finishes.	true

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	EFD543DD-E087-54A2-AC0B-54E0656511D7
Code	string	The status code. A value of 'OK' indicates that the request was successful.	OK
Mesage	string	The status message.	OK
Result	boolean	The result of the operation. Valid values: true: The hang-up was successful. false: The hang-up operation failed.	true

Examples

Success response

JSON format

{
  "RequestId": "EFD543DD-E087-54A2-AC0B-54E0656511D7",
  "Code": "OK",
  "Mesage": "OK",
  "Result": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.CallId	The parameter CallId is invalid.	The parameter CallId is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.