IVR流程管理-华为云

云客服-查询满意度调查结果（satisfaction/query）:报文样例

报文样例请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "callId": "1647265024-xxxx", "beginTime": 1647265028000, "endTime": 1647265029000 } 响应参数: { "returnCode": "0", "satisfactionEvaluations": { "channel": "audio", "evaluationValue": "5", "evaluationTime": 1647265028000 }, "description": " query Success" }

云客服 IVR流程管理

云客服-查询满意度调查结果（satisfaction/query）:响应说明

响应说明响应状态码: 200 表3 响应体参数序号名称参数类型是否必选说明 1 schema object True - 1.1 returnCode string True 结果返回码，0表示查询成功，-1表示查询失败，description表示失败具体原因 1.2 description string True 结果返回描述 1.3 satisfactionEvaluations object True 满意度评价 1.3.1 evaluationValue string False 满意度评价，为满意度等级配置的字典key值。 “1”表示“很不满意”， “2”表示“不满意”， “3”表示“一般”， “4”表示“满意”， “5”表示“很满意” “-1”表示“超时未回复”，指用户收到满意度评价后，评价超时， “-2”表示“评价错误”指用户回复的满意度，不在满意度配置的按键值中。 1.3.2 channel string False 渠道： audio表示音频渠道，MSG表示短信，WEB表示网页文字交谈渠道 1.3.3 evaluationTime number False 评价时间，毫秒级别Timestamp时间戳类型响应状态码: 400 错误的请求：请检查请求路径及参数。响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服 IVR流程管理

云客服-查询满意度调查结果（satisfaction/query）:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）表2 请求体参数序号名称参数类型是否必选说明 1 requestBody object True 请求入参 1.1 callId string True 通话标识callId 1.2 beginTime number True 评价开始时间，毫秒级别Timestamp时间戳类型 1.3 endTime number True 评价结束时间，毫秒级别Timestamp时间戳类型

云客服 IVR流程管理

云客服-上传IVR语音文件（importVoiceFile/upload）:响应说明

响应说明响应状态码: 200 表4 响应体参数序号名称参数类型是否必选说明 1 schema object True - 1.1 returnCode string True 0，成功，其他为失败 1.2 description string True 描述。 1.3 fileId string False 上传后的语音文件后生成的id，用于关联云客服的录音响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

云客服 IVR流程管理

云客服-上传IVR语音文件（importVoiceFile/upload）:报文样例

报文样例请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "locale" : "zh_CN", "voiceType" : "0", "fileType" : "wav", "callBackUrl" : "http://10.130.40.194:18133/upload", "fileInfo" : "UklGRjJ+AABXQVZFZm10IBIAAAAGAAEAQB8AAEAfAAABAAgAAABkYXRhAH4AANXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1" } 响应参数: { "returnCode": "0", "description": "File uploaded successfully.", "fileId": "1182733043937561608" } 回调URL样例报文： //请求参数 { "fileUrl": "Y:/IVR/147/voice/0/nPqV9vU3_1666706957559.wav", "fileId": "1323606152730207249", "status": "2", "comment": "审核通过" } //响应参数 { "returnCode": "0" }

云客服 IVR流程管理

云客服-上传IVR语音文件（importVoiceFile/upload）:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 2 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数序号名称参数类型是否必选说明 1 body object False - 1.1 fileInfo string True Base64编码后的录音文件信息，限制8MB。上传文件大小会相应增加上传时间 1.2 locale string True 录音文件的语种，zh_CN(中文)、en_US(英文)、pt_BR(葡萄牙语)、th_TH(泰语) 1.3 voiceType string True 语音类型，比如0 是IVR，1提示音，2故障音，3语音通知 1.4 fileType string True 文件类型，支持wav格式和MP3格式 wav格式和MP3格式均会使用ffmpeg工具转码为平台所支持的音频文件格式（A-law压缩算法、单声道、采样位数:8bit、采样频率:8000HZ），转换后音质可能会有影响，音频文件数据可能会丢失，建议使用符合平台支持的音频文件格式。 1.5 callBackUrl string False 回调URL，系统审核后，系统会通过这个url返回审核的结果信息。回调URL为客户自定义接口，用于接收系统审核结果信息，其中请求参数与响应参数可参考表3。回调URL已通过系统管理员加入IVR语音上传回调的地址白名单中。 URL格式参考如下：https://support.huaweicloud.com/productdesc-cec/cec_01_0001.html 1.6 voiceFileName string False IVR语音名称，长度不能超过50字符，只能包含中文、大小写字母，数字。表3 回调URL参数说明序号名称参数类型是否必选说明请求参数 1.5.1 fileUrl string True 审核文件地址，文件地址全称，包括文件后缀。 1.5.2 fileId string True 审核文件ID，具体值可参考表4中的fileId字段设置。 1.5.3 status string True 文件审核状态，取值范围： 2：审核通过。 3：审核不通过。 1.5.4 comment string False 审核状态备注。响应参数 1.5.5 returnCode string True 响应代码，取值范围： 0：审核结果接收成功。其他：审核结果接收失败。说明：审核结果接收失败后会重复调用回调接口继续返回文件上传审核结果，超过6次后同一文件的上传审核结果不再继续响应。

云客服 IVR流程管理

云客服-查询指定租间的所有IVR流程（queryIVRFlowList）:报文样例

报文样例请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 响应参数: { "result": [ { "isLoad": 1, "accessCode": "90500", "maxCallNum": null, "description": "异常处理", "id": 1, "flowFileName": "defaultIVR.GSL", "flowType": 1 }, { "isLoad": 1, "accessCode": "90501", "maxCallNum": null, "description": "1015", "id": 2, "flowFileName": "defaultIVR.GSL", "flowType": 1 } ], "retCode": "0", "message": "success" }

云客服 IVR流程管理

云客服-查询指定租间的所有IVR流程（queryIVRFlowList）:响应说明

响应说明响应状态码: 200 表2 响应体参数序号名称参数类型是否必选说明 1 schema object True - 1.1 result array[object] False IVR信息 1.1.1 isLoad number False 流程是否加载 0：否 1：是 1.1.2 accessCode string False 流程接入码 1.1.3 maxCallNum integer False 流程最大并发呼叫数 1.1.4 description string False 流程描述 1.1.5 id number False 流程编号 1.1.6 flowFileName string False 流程文件名 1.1.7 flowType number False 流程类型 0：未明确的业务类型 1：GSL业务文件类型 2：VoiceXML业务文件类型 3：第三方IVR的业务类型 4：CCIVR支持的VXML流程 5：CCXMLL流程 6：WaitScript流程 1.2 retCode string False 返回码 0：成功其他：失败 1.3 message string False 返回信息响应状态码: 400 错误的请求：请检查请求路径及参数响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。响应状态码: 403 鉴权失败响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服 IVR流程管理

云客服-上传语音通知的文字转语音模板文件（createVoiceTemplate）:报文样例

报文样例请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "name":"ctest1", "scene":"3", "volume":0, "speed":50, "voicename":"cn_kefuman_cn", "callBackUrl" : "http://10.134.227.74:18133/upload", "voicecontent":{ "language":"zh_CN", "textcontent":"测试" } } 响应参数: { "returnCode": "0", "description": "The file is uploaded successfully.", "templateId": "1249756280719641601" } 回调URL样例报文： //请求参数 { "fileUrl": "Y:/IVR/147/voice/0/nPqV9vU3_1666706957559.wav", "fileId": "1323606152730207249", "status": "2", "comment": "审核通过" } //响应参数 { "returnCode": "0" }

云客服 IVR流程管理

云客服-上传语音通知的文字转语音模板文件（createVoiceTemplate）:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 2 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数序号名称参数类型是否必选说明 1 requestBody object False - 1.1 name string True 文字转语音模板文件名称，支持填写中文，数字，大小写英文字母。长度不超过50字符。 1.2 scene string False 使用场景。取值范围：3，表示语音通知 1.3 speed number False 转成语音的播放语速，取值范围[-200，500]，若不填则默认值：0 1.4 volume number False 转成语音的播放音量，取值范围[0，100]，若不填则默认值：50 1.5 voicename string False 转成语音的播放音色，取值范围： cn_kefuman_common，表示客服曼 cn_chengshuxing_common，表示成熟型 cn_roumeiqian_common，表示柔美倩 cn_ziranzhen_common，表示自然真 cn_tianmeiru_common，表示甜美茹若不填则给默认值：cn_kefuman_common 1.6 voicecontent object True 需要转为语音的文本内容。 1.6.1 textcontent string True 文本内容，最大长度500字节。具体模板内容由固定文本和变量组成。模板采用UTF-8编码格式，汉字和中文符号为3个字节，字母、数字和英文符号为1个字节。模板内容不能以变量开头。模板内容长度不超过500字节。单个变量长度不超过32字节（如果单个变量长度超过32字节，建议拆分成多变量）。支持的变量格式有： ${TXT_数字}：表示变量为定义相应长度的字符串，数字表示该字符串的最大长度，如${TXT_9}表示最大长度为9字节的字符串。 ${NUM_数字}：表示变量只能为数字（0～9）的组合，数字表示该变量的最大个数，如${NUM_6}表示最大6个数字的组合。 ${DATE}表示变量为日期，格式要求为“YYYY/MM/DD”，其中，“YYYY”代表年，“MM”代表月，“DD”代表日，如2022/07/16。 ${TIME}表示变量为时间，支持两种格式，一种格式精确到分钟，格式为“HH:MM”，“HH”代表时，“MM”代表分，如14:30；另一种格式精确到秒，格式为“HH:MM:SS”，“HH”代表时，“MM”代表分，“SS”代表秒，如：14:30:30。模板样例：样例一：尊敬的${TXT_8}您的初始密码为${NUM_6}。样例二：请于${DATE}，${TIME}前领取您的快递。说明： ${DATE}和${TIME}必须用逗号隔开。 1.6.2 language string True 语种。 zh_CN(中文) en_US(英文) pt_BR(葡萄牙语) th_TH(泰语) 1.7 callBackUrl string False 回调URL，系统审核后，系统会通过这个url返回审核的结果信息回调URL为客户自定义接口，用于接收系统审核结果信息，其中请求参数与相应参数可参考表3。回调URL已通过系统管理员加入IVR语音上传回调的地址白名单中。表3 回调URL参数说明序号名称参数类型是否必选说明请求参数 1.7.1 fileUrl string True 审核文件地址，文件地址全称，包括文件后缀。 1.7.2 fileId string True 审核文件ID，具体值可参考表4中的templateId字段设置。 1.7.3 status string True 文件审核状态，取值范围： 2：审核通过。 3：审核不通过。 1.7.4 comment string False 审核状态备注。响应参数 1.7.5 returnCode string True 响应代码，取值范围： 0：审核结果接收成功。其他：审核结果接收失败。说明：审核结果接收失败后会重复调用回调接口继续返回文件上传审核结果，超过6次后同一文件的上传审核结果不再继续响应。

云客服 IVR流程管理

云客服-上传语音通知的文字转语音模板文件（createVoiceTemplate）:响应说明

响应说明响应码：200 表4 响应参数说明序号名称参数类型是否必选说明 1 schema object True - 1.1 returnCode string True 0：成功，其他为失败。 1.2 description string True 描述。 1.3 templateId string False 模板ID 响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

云客服 IVR流程管理

云客服-上传语音通知的文字转语音模板文件（createVoiceTemplate）:报文样例

报文样例请求头: Content-Type:application/jsonAuthorization:Bearer XXXXXXXXXXXXXXXXXXXXXXXX-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "name":"ctest1"， "scene":"3"， "volume":0， "speed":50， "voicename":"cn_kefuman_cn"， "callBackUrl" : "http://10.134.227.74:18133/upload"， "voicecontent":{ "language":"zh_CN"， "textcontent":"测试" } } 响应参数: { "returnCode": "0"， "description": "The file is uploaded successfully."， "templateId": "1249756280719641601" } 回调URL样例报文： //请求参数{ "fileId": "1323606152730207249"， "status": "2"， "comment": "审核通过"}//响应参数{ "returnCode": "0"}

云客服 IVR流程管理

云客服-上传语音通知的文字转语音模板文件（createVoiceTemplate）:响应说明

响应说明响应码：200 表4 响应参数说明序号名称参数类型是否必选说明 1 schema object True - 1.1 returnCode string True 0：成功，其他为失败。 1.2 description string True 描述。 1.3 templateId string False 模板ID 响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值

云客服 IVR流程管理

云客服-上传语音通知的文字转语音模板文件（createVoiceTemplate）:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 2 X-APP-Key string False appKey字段，用户标识，请联系运营人员获取appKey 表2 请求体参数序号名称参数类型是否必选说明 1 requestBody object False - 1.1 name string True 文字转语音模板文件名称，支持填写中文，数字，大小写英文字母。长度不超过50字符。 1.2 scene string False 使用场景。取值范围：3，表示语音通知 1.3 speed number False 转成语音的播放语速，取值范围[-200，500]，若不填则默认值：0 1.4 volume number False 转成语音的播放音量，取值范围[0，100]，若不填则默认值：50 1.5 voicename string False 转成语音的播放音色，取值范围： cn_kefuman_common，表示客服曼 cn_chengshuxing_common，表示成熟型 cn_roumeiqian_common，表示柔美倩 cn_ziranzhen_common，表示自然真 cn_tianmeiru_common，表示甜美茹若不填则给默认值：cn_kefuman_common 1.6 voicecontent object True 需要转为语音的文本内容。 1.6.1 textcontent string True 文本内容，最大长度500字节。具体模板内容由固定文本和变量组成。模板采用UTF-8编码格式，汉字和中文符号为3个字节，字母、数字和英文符号为1个字节。模板内容不能以变量开头。模板内容长度不超过500字节。单个变量长度不超过32字节（如果单个变量长度超过32字节，建议拆分成多变量）。支持的变量格式有： ${TXT_数字}：表示变量为定义相应长度的字符串，数字表示该字符串的最大长度，如${TXT_9}表示最大长度为9字节的字符串。 ${NUM_数字}：表示变量只能为数字（0～9）的组合，数字表示该变量的最大个数，如${NUM_6}表示最大6个数字的组合。 ${DATE}表示变量为日期，格式要求为“YYYY/MM/DD”，其中，“YYYY”代表年，“MM”代表月，“DD”代表日，如2022/07/16。 ${TIME}表示变量为时间，支持两种格式，一种格式精确到分钟，格式为“HH:MM”，“HH”代表时，“MM”代表分，如14:30；另一种格式精确到秒，格式为“HH:MM:SS”，“HH”代表时，“MM”代表分，“SS”代表秒，如：14:30:30。模板样例：样例一：尊敬的${TXT_8}您的初始密码为${NUM_6}。样例二：请于${DATE}，${TIME}前领取您的快递。说明： ${DATE}和${TIME}必须用逗号隔开。 1.6.2 language string True 语种。 zh_CN(中文) en_US(英文) pt_BR(葡萄牙语) th_TH(泰语) 1.7 callBackUrl string False 回调URL，系统审核后，系统会通过这个url返回审核的结果信息回调URL为客户自定义接口，用于接收系统审核结果信息，其中请求参数与相应参数可参考表3。表3 回调URL参数说明序号名称参数类型是否必选说明请求参数 1.7.1 fileUrl string True 审核文件地址，文件地址全称，包括文件后缀。 1.7.2 fileId string True 审核文件ID，具体值可参考表4中的templateId字段设置。 1.7.3 status string True 文件审核状态，取值范围： 2：审核通过。 3：审核不通过。 1.7.4 comment string True 审核状态备注。响应参数 1.7.5 returnCode string True 响应代码，取值范围： 0：审核结果接收成功。其他：审核结果接收失败。说明：审核结果接收失败后会重复调用回调接口继续返回文件上传审核结果，超过6次后同一文件的上传审核结果不再继续响应。

云客服 IVR流程管理

云服务器内容精选

IVR流程管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线