华为云用户手册

  • 报文样例 请求消息样例 { "tenantId": "ipcc", "authToken": "0**************************", "sentence": "请座", "language": "zh_CN", "checkerType": "nonWordSpellChecker"} 响应消息样例 { "hasMistake": false, "spellCheckerMatchList": [ { "word": "请", "startIndex": 0, "endIndex": 1, "hasMistake": false, "correctWord": "请" }, { "word": "座", "startIndex": 1, "endIndex": 2, "hasMistake": true, "correctWord": "坐" } ]}
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID,默认为ipcc用户,即同获取token时,约定好的ipcc用户。 authToken String body True Token token失效后,需重新调用获取token接口。 请参见C3 智能助手平台接口鉴权方式。 sentence String body True 输入文本,长度限制4096位 language String body True 传入语言参数: zh_CN:中文 en_US:英文 传入语言参数类型要求与输入文本类型匹配。 【限制】中英文可正常纠错,其他语种文本不做纠错直接返回。再返回的对象中的“是否存在错别字”字段设置为false,即不存在纠错的情况 checkerType String body True 校验类型: 错字纠错: nonWordSpellChecker 别字纠错: realWordSpellChecker 中文仅存在别字纠错。 英文推荐使用错字纠错
  • 场景描述 给第三方接入方调用,实现拼写检查能力。 当用户输入要查询的问题时,如果输入的句子中存在错别字(中文是同音错字,英文是拼写错误),系统能够具有对这些错误进行纠错的能力。 对接Customer Service Platform系统时,采取Headers头部的userName+token组合鉴权方式,其中userName为ipcc,token获取方式参见C3 智能助手平台接口鉴权方式。 对接其他第三方系统,采取请求体的authToken鉴权方式。
  • 报文样例 请求消息样例 { "serviceToken":"160*******************bbb489426", "subCCID":"10001", "taskID":"node_action_97511fbc15d9b23074405ee736187a82c529", "respType":"StartSpeech", "sentence":{ "st":1 "et":2 "isFinal":true "text":"sdffasdfaedfasdfasdfsad" "confidence":0 } } 响应消息样例 { "retCode" : "0", "retMsg":"asr recognize success" }
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 serviceToken String body True 鉴权token,OIAP调用宇高请求识别接口(transfertoasr)携带的serviceToken字段 subCCID String body False 呼叫中心编号 taskID String body True capturesession时使用的ID 对话开启抓包录制请求(inaction=7)中使用的呼叫唯一标志,与userid 、call_id取值相同,给流程使用。 说明: capturesession的含义请参见对应音视频录制服务器配套提供的接口参考。 respType String body True NormalResult:正常结束 StartSpeech:用户开始说话 默认为StartSpeech sentence Json Object body True 转写结果信息 analysis Json Object body False 对象质检分析信息 speakerID String body False 通话者标识,人工通话时使用 0 客户 1 座席 2 其它 缺省为0 表2 sentence参数说明 参数 数据类型 参数位置 必选/可选 描述 st int body True 一句的起始时间戳,单位ms et int body True 一句的结束时间戳,单位ms isFinal boolean body True true表示是最终结果,false表示是中间临时结果 text String body True 识别结果文本,使用 text = URLEncoder.encode(text,"UTF-8"); confidence float body True 识别结果的置信度0~1,中间结果统一为0 表3 analysis参数说明 参数 数据类型 参数位置 必选/可选 描述 emotions emotion[] body False 情绪信息数组,如果 checkEmotion 为 false 或者没有检测到情绪信息时,没有此字段 说明: checkEmotion的含义请参见对应音视频录制服务器配套提供的接口参考。 avgVol int body False 平均音量,如果 outputVolume 为 false, 则无此字段 说明: outputVolume的含义请参见对应音视频录制服务器配套提供的接口参考。 maxVol int body False 最大音量,如果 outputVolume 为 false, 则无此字段 speed int body False 语速,如果 outputSpeed 为 false, 则无此字段 说明: outputSpeed的含义请参见对应音视频录制服务器配套提供的接口参考。 表4 emotion参数说明 参数 数据类型 参数位置 必选/可选 描述 st int body True 音频开始时间,单位ms et int body True 音频结束时间,单位ms c float body True 置信度,范围[0.0, 1.0] e String body False 情绪, HAPPY, ANGRY, SAD, DISGUSTED 之一(不同ASR厂家可能不同)
  • 报文样例 请求样例 {"account":"odfs","nonce":"*******", // 服务端提供的原始随机文本"checksum":"0dbe11*******************0b505de" // 客户端根据nonce值及本地密钥使用HmacSHA256加密算法加密处理后的文本} 响应样例 {"token":"2**************************d","duration":3600}
  • 响应参数 名称 是否必选 参数类型 长度 说明 token False String 128 认证成功必须返回,业务请求接口需要的token duration False int 4 认证成功必须返回,token有效期(秒) error False String 512 认证失败时返回错误信息,同时状态码返回401。 nonce False String 128 认证失败时返回,服务端随机生成的字符串。
  • 常用错误码 表1 常用错误码参考表 错误码 描述 900001 无Token信息,或Token已过期。 900002 检查Token信息失败。 10000001 内部错误,通常因为应用系统故障引起。 10000002 参数错误。通常由于请求中未提供全部必填字段的值。 10000006 接口入参重复 10000007 接口出参重复 10000008 接口头参数重复 10000003 参数不存在,必须输入该参数 10000004 参数已经在系统中存在,不能重复使用 20000001 处于发布状态不能修改 20000002 流程名已经存在 20000003 删除节点错误,节点被别的流程引用 20000004 删除变量错误,变量被流程或者模板引用 20000005 修改变量错误,原变量被流程或者模板引用 20000006 文件路径不存在 20000007 IOException 读取文件流错误 20000008 更新数据错误 200900002 内部错误,通常因为应用系统故障引起 200900003 参数错误。通常由于请求中未提供全部必填字段的值 200800001 密钥不存在 200800002 密钥错误 200800003 锁账号
  • 典型交互序列 第一步 获取token 首先确认是系统粒度(内部系统如CEC或CSP)对接还是租户粒度(第三方系统)对接。 第三方系统在与智能助手平台系统对接,需要使用租户id来获取token(C3 智能助手平台接口鉴权方式),在token有效期内完成调用操作,而且后续每一次接口调用都需要传入获取的token。 内部系统(CEC或CSP)与OIAP对接,需要使用默认系统对接约定的默认用户来获取token(C3 智能助手平台接口鉴权方式),在token有效期内完成调用操作,而且后续每一次接口调用都需要传入获取的token。 第二步 建立与智能助手平台系统的绑定关系 在获取token后,第三方需通过传入特定租户和语言信息查询号航系统对应已激活的领域(领域查询接口),并绑定第三方的接入标识与领域的绑定(对话标识绑定查询接口)。 第三步 完成对话交互 在将接入标识与智能助手平台系统的领域完成绑定后,就可以通过调用智能助手平台的各种对话接口来实现对话交互了(对话接口),比如初始化,放音,转接,挂机等。
  • 响应消息样例3 { "userid": "1528780879-9581", "outaction": 10, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "start_time": "2018090407:16:24", "end_time": "2018090407:30:24", "release_reason": "0", "region_id": "025", "entrance_id": "03", "exit_id": "05", "user_type_id": "01", "suilu_region_id":"025" }}
  • outparams参数(outaction=11:对话转接类操作) 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 call_sor_id String body True 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) trans_type String body True 对话转移类型 1:转人工(路由码方式转技能队列) 2:转IVR 3:转人工(技能名称方式转技能队列) 4:转人工(转座席工号) 5:转接第三方号码 6:在线数字辅助 7:转人工(转熟客,目前仅支持多媒体) 8:转人工(转座席所在技能队列,目前仅支持多媒体) 31:转多媒体留言(转熟客) 32:转多媒体留言(转技能队列) 33:转多媒体留言(转座席) route_value String body True 路由值信息,依赖trans_type取值,当trans_type= 如下值时: 1,route_value=技能队列后续接入码 2,route_value=IVR流程接入码 3,route_value=技能队列名称 4,route_value=座席工号 5,route_value=第三方号码 6,流程路由码 7,无 8,座席工号 31,无 32,技能队列名称或者接入码 33,座席工号 trans_data String body False 随路数据(转人工时传递) calling_num String body O 呼叫转移第三方号码时,优先使用此号码作为主叫号码 record_path String body O 录音全路径名(仅当route_value=第三方号码时生效,启动会场录音,当为空或不存在时则不录音) inter_idx String body O(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。 trans_idx String body O(语音导航场景特有字段) 跳转序数。 question_id String body False(语音外呼问卷场景特有字段) 问题id(外呼场景使用)(废弃) question_name String body False(语音外呼问卷场景特有字段) 问题名称(外呼场景使用)(废弃) answer_id String body False(语音外呼问卷场景特有字段) 问题答案(外呼场景使用)(废弃)
  • 响应消息样例2 { "userid": "1528780879-9581", "outaction": 11, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "calling_num":"1234567890", "trans_type": "1", "route_value": "123456789", "inter_idx": "1", "trans_idx": "1", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" }}
  • outparams参数(outaction=10:对话拆线类操作) 注:一通会话结束,都要以IVR发起inaction=9/11且input=hangup的请求后,ODFS触发拆线响应,返回给IVR后为结束标记,IVR此后不再调用ODFS的接口。 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 call_sor_id String body True 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) call_dst_id String body True 接入标识 (1、语音导航场景传入被叫号码; 2、语音外呼问卷场景时为问卷类型id; 3、其他交互场景时传入接入标识)。 start_time String body True 对话交互开始时间 end_time String body True 对话交互结束时间。 release_reason String body False odfs流程走到结束图元是否是正常流程逻辑 0、正常业务逻辑进入结束图元; 1、流程遇到异常、超时等没有容错业务逻辑处理时走到结束图元。 region_id String body False(语音导航场景特有字段) 用户归属地。 entrance_id String body False(语音导航场景特有字段) 入口维度。 exit_id String body False(语音导航场景特有字段) 出口维度,取值同入口维度。 user_type_id String body False(语音导航场景特有字段) 用户类型。 suilu_region_id String body False(语音导航场景特有字段) 呼叫接入地。
  • 响应消息样例1 { "userid": "1528780879-9581", "outaction": 9, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "prompt_wav": "welcome", "prompt_text": "查询话费", "language": "0", "inter_idx": "1", "model_type":"1011201" "timeout": "10", "tone": "", "grammar": "", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" }}
  • outparams参数(outaction=12:查询类操作) 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 prompt_type String body True 查询类型。 1:通话在技能队列中排队时,查询当前技能队列排队信息; 2:通话不在技能队列排队,进入技能队列前,根据技能队列Id查询排队信息; 3:根据座席工号,查询座席所在技能队列信息 5: 音视频切换操作 moduleName String body False 模块名称,图元的名称 inter_idx String body False(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。 changeType String body True 切换类型. 音频:1 音视频:3
  • 请求消息样例 { "userid": "1528780879-9581", "inaction": 9, "inparams": { "call_id": "1528780879-9581", "call_dst_id": "10086", "flow_result_type":"1", "input":"帮我查一下我的话费", "inter_idx": "1", "begin_play": "2018090407:16:24", "end_play": "2018090407:16:30", "result_time":"2018090407:16:3", "inter_no":"0" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005", "queueIndex":"2", "agentCount":"5" }} ODFS判断如果 flow_result_type = 1 且 input = (识别结果id值) 时会调用Redis获取转写文本(key=识别结果id值中redis值编号key),获取到的识别文本格式为字符串(非JSON格式)。 Lua脚本获取Redis结果示例代码如下,示例中代码key值为“msg”字符串。
  • outparams参数(outaction=9:对话交互类操作) 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 prompt_type String body True 交互类型。 0:语音交互播放指定提示音(全路径) 1:语音交互播放指定提示 2:语音交互播放TTS内容 3:文字交互 4:对呼叫方录音 5:视频播放 6:多媒体 7:卡片 prompt_wav String body False(语音导航场景特有字段) 当prompt_type=0,4,5 时填播放或录音的文件全路径名(必须保证为UAP可读取的路径); 当prompt_type=1 时填语音文件名(不包含路径头,播放时由IVR拼接路径头) prompt_text String body True TTS动态文本内容/文字对话内容, 当prompt_type为2,3,6,7时必填 language String body True 语种id(TTS放音以及ASR识别必须传) 0:中文 1:英文 inter_idx String body False(语音导航场景特有字段) ODFS侧记录的与用户连续交互的次数。 model_type String body O(语音导航场景特有字段) 模板类型,由7位数字组成,前三位分别代表放音\识别\按键的支持情况(1支持,0不支持);紧接着两位代表最大按键长度,后两位是*#是否做为功能键(1功能键-#代表确定,*代表取消,0不作为功能键-普通输入键)。 如:1011201代表支持放音按键,不支持识别,最大按键长度为12位,#为确认键。 1101200 代表支持放音识别,不支持按键,后面四位1200无效。 timeout String body False(语音导航场景特有字段) 放音超时时长(秒),放音结束后等待输入超时时间。 collectTimeout String body False(应答模式为支持按键打断场景特有字段) 收号超时时间(秒) tone String body False(语音导航场景特有字段) 当prompt_type=4 录音时必传 true:录音开始前播放“嘀”音 false:录音开始前不播放“嘀”音 vendor String body False(语音导航场景特有字段) ASR语音识别扩展参数 grammar String body False(语音导航场景特有字段) ASR语法文件名(包含路径和后缀) question_id String body False(语音外呼问卷场景特有字段) 问题序号(外呼场景使用),如Q1,Q2;(废弃) question_name String body False(语音外呼问卷场景特有字段) 问题名称(外呼场景使用) (废弃) answer_id String body False(语音外呼问卷场景特有字段) 问题答案(外呼场景使用), 是:Y; 否:N; 超时:TIMEOUT; 拒识:NOMATCH; 其他异常:ERROR 如问题设定非“是”“否”这种答案,则需要以实际约定配置的结果为准 (废弃) flowRecordFlag String body False 是否需要录音标志。 0:需要 1:不需要 flowRecordPath String body False 需要录音时返回录音文件的路径。 ttsGroupId String body False TTS服务器在Uap上配置的GroupId ttsSoundEffect String body False TTS声效 男生朗读:0 女生朗读:1; ttsSoundSpeed String body False TTS音速: 低速朗读:0; 中速朗读:1; 高速朗读:2 ttsMRCPVendor String body False TTS扩展参数,即它的mrcp vendor参数,当前最大长度40 asrMRCPId String body False ASR服务器在Uap上配置的MRCPId asrSlotName String body False 解析ASR识别槽位使用的关键字 asrRecognizeType String body False ASR识别类型 普通识别:0; 智能识别:1 asrNoInputTimeout String body False 用户无话超时时长,默认100,单位s asrRecognitionTimeout String body False 识别结果超时时长,默认200,单位s asrSpeechCompleteTimeout String body False 用户停顿超时长,默认500,单位s responseSource int body False 回复来自机器人还是静默座席,机器人--0,静默座席--1 specialRecognize int body False 是否使用抓包录制的识别 原始识别--0,抓包录制识别--1 Prompt_text格式说明【for 智能信息匹配业务】 参数名称 数据类型 参数位置 必选/可选 Value描述 来源 sentiment_analysis String body False 情绪检测类型: negative, positive, neutrality TUC实时质检 sentiment_analysis_score Integer body False 情绪检测得分 0-100 TUC实时质检 role String body False 用户类型 座席:staff 用户:customer 其他:空字符串 TUC实时质检 sensitive_word Json Object body O 敏感词的提醒信息 {"违禁语":["密码"]} TUC敏感词配置 Intend String body True 客户意图 说明文本 TUC意图 recomand_KP List body False 推荐知识点信息 业务知识库 call_script Json String body True 话术推荐 说明: intentcode是TUC意图码,允许为空intentDsp是意图描述,不能为空 { {intentcode:“”, intentDsp:“”,"status":"",childintent[{intentcode:“”, intentDsp:“”,"status":""},{intentcode:“”, intentDsp:“”, "status":""}…]} { intentcode:“”, intentDsp:“”, "status":""} } ODFS资源模板配置 call_script_matchedstep String body False 意图码 对应上述call_script中的意图码 表示话术进展(被匹配的步骤) TUC意图 Prompt_text格式说明【for 智能工单填写业务】 参数名称 数据类型 参数位置 必选/可选 描述 使用方法 beginIndex String body True 实体在文本中的开始索引位置 实体在文本中的开始索引位置 endIndex String body True 实体在文本中的结束索引位置 实体在文本中的结束索引位置 type String body True 抽取的实体类型 用于标注此实体的识别类型,不需要填入表单 entity String body True 实体内容,已做规则化 用于填入表单对应字段 tag String body True 表单中待填写的字段名 如:对象二级
  • ExtParams参数 参数名称 数据类型 参数位置 必选/可选 描述 transin_data String body False 由接入方跟OIAP约定的随路数据参数,例如IVR传入的数据包参数 release_reason String body False(语音导航场景特有字段) ivr上报给odfs呼叫拆线的原因码: 0、业务流程正常拆线; 1、系统异常拆线; 2、用户拆线; queueIndex String body False(查询排队信息场景特有) 查询技能队列的排队位置 agentCount String body False(查询排队信息场景特有) 查询技能队列的在线座席数 estimateTime String body False(查询排队信息场景特有) 查询技能队列的预计等待时间 idleAgentCount String body False(查询排队信息场景特有) 查询技能队列的空闲座席数
  • inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同,给流程使用。 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入被叫号码; 2、语音外呼问卷场景时为问卷类型id; 3、其他交互场景时传入接入标识。 不超过20位 flow_result_type String body True 结果类型。 1:语音识别输入或者文字输入 2:语音按键输入 3:正常无输入(只播放) 4:录音结束 -1:其他 input String body True 对话交互结果。 语音识别结果或者文字输入:语音识别结果为id值,格式为redis值编号key+@+inter_no;文字输入结果则直接为文字内容 语音按键结果:按键值,如"1","201801"等 playover:放音结束 timeout:超时 nomatch:识别或按键失败 sys_err:系统异常 hangup:挂机 recordend:录音结束 当结果为hangup时,可触发ODFS的拆线响应。 不超过1024位 auth_token String body True 授权信息,取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 recordFileName String body False(支持全流程录音的语音导航场景特有字段) 全流程录音的路径文件名,例如:Y:/record/1/20200421/xxxxxx.wav inter_idx String body False(语音导航场景特有字段) 交互次数,直接取上一次ODFS返回的inter_idx值即可。 begin_play String body False(语音导航场景特有字段) 放音开始时间 end_play String body False(语音导航场景特有字段) 放音结束时间 result_time String body False(语音导航场景特有字段) 结果产生的时间 inter_no String body False(语音导航场景特有字段) 识别标识 IACmd String body False(语音导航场景特有字段) 智能匹配和智能工单填写专用字段 智能匹配时,只支持值为match 智能工单时,可取值如下: match:请求填单 rematch:当识别的事项分类错误时,重新识别 confirm:当座席点选某字段时,告知odfs该字段已确认 TextSource String body False(语音导航场景特有字段) 当IACmd为match时,用于区分输入文本来自座席还是用户(智能匹配、智能工单相同),值为staff或customer staff:座席 customer:用户 当IACmd为confirm时,传入座席点选的字段名,如:对象二级 当IACmd为rematch时,可不填 feedback int body False 反馈的满意度: 1(满意);0(不满意) feedbackContent String body False 反馈的不满意原因(如果反馈为满意则为空) mediaType String body False 媒体类型(文本,音频,视频... 例如:audio,video...) channelType String body False 渠道类型(电话,微信 ...) 例如:WEB...) refeedbackContentcordFileName String body False 录音文件名 call_media_type String body False 呼入ivr的呼叫类型,音频:1 视频:3
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 userid String body True ODFS根据在Userid内部建立呼叫实例,同一时间ODFS内部可能有多个呼叫实例, 后继的交互根据Userid将同一通电话关联起来。 不超过64位 inaction int body True 接入方本次执行的是什么类型的请求: 8: 对话初始化请求 (第一次调用时) 9: 对话交互后请求 11: 对话转移后请求 注:除了第一次调用时必须为8, 后继传入值即为上次交互接收到的“outaction”即可。 seat String body False 座席类型,不填默认为vir vir:虚拟座席 ass:座席助手 inparams Object body True 用于向ODFS传递参数,告知ODFS本次操作结果的详细信息,Inaction的值不同,Params的参数也不相同,根据下面细分的场景详细了解参数介绍。 extparams Object body False 用于向ODFS传递参数,可选的扩展参数,当前只有初始化场景使用
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 ret int body True 执行结果 0:成功 非0表示失败 userid String body True ODFS根据在userid内部建立呼叫实例,同一时间ODFS内部可能有多个呼叫实例,,后继的交互根据userid将同一通电话关联起来。 outaction int body True 接下来接入方需要执行什么类型的操作 9:对话交互类操作 11:对话转接类操作 10:拆线操作 12:查询类操作 7:对话开启抓包录制请求 13:请求识别结果 outparams Object body True 用于知会接入方完成操作需要的详细信息,请根据具体的场景查看参数介绍。
  • 请求说明 表1 请求体参数 序号 参数名 参数类型 是否必选 说明 1 tenantId string True 租户ID。 2 authToken string True 认证token。 请参见C3 智能助手平台接口鉴权方式。 3 text string True 待合成的文本内容,必须使用UTF-8编码。 4 config Object True 语音合成的配置信息。 该对象的参数说明请参见表2。 表2 config参数说明 序号 参数名 参数类型 是否必选 说明 4.1 voiceName String True 模型特征串,服务器端利用此值来调用不同的模型。 目前支持的有: cn_chengshuxing_common(成熟型) cn_kefuman_common(客服曼) cn_roumeiqian_common(柔美倩) cn_tianmeiru_common(甜美茹) cn_ziranzhen_common(自然真) 4.2 pitch String False 基频,调节音调高低。 取值范围:-500~500, 缺省:0。 4.3 volume String False 音量,调节音量大小。 取值范围:0~100,缺省:50。 4.4 speed String False 语速,调节语速快慢。 取值范围:-500~500, 缺省:0。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 参数名 参数类型 说明 1 retCode String 0,成功,其他为失败。 2 retMsg String 失败原因的描述。 3 data object 返回结果。 该对象的参数说明请参见表4。 表4 data参数说明 序号 参数名 参数类型 说明 3.1 format String 音频编码格式。 3.2 sampleRate int 音频采样率。 3.3 voiceData String BASE64编码之后的音频数据。 3.4 sentences List 输出的分句信息。 该对象的参数说明请参见表5。 表5 sentences参数说明 序号 参数名 参数类型 说明 3.4.1 st int 本句的开始时间戳,以ms为单位。 3.4.2 et int 本句的结束时间戳,以ms为单位。 3.4.3 offset int 本分句在原始文本中的起始位置,以字节为单位。 3.4.4 len int 本分句在原始文本中的长度,以字节为单位。 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求消息头 Content-Type:application/json; charset=UTF-8 请求体消息 { "config": { "voiceName":"cn_tianmeiru_common" }, "text":"你好,测试一下文本合成语音接口。", "authToken": "********************", "tenantId":"********************"} 响应体消息 { "data": { "sentences": [ { "st": 0, "offset": 0, "len": 48, "et": 2790 } ], "voiceData": "UklGRuRsAQBXQVZFZm10IBA", "format": "wav", "sampleRate": "16000" }, "retCode": "0"}
  • inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body False 呼叫唯一标志,与userid 取值相同,给流程使用。 不超过64位 call_sor_id String body False 用户标识。(语音导航、语音外呼场景传入用户号码,其他交互场景传入用户id) 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入流程接入码; 2、语音外呼问卷场景时为流程接入码; 3、其他交互场景时传入接入标识。 不超过20位 real_callee String body False 实际接入IVR时的被叫号码,当语音导航场景下有效 不超过32位 cti_callid String body False(语音导航场景特有字段) 华为ivr传入的实际呼叫的CTI的callid,其他场景此值为空 不超过32位 auth_token String body True 授权信息,取接入控制系统返回的token值。
  • 请求消息样例 { "userid": "1528780879-9581", "inaction": 7, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1MzgwMzg5MzUsImV4cCI6MTUzODA0MjUzNSwian" }}
  • 报文样例 请求样例 {"beginTime": 1631203200000,"endTime": 1631289540000,"tenantId": "xxxxxx","pageNum": 1,"pageSize": 100,"authToken": "xxxxxxxxxx"} 响应样例 { "rbtRecognitions": [ { "rbtRecognitionId": 953730645354352640, "callId": "xxxxxxx-xxxx", "fileName": "Y:\\268\\0\\20210908\\2608\\xxxx.V3", "callerNo": "xxxxxxx", "calleeNo": "xxxxxxx", "agentId": 1234, "recordBeginTime": 1631240233000, "recordEndTime": 1631067449000, "callType": 7, "mediaType": 5, "vdnId": 123, "tenantId": "123456789", "callCenterId": 1, "releaseCause": 531, "beginTime": 1631241600000, "endTime": 1631241730000, "result": 105 } ], "total": 1, "pageSize": 100, "pageNum": 1}
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 beginTime long body True 查询开始时间的毫秒时间戳 须知: 该接口数据为保证效率已按月份分表,查询时只会查询开始时间所对应月份的表 endTime long body True 查询结束时间的毫秒时间戳 tenantId String body True 租户ID pageNum int body False 查询页数,从1开始,默认为1 pageSize int body False 查询每页数量,最大为1000,默认为1000 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 rbtRecognitions RbtRecognition[] body True 外呼失败原因分析结果 total int body True 总数 pageSize int body True 每页数量 pageNum int body True 第几页,从1开始 表2 RbtRecognition 名称 是否必选 参数类型 说明 rbtRecognitionId True long 结果标识 callId True string 机器人访问量 fileName True string 录音文件盘符路径 callerNo True string 主叫号码 calleeNo True string 被叫号码 agentId True int 座席ID recordBeginTime True long 录音开始时间 recordEndTime True long 录音结束时间 callType True int 呼叫类型,固定值7,代表人工外呼 mediaType True int 媒体类型,固定值5,代表语音 vdnId True int CTI 虚拟呼叫中心标识 tenantId True string 租户标识 callCenterId True int CTI 呼叫中心标识 releaseCause True int 拆线原因,具体可参考CTI产品文档 beginTime True long 结果录入时间 endTime False long 结果更新时间 result False int 结果,请参考表3 表3 外呼失败原因 code 原因 -1 录音文件名错误 -2 录音下载失败 -3 请求ASR转写失败 -4 获取ASR转写返回失败 -5 获取意图识别结果失败 101 被叫号码是空号 102 被叫用户关机 103 被叫网络忙 104 主叫号码欠费停机 105 被叫号码停机 106 被叫正忙,且已登记呼叫等待 107 被叫正忙,且未登记呼叫等待 108 被叫不在服务区 109 被叫已开通呼叫转移 110 国际长途限制 111 被叫长时间未接听 112 被叫已设置呼入限制 113 其他运营商方向线路故障 114 被叫无法接通,且已开通来电提醒
  • 报文样例 场景描述:样例报文 请求头: x-app-key:9******************************3 Authorization:Bearer c******************************f Content-Type:application/json 请求参数: {"offset": 0,"limit": 3} 响应头: {"connection": "keep-alive","content-type": "application/json;charset=UTF-8"} 响应参数: {"retMsg": "successfully","retCode": "0","result": {"total": 6,"regPort": "5060","phone": [{"phoneNum": "999000","password": "****"},{"phoneNum": "999001","password": "****"},{"phoneNum": "999002","password": "****"}],"regIPAddress": "10.10.18.36"}}
共100000条