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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	ListInstances	系统规定参数。取值：ListInstances。
ResourceGroupId	String	否	rg-acfm3iugit3uw7a	资源组ID。
Tag.N.Key	String	否	name	资源组标签Key。
Tag.N.Value	String	否	xxx	资源组标签值。
Name	String	否	xxx	智能外呼实例名称
PageNumber	Integer	否	1	页号
PageSize	Integer	否	10	分页大小

返回数据

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

示例

请求示例

http(s)://[Endpoint]/?Action=ListInstances
&ResourceGroupId=rg-acfm3iugit3uw7a
&Tag=[{"Key":"name","Value":"xxx"}]
&Name=xxx
&PageNumber=1
&PageSize=10
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "Code" : "OK",
  "Message" : "Success",
  "RequestId" : "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success" : true,
  "Instances" : [ {
    "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
}

错误码

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

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