ListInstancesOfUser - 获取用户所属的实例列表

更新时间:
复制为 MD 格式

调用ListInstancesOfUser获取用户所属的云联络中心实例列表。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

PageNumber

integer

分页序号,范围 1-100。

1

PageSize

integer

分页大小,范围 1-100。

10

返回参数

名称

类型

描述

示例值

object

Code

string

响应码。

OK

HttpStatusCode

integer

HTTP 状态码。

200

Message

string

响应信息。

RequestId

string

请求 ID。

3969FC68-CEC2-4398-B76A-60D2F7EDEBAF

Data

object

数据。

PageNumber

integer

分页序号,范围 1-100。

1

PageSize

integer

分页大小,范围 1-100。

10

TotalCount

integer

总数。

10

List

array<object>

列表。

array<object>

Status

string

实例状态。

枚举值:

  • RELEASED(已注销) :

    RELEASED(已注销)

  • CREATING(创建中) :

    CREATING(创建中)

  • RUNNING(正常运行中) :

    RUNNING(正常运行中)

  • STOPPED(已停服) :

    STOPPED(已停服)

RUNNING

ConsoleUrl

string

云联络中心实例的网址,用于访问云联络中心实例的主页面,由云联络中心的特定网址加上实例 ID 组成。

https://ccc-v2.aliyun.com/#/workbench/ccc-test

Description

string

实例的描述。

云联络中心的测试实例。

AliyunUid

string

实例所属的阿里云账户 ID。

157123456789****

Name

string

实例名称。

测试实例

DomainName

string

实例的域名,全局唯一。

ccc-test

Id

string

实例 ID。

ccc-test

AdminList

array<object>

管理员列表。

object

DisplayName

string

管理员的姓名。

测试坐席

Extension

string

坐席分机号。

8032****

LoginName

string

坐席登录名。

agent

Email

string

邮箱。

username@example.com

WorkMode

string

工作模式。

枚举值:

  • OFF_SITE(场外模式) :

    OFF_SITE(场外模式)

  • ON_SITE(场内模式) :

    ON_SITE(场内模式)

  • OFFICE_PHONE(办公电话模式) :

    OFFICE_PHONE(办公电话模式)

ON_SITE

Mobile

string

坐席的个人电话号码。

1382114****

UserId

string

坐席 ID。

agent@ccc-test

RoleName

string

角色名称。

枚举值:

  • Agent :

    坐席

  • Manager(技能组组长) :

    Manager(技能组组长)

  • Admin(管理员) :

    Admin(管理员)

Admin

InstanceId

string

实例 ID。

ccc-test

RoleId

string

角色 ID,格式为:角色@实例 ID。

Admin@ccc-test

NumberList

array<object>

号码列表。

array<object>

Active

boolean

是否可用。

true

UserId

string

坐席 ID,如果此参数不为空,说明该号码是座席个人外呼号码。

agent@ccc-test

Number

string

号码。

0830011****

City

string

号码归属地市。

乐山

InstanceId

string

实例 ID。

ccc-test

Usage

string

号码用途。

枚举值:

  • Bidirection(呼入及呼出) :

    Bidirection(呼入及呼出)

  • Inbound(呼入) :

    Inbound(呼入)

  • Outbound(呼出) :

    Outbound(呼出)

Bidirection

ContactFlowId

string

该电话号码所关联的联系流 ID(IVR)。

a3fb6c62-9b49-4942-ae5b-cf2abd4123ek

Province

string

号码归属地省。

四川

SkillGroups

array<object>

号码所关联的技能组列表。

object

DisplayName

string

技能组展示名。

测试技能组

Description

string

技能组描述。

云联络中心的测试技能组。

PhoneNumberCount

integer

技能组关联的号码数量。

1

SkillGroupId

string

技能组 ID。

skillgroup@ccc-test

UserCount

integer

技能组关联的坐席数量。

2

InstanceId

string

实例 ID。

ccc-test

Name

string

技能组名称。

skillgroup

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "3969FC68-CEC2-4398-B76A-60D2F7EDEBAF",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "List": [
      {
        "Status": "RUNNING",
        "ConsoleUrl": "https://ccc-v2.aliyun.com/#/workbench/ccc-test",
        "Description": "云联络中心的测试实例。",
        "AliyunUid": "157123456789****",
        "Name": "测试实例",
        "DomainName": "ccc-test",
        "Id": "ccc-test",
        "AdminList": [
          {
            "DisplayName": "测试坐席",
            "Extension": "8032****",
            "LoginName": "agent",
            "Email": "username@example.com",
            "WorkMode": "ON_SITE",
            "Mobile": "1382114****",
            "UserId": "agent@ccc-test",
            "RoleName": "Admin",
            "InstanceId": "ccc-test",
            "RoleId": "Admin@ccc-test"
          }
        ],
        "NumberList": [
          {
            "Active": true,
            "UserId": "agent@ccc-test",
            "Number": "0830011****",
            "City": "乐山",
            "InstanceId": "ccc-test",
            "Usage": "Bidirection",
            "ContactFlowId": "a3fb6c62-9b49-4942-ae5b-cf2abd4123ek",
            "Province": "四川",
            "SkillGroups": [
              {
                "DisplayName": "测试技能组",
                "Description": "云联络中心的测试技能组。",
                "PhoneNumberCount": 1,
                "SkillGroupId": "skillgroup@ccc-test",
                "UserCount": 2,
                "InstanceId": "ccc-test",
                "Name": "skillgroup"
              }
            ]
          }
        ]
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 Parameter.Maximum The parameter %s must be less than or equal to %s. 参数必须小于或等于系统规定的最大值。
400 Parameter.Minimum The parameter %s must be greater than or equal to %s. 参数必须大于或等于系统规定的最小值。

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

变更历史

更多信息,参考变更详情