查询外呼实例列表

调试

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

请求参数

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

系统规定参数。取值：ListInstances。
ResourceGroupId String 否 rg-acfmwd4qr3z773y

资源组id
Tag.N.Key String 否 name

资源组标签key
Tag.N.Value String 否 xxx

资源组标签值

返回数据

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

接口状态码
HttpStatusCode Integer 200

http 状态码
Instances Array of Instance

实例列表
CreationTime Long 1578469042851

创建时间
CreatorId Long 435986

创建者id
CreatorName String xxx

实例创建者
InstanceDescription String 这个第一个实例

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

实例id
InstanceName String 第一个实例

实例名字
MaxConcurrentConversation Integer 10

最大允许的外呼并发数量
OwnerName String xxx

所有者名称
ResourceGroupId String rg-acfmwd4qr3z773y

资源组id
ResourceTags Array of ResourceTag

标签信息
Key String age

标签key
Value String 20

标签值
Message String Success

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

请求id
Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=ListInstances
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

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

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