华为云用户手册

云客服-更新业务场景:响应说明

响应说明响应状态码: 200 表3 响应体参数序号名称参数类型是否必选说明 1 schema string True 响应成功 1.2 resultCode string False 返回码 0406000 表示成功其他表示失败 1.3 resultDesc string False 返回描述响应状态码: 400 错误的请求：请检查请求路径及参数。响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服
云客服-更新业务场景:报文样例

报文样例场景描述：更新业务场景状态请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "group_id": "groupid_826b89d9-bec9-4c14-b677-1d86f16c4993", "is_enable": 1 } 响应参数: { "resultCode": "0406000", "resultDesc": "更新业务场景状态成功" }

云客服
云客服-更新业务场景:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string False appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string False 操作员标识可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数序号名称参数类型是否必选说明 1.1 group_id string True 业务场景标识 1.2 is_enable number True 该业务场景是否正在被启用（0 代表不启用，1 代表启用）

云客服
云客服-删除主叫号码:错误结果码

错误结果码表6 错误原因码说明序号错误码说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200007 外呼活动不存在。 3 02000001 参数值为空 4 02000002 参数包含非法字符 5 02000003 参数长度不能大于规定长度 6 02000004 参数长度不能小于规定长度 7 02000005 参数长度需要介于规定长度之间 8 02000006 参数值类型不正确 9 02000007 参数值大小不正确 10 02000008 参数转换异常，请检查请求参数 11 02000009 参数组合不正确，请检查请求参数 12 02000010 hour和minute必须同时存在 13 02000011 参数个数不能大于规定个数

云客服
云客服-删除主叫号码:请求说明

请求说明表2 请求消息头参数序号名称参数类型是否必选说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。表3 请求消息体参数说明序号参数名参数类型是否必选说明 1 callerNo List True 支持多主叫号码。最多100个号码。该对象的参数说明请参见表4 表4 callerNo参数说明序号参数名参数类型是否必选说明 1.1 accessCode String True 主叫号码。呼通客户后，客户的电话终端上显示的号码。最大长度为24个字符，有效字符为：0~9。

云客服
云客服-修改与会者属性:请求说明

请求说明消息头表2 请求头参数说明序号名称参数类型是否必选说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。消息体表3 消息体参数说明序号名称参数类型是否必选说明 1 attribute int True 与会者属性。 1：只能听，不能说。 2：只能说，不能听。 3：既能听，也能说。 4：不能听，不能说。 2 addressType String True 地址类型。 6：电话号码 9：座席工号 3 address String True 地址标识，即电话号码或座席工号。最大长度为24字节。

云客服
云客服-修改与会者属性:接口URI

接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/changeparticipantmode 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。表1 URI中携带的参数说明序号参数名数据类型选取原则说明 1 agentid string True 座席的工号，取值范围：101～59999。

云客服
云客服-修改与会者属性:报文样例

报文样例消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "attribute": 3, "address": "88887744", "addressType": "6" } 响应参数 { "result": {}, "message": "success", "retcode": "0" }

云客服
云客服-认证Token信息接口:报文样例

报文样例无请求头请求参数: {"token":"*********************"} 响应参数: { "returnCode":"0", "returnMsg":"success", "data":{ "userAccount":"xx", "userId":"xx", "tenantId":"xx", "tenantSpaceId":"xx", "locale":"zh_CN" } }

云客服其他类接口参考
云客服-认证Token信息接口:响应说明

响应说明响应状态码: 200 表2 响应体参数序号名称参数类型是否必选说明 1 schema object True 返回消息 1.1 returnCode string True 返回码。 0：成功 1：token为空 2：token不合法 3：token过期 4：系统错误 1.2 returnMsg string False 描述信息 1.3 data object False 用户信息 1.3.1 userAccount string False 用户账号 1.3.2 userId string False 用户唯一标识 1.3.3 tenantId string False 租户唯一标识 1.3.4 tenantSpaceId string False 租间标识 1.3.5 locale string False 语言信息响应状态码: 400 错误的请求：请检查请求路径及参数响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。响应状态码: 403 鉴权失败响应状态码: 404 请求的内容未找到：请检查请求的路径响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服其他类接口参考
云客服-离线转写回调接口:响应说明

响应说明响应状态码: 200 表7 响应体参数序号参数名参数类型说明 1 retCode String 0,成功,其他为失败。 2 retMsg String 失败原因的描述。响应状态码: 400 错误的请求：请检查请求路径及参数。响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服
云客服-离线转写回调接口:报文样例

报文样例请求消息头 Content-Type:application/json; charset=UTF-8 userName:ODFS_SYS_OPENAPI token:******************** 请求体消息 { "body": { "state": { "code": 0, "success": true }, "body": { "aid": "FJKkMeepk8l", "lattices": [{ "begin": 4360, "end": 5970, "lid": 0, "onebest": "喂接通了吗？", "spk": 0 }] } } } 响应体消息 { "retCode": "0", "retMsg": "success" }

云客服
云客服-离线转写回调接口:请求说明

请求说明表2 请求体参数序号参数名参数类型是否必选说明 1 body Object True 回写结果。该对象的参数说明请参见表3。表3 body参数说明序号参数名参数类型是否必选说明 1.1 state Object True 转写状态。该对象的参数说明请参见表4。 1.2 body Object True 回写结果body体。该对象的参数说明请参见表5。表4 state参数说明序号参数名参数类型是否必选说明 1.1.1 code String True 转写的结果编码。 1.1.2 success boolean True 转写是否成功,true标识成功,false标识失败。表5 body参数说明序号参数名参数类型是否必选说明 1.2.1 aid String True 音频文件唯一标识符,由客户端传入。 1.2.2 lattices List True 转写结果。该对象的参数说明请参见表6。表6 lattices参数说明序号参数名参数类型是否必选说明 1.2.2.1 lid int True 片段序列号。 1.2.2.2 begin int True 分片开始时间。 1.2.2.3 end int True 分片结束时间。 1.2.2.4 onebest String True 转写后的文本。 1.2.2.5 spk int True 说话人的角色。

云客服
云客服-删除语速规则:请求说明

请求说明表1 请求头参数序号名称参数类型是否必选说明 1 Content-Type string False 固定填 application/json; charset=UTF-8。 2 x-app-key string False appKey标识 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 4 x-UserId string False 操作员标识可在登录后，进入员工管理页面，查看接口返回的userId 表2 请求体参数序号名称参数类型是否必选说明 1 speed_id string True 规则标识

云客服语速规则接口 (speedrule)
云客服-删除语速规则:报文样例

报文样例场景描述：删除语速规则请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** x-TenantSpaceId:202101124979 请求参数: { "speed_id": "849706874868600832" } 响应参数: { "resultCode": "0405000", "resultDesc": "操作成功" }

云客服语速规则接口 (speedrule)
云客服-删除语速规则:响应说明

响应说明响应状态码: 200 表3 响应体参数序号名称参数类型是否必选说明 1.1 resultCode string False 返回码，0405000表示成功，其他表示失败 1.2 resultDesc string False 返回的描述信息响应状态码: 400 错误的请求：请检查请求路径及参数。响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。响应状态码: 404 请求的内容未找到：请检查请求的路径。响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

云客服语速规则接口 (speedrule)
云客服-对话初始化接口（inaction=8）:响应消息样例4

响应消息样例4 { "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" } }

云客服
云客服-查询UAP终端设备统计接口:响应消息

响应消息表3 响应消息体参数说明参数名数据类型说明 resultCode String 查询结果。取值如下： "0100000"：成功其他：失败失败的原因说明请参见错误码参考。 resultDesc List 查询成功后，返回结果信息的对象列表。该数组中对象的参数说明请参见下表。表4 resultDesc对象参数说明参数名数据类型说明 beginTime String 统计开始时间，毫秒级时间戳(五分钟统计区间开始时间) ccId int 呼叫中心编号 uapIp String UAP的IP agentOnlineCount int 软终端注册数

云客服
云客服-对话初始化接口（inaction=8）:响应消息样例3

响应消息样例3 { "outaction": 12, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "inter_idx": "1", "moduleName":"查询", "xxx":"xxx" //扩展 } }

云客服
云客服-对话初始化接口（inaction=8）:响应消息样例2

响应消息样例2 { "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" } }

云客服
云客服-对话初始化接口（inaction=8）:响应消息样例5

响应消息样例5 { "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" } }

云客服
云客服-查询UAP终端设备统计接口:样例报文

样例报文请求头： Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数： { "ccId":1, "uapIP":"1.1.1.1", "beginDate":"2021-09-09 00:00:00", "endDate":"2021-09-11 23:00:00", "limit":"100", "offset":"0" } 响应参数： { "resultCode": 0, "resultDesc": { "data": [ { "beginTime": "1631594100000", "ccId": 1, "uapIp": "1.1.1.1", "agentOnlineCount": 1 } ], "count": 1 } }

云客服
云客服-对话初始化接口（inaction=8）:请求消息样例1

请求消息样例1 { "userid": "1528780879-9581", "inaction": 8, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1MzgwMzg5MzUsImV4cCI6MTUzODA0MjUzNSwian", "suilu_region_id": "025", "entrance_id": "03" }, "extparams": { "transin_data":"95,22714,0,,1,1,,test_gdj_01005" } }

云客服
云客服-对话初始化接口（inaction=8）:ExtParams参数

ExtParams参数参数名称数据类型参数位置必选/可选描述 transin_data String body False 由接入方跟OIAP约定的随路数据参数,例如IVR传入的数据包参数 locationid String body False 呼叫录音节点号 mediaability String body False 媒体能力 1：音频 2：视频 3：音视频 ieValue String body False 接入方跟OIAP约定的User To User类型的随路数据参数，使用场景为：在与其他的平台对接时，如果呼叫是从其他的第三方的平台转移过来的呼叫，使用该参数携带SIP Header UUI信息。该参数的取值记录日志时会匿名化处理，保存数据库时会加密处理

云客服
云客服-对话初始化接口（inaction=8）:inparams 参数

inparams 参数参数名称数据类型参数位置必选/可选描述 call_id String body True 呼叫唯一标志，与userid 取值相同,给流程使用。不超过64位 call_sor_id String body True 用户标识。（语音导航、语音外呼场景传入用户号码，其他交互场景传入用户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值。请参见C3 智能助手平台接口鉴权方式。 suilu_region_id String body False(语音导航场景特有字段) 呼入地。不超过64位 entrance_id String body False(语音导航场景特有字段) 导航入口。 01：广告语 02：欢迎语 03：首层主菜单 04：人工拦截 05：人工座席 06：直接通过短号接入 07：全语音门户 08：“0”号夜间导航模式 09：夜间全语音门户 10：直接通过自助短号接入 11：人工忙碌 98：其他 99：未识别 mediaType String body False 媒体类型（文本，音频，视频...） call_media_type String body False 呼入ivr的呼叫类型，文本：0 音频：1视频：3 channelType String body False 渠道类型 WEB（Web） INSTAG RAM （Instagram） TELEGRAM(Telegram) WECHAT(微信) FACEBOOK（Facebook） TWITTER（X (Twitter)） EMAIL（邮件） LINE WHATSAPP（WhatsApp） 5G（5G消息） SMS （短信）。说明：括号里为界面字段，区别于接口传参字段。 responseStyle String body False 回复风格

云客服
云客服-下载智能IVR录音文件:请求说明

请求说明表2 请求Request参数说明序号名称参数类型是否必选默认值说明 1 Content-Type String True 无固定填 application/json; charset=UTF-8。 2 Authorization String True 无生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。表3 请求Body中request参数说明序号名称参数类型是否必选默认值说明 1 version String（1-32） True 2.0 协议版本。当前固定值为2.0。表4 请求Body中msgBody参数说明序号名称参数类型是否必选默认值说明 1 fileName String（1-127） True 无智能IVR录音文件名称参数格式：一：{录音盘符}:/{record}/{vdnId}/{odfsrecord}/{yyyymmdd}/{文件主名}.wav；例如：Y:/record/39/odfsrecord/20201015/10233946082696733.wav 二：{录音盘符}:/{vdnId}/{odfsrecord}/{yyyymmdd}/{文件主名}.wav；例如：Y:/39/odfsrecord/20201015/10233946082696733.wav 三： {录音盘符}:/{record}/{vdnId}/{yyyymmdd}/{文件主名}.wav ；例如：Y:/record/39/20201015/10233946082696733.wav 四：{录音盘符}:/{vdnId}/{transferrecord}/{yyyymmdd}/{文件主名}.wav 例如：Y:/39/transferrecord/20201015/10233946082696733.wav 说明：{vdnId}为vdn编号，{yyyymmdd}为生成智能IVR录音文件的日期，{文件主名}为录音文件的名称。

云客服
云客服-下载智能IVR录音文件:接口URI

接口URI https://ip:port/CCFS/resource/ccfs/downloadOiapRecord?locationId={locationId} 其中，ip为CC-FS安装的服务器IP地址，port为CC-FS的HTTPS端口号。如果经过NSLB路由，ip为NSLB的服务器IP地址，port为CC-FS服务在NSLB映射的HTTPS端口号。表1 URL中携带的参数说明序号名称参数类型是否必选说明 1 locationId int False 节点Id，通过调用会话记录查询接口（https://IP:PORT/oifde/rest/api/queryRecordHistory）查询locationId。

云客服
云客服-下载智能IVR录音文件:响应说明

响应说明当调用本接口响应成功，则从httpresponse消息中获取文件的二进制数据生成录音文件，文件后缀名为.wav，响应中content-type字段为Application/Octet-stream;charset=UTF-8。当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表响应消息response参数说明，resultData为保留字段，默认为空字符串。表5 响应消息参数说明序号名称参数类型说明 1 resultCode String 请求返回的结果码，详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据 4 response Object 请求结果对象，参数说明详见表6 不推荐使用，为兼容老版本保留字段。表6 响应消息response参数说明序号名称参数类型说明 4.1 version String（1-32）协议版本，如2.0。 4.2 resultCode String(1-32) 请求返回的结果码，详见错误码参考。 4.3 resultMsg String 请求结果描述。

云客服
云客服-下载智能IVR录音文件:报文样例

报文样例请求头 POST /CCFS/resource/ccfs/downloadOiapRecordHTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/ eb453f68e******************96c509c4913 Accept: */* Content-Type: application/json;charset=UTF-8 Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/39/odfsrecord/20201019/1603089033-1205143033.wav" } }

云客服
云客服-查询通话信息（queryCallInfoByCallId）:报文样例

报文样例请求头： x-app-key:9******************************3 Authorization:Bearer 9******************************7 请求参数: { "callId": "1652317325-339", "userId": "1652268429538866153", "tenantId": "202205116084", "agentId": "109" } 响应参数: { "caller": 70004, "called": 60015, "mediaAbility": 1, "calldata": "1", "callId": "1652317325-339", "callSkillId": 1, "callSkill": "voice", "callType": 0 }

云客服

共100000条

undefined

意见反馈

0/200

提交取消

提交成功！非常感谢您的反馈，我们会继续努力做到更好反馈提交失败！请稍后重试！

华为云用户手册

7*24

备案

专业服务

退订

建议反馈

售前咨询热线