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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeInstance	系统规定参数。取值：DescribeInstance。
InstanceId	String	是	af81a389-91f0-4157-8d82-720edd02b66a	实例ID。

返回数据

名称	类型	示例值	描述
HttpStatusCode	Integer	200	HTTP状态码。
Code	String	OK	状态码。
Message	String	Success	接口提示信息。
RequestId	String	254EB995-DEDF-48A4-9101-9CA5B72FFBCC	请求ID。
Success	Boolean	true	是否成功。
Instance	Object		业务实例信息。
CreationTime	Long	1578469042851	创建时间。
InstanceId	String	90515b5-6115-4ccf-83e2-52d5bfaf2ddf	业务实例ID。
CreatorId	Long	435986	创建者ID。
OwnerName	String	xxxx	业务实例拥有者名字。
InstanceDescription	String	这个是第一个实例	业务实例描述。
InstanceName	String	第一个实例	业务实例名字。
CreatorName	String	xxx	创建者名字。
ResourceGroupId	String	90515b5-6115-4ccf-83e2-52d5bfaf2ddf	资源组ID。
MaxConcurrentConversation	Integer	4	实例最大并发。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeInstance
&InstanceId=af81a389-91f0-4157-8d82-720edd02b66a
&公共请求参数

正常返回示例

XML格式

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

<DescribeInstanceResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <Code>OK</Code>
    <Message>Success</Message>
    <RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
    <Success>true</Success>
    <Instance>
        <CreationTime>1578469042851</CreationTime>
        <InstanceId>90515b5-6115-4ccf-83e2-52d5bfaf2ddf</InstanceId>
        <CreatorId>435986</CreatorId>
        <OwnerName>xxxx</OwnerName>
        <InstanceDescription>这个是第一个实例</InstanceDescription>
        <InstanceName>第一个实例</InstanceName>
        <CreatorName>xxx</CreatorName>
        <ResourceGroupId>90515b5-6115-4ccf-83e2-52d5bfaf2ddf</ResourceGroupId>
        <MaxConcurrentConversation>4</MaxConcurrentConversation>
    </Instance>
</DescribeInstanceResponse>

JSON格式

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

{
  "HttpStatusCode" : 200,
  "Code" : "OK",
  "Message" : "Success",
  "RequestId" : "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success" : true,
  "Instance" : {
    "CreationTime" : 1578469042851,
    "InstanceId" : "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
    "CreatorId" : 435986,
    "OwnerName" : "xxxx",
    "InstanceDescription" : "这个是第一个实例",
    "InstanceName" : "第一个实例",
    "CreatorName" : "xxx",
    "ResourceGroupId" : "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
    "MaxConcurrentConversation" : 4
  }
}

错误码

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

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