调用AddPhoneNumber新增号码。

将从云呼控制台购买的电话号码绑定到呼叫中心实例中,并且可以和IVR流程进行绑定。

调试

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

请求参数

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

系统规定参数。取值:AddPhoneNumber

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

待添加电话号码的呼叫中心实例ID。

PhoneNumber String 053168962496

待添加电话号码。

Usage String Bidirection

该电话号码的用途。取值:呼入(Inbound),呼出(Outboung),已经同时用于呼入和呼出(Bidirection)。

说明 如果传入号码为400号码,该值只能传入Inbound
ContactFlowId String dDMD_0mif4hv

和电话号码绑定的联系流ID。

返回数据

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

响应码

HttpStatusCode Integer 200

HTTP状态码

Message String

响应信息

PhoneNumber

新添加的电话号码的信息

AllowOutbound Boolean true

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

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

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

ContactFlowDescription String Welcome

联系流的简单描述。

ContactFlowId String 2957

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

ContactFlowName String Welcome

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

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

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

Type String 0

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

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

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

Number String 17888888888

电话号码。

PhoneNumberDescription String

电话号码的简单描述。

PhoneNumberId String 9191956d-3464-402b-8017-ea8df5d831fc

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

RemainingTime Integer 60

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

TestOnly Boolean true

是否是测试号码。

Trunks Integer 30

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

Usage String Bidirection

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

该值的结果取决于:

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

请求ID

Success Boolean true

是否成功

示例

请求示例


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

正常返回示例

XML 格式

<AddPhoneNumberResponse>
      <HttpStatusCode>200</HttpStatusCode>
      <RequestId>BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E</RequestId>
      <PhoneNumber>
            <PhoneNumberId>9191956d-3464-402b-8017-ea8df5d831fc</PhoneNumberId>
            <Trunks>1</Trunks>
            <Number>053168962496</Number>
            <AllowOutbound>true</AllowOutbound>
            <ContactFlow>
                  <ContactFlowName>Welcome</ContactFlowName>
                  <ContactFlowDescription>Welcome</ContactFlowDescription>
                  <ContactFlowId>2957</ContactFlowId>
                  <Type>0</Type>
                  <InstanceId>9cfad875-6260-4a53-ab6e-b13e3fb31f7d</InstanceId>
            </ContactFlow>
            <InstanceId>9cfad875-6260-4a53-ab6e-b13e3fb31f7d</InstanceId>
            <PhoneNumberDescription>Ali Telecom</PhoneNumberDescription>
            <TestOnly>false</TestOnly>
            <RemainingTime>0</RemainingTime>
            <Usage>Bidirection</Usage>
      </PhoneNumber>
      <Success>true</Success>
      <Code>OK</Code>
</AddPhoneNumberResponse>

JSON 格式

{
	"HttpStatusCode":200,
	"RequestId":"BC976D32-AC4C-4E0F-8AA9-F4BC6C4E2B3E",
	"PhoneNumber":{
		"PhoneNumberId":"9191956d-3464-402b-8017-ea8df5d831fc",
		"Trunks":1,
		"ContactFlow":{
			"ContactFlowName":"Welcome",
			"ContactFlowDescription":"Welcome",
			"ContactFlowId":"2957",
			"Type":"0",
			"InstanceId":"9cfad875-6260-4a53-ab6e-b13e3fb31f7d"
		},
		"AllowOutbound":true,
		"Number":"053168962496",
		"InstanceId":"9cfad875-6260-4a53-ab6e-b13e3fb31f7d",
		"TestOnly":false,
		"PhoneNumberDescription":"Ali Telecom",
		"Usage":"Bidirection",
		"RemainingTime":0
	},
	"Success":true,
	"Code":"OK"
}

错误码

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