《语音对讲功能接口技术要求.docx》由会员分享,可在线阅读,更多相关《语音对讲功能接口技术要求.docx(4页珍藏版)》请在优知文库上搜索。
1、语音对讲功能接口技术要求1.l语音通知1)功能代码:notify2)功能介绍向指定号码发起呼叫,播放指定或组合的语音文件、TTS文本。3)接口参数参数参数说明数据类型必须备注ClisplayNumber主显号码,默认不填String否为空表示随机使用本账户下主显号码呼出,输入云呼平台已分配号码则表示使用输入的号码,主显号码必须由云呼平台分配,不可使用用户自己号码,具体可用号码请于商务沟通。CalleeNumber被叫号码String是格式要求:手机号VoiceFileId语音文件IDString是语音文件、TelnPIatelD二者至少有个templateID语音通知TTS模板IDString
2、是登录云呼官网添加模板,并获取模板ID,模板最多8个变量,模板内容+变量内容最多200字符,中文算一个字符IemplateArgSTTS变量内容:varl:xx”,var2xxString是使用TemplateID时必填,模板无变量时规则:,tempIdIeArgs*:,单个变量最多30个字replayTimes重播次数:1、2、3int否默认重播1次,线路不支持时无效ttsFirst0:先播11S,1:先播语音文件int否默认语音文件先播,不存在TTS时无效,线路不支持时无效recordButton是否记录用户按键,0:开启,1:关闭int否默认关闭,线路不支持时无效calIRec是否对通话
3、录音,1:开启,0:关闭int否默认关闭,线路不支持时无效CallbackUrl呼叫结果推送地址String否可自由指定呼叫结果推送的地址CustomerData用户自定义字段,推送话单时会将该字段推送给用户。String(64)否最大长度不要超过64.4)示例POSTvoicel.0.0notifyda622c2aec784991a6002a71cd2b0be78cfbfl14b9875d39bff6fb5c7be3d9bdIITTP/1.1Host:101.37.133.245:11008Authorization:NTU50UZDREEyQTZBMEI40EI2MjgIMERENjdCQ
4、TQyQUl=Accept:application/jsonContent-Type:application/json(*templateId*/400098*,*templateArgs*:varl:*leeon*,*displayNumber*:*,*caIleeNumber*:*,replayTmes:3,*callbackUr1:9780/Voice/api/VoiceWebreceiveRecord*)5)响应参数参数参数说明数据类型备注callTd呼叫标识String单个呼叫时返回,用于标识每通电话result响应结果StringOOoooO表示提交成功,详见响应代码message
5、响应代码具体原因String详见响应代码6)示例“cal1Id:be4b9e90bl3c65f28a8f4f”,“result:000000”,“message:OK1.1.1语音通知推送1)功能介绍用于向语音通知中参数“callbackUrl”定义的地址推送语音通知的呼叫结果。每条记录只推送一次,请确保推送地址的稳定性,接收后需要响应,若推送失败(无响应)超过3次,会停止推送此条记录。2)接口参数参数参数说明数据格式必要备注accountld用户账号String是用户账号callld呼叫标识String是CalleeNumber被叫号码String是StartCallTime呼叫开始时间St
6、ring否anSwercdTime接通时间String否endTime结束时间String否CallState呼叫状态String是详见呼叫状态说明duration通话时长Int否单位:秒button用户所按按键Int在recUrl录音文件下载URLString否若需要下载,建议1小时后再获取CustomcrData用户提交请求中携带的自定义字段String否3)推送示例*accountld*:*bl7ccd0afaf248f78cf648aa29f26bf7*,*answeredTime*:*2017-07-1915:03:52*,wCalleeNumber*button:,“callid:c82acc353a98a5a4de”,*cal!State*:0,“duration*,*endTime*2017-07-1915:03:55*,*startCallTime*2017-07-1915:03:52*)4)响应信息(必须给予响应,否则认为推送失败)(resultCode”:“200”,