查询一个外呼实例

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeInstance

系统规定参数。取值：DescribeInstance。
InstanceId String 是 af81a389-91f0-4157-8d82-720edd02b66a

实例ID

返回数据

名称 类型 示例值 描述
Code String OK

接口状态码
HttpStatusCode Integer 200

http 状态码
Instance Struct

实例信息
CreationTime Long 1578469042851

创建时间
InstanceDescription String 这个是第一个实例

实例描述
InstanceId String 90515b5-6115-4ccf-83e2-52d5bfaf2ddf

实例id
InstanceName String 第一个实例

实例名字
MaxConcurrentConversation Integer 4

实例最大并发
Message String Success

接口提示信息
RequestId String 254EB995-DEDF-48A4-9101-9CA5B72FFBCC

请求id
Success Boolean true

是否成功

示例

请求示例

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

正常返回示例

XML 格式 

<Code>OK</Code>
<HttpStatusCode>200</HttpStatusCode>
<Instance>
    <InstanceDescription>这是第一个的实例</InstanceDescription>
    <creationTime>1578469042851</creationTime>
    <InstanceId>90515b5-6115-4ccf-83e2-52d5bfaf2ddf</InstanceId>
    <InstanceName>第一个实例</InstanceName>
    <MaxConcurrentConversation>4</MaxConcurrentConversation>
</Instance>
<requestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</requestId>
<success>true</success>

JSON 格式 

{
    "Code": "OK",
    "HttpStatusCode": 200,
    "Instance": {
        "InstanceDescription": "这是第一个的实例",
        "creationTime":1578469042851,
        "InstanceId": "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
        "InstanceName": "第一个实例",
        "MaxConcurrentConversation": 4
    },
    "requestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "success": true
}

错误码

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

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