调用ModifyPhoneNumber修改电话号码相关的属性,比如内呼和外呼属性以及绑定的IVR流程。

调试

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

请求参数

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

系统规定参数。取值:ModifyPhoneNumber

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

呼叫中心实例ID

PhoneNumberId String cc583e96-6bae-437e-9aeb-bffd5aeddb73

待修改的电话号码ID

Usage String Bidirection

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

ContactFlowId String 8Cvg_0mcsm6

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

SkillGroupId.N RepeatList 3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0

和电话号码绑定的技能组ID。

参数名称SkillGroupId.1表示只获取1个技能组信息。如果要获取多个技能组信息,则需要有SkillGroupId.1以及SkillGroupId.2。

返回数据

名称 类型 示例值 描述
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 2932

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

ContactFlowName String Welcome

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

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

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

Type String 0

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

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

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

Number String 17788888888

电话号码。

PhoneNumberDescription String Ali Telecom

电话号码的简单描述。

PhoneNumberId String 346489

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

RemainingTime Integer 60

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

SkillGroups

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

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 54F6A60E-541A-4C3B-8A9D-F69FEA9DD704

请求ID

Success Boolean true

是否成功

示例

请求示例


http(s)://ccc.cn-hangzhou.aliyuncs.com/?Action=ModifyPhoneNumber
&InstanceId=d278629c-c687-4aa3-b044-4fe9b012e7ef
&PhoneNumberId=cc583e96-6bae-437e-9aeb-bffd5aeddb73
&Usage=Bidirection
&<公共请求参数>

正常返回示例

XML 格式

<ModifyPhoneNumberResponse>
      <HttpStatusCode>200</HttpStatusCode>
      <RequestId>54F6A60E-541A-4C3B-8A9D-F69FEA9DD704</RequestId>
      <PhoneNumber>
            <PhoneNumberId>cc583e96-6bae-437e-9aeb-bffd5aeddb73</PhoneNumberId>
            <Trunks>1</Trunks>
            <ContactFlow>
                  <ContactFlowName>Welcome</ContactFlowName>
                  <ContactFlowDescription>Welcome</ContactFlowDescription>
                  <ContactFlowId>2932</ContactFlowId>
                  <Type>0</Type>
                  <InstanceId>d278629c-c687-4aa3-b044-4fe9b012e7ef</InstanceId>
            </ContactFlow>
            <AllowOutbound>true</AllowOutbound>
            <Number>02160664656</Number>
            <SkillGroups>
                  <SkillGroup>
                        <SkillGroupName>预测试外呼技能组</SkillGroupName>
                        <SkillGroupId>3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0</SkillGroupId>
                  </SkillGroup>
            </SkillGroups>
            <InstanceId>d278629c-c687-4aa3-b044-4fe9b012e7ef</InstanceId>
            <TestOnly>false</TestOnly>
            <PhoneNumberDescription>Ali Telecom</PhoneNumberDescription>
            <Usage>Bidirection</Usage>
            <RemainingTime>0</RemainingTime>
      </PhoneNumber>
      <Success>true</Success>
      <Code>OK</Code>
</ModifyPhoneNumberResponse>

JSON 格式

{
	"HttpStatusCode":200,
	"RequestId":"54F6A60E-541A-4C3B-8A9D-F69FEA9DD704",
	"PhoneNumber":{
		"PhoneNumberId":"cc583e96-6bae-437e-9aeb-bffd5aeddb73",
		"Trunks":1,
		"Number":"02160664656",
		"AllowOutbound":true,
		"ContactFlow":{
			"ContactFlowName":"Welcome",
			"ContactFlowDescription":"Welcome",
			"ContactFlowId":"2932",
			"Type":"0",
			"InstanceId":"d278629c-c687-4aa3-b044-4fe9b012e7ef"
		},
		"InstanceId":"d278629c-c687-4aa3-b044-4fe9b012e7ef",
		"SkillGroups":{
			"SkillGroup":[
				{
					"SkillGroupName":"预测试外呼技能组",
					"SkillGroupId":"3f3ceb0d-d6b6-4c97-af20-f3daf04f90e0"
				}
			]
		},
		"PhoneNumberDescription":"Ali Telecom",
		"TestOnly":false,
		"RemainingTime":0,
		"Usage":"Bidirection"
	},
	"Success":true,
	"Code":"OK"
}

错误码

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