调用GetInstance获取实例_云联络中心(Cloud Contact Center)-阿里云帮助中心

调用GetInstance获取指定实例ID所对应的云呼叫中心实例的详细信息。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	2778FA12-EDD6-42AA-9B15-AF855072E5E5
Data	object	数据。
Status	string	实例状态。枚举值： RELEASED：已释放。 RUNNING：正常运行中。 STOPPED：已停服。 CREATING：创建中。	RUNNING
ConsoleUrl	string	云呼叫中心实例的网址，用于访问云呼叫中心实例的主页面，由云呼叫中心的特定网址加上实例 ID 组成。	https://ccc-v2.aliyun.com/#/workbench/ccc-test
Description	string	实例的描述。	云呼叫中心的测试实例。
AliyunUid	string	实例所属的阿里云账户 ID。	157123456789****
Name	string	实例名称。	测试实例
DomainName	string	实例的域名，全局唯一。	ccc-test
Id	string	实例 ID。	ccc-test
AdminList	array<object>	管理员列表。
User	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>	号码列表。
PhoneNumber	object
Active	boolean	是否可用。	true
UserId	string	坐席 ID。如果此参数不为空，说明该号码是座席个人外呼号码。	agent@ccc-test
Number	string	号码。	0830011****
City	string	号码归属地市。	乐山
InstanceId	string	实例 ID。	ccc-test
Usage	string	号码用途。枚举值： Outbound：呼出。 Inbound：呼入。 Bidirection：呼入及呼出。	Bidirection
ContactFlowId	string	该电话号码所关联的联系流 ID（IVR）。	2ec7a58f-3243-4815-bb21-97b480b95f5e
Province	string	号码归属地省。	四川
SkillGroups	array<object>	号码所关联的技能组列表。
SkillGroup	object
DisplayName	string	技能组展示名。	测试技能组
Description	string	技能组描述。	云呼叫中心的测试技能组。
PhoneNumberCount	integer	技能组关联的号码数量。	1
SkillGroupId	string	技能组 ID。	skillgroup@ccc-test
UserCount	integer	技能组关联的坐席数量。	3
InstanceId	string	实例 ID。	ccc-test
Name	string	技能组名称。	skillgroup

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "2778FA12-EDD6-42AA-9B15-AF855072E5E5",
  "Data": {
    "Status": "RUNNING",
    "ConsoleUrl": "https://ccc-v2.aliyun.com/#/workbench/ccc-test",
    "Description": "云呼叫中心的测试实例。",
    "AliyunUid": "157123456789****",
    "Name": "测试实例",
    "DomainName": "ccc-test",
    "Id": "ccc-test\n",
    "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": "2ec7a58f-3243-4815-bb21-97b480b95f5e",
        "Province": "四川",
        "SkillGroups": [
          {
            "DisplayName": "测试技能组",
            "Description": "云呼叫中心的测试技能组。",
            "PhoneNumberCount": 1,
            "SkillGroupId": "skillgroup@ccc-test",
            "UserCount": 3,
            "InstanceId": "ccc-test",
            "Name": "skillgroup"
          }
        ]
      }
    ]
  }
}

错误码

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

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