响应参数

客户服务器接收到 隐私保护通话 平台的呼叫事件通知后，根据不同的模式返回不同响应消息。

• Notify模式

  返回无消息体的200响应。

  消息样例

  HTTP/1.1 200 OK 

• Block模式
  响应必须参照表10携带消息体，返回对呼叫事件的处理操作。

  表10 响应消息参数说明

  参数名称	是否必选	参数类型	说明
  operation	否	String(1-32)	用于指示平台的呼叫操作。取值范围如下： connect：接续被叫通话。 close：结束本次呼叫。
  connectInfo	否	ApiConnectInfo	指示平台接续被叫通话的参数列表。 当operation取值为connect时携带。
  closeInfo	否	ApiCloseInfo	指示平台结束会话的参数列表。 当operation取值为close时携带。

  表11 ApiConnectInfo定义

  参数名称	是否必选	参数类型	说明
  displayCalleeNum	否	String(4-31)	被叫端的来显号码，填写为真实主叫号码或呼叫使用的X号码。 填写为全局号码格式。 手机号码格式为国家码（如+86）+手机号码（11位数字的手机号码，如138****0001），填写为"+86138****0001"。 固话号码为国家码（如+86）+不带前置0的区号（如755）+本地固话号码（7或8位数字的固话号码，以实际号码为准，如28****01），填写为"+8675528****01"。 不携带该参数时，默认显示本次呼叫的X号码。 说明： 由于运营商管控，当前平台要求该参数必须设置为呼叫使用的X号码，否则呼叫会被运营商拦截。 若想使用应用下申请的其他X号码作为外显号码，请联系华为云客服。
  calleeNum	是	String(4-31)	真实被叫号码。 填写为全局号码格式。 手机号码格式为国家码（如+86）+手机号码（11位数字的手机号码，如138****0001），填写为"+86138****0001"。 固话号码为国家码（如+86）+不带前置0的区号（如755）+本地固话号码（7或8位数字的固话号码，以实际号码为准，如28****01），填写为"+8675528****01"。
  maxDuration	否	Integer	设置允许本次通话进行的最长时间，单位：分钟，通话时间从接通被叫的时刻开始计算。 取值范围：0~1440 0：系统不主动结束通话，由主被叫双方结束通话。 1~1440：当通话时长达到此配置值，系统主动结束通话。 不携带时，参数值默认为0。
  waitVoice	否	String(0-128)	设置个性化通话前等待音，即主叫听到的回铃音。填写为放音文件名，可在放音文件管理页面查看。 不携带该参数时主叫会听到真实被叫的回铃音。
  recordFlag	否	String（枚举）	是否需要针对本次通话录音。 false：表示不录音 true：表示录音。 该参数仅当客户添加应用时申请开通了录音功能才有效。 如果不携带该参数，系统默认不录音。
  recordHintTone	否	String(0-128)	此参数仅在recordFlag为true时有效。 此字段用于设置录音提示音，填写为放音文件名，可在放音文件管理页面查看。 说明： 因隐私协议及运营商管控，录音的呼叫必须携带该参数，否则呼叫会被运营商拦截。
  lastMinVoice	否	String(0-128)	设置通话剩余最后一分钟时的提示音，填写为放音文件名，可在放音文件管理页面查看。 当maxDuration字段设置为非0时此参数有效。 不携带该参数表示通话剩余最后一分钟时不放音。
  calleeHintVoice	否	String(0-128)	该参数用于设置被叫提示音，即通话接通后优先向被叫用户播放提示音。填写为放音文件名，可在放音文件管理页面查看。 不携带该参数表示不优先向被叫用户播放提示音。
  userData	否	String(0-256)	用户自定义数据，会在该次通话的后续状态报告和话单中原样返回。 不允许携带以下字符：“{”，“}”（即大括号）。 不允许包含中文字符，如果包含中文字符请采用Base64编码。 说明： 当X模式callin事件响应中的userData包含中文时，平台会终止呼叫接续。

  表12 ApiCloseInfo定义

  参数名称	是否必选	参数类型	说明
  closeHintTone	否	String(1-128)	设置挂机提示音，即主叫被挂机前听到的提示音。 填写为放音文件名，可在放音文件管理页面查看。 不携带该参数时系统挂机前不放音。
  userData	否	String(1-256)	用户自定义数据，会在该次通话的后续状态报告和话单中原样返回。 不允许携带以下字符：“{”，“}”（即大括号）。 不允许包含中文字符，如果包含中文字符请采用Base64编码。 说明： 当X模式callin事件响应中的userData包含中文时，平台会终止呼叫接续。

消息样例

• 接续被叫通话

  HTTP/1.1 200 OK
  
  Content-Type: application/JSON;charset=UTF-8
  Content-Length: xx
  
  {"operation":"connect",
  "connectInfo":{"calleeNum":"+86156****6201","maxDuration":0,"waitVoice":"waitVoice.wav","recordFlag":"true","recordHintTone":"recordHintTone.wav","userData":"testuserdate"}}

• 结束本次呼叫

  HTTP/1.1 200 OK
  
  Content-Type: application/JSON;charset=UTF-8
  Content-Length: xx
  
  {"operation":"close",
  "closeInfo":{"closeHintTone":"closeHintTone.wav","userData":"testuserdate"}}