首页 云呼叫中心 API参考 API目录 实例 ListInstancesOfUser - 获取用户所属的实例列表

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

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

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
PageNumberinteger

分页序号,范围1-100。

1
PageSizeinteger

分页大小,范围1-100。

10

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

RequestIdstring

请求ID。

3969FC68-CEC2-4398-B76A-60D2F7EDEBAF
Dataobject

数据。

PageNumberinteger

分页序号,范围1-100。

1
PageSizeinteger

分页大小,范围1-100。

10
TotalCountinteger

总数。

10
Listarray

列表。

object
Statusstring

实例状态。

RUNNING
枚举值:
- RELEASED(已注销): RELEASED(已注销)
- CREATING(创建中): CREATING(创建中)
- RUNNING(正常运行中): RUNNING(正常运行中)
- STOPPED(已停服): STOPPED(已停服)
ConsoleUrlstring

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

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

实例的描述。

云呼叫中心的测试实例。
AliyunUidstring

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

157123456789****
Namestring

实例名称。

测试实例
DomainNamestring

实例的域名,全局唯一。

ccc-test
Idstring

实例ID。

ccc-test
AdminListarray

管理员列表。

object
DisplayNamestring

管理员的姓名。

测试坐席
Extensionstring

坐席分机号。

8032****
LoginNamestring

坐席登录名。

agent
Emailstring

邮箱。

username@example.com
WorkModestring

工作模式。

ON_SITE
枚举值:
- OFF_SITE(场外模式): OFF_SITE(场外模式)
- ON_SITE(场内模式): ON_SITE(场内模式)
- OFFICE_PHONE(办公电话模式): OFFICE_PHONE(办公电话模式)
Mobilestring

坐席的个人电话号码。

1382114****
UserIdstring

坐席ID。

agent@ccc-test
RoleNamestring

角色名称。

Admin
枚举值:
- Manager(技能组组长): Manager(技能组组长)
- Agnet(坐席): Agnet(坐席)
- Admin(管理员): Admin(管理员)
InstanceIdstring

实例ID。

ccc-test
RoleIdstring

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

Admin@ccc-test
NumberListarray

号码列表。

object
Activeboolean

是否可用。

true
UserIdstring

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

agent@ccc-test
Numberstring

号码。

0830011****
Citystring

号码归属地市。

乐山
InstanceIdstring

实例ID。

ccc-test
Usagestring

号码用途。

Bidirection
枚举值:
- Bidirection(呼入及呼出): Bidirection(呼入及呼出)
- Inbound(呼入): Inbound(呼入)
- Outbound(呼出): Outbound(呼出)
ContactFlowIdstring

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

a3fb6c62-9b49-4942-ae5b-cf2abd4123ek
Provincestring

号码归属地省。

四川
SkillGroupsarray

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

object
DisplayNamestring

技能组展示名。

测试技能组
Descriptionstring

技能组描述。

云呼叫中心的测试技能组。
PhoneNumberCountinteger

技能组关联的号码数量。

1
SkillGroupIdstring

技能组ID。

skillgroup@ccc-test
UserCountinteger

技能组关联的坐席数量。

2
InstanceIdstring

实例ID。

ccc-test
Namestring

技能组名称。

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 code错误码错误信息描述
400Parameter.MaximumThe parameter %s must be less than or equal to %s.参数必须小于或等于系统规定的最大值。
400Parameter.MinimumThe parameter %s must be greater than or equal to %s.参数必须大于或等于系统规定的最小值。

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

阿里云首页 云呼叫中心 相关技术圈