首页 云呼叫中心 API参考 API目录 实例 ListInstances - 获取实例列表

ListInstances - 获取实例列表

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

接口说明

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

调试

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

调试

授权信息

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

请求参数

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

分页序号,范围1-100。

1
PageSizeinteger

分页大小,范围1-100。

10

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

RequestIdstring

请求ID。

26A34338-5CD9-4C95-A7A6-5BDCE76C6B94
Dataobject

数据。

PageNumberinteger

分页序号,范围1-100。

1
PageSizeinteger

分页大小,范围1-100。

10
TotalCountinteger

总数。

10
Listarray

列表。

object
Statusstring

实例状态。

RUNNING
枚举值:
- RELEASED: 已释放
- RUNNING: 正常运行中
- STOPPED: 已停服
- CREATING: 创建中
ConsoleUrlstring

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

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

实例的描述。

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

实例的创建时间。

1624679747000
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
枚举值:
- ON_SITE: 场内模式
- OFF_SITE: 场外模式
- OFFICE_PHONE: 办公电话模式
Mobilestring

坐席的个人电话号码。

1382114****
UserIdstring

坐席ID。

agent@ccc-test
RoleNamestring

角色名称。

Admin
枚举值:
- Mannager: 技能组组长
- Agent: 坐席
- Admin: 管理员
InstanceIdstring

实例ID。

ccc-test
RoleIdstring

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

Admin@ccc-test
NumberListarray

号码列表。

object
Numberstring

号码。

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 code错误码错误信息描述
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。

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

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