DocsICP FilingConsole
官方文档
首页

ListInstances

更新时间：
复制 MD 格式
产品详情
我的收藏

Invoke the ListInstances API to obtain the list of Cloud Contact Center instances under the current Alibaba Cloud account.

Operation description

If a RAM user needs to invoke this API, the RAM user must have the "Manage Cloud Call Center (CCC)" permission (AliyunCCCFullAccess).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
PageNumber

integer

Yes

The paging ordinal number, ranging from 1 to 100.

1
PageSize

integer

Yes

The paging size, ranging from 1 to 100.

10

Response elements

Element

Type

Description

Example

object

Code

string

The response code.

OK
HttpStatusCode

integer

HTTP status code.

200
Message

string

Response message.

无
RequestId

string

Request ID.

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

object

Data.

PageNumber

integer

Page number, ranging from 1 to 100.

1
PageSize

integer

Page size, ranging from 1 to 100.

10
TotalCount

integer

Total count.

10
List

array<object>

List.

array<object>

Status

string

Instance status.

Valid values:

  • RELEASED :

    Released

  • RUNNING :

    Running normally

  • STOPPED :

    Stopped

  • CREATING :

    Creating

RUNNING
ConsoleUrl

string

The URL of the Cloud Contact Center instance, used to access the homepage of the Cloud Call Center instance. It is composed of the specific Cloud Call Center URL followed by the instance ID.

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

string

The instance description.

云联络中心的测试实例。
CreateTime

integer

The creation time of the instance.

1624679747000
AliyunUid

string

The Alibaba Cloud account ID to which the instance belongs.

157123456789****
Name

string

The instance name.

测试实例
DomainName

string

The domain name of the instance, which is globally unique.

ccc-test
Id

string

The instance ID.

ccc-test
AdminList

array<object>

Administrator list.

object

DisplayName

string

The administrator's name.

测试坐席
Extension

string

Agent extension number.

8032****

LoginName

string

Agent logon name.

agent
Email

string

Mailbox.

username@example.com
WorkMode

string

Work mode.

Valid values:

  • ON_SITE :

    On-site mode

  • OFF_SITE :

    Off-site mode

  • OFFICE_PHONE :

    Office phone mode

ON_SITE
Mobile

string

The agent's personal phone number.

1382114****
UserId

string

Agent ID.

agent@ccc-test
RoleName

string

Role name.

Valid values:

  • Mannager :

    Skill group leader

  • Agent :

    Agent

  • Admin :

    Administrator

Admin
InstanceId

string

Instance ID.

ccc-test
RoleId

string

The role ID, in the format: role@instance ID.

Admin@ccc-test
NumberList

array<object>

The list of numbers.

object

Number

string

The number.

0830011****

Examples

Success response

JSON format

{
  "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****"
          }
        ]
      }
    ]
  }
}

Error codes

HTTP status code

Error code

Error message

Description
404 NotExists.InstanceId The specified instance %s does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.