ListInstancesOfUser-阿里云帮助中心

You can invoke ListInstancesOfUser to obtain the list of Cloud Contact Center instances to which the User belongs.

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	Paging ordinal number, ranging from 1 to 100.	1
PageSize	integer	Yes	Paging size, ranging from 1 to 100.	10

Response elements

Element	Type	Description	Example
	object
Code	string	Response code.	OK
HttpStatusCode	integer	HTTP status code.	200
Message	string	Response message.	无
RequestId	string	Request ID.	3969FC68-CEC2-4398-B76A-60D2F7EDEBAF
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 (log off) CREATING（创建中） : CREATING (Creation in progress) RUNNING（正常运行中） : RUNNING (running) STOPPED（已停服） : STOPPED (service stopped)	RUNNING
ConsoleUrl	string	The URL of the Cloud Contact Center instance, used to access the homepage of the Cloud Contact Center instance. It consists of the specific Cloud Contact Center URL followed by the instance ID.	https://ccc-v2.aliyun.com/#/workbench/ccc-test
Description	string	The instance description.	云联络中心的测试实例。
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: OFF_SITE（场外模式） : OFF_SITE (off-site mode) ON_SITE（场内模式） : ON_SITE (on-site mode) OFFICE_PHONE（办公电话模式） : 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: Agent : Agent Manager（技能组组长） : Manager (Skill Group Leader) Admin（管理员） : 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>	List of numbers.
	array<object>
Active	boolean	Indicates whether the number is active.	true
UserId	string	Agent ID. If this parameter is not empty, the number is a personal outbound number assigned to the agent.	agent@ccc-test
Number	string	The number.	0830011****
City	string	The city of the phone number's registration location.	乐山
InstanceId	string	Instance ID.	ccc-test
Usage	string	The usage of the number. Valid values: Bidirection（呼入及呼出） : Bidirection (inbound and outbound) Inbound（呼入） : Inbound (incoming calls) Outbound（呼出） : Outbound (outgoing calls)	Bidirection
ContactFlowId	string	The contact flow ID (IVR) associated with this phone number.	a3fb6c62-9b49-4942-ae5b-cf2abd4123ek
Province	string	The province of the phone number's registration location.	四川
SkillGroups	array<object>	List of skill groups associated with the phone number.
	object
DisplayName	string	The display name of the skill group.	测试技能组
Description	string	Skill group description.	云联络中心的测试技能组。
PhoneNumberCount	integer	Number of phone numbers associated with the skill group.	1
SkillGroupId	string	The skill group ID.	skillgroup@ccc-test
UserCount	integer	The number of agents associated with the skill group.	2
InstanceId	string	Instance ID.	ccc-test
Name	string	The name of the skill group.	skillgroup

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Parameter.Maximum	The parameter %s must be less than or equal to %s.
400	Parameter.Minimum	The parameter %s must be greater than or equal to %s.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.