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

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

调试

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

请求参数

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

系统规定参数。取值:ListInstances。

PageNumber Integer 1

分页序号,范围1-100。

PageSize Integer 10

分页大小,范围1-100。

返回数据

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

响应码。

Data Struct

数据。

List Array of CallCenterInstance

呼叫中心实例列表。

AdminList Array of User

管理员列表。

DisplayName String 云呼测试1

管理员的姓名。

Email String 18866668888@163.com

电子邮件地址。

Extension String 80326034

分机号码。

InstanceId String ccc-test

呼叫中心实例ID。

LoginName String user-test

用户登陆名。

Mobile String 138xxxx2114

用户电话号码。

RoleId String Admin@ccc-test

用户的角色ID。

RoleName String Admin

角色名称。

  • 管理员(Admin)
  • 技能组组长(Manager)
  • 坐席(Agent)
UserId String user-test@ccc-test

用户ID。

WorkMode String ON_SITE

工作模式。

AliyunUid String 1571234567890123

呼叫中心所对应的阿里云账户ID。

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

呼叫中心控制台URL,由阿里云呼叫中心官方URL加呼叫中心实例的域名组成。

CreateTime Long 1624679747000

呼叫中心实例的创建时间。

Description String 测试实例

呼叫中心实例的简单描述。

DomainName String ccc-test

呼叫中心实例的二级域名,全局唯一。

Id String 呼叫中心实例ID,等价于DomainName。

呼叫中心实例ID。

Name String 云呼测试实例

呼叫中心实例名称。

NumberList Array of PhoneNumber

呼叫中心号码列表。

Number String 083xxxx0011

呼叫中心号码。

Status String RUNNING

实例状态。

PageNumber Integer 1

分页序号。

PageSize Integer 10

分页大小。

TotalCount Integer 3

总条目数。

HttpStatusCode Integer 200

HTTP状态码。

Message String

响应信息。

Params List

响应参数。

RequestId String 26A34338-5CD9-4C95-A7A6-5BDCE76C6B94

请求ID。

示例

请求示例

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

正常返回示例

JSON格式

{
	"RequestId": "26A34338-5CD9-4C95-A7A6-5BDCE76C6B94",
	"Message": "无",
	"HttpStatusCode": "200",
	"Params": "无",
	"Data": {
		"TotalCount": "3",
		"PageSize": "10",
		"PageNumber": "1",
		"List": [{
			"Status": "RUNNING",
			"Description": "测试实例",
			"DomainName": "ccc-test",
			"ConsoleUrl": "https://ccc-v2.aliyun.com/#/workbench/ccc-test",
			"CreateTime": "1624679747000",
			"AliyunUid": "1571234567890123",
			"Id": "呼叫中心实例ID,等价于DomainName。",
			"Name": "云呼测试实例",
			"AdminList": [{
				"Extension": "80326034",
				"LoginName": "user-test",
				"RoleName": "Admin",
				"Email": "18866668888@163.com",
				"InstanceId": "ccc-test",
				"UserId": "user-test@ccc-test",
				"DisplayName": "云呼测试1",
				"RoleId": "Admin@ccc-test",
				"Mobile": "138xxxx2114",
				"WorkMode": "ON_SITE"
			}],
			"NumberList": [{
				"Number": "083xxxx0011"
			}]
		}]
	},
	"Code": "OK"
}

错误码

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

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