调用GetInstance通过呼叫中心实例ID获取该实例相关信息。

调试

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

请求参数

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

系统规定参数。取值:GetInstance

InstanceId String ef1e71e9-ae9d-487c-96ad-9181d85cf802

待获取信息的呼叫中心实例ID。

返回数据

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

响应码

HttpStatusCode Integer 200

HTTP状态码

Instance Struct

呼叫中心实例信息

Admin Array of User

呼叫中心实例管理员列表,是用户列表的子集。

User
Detail Struct

详细信息。

Department String IT

部门。

DisplayName String 测试test

用户的全名。

Email String 123@xx.com

用户的电子邮件地址。

LoginName String cctest

用户登陆名。

Phone String 131xxxx1234

用户的电话号码。

InstanceId String ef1e71e9-ae9d-487c-96ad-9181d85cf802

用户所归属的呼叫中心实例。

RamId String 1059803544828509

用户所对应的RAM账户ID。

UserId String

用户ID, 全局唯一。

ConsoleUrl String ccc.aliyun.com/workbench/111

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

CreatedTime Long 1537867125000

创建时间。

DirectoryId String

目录ID,即阿里云UID。

DomainName String 111

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

InstanceDescription String 测试实例

实例描述信息。

InstanceId String ef1e71e9-ae9d-487c-96ad-9181d85cf802

呼叫中心实例ID,系统自动生成的唯一标示符。

InstanceName String 测试11111

呼叫中心实例的名称。

MaxOnlineAgents Integer 100

呼叫中心实例的最大同时登陆在线的座席数量。

Owner String 1059803544828509

实例的拥有者。

PhoneNumbers Array of PhoneNumber

呼叫中心对外服务的电话号码列表。

一个呼叫中心可以有多个电话号码对外服务,但是呼入时所有电话号码都对应同一个IVR流程。比如招商银行分别为位于国内和国外的客户分别提供了400和021的电话号码。默认情况下,每一个号码都可以用于呼入呼出。

PhoneNumber
AllowOutbound Boolean true

是否允许外呼。

InstanceId String ef1e71e9-ae9d-487c-96ad-9181d85cf802

电话号码所归属的呼叫中心实例。

Number String 02500000000

电话号码。

PhoneNumberDescription String Ali Telecom

该电话号码的简单描述。

PhoneNumberId String 51349d57-e7a1-4dba-bd16-34d93251207d

电话号码ID,系统自动生成的唯一标示符。

RemainingTime Integer 0

测试号码剩余的通话时间。单位为分钟。

TestOnly Boolean false

是否是测试号码。

Trunks Integer 1

电话号码的中继数量,即可同时支持几路通话,数据来源于大于。

Usage String Bidirection

电话号码的用途。

Status String Creating

实例状态。

StorageBucket String cloudcallcenter-online

录音文件存贮位置,如果不指定,则存放在一个公共的存贮空间。

StorageMaxDays Integer 0

录音文件最多存贮多少天。

StorageMaxSize Integer 100

录音文件最大存贮容量GB。

TenantId String acc2985

租户ID。

Message String

响应信息

RequestId String 2778FA12-EDD6-42AA-9B15-AF855072E5E5

请求ID

Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=GetInstance
&InstanceId=ef1e71e9-ae9d-487c-96ad-9181d85cf802
&<公共请求参数>

正常返回示例

XML 格式

<Message>无</Message>
<RequestId>2778FA12-EDD6-42AA-9B15-AF855072E5E5</RequestId>
<Instance>
    <Status>Creating</Status>
    <PhoneNumbers>
        <PhoneNumber>
            <Usage>Bidirection</Usage>
            <AllowOutbound>true</AllowOutbound>
            <TestOnly>false</TestOnly>
            <Number>02500000000</Number>
            <InstanceId>ef1e71e9-ae9d-487c-96ad-9181d85cf802</InstanceId>
            <RemainingTime>0</RemainingTime>
            <Trunks>1</Trunks>
            <PhoneNumberId>51349d57-e7a1-4dba-bd16-34d93251207d</PhoneNumberId>
            <PhoneNumberDescription>Ali Telecom</PhoneNumberDescription>
        </PhoneNumber>
    </PhoneNumbers>
    <Owner>1059803544828509</Owner>
    <CreatedTime>1537867125000</CreatedTime>
    <ConsoleUrl>ccc.aliyun.com/workbench/111</ConsoleUrl>
    <DomainName>111</DomainName>
    <InstanceId>ef1e71e9-ae9d-487c-96ad-9181d85cf802</InstanceId>
    <StorageMaxSize>100</StorageMaxSize>
    <Admin>
        <User>
            <RamId>1059803544828509</RamId>
            <InstanceId>ef1e71e9-ae9d-487c-96ad-9181d85cf802</InstanceId>
            <UserId>无</UserId>
        </User>
        <User>
            <Detail>
                <LoginName>cctest</LoginName>
                <Department>IT</Department>
                <Email>123@xx.com</Email>
                <Phone>131xxxx1234</Phone>
                <DisplayName>测试test</DisplayName>
            </Detail>
        </User>
    </Admin>
    <InstanceName>测试11111</InstanceName>
    <MaxOnlineAgents>100</MaxOnlineAgents>
    <TenantId>acc2985</TenantId>
    <DirectoryId>无</DirectoryId>
    <StorageBucket>cloudcallcenter-online</StorageBucket>
    <StorageMaxDays>0</StorageMaxDays>
    <InstanceDescription>测试实例</InstanceDescription>
</Instance>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Success>true</Success>

JSON 格式

{
	"Message": "无",
	"RequestId": "2778FA12-EDD6-42AA-9B15-AF855072E5E5",
	"Instance": {
		"Status": "Creating",
		"PhoneNumbers": {
			"PhoneNumber": [{
				"Usage": "Bidirection",
				"AllowOutbound": "true",
				"TestOnly": "false",
				"Number": "02500000000",
				"InstanceId": "ef1e71e9-ae9d-487c-96ad-9181d85cf802",
				"RemainingTime": "0",
				"Trunks": "1",
				"PhoneNumberId": "51349d57-e7a1-4dba-bd16-34d93251207d",
				"PhoneNumberDescription": "Ali Telecom"
			}]
		},
		"Owner": "1059803544828509",
		"CreatedTime": "1537867125000",
		"ConsoleUrl": "ccc.aliyun.com/workbench/111",
		"DomainName": "111",
		"InstanceId": "ef1e71e9-ae9d-487c-96ad-9181d85cf802",
		"StorageMaxSize": "100",
		"Admin": {
			"User": [{
				"RamId": "1059803544828509",
				"InstanceId": "ef1e71e9-ae9d-487c-96ad-9181d85cf802",
				"UserId": "无"
			}, {
				"Detail": {
					"LoginName": "cctest",
					"Department": "IT",
					"Email": "123@xx.com",
					"Phone": "131xxxx1234",
					"DisplayName": "测试test"
				}
			}]
		},
		"InstanceName": "测试11111",
		"MaxOnlineAgents": "100",
		"TenantId": "acc2985",
		"DirectoryId": "无",
		"StorageBucket": "cloudcallcenter-online",
		"StorageMaxDays": "0",
		"InstanceDescription": "测试实例"
	},
	"HttpStatusCode": "200",
	"Code": "OK",
	"Success": "true"
}

错误码

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