ListChatbotInstances-阿里云帮助中心

Lists the instances of the Yunxiao Mi chatbot service in Alibaba Cloud.

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

outboundbot:ListChatbotInstances

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	Page number.	1
PageSize	integer	Yes	Number of items per page. Note The value must be less than or equal to 50.	10
AgentKey	string	No	Workspace access key for the chatbot. Note Get this key by calling ListChatbotAgents. If you omit this parameter, the API returns instances from all workspaces.	9137ab9c27044921860030adf8590ec4_p_outbound_public

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	HTTP status code.	200
Code	string	Response code.	OK
Message	string	Response message.	Success
RequestId	string	Request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the call succeeded.	true
Bots	array<object>	Chatbot list details
	object	Chatbot instance details.
Introduction	string	Chatbot description.	这是直播的描述
Avatar	string	Profile picture URL.	https://ccrm.wengine.cn/ccrm/system/common/fileDownload/noToken?fileId=975cdeaa064846e3b6004abd9ba1d7c8
TimeZone	string	Time zone of the chatbot. See Common Time Zone Codes.	Asia/Shanghai
CreateTime	string	Creation time.	2022-01-18T02:36:00Z
LanguageCode	string	Language used by the chatbot, such as zh-cn or en-us.	zh-cn
InstanceId	string	Instance ID.	e874fcf0-d2f4-4e62-9377-b6f35fe55210
Name	string	Chatbot name.	智能回访2
PageSize	integer	Number of items per page.	10
PageNumber	integer	Page number.	5
TotalCount	integer	Total number of items.	100

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Bots": [
    {
      "Introduction": "这是直播的描述",
      "Avatar": "https://ccrm.wengine.cn/ccrm/system/common/fileDownload/noToken?fileId=975cdeaa064846e3b6004abd9ba1d7c8",
      "TimeZone": "Asia/Shanghai",
      "CreateTime": "2022-01-18T02:36:00Z",
      "LanguageCode": "zh-cn",
      "InstanceId": "e874fcf0-d2f4-4e62-9377-b6f35fe55210",
      "Name": "智能回访2"
    }
  ],
  "PageSize": 10,
  "PageNumber": 5,
  "TotalCount": 100
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404	NotExist.Instance	The specified Instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.