调用ListInstances查询云联络中心实例列表-云联络中心-阿里云-云联络中心(Cloud Contact Center)-阿里云帮助中心

调用ListInstances获取当前阿里云账号下的云联络中心实例列表。

接口说明

若 RAM 子账号需要调用该接口，则需具有“管理云呼叫中心(CCC)的权限”（AliyunCCCFullAccess）。

调试

您可以在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。	26A34338-5CD9-4C95-A7A6-5BDCE76C6B94
Data	object	数据。
PageNumber	integer	分页序号，范围 1-100。	1
PageSize	integer	分页大小，范围 1-100。	10
TotalCount	integer	总数。	10
List	array<object>	列表。
	array<object>
Status	string	实例状态。枚举值： RELEASED : 已释放 RUNNING : 正常运行中 STOPPED : 已停服 CREATING : 创建中	RUNNING
ConsoleUrl	string	云联络中心实例的网址，用于访问云呼叫中心实例的主页面，由云呼叫中心的特定网址加上实例 ID 组成。	https://ccc-v2.aliyun.com/#/workbench/ccc-test
Description	string	实例的描述。	云联络中心的测试实例。
CreateTime	integer	实例的创建时间。	1624679747000
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	工作模式。枚举值： ON_SITE : 场内模式 OFF_SITE : 场外模式 OFFICE_PHONE : 办公电话模式	ON_SITE
Mobile	string	坐席的个人电话号码。	1382114****
UserId	string	坐席 ID。	agent@ccc-test
RoleName	string	角色名称。枚举值： Mannager : 技能组组长 Agent : 坐席 Admin : 管理员	Admin
InstanceId	string	实例 ID。	ccc-test
RoleId	string	角色 ID，格式为：角色@实例 ID。	Admin@ccc-test
NumberList	array<object>	号码列表。
	object
Number	string	号码。	0830011****

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "26A34338-5CD9-4C95-A7A6-5BDCE76C6B94",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "List": [
      {
        "Status": "RUNNING",
        "ConsoleUrl": "https://ccc-v2.aliyun.com/#/workbench/ccc-test",
        "Description": "云联络中心的测试实例。",
        "CreateTime": 1624679747000,
        "AliyunUid": "157123456789****",
        "Name": "测试实例",
        "DomainName": "ccc-test",
        "Id": "ccc-test",
        "AdminList": [
          {
            "DisplayName": "测试坐席",
            "Extension": "8032****\n",
            "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": [
          {
            "Number": "0830011****"
          }
        ]
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	NotExists.InstanceId	The specified instance %s does not exist.	指定的呼叫中心实例不存在。

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

变更历史

更多信息，参考变更详情。