华为云用户手册

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 sg_id string False 话术标识 1.2 role string False 话术对应的角色 1.3 dialogueFlowId string False 对话逻辑标识 1.4 sentences array[object] False 句子数组 1.4.1 category_id string False 句子分类标识 1.4.2 sentence_id string False 句子标识 1.4.3 sentence_name string False 句子名称 1.5 position_distance string False 话术位置距离 1.6 position string False 话术位置 1.7 SGType string False 表达式类型 1.8 resultCode string False 返回码 0405000 表示成功 其他表示失败 1.9 resultDesc string False 返回描述 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

报文样例 场景描述：查询话术详情 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "sg_id": "923004925930115072" } 响应参数: { "sg_id": "923083618002145280", "role": "any", "dialogueFlowId": "923083617557549056", "sentences": [{ "category_id": "925090936373907456", "sentence_id": "14402", "sentence_name": "询问客户是否需要帮助" }], "position_distance": "0", "resultCode": "0405000", "sg_name": null, "position": "any", "SGType": "must", "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 sg_id object True 话术标识

触发事件 座席进入（AgentEvent_Talking） 连接失败（AgentEvent_Connect_Fail） 座席挂断呼叫（AgentEvent_Call_Release） 转移模式为成功转时： 成功转结果通知（AgentEvent_SuccTransResult） 停止录音成功（AgentMediaEvent_StopRecordDone） 转移模式为三方转时： 三方通话成功（AgentEvent_Conference） 转移模式为挂起转 从IVR返回（AgentEvent_ReturnFromIvr）

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "devicetype": 2, "mode": 3, "address": "49998", "callappdata": "", "caller": "40040", "mediaability": 0, "holdflag": "true" } 响应参数 { "result": {}, "message": "success", "retcode": "0" }

请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式，缺省值：application/json; charset=UTF-8 2 Guid string True 静态鉴权（AUTHMODE = 1）签入接口返回的Guid；动态鉴权（AUTHMODE = 2）轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 devicetype int True 转移设备类型，技能队列为1，业务代表为2，IVR设备为3，系统接入码为4，外呼号码为5。 2 address string True 转移地址，只允许配置数字，最大长度24。取值范围： 当devicetype为1时，配置技能队列的编号ID。 当devicetype为2时，配置待转移座席的座席工号。 当devicetype为3时，配置IVR流程接入码。 当devicetype为4时，配置系统接入码。 当devicetype为5时，配置外呼号码。 3 mode int True 转移模式。 当devicetype值为1时取值： 0：释放转 2：成功转 当devicetype值为2时取值： 0：释放转 2：成功转 当devicetype值为3时取值： 0：释放转 1：挂起转 说明： 挂起转可以转音视频IVR流程，不能转座席。 当devicetype值为4时取值： 0：释放转 2：成功转 当devicetype值为5时取值： 1：释放转（呼出时不支持向指定外呼号码释放转） 2：成功转 3：通话转 4：三方转 4 callappdata string False 需设置的随路数据。内容可为空，最大长度为16k。 5 caller string False 主叫号码。（内容可为空，为空时为平台默认主叫号码，0-24位数字）。在转外部号码时有效。并且当转出方式为“释放转”时，该参数值无效，即不能携带指定的主叫号码。 6 mediaability int False 媒体能力。（默认为0。0：音频，1：视频，2：以最大能力呼叫，由主机与终端进行协商。在转外部号码时有效，其他方式的转移根据座席的类型来判断是否带媒体能力） 7 holdflag boolean False 三方转时是否保持呼叫，取值为false时不保持，true为保持，默认为true 8 skillId Integer 可选 技能ID。当devicetype为业务代表为2时，设置该字段才有效。

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

报文样例 请求头: x-app-key:6******************************b Authorization:Bearer e******************************6 Content-Type:application/json 请求参数: { "callSerialNo": "679218118865715226" } 响应头: { "connection": "keep-alive", "content-type": "application/json;charset=UTF-8" } 响应参数: { "retMsg": "success", "result": { "url": "https://aicc-obs0.obs.cn-south-1.myhuaweicloud.com:443/644429155876552705?AWSAccessKeyId=ZGUZVMUDBS2DKAQ5X141&Expires=1565681851&Signature=sb3ZDPyzg%2FXZLMIPK0zBTRA6x5s%3D" }, "retCode": "0" }

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False 用户标识，与tokenByAkSk接口请求参数中的app_key一致 2 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callSerialNo string True 呼叫流水号 长度限制：string（50）

响应说明 响应状态码: 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 业务失败：请依次确认您请求中各参数的取值

报文样例 请求头: 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" }

请求说明 表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次后同一文件的上传审核结果不再继续响应。

报文样例 请求消息样例 { "tenantId": "tenant001", "accessCode": "10086", "accessId": "100001" , "domainId": 10001 , "dialogType":1, "flowCode": "flowxxxxxx" , "description": "" , "authToken": "0dbe11*******************b505de" } 响应消息样例 修改成功： 无响应体报文。 修改失败场景： { "errorCode" : 100000, // int, 错误码,成功通过状态码为200判断 "errorMsg" : "" }

请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID accessId String body True 对话标识绑定关系内部序号 accessCode String body False 接入标识 不超过20位 domainId int body False 领域ID dialogType int body True 对话类型 1：语音导航 2：智能外呼 3：聊天机器人 4：IVR流程 flowCode String body False 流程编码 description String body True 描述 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。 source String body False 发起对话识别的源设备。 IVR：来自IVR流程 OIFDE：表示来自ODFS配置的智能化流程

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 返回码。0表示成功，其他为失败。 4：获取不到被叫标示 5：被叫未配置标示 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 devType number False 设备类型: 0：技能队列； 1：号码 长度限制：number (4) 1.3.2 called string False 被叫号码 长度限制:string(32) 1.3.3 skillId number False 技能队列 长度限制：number (16) 1.3.4 skillName string False 技能队列名称 长度限制：string(100) 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段，用户标识 2 Authorization string True 鉴权字段，内容格式为：Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 called string True 被叫号码 长度限制:string(32) 1 caller string True 主叫号码 长度限制:string(32)

报文样例 场景描述：样例报文 请求头： x-app-key:9******************************3 Authorization:Bearer 9******************************7 Content-Type:application/json 请求参数: { "caller": "8888888", "called": "6666614" } 响应参数: { "retMsg": "Called is not configured", "retCode": "5" }

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

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{defId}/deleteObsResult 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 defId String True 需要删除的外显结果ID

报文样例 请求头: { "x-app-key": "f******************************f" "Authorization": "Bearer 0******************************8" } 响应参数: { "servicePort": 448, "serviceIp": "127.0.0.0", "sipServiceIp": "127.0.0.0", "sipServicePort": 5060, "agents": [{ "workNo": 1522, "password": "7****tt", "sipAccount": "88881619", "sipPwd": "1****tt" }, { "workNo": 1523, "password": "f*****xL", "sipAccount": "88881620", "sipPwd": "1*****xL" }] }

响应说明 响应状态码: 200 表2 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 serviceIp string False 座席登录服务实例地址，Nginx地址，或SLB地址 长度限制:string(50) 1.2 sipServicePort string False 软电话注册端口，1~65535 长度限制:string(5) 1.3 sipServiceIp string False 软电话注册地址 长度限制:string(50) 1.4 servicePort string False 座席登录服务端口 长度限制:string(5) 1.5 agents array[object] False 座席集合 1.5.1 workNo integer True 座席工号，范围从101到59999 1.5.2 sipAccount string False SIP软电话号码 长度限制:string(24) 1.5.3 sipPwd string False SIP软电话加密前密码 长度限制:string(24) 1.5.4 password string False 座席签入登录平台的加密前密码 长度限制:string(8) 1.5.6 id string False 座席配置id 1.5.7 ccRoleId string False 平台角色Id 1.5.8 accountId string False 关联的Service Cloud账号ID 1.5.9 accountCode string False 关联的Service Cloud账号Code 1.5.10 accountName string False 关联的Service Cloud账号姓名 1.5.11 agentType integer False 座席类型 1.5.12 selfPhone string False 座席固话或手机 1.5.13 createInCtiFlag integer False 在CTI平台创建过座席的标记，0：未创建，1：创建过 1.5.14 guId string False 座席签入登录平台的的GUID 1.5.15 singlePhoneFlag string False 单电话座席开关 1.5.16 agentpara string False 座席可选参数 1.5.17 partdbId string False 分区Id 1.5.18 tenantId string False 租户ID 1.5.19 agentStatus string False 座席停用标志 0：可用（默认） 1.5.20 timeRemaining integer False 密码剩余过期时间 1.5.21 omsAgentType string False OMS 座席类型 1.5.22 dualChannelRecFlag integer False 双轨道录音，0：关闭（默认），1：开启 1.5.23 transparentDisplayFlag integer False 座席透显开关，0：关闭（默认），1：开启 1.5.24 authFlag string False 认证方式，0或null：UAP认证，1：统一认证 1.5.25 validTime integer False 密码有效期天数，范围从0到180，默认值90 1.5.26 socialChatNum integer False 座席并发处理多媒体呼叫数，范围从0到60 1.5.27 ccAgentAndSkillList array[object] False 座席技能队列 1.5.28 AIRecognition integer False 智能识别开关 响应状态码: 400 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 错误的请求：请检查请求路径及参数。 响应状态码: 401 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 表5 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 请求的内容未找到：请检查请求的路径。 响应状态码: 500 表6 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema string True 业务失败：请依次确认您请求中各参数的取值。

报文样例 请求头: ccmessaging-token: x-app-key: Authorization: 请求参数: 无 响应参数: { resultCode: "0", resultDesc: "Call connected", "eventId": 168101, "content": { "domain": "xxx", "gwAddresses": ["xx1", "xx2"], "accessCode": "179080000537636", "clickToCallCaller": "AnonymousCard" } }

响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 resultCode string 响应结果码 1.2 resultDesc string 响应结果描述。 如果resultCode返回0：Call in queue或Call connected或Call disconnected或Call queued timeout或Call failed或Call continue to poll events with unknown events或ClickToCall polled without any events 1.3 eventId string 事件编号 1.4 content object 事件内容 1.4.1 causeDesc string 原因描述 1.4.2 causeId string 原因 id 1.4.3 accessCode string 点击通话被叫 1.4.4 domain string WebRTC Gateway 域名 1.4.5 gwAddresses array WebRTC Gateway通信地址和端口 1.4.6 clickToCallCaller string 点击通话主叫 响应状态码: 400 错误的请求：请检查请求路径及参数。 响应状态码: 401 未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到：请检查请求的路径。 响应状态码: 500 业务失败：请依次确认您请求中各参数的取值。

请求说明 表1 查询参数 序号 名称 参数类型 是否必选 说明 1 channel string True 接收者渠道类型（WEB） 表2 请求头参数 序号 名称 参数类型 是否必选 说明 1 ccmessaging-token string True applyToken接口生成的ccmessagign-token 2 x-app-key string True appKey字段，用户标识，在API Fabric上配置 3 Authorization string True 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

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

接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/{serverId}/deleteServer 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 serverId string True 文件服务器ID

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result list 查询成功后，返回排队等待呼叫信息对象列表。 该对象的参数说明请参考表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 callfeature int 呼叫类型，请参考呼叫类型 3.2 callid string 呼叫ID 3.3 caller int 主叫号码 3.4 called int 被叫号码 3.5 callskill string 呼叫技能描述 3.6 callskillid int 呼叫技能ID 3.7 orgicallednum string 未使用该返回参数 3.8 calldata string 随路数据 3.9 begintime long 应答开始时间，时间戳（毫秒） 3.10 endtime long 未使用该返回参数 3.11 userPriority int 客户级别 3.12 trunkNo int 中继号 3.13 logontimes int 进入总时长（秒）。 3.14 mediaType int 媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 3.15 mediaAbility int 媒体能力。其中： 1：音频 2：视频 3：音视频 3.16 waitTime long 等待应答时间，时间戳（秒） 3.17 trace HWCallDeviceTraceEx 呼叫轨迹扩展属性，预留字段，默认为空。

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": [ { "callfeature": 0, "callid": "1476707884-279", "caller": "70004", "called": "60015", "callskill": "voice", "callskillid": 1, "orgicallednum": "", "calldata": "", "begintime": 1476707884000, "endtime": null, "userPriority": 0, "mediaType": 5, "mediaAbility": 1, "waitTime": 0, "trace": null }, { "callfeature": 0, "callid": "1476707885-280", "caller": "70003", "called": "60015", "callskill": "voice", "callskillid": 1, "orgicallednum": "", "calldata": "", "begintime": 1476707885000, "endtime": null, "userPriority": 0, "trunkNo": 65535, "logontimes": 0, "mediaType": 5, "mediaAbility": 1, "waitTime": 0, "trace": null } ] }

接口URI https://ip:port/agentgateway/resource/calldata/{agentid}/waitcallinfo/{skillid} 其中，ip为agentgateway服务器地址，port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号，取值范围：101～59999。 2 skillid int True 被查询技能队列ID。

转出通知 标示符 AgentEvent_linkagePhoneTransferOut 作用 表示座席正在通过话机转出当前呼叫。 附带信息 addrOut：表示被转出的电话号码。 addrSelf：表示座席的电话号码。 address：表示地址标识。 addressType：表示地址类型（当前只会为6，表示电话号码）。 示例： {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneTransferOut","workNo":"120","content":{"addrOut":{"address":"70002","addressType":6},"addrSelf":{"address":"70001","addressType":6}}}} 父主题： 话机联动事件