呼叫回调文档 - 语音服务

简介

当您使用融合通信服务时，在呼叫的某些环节会回调开发者的http接口，用业务鉴权和呼叫控制。所有http接口都是使用post的方式，返回值是一个json对象。

如果您在我们平台配置了呼出操作鉴权http回调地址，我们在隶属于您的融合通信账号发生呼出操作时，会通过http接口回调您的服务端接口，并依据返回的结果决定是否允许当前操作继续发生。如果您没有配置对应的回调接口，我们默认这个操作是允许的。

参数名称	参数类型	必填与否	样例取值	参数说明
communicationType	String	必须	voip2voip	呼叫类型，可能的值为voip2voip/voip2pstn
callerInfo	Object	必须	{“voipId” : “2000000000000007”}	主叫信息
calleeInfos	Array	必须	[{“isPstn” : “true”, “platformNumber” : “13812341234”,”phoneNumber” : “13712341234”}]	被叫信息
channelId	String	必须	12323123123	本次通话的唯一标识
extend	String	必须	abc	sdk发起呼叫时传入的扩展字段

callerInfo结构体

参数名称	参数类型	必填与否	样例取值	参数说明
voipId	String	必须	20000000000001	主叫数据语音账号

calleeInfo结构体

参数名称	参数类型	必填与否	样例取值	参数说明
isPstn	Boolean	必须	true	是否为pstn
platformNumber	String	非必须	057100000000	isPstn为true时有该字段，呼出到pstn时使用的主叫电话号码，即被叫看到的来电号码
phoneNumber	String	非必须	13800000000	isPstn为true时有该字段，被叫电话号码
selfLineName	String	非必须	123	isPstn为true且为自有线路用户时有该字段，自有线路名称
voipId	String	非必须	20000000000001	isPstn为false时有该字段，被叫数据语音账号

model结构体

出参名称	出参类型	样例取值	参数说明
timeLimit	Long	100	本次通话可允许的最大通话时长，单位为秒，可选
needRecord	Boolean	true	本次通话是否需要服务端录音，会覆盖sdk调用相关接口设置的值

如果您在我们平台配置了呼入http回调地址，我们在隶属于您的呼叫送达到我们平台时会调用您的这个http接口获取您希望呼叫的融合通信账号列表（也就是被叫）。

出参名称	出参类型	样例取值	参数说明
success	Boolean	true	是否允许当前操作，为true表示允许
model	Object	{“calleeInfos”:[{“rtcId”:2000000000003812}]}	被叫信息列表

model结构体

出参名称	出参类型	样例取值	参数说明
calleeInfos	Array	[{“rtcId”:2000000000003812}]	呼入到voip端的被叫信息，暂只支持一个被叫，若存在该字段则呼转信息不生效，可选
pstnTransferInfos	Object	{“callMode” : “sequence”, “pstnTransferCallees” : [{“showNumber” : “057186842823”, “phoneNumber” : “13858139970”}]}	转呼到其他pstn端的被叫信息，支持多个号码顺序振铃或同时振铃，可选
timeLimit	Long	100	本次通话可允许的最大通话时长，单位为秒，可选
needRecord	Boolean	true	（即将支持）本次通话是否需要服务端录音，会覆盖sdk调用相关接口设置的值

calleeInfo结构体

出参名称	出参类型	样例取值	参数说明
rtcId	String	20000000000001	被叫数据语音账号

pstnTransferInfos结构体

出参名称	出参类型	样例取值	参数说明
callMode	String	sequence	呼叫模式，sequence表示多个被叫顺序振铃，parallel表示多个被叫同时振铃
pstnTransferCallees	Array	[{“showNumber” : “057186842823”, “phoneNumber” : “13858139970”}]	pstn被叫信息，如果为顺序振铃模式则按照传入顺序依次振铃，数组最大长度为3

pstnTransferCallee结构体

出参名称	出参类型	样例取值	参数说明
phoneNumber	String	1876713xxxx	被叫电话号码
platformNumber	String	057100000000	转呼时使用的主叫电话号码，需要为已在平台购买且开通数据语音服务的固话号码