调用ListPhoneNumbers获取呼叫中心实例的所有电话号码。

调试

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

请求参数

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

系统规定参数。取值:ListPhoneNumbers

InstanceId String 9cfad875-6260-4a53-ab6e-b13e3fb31f7d

待获取电话号码的呼叫中心实例ID

OutboundOnly Boolean false

仅包含外呼电话号码

返回数据

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

响应码

HttpStatusCode Integer 200

HTTP状态码

Message String

响应信息

PhoneNumbers Array

获取到的呼叫中心实例的所有电话号码列表

PhoneNumber

获取到的呼叫中心实例的所有电话号码列表

AllowOutbound Boolean true

是否允许外呼,结果取决于:

  • 大于的设置,比如400号码不允许外呼
  • 呼叫中心实例的设置
说明 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不绑定联系流IVR,但是ACC不建议这么做。
Assignee String 3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0

号码占用者,如技能组ID

City String 杭州

电话号码的城市。

ContactFlow

电话号码所连接的联系流IVR。

ContactFlowDescription String Welcome

联系流的简单描述。

ContactFlowId String 2932

联系流唯一ID,系统自动生成的唯一标示符。

ContactFlowName String Welcome

联系流名称,在一个实例内名称不能重复。

InstanceId String d278629c-c687-4aa3-b044-4fe9b012e7ef

联系流所归属的呼叫中心实例。

Type String 0

流程类型, 定义来自于ContactFlowType。

InstanceId String ade80092-03d9-4f4d-ad4f-ab8a247d3150

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

Number String 057128236231

电话号码。

NumberCommodityStatus Integer 0

号码商品状态 0 正常 1 欠费 2 实例已删除

PhoneNumberDescription String Ali Telecom

电话号码的简单描述。

PhoneNumberId String 0010faaa-0c07-4421-8929-9ea6a051464b

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

PrivacyNumber

电话号码所绑定的虚拟号码关系。

BizId String 4b32b62d3aae4d86a6c4bb26c3eea3dd

第三方业务ID。

Extra String {"name":"amy","cardno":"130226198001110819"}

其他参数,以Json字符串存入。

PhoneNumber String 057128236231

绑定的呼叫中心号码。

PoolId String 18b74553-484f-40c7-b6f9-81be0cbe3593

虚拟号码所在池子ID。

PoolName String 个人虚拟号码

虚拟号码池名称。

RegionNameCity String 上海市

虚拟号码归属地市。

SubId String 6a5f6c7c2f774fb38b4aaf35c4e797c3

类型为AXN,返回的绑定关系唯一标识,若类型为AXB,则此字段为空。

TelX String 13020155449

选择AXN模式绑定的虚拟号码,若类型为AXB,则此字段为空。

Type String AXN

选择绑定虚拟号码的类型,包括AXNAXB

Province String 浙江

电话号码的省份。

RemainingTime Integer 60

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

SipTelX String 19701699172

sip虚拟号码

SkillGroups Array

电话号码所关联的技能组。

SkillGroup

电话号码所关联的技能组。

SkillGroupId String 3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0

技能组ID。

SkillGroupName String 预测试外呼技能组

技能组名称。

TestOnly Boolean false

是否是测试号码。

Trunks Integer 30

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

Usage String Bidirection

电话号码的用途,呼入(Inbound),呼出(Outbound),已经同时用于呼入和呼出(Bidirection)。上述值由枚举类型PhoneNumberType定义。

该值的结果取决于:

  • 大于的设置,比如400号码不允许外呼
  • 呼叫中心实例的设置
说明 电话号码一般都允许内呼,如果不允许内呼,可以1)由大于做设置,用户拨打该号码时听到提示音 2)该号码不连接人和联系流IVR,但是ACC不建议这么做。
RequestId String D38E508B-5190-4E1A-AA88-709B0BA547A3

请求ID

Success Boolean true

是否成功

示例

请求示例


http(s)://ccc.cn-shanghai.aliyuncs.com/?Action=ListPhoneNumbers
&InstanceId=9cfad875-6260-4a53-ab6e-b13e3fb31f7d
&OutboundOnly=false
&<公共请求参数>

正常返回示例

XML 格式

<ListPhoneNumbersResponse>
      <code>OK</code>
      <httpStatusCode>200</httpStatusCode>
      <phoneNumbers>
            <allowOutbound>true</allowOutbound>
            <assignee>test-friend-mode</assignee>
            <city>杭州</city>
            <contactFlow>
                  <contactFlowDescription>description for 虚拟号码回拨</contactFlowDescription>
                  <contactFlowId>xEcD_10ZSbN8</contactFlowId>
                  <contactFlowName>虚拟号码回拨</contactFlowName>
                  <instanceId>ade80092-03d9-4f4d-ad4f-ab8a247d3150</instanceId>
                  <type>0</type>
            </contactFlow>
            <instanceId>ade80092-03d9-4f4d-ad4f-ab8a247d3150</instanceId>
            <number>057128236231</number>
            <phoneNumberDescription>Ali Telecom</phoneNumberDescription>
            <phoneNumberId>0010faaa-0c07-4421-8929-9ea6a051464b</phoneNumberId>
            <privacyNumber>
                  <bizId>4b32b62d3aae4d86a6c4bb26c3eea3dd</bizId>
                  <extra>
                        <name>amy</name>
                        <cardno>130226198001110819</cardno>
                  </extra>
                  <phoneNumber>057128236231</phoneNumber>
                  <poolId>18b74553-484f-40c7-b6f9-81be0cbe3593</poolId>
                  <poolName>个人虚拟号码</poolName>
                  <regionNameCity>上海市</regionNameCity>
                  <subId>6a5f6c7c2f774fb38b4aaf35c4e797c3</subId>
                  <telX>13020155449</telX>
                  <type>AXN</type>
            </privacyNumber>
            <province>浙江</province>
            <remainingTime>0</remainingTime>
            <testOnly>false</testOnly>
            <trunks>1</trunks>
            <usage>Bidirection</usage>
      </phoneNumbers>
      <requestId>D38E508B-5190-4E1A-AA88-709B0BA547A3</requestId>
      <success>true</success>
</ListPhoneNumbersResponse>

JSON 格式

{
	"httpStatusCode":200,
	"requestId":"D38E508B-5190-4E1A-AA88-709B0BA547A3",
	"phoneNumbers":[
		{
			"phoneNumberDescription":"Ali Telecom",
			"testOnly":false,
			"instanceId":"ade80092-03d9-4f4d-ad4f-ab8a247d3150",
			"assignee":"test-friend-mode",
			"remainingTime":0,
			"number":"057128236231",
			"city":"杭州",
			"phoneNumberId":"0010faaa-0c07-4421-8929-9ea6a051464b",
			"privacyNumber":{
				"telX":"13020155449",
				"regionNameCity":"上海市",
				"poolName":"个人虚拟号码",
				"phoneNumber":"057128236231",
				"subId":"6a5f6c7c2f774fb38b4aaf35c4e797c3",
				"extra":{
					"name":"amy",
					"cardno":"130226198001110819"
				},
				"type":"AXN",
				"bizId":"4b32b62d3aae4d86a6c4bb26c3eea3dd",
				"poolId":"18b74553-484f-40c7-b6f9-81be0cbe3593"
			},
			"contactFlow":{
				"contactFlowDescription":"description for 虚拟号码回拨",
				"contactFlowName":"虚拟号码回拨",
				"instanceId":"ade80092-03d9-4f4d-ad4f-ab8a247d3150",
				"type":"0",
				"contactFlowId":"xEcD_10ZSbN8"
			},
			"allowOutbound":true,
			"province":"浙江",
			"trunks":1,
			"usage":"Bidirection"
		}
	],
	"code":"OK",
	"success":true
}

错误码

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