ListInstances - 查询业务实例列表_智能外呼机器人(Outbound Bot)-阿里云帮助中心

查询智能外呼业务实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
outboundbot:ListInstances	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ResourceGroupId	string	否	资源组 ID。	rg-acfm3iugit3uw7a
Tag	array<object>	否	业务实例的标签列表。
	object	否
Key	string	否	资源组标签 Key。	name
Value	string	否	资源组标签值。	xxx
Name	string	否	智能外呼实例名称	xxx
PageNumber	integer	否	页号	1
PageSize	integer	否	分页大小	10

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码。	200
Code	string	响应码。	OK
Message	string	接口提示消息。	Success
RequestId	string	请求 ID。	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	是否成功。	true
Instances	array<object>	业务实例列表。
Instance	object
CreationTime	long	创建时间。	1578469042851
InstanceId	string	业务实例 ID。	90515b5-6115-4ccf-83e2-52d5bfaf2ddf
OwnerName	string	主账号名称。	xxx
CreatorId	long	创建者 ID。	34234
InstanceDescription	string	智能外呼业务实例描述。	这是一个实例
InstanceName	string	智能外呼业务实例名称。	回访
ResourceGroupId	string	资源组 ID。	90515b5-6115-4ccf-83e2-52d5bfaf2ddf
CreatorName	string	创建者姓名。	xxx
MaxConcurrentConversation	integer	允许的最大外呼并发数量。	10
ResourceTags	array<object>	标签信息。	[]
ResourceTag	object
Key	string	标签 Key。	age
Value	string	标签值。	20
IsPreset	boolean	是否是预置实例。	false
TotalCount	integer	实例数量	1
PageNumber	integer	页号	1
PageSize	integer	分页大小	10

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Instances": [
    {
      "CreationTime": 1578469042851,
      "InstanceId": "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
      "OwnerName": "xxx",
      "CreatorId": 34234,
      "InstanceDescription": "这是一个实例",
      "InstanceName": "回访",
      "ResourceGroupId": "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
      "CreatorName": "xxx",
      "MaxConcurrentConversation": 10,
      "ResourceTags": [
        {
          "Key": "age",
          "Value": "20"
        }
      ],
      "IsPreset": false
    }
  ],
  "TotalCount": 1,
  "PageNumber": 1,
  "PageSize": 10
}

错误码

HTTP status code	错误码	错误信息	描述
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.	内部错误。建议重试，如果多次重试报错请提交工单。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-04-22	OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情