华为云用户手册

  • 报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer 9******************************7 请求参数: {"callId": "1652317325-339","userId": "1652268429538866153","tenantId": "202205116084"} 响应参数: {"callSerialno": "1243353389979684865","countId": "1652268429538866153","callId": "1652317325-339","mediaAbility": 1,"channelType": 1,"talkReason": "1300404704098042886,1300404506395329541","beginTime": "2022-05-12 01:01:33","callType": 1}
  • 报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer 9******************************7 请求参数: {"called": "8899","voiceContent": "100001","callerPresent": "2222201","callBackUrl": "http://xx.xx.xx.xx:8800/callbackTest"} 响应参数: {"retMsg": "Created successfully.","retCode": "0", "result": {"callSerialNo": "1308434073450058757"}}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callId string True 呼叫id 2 userId string True 用户id 3 tenantId string True 租户id
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 called string True 外呼被叫号码 长度限制:string(32) 2 voiceContent string True 录音id 长度限制:string(1024) 3 callBackUrl string False 回调URL 长度限制:string(256) 4 callerPresent string False 用户侧主叫外显号码 长度限制:string(32) 5 priority string False 播放语音通知优先级参数。 取值范围1-9整数,默认值为9。数字越小优先级越高。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string False 返回码。0表示成功,其他为失败。 1.2 retMsg string False 失败原因的描述 1.3 result object False 返回结果 1.3.1 callSerialNo string False 呼叫流水号 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer 9******************************7 请求参数: {"called": "8899","playList": [{ "voiceId": "100001","templateParams": ["100","200"] }],"playTimes": 1,"callerPresent": "2222201","callBackUrl": "http://xx.xx.xx.xx:8800/callbackTest"} 响应参数: {"retMsg": "Created successfully.","retCode": "0", "result": {"callSerialNo": "1308434073450058757"}}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 called string True 外呼被叫号码 长度限制:string(32) 2 playList array[object] True 数组长度:1-5 2.1 voiceId string False 录音id(voiceId,voiceFileName,templateId必须填写1个) 2.2 voiceFileName string False 录音文件名(voiceId,voiceFileName,templateId必须填写1个) 2.3 templateId string False 模板id(voiceId,voiceFileName,templateId必须填写1个) 2.5 templateParams array[string] False 数组长度:1-10 长度限制:string(32) 3 callBackUrl string False 回调URL 长度限制:string(256) 4 callerPresent string False 用户侧主叫外显号码 长度限制:string(32) 5 playTimes number False 播放次数 范围:1-5 6 priority string False 播放语音通知优先级参数。 取值范围1-9整数,默认值为9。数字越小优先级越高。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string False 返回码。0表示成功,其他为失败。 1.2 retMsg string False 失败原因的描述 1.3 result object False 返回结果 1.3.1 callSerialNo string False 呼叫流水号 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: 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}
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 caller number False 主叫号码 2 called number False 被叫号码 3 mediaAbility number False 媒体类别 4 calldata string False 随路数据 5 callId string False 呼叫ID 6 callSkillId number False 呼叫技能ID 7 callSkill string False 呼叫技能描述 8 callType number False 呼叫类型 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 callId string True 呼叫id 2 userId string True 用户id 3 tenantId string True 租户id 4 agentId string True 座席id
  • 呼叫类型 表1 呼叫类型 编号 呼叫类型 描述 0 SP_CALL_NORMAL 普通呼入 5 SP_CALL_LONG 长途呼入呼叫 6 INTER_CALL 内部呼叫 内部呼叫是指一个业务代表向另一个业务代表发起呼叫并实现通话。内部呼叫不能被转出、不能被静音。 7 SP_CALL_OUT 普通呼出 一般指人工呼出。 8 OP_CALL_OUT 座席呼出类型 9 OP_PRI_OUT PRI呼出 10 IVR_CALL_OUT IVR呼出 11 SELF_CALLOUT 电话座席的自身呼出 12 IVR_PRI_CALL IVR PRI呼出 13 NIRC_CALL_IN 网络呼叫中心的呼入 14 NIRC_CALL_OUT 网络呼叫中心的呼出 15 NIRC_SPY_CALL_IN 网络呼叫中心的质检呼入 16 NIRC_SPY_CALL_OUT 网络呼叫中心的质检呼出 17 NIRC_INTER_CALL_IN 内部呼叫虚座席的网络呼入 18 NIRC_INTER_CALL_OUT 内部呼叫虚座席的网络呼出 20 ICD_SP_OPS_AIDERCALL 辅助呼叫 21 ICD_SP_OPS_INCALL 来话呼叫(国际话务员) 22 ICD_SP_OPS_PASSCALL 递延呼叫 23 ICD_SP_OPS_GIVECALL 去话呼叫(国际话务员) 40 OUTBOUND_CALL_OUT 预约呼出 预约呼出就是系统定期查询一次预约呼出数据库,将预约时间在当前机器时间之前的所有预约呼叫取回,进行强制呼出。 41 ICD_SP_OUTBOUND_PRE_OCCUPY 预占用呼出 系统首先占用某空闲座席,然后才发起呼出,成功后由该座席处理。 42 ICD_SP_OUTBOUND_PRE_CONNECT 预连接呼出 系统直接向用户发起呼叫,呼叫成功用户开始振铃后再连接座席。 43 ICD_SP_OUTBOUND_VIRTUAL_CALLIN 预测呼出 系统直接向用户发起呼叫,呼叫成功用户摘机后再连接座席。 44 ICD_SP_OUTBOUND_PREVIEW 预览呼出 呼出信息首先发给座席预览,然后由座席发起呼叫。 45 ICD_SP_OUTBOUND_CALLBACK 回呼请求 当Web用户在因特网上进行浏览时,如需要与呼叫中心取得联系,可以通过该网页的“回呼请求”服务,由呼叫中心的业务代表呼叫该Web用户预先指定的电话号码。 当电话接通后,Web用户既可以接受业务代表的语音指导,同时又可以享受到护航浏览等其他服务。 46 ICD_SP_IDD 国际长途来话 50 ICD_SP_CBRT_CALL 彩铃业务呼叫 51 ICD_SP_INTERNAL_TWO_HELP 两方求助呼叫 业务代表在接听来话的时候,可以发起内部求助。如果是两方求助,客户的呼叫被保持,业务代表和被求助的业务代表通话。 52 ICD_SP_INTERNAL_THREE_HELP 三方求助呼叫 业务代表在接听来话的时候,可以发起内部求助。如果是三方求助,用户、业务代表和被求助的业务代表三方通话。在两方求助的情况,可以通过再发起三方求助进行三方通话。 60 ICD_SP_OUTBOUND_PRE_OCCUPY_PRI_CALL 预占用PRI呼出 61 ICD_SP_OUTBOUND_PRE_CONNECT_PRI_CALL 预连接PRI呼出 62 ICD_SP_OUTBOUND_VIRTUAL_CALLIN_PRI_CALL 虚呼入PRI呼出 63 ICD_SP_OUTBOUND_PREVIEW_PRI_CALL 预览PRI呼出 64 ICD_SP_OUTBOUND_CALLBACK_PRI_CALL PRI回呼请求
  • Issue 01(2021-12-15) 本次随Service Cloud 8.21.0 版本发布,变更如下接口。 序号 接口 类型 备注 1 https://域名/apiaccess/rest/cc-management/v1/agentAccount/create 新增 创建座席账号 2 https://域名/apiaccess/rest/cc-management/v1/agentAccount/delete 新增 删除指定座席账号 3 https://域名/apiaccess/rest/cc-management/v1/agentAccount/update 新增 修改座席账号信息 4 https://域名/apiaccess/rest/cc-management/v1/agentAccount/query 新增 查询座席账号信息 5 https://域名/apiaccess/rest/cc-management/v1/agentAccount/addSkillsToAgent 新增 绑定座席和技能队列 6 https://域名/apiaccess/rest/cc-management/v1/agentAccount/releaseAgentBySkillId 新增 解绑座席和技能队列 7 https://域名/apiaccess/rest/cc-management/v1/sipPhone/updateSipPhonePassword 新增 修改座席软电话号码登录密码 8 https://域名/apiaccess/rest/cc-management/v1/agentAccount/queryAgentInfoBySkillId 新增 依据技能队列ID查询座席信息 9 https://域名/apiaccess/rest/cc-management/v1/skill/createSkill 新增 创建技能队列 10 https://域名/apiaccess/rest/cc-management/v1/skill/deleteSkill 新增 删除技能队列 11 https://域名/apiaccess/rest/cc-management/v1/skill/modifySkill 新增 修改技能队列 12 https://域名/apiaccess/rest/cc-management/v1/skill/querySkills 新增 查询技能队列 13 https://域名/apiaccess/rest/cc-management/v1/accessCodeInfo/queryAccessCodeList 新增 查询指定租间的接入码 14 https://域名/apiaccess/rest/cc-management/v1/calledRoute/createCalledRoute 新增 单个创建接入码与技能队列、IVR绑定关系的接口 15 https://域名/apiaccess/rest/cc-management/v1/calledRoute/deleteCalledRoute 新增 删除接入码与技能队列、IVR绑定关系的接口 16 https://域名/apiaccess/rest/cc-management/v1/calledRoute/modifyCalledRoute 新增 单个修改接入码与技能队列、IVR绑定关系的接口 17 https://域名/apiaccess/rest/cc-management/v1/calledRoute/queryCalledRoute 新增 查询接入码与技能队列、IVR绑定关系的接口 18 https://域名/apiaccess/rest/cc-management/v1/phonearea/getPhoneNoRegionInfo 新增 查询号码归属地 19 https://域名/apiaccess/rest/cc-management/v1/ivrFlow/queryIVRFlowList 新增 查询指定租间的所有IVR流程 20 https://域名/apiaccess/rest/cc-management/v1/satisfactionconfig/querySatifyConfig 新增 查询满意度调查的IVR流程 21 https://域名/apiaccess/rest/cc-management/v1/offline/agent/login 新增 手机接听 22 https://域名/apiaccess/rest/cc-management/v1/offline/agent/logout 新增 退出手机接听 23 https://域名/apiaccess/rest/cc-management/v1/offline/agent/isOfflineAgent 新增 查询指定座席是否为手机接听状态 24 https://ip:port/rest/cmsapp/v2/openapi/vdn/querycalls 新增 查询指定VDN下的呼叫信息(v2) 25 https://ip:port/rest/cmsapp/v1/openapi/vdn/queryAgentByStatus 新增 根据座席状态分页查询座席信息 26 https://ip:port/CCFS/resource/ccfs/getRecordFileUrlFromObs 新增 录音下载和播放URL接口 27 https://ip:port/rest/cmsapp/v1/openapi/hisindex/agent 修改 新增两个监控指标: IDX_COUNT_TOTAL_AGENT_CALL_OUT(呼出总次数) IDX_RATE_AGENT_SUCC_CALL_OUT (呼出成功通话率) 28 https://ip:port/rest/cmsapp/v1/openapi/hisindex/agentforday 修改 新增两个监控指标: IDX_COUNT_TOTAL_AGENT_CALL_OUT(呼出总次数) IDX_RATE_AGENT_SUCC_CALL_OUT (呼出成功通话率) 29 https://ip:port/rest/cmsapp/v1/openapi/hisindex/agentformonth 修改 新增两个监控指标: IDX_COUNT_TOTAL_AGENT_CALL_OUT(呼出总次数) IDX_RATE_AGENT_SUCC_CALL_OUT (呼出成功通话率) 30 https://ip:port/rest/cmsapp/v1/callinday/querymanualindexesbycondition 修改 新增响应参数: inCallAllCostMinute (每通通话计费总时长(分钟)) 31 https://ip:port/rest/cmsapp/v1/calloutday/querymanualindexesbycondition 修改 新增响应参数: outCallAllCostMinute (每通通话计费总时长(分钟))
  • Issue 06(2022-07-31) 本次随MicroService 1.0.8 版本发布,变更如下接口。 表7 接口修改记录 序号 接口 类型 备注 1 https://IP:PORT/oifde/rest/api/queryRecordHistory 修改 会话记录查询接口,响应参数businessInfoStr的JSON串中新增locationId(节点Id) 2 https://ip:port/CCFS/resource/ccfs/downloadOiapRecord?locationId=xx 修改 下载智能IVR录音文件接口,请求URL中的locationId由CTI POOL模式下必选改为可选 3 https://ip:port/CCFS/resource/ccfs/downloadIVRRecordFile?locationId=xx 修改 下载IVR留言接口,请求URL中的locationId由CTI POOL模式下必选改为可选 4 https://域名/apiaccess/rest/cc-management/v1/ita/twopartiescall/statusnotify 新增 ITA双呼结果通知接口
  • Issue 04(2022-04-30) 本次随MicroService 1.0.6 版本发布,变更如下接口。 表9 接口修改记录 序号 接口 类型 备注 1 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/blocklist/add 修改 新增外呼黑名单接口,请求参数新增可选参数: restrictTimes (限制次数) restrictPeriod (限制周期) 2 https://ip:port/oifde/rest/api/tts/texttovoice 新增 依据文本生成 TTS 语音接口 3 https://域名/apiaccess/rest/voiceNotification/v2/createVoiceNotification 新增 创建语音通知(V2)接口 4 https://域名/apiaccess/rest/cc-management/v1/satisfactionconfig/querySatisfactionConfig 修改 查询满意度调查的IVR流程,响应参数新增可选参数: accessCode (流程接入码) 5 https://ip:port/rest/cmsapp/v1/openapi/hisindex/skill https://ip:port/rest/cmsapp/v1/openapi/hisindex/skillforday https://ip:port/rest/cmsapp/v1/openapi/hisindex/skillformonth 修改 获取技能维度的历史监控指标接口 获取指定日期内的技能维度的历史监控指标接口 获取指定月份内的技能维度的历史监控指标接口 修改以上三个接口的IDX_COUNT_SKILL_INCOMING_CALL(人工呼入请求服务数)参数的计算逻辑。
  • Issue 03(2022-03-31) 本次随MicroService 1.0.5 版本发布,变更如下接口。 表10 接口修改记录 序号 接口 类型 备注 1 https://ip:port/CCFS/resource/ccfs/queryBillData https://ip:port/CCFS/resource/ccfs/downloadBillFile 修改 通过生成话单和录音索引接口、下载话单和录音索引接口下载的话单和录音索引文件新增参数。 话单索引文件新增参数: vdn (虚拟呼叫中心编号) pre_device_type(呼叫经历的上一个设备的设备类型) pre_device_no (呼叫经历的上一个设备的设备标号) skill_id(呼叫所属技能队列的ID) current_skill_id(当前处理呼叫的技能队列的编号) 录音索引文件新增参数: vdn(虚拟呼叫中心编号) call_type (呼叫类型) media_type (媒体类型) user_wanted_skill_id(引导技能) current_skill_id(当前处理呼叫的技能队列的编号) 2 https://域名/apiaccess/rest/cc-management/v1/importVoiceFile/upload 修改 上传IVR语音文件接口,请求参数 fileType(文件类型)新增支持MP3格式的音频文件。 3 https://ip:port/rest/cmsapp/v1/openapi/agent/agentoprinfo 修改 获取座席操作详情接口,请求参数operateType(操作类型)由必填改为选填。 4 https://域名/apiaccess/ccmessaging/send 修改 网页客户端接入的发送消息接口,请求参数mediaType(消息媒体类型)新增网页卡片消息(WEBCARD) 5 https://ip:port/rest/cmsapp/v1/openapi/hisindex/skill https://ip:port/rest/cmsapp/v1/openapi/hisindex/skillforday https://ip:port/rest/cmsapp/v1/openapi/hisindex/skillformonth 修改 获取技能维度的历史监控指标接口 获取指定日期内的技能维度的历史监控指标接口 获取指定月份内的技能维度的历史监控指标接口 以上三个接口新增监控指标: IDX_COUNT_SKILL_INCOMING_CALL(人工呼入请求服务数) 6 https://域名/apiaccess/rest/cc-management/v1/satisfaction/query 新增 查询满意度调查结果接口 7 https://域名/apiaccess/rest/service-pub/authentication 新增 认证Token信息接口
  • Issue 02(2022-02-11) 本次随MicroService 1.0.4 版本发布,变更如下接口。 序号 接口 类型 备注 1 https://域名/apiaccess/rest/cc-management/v1/agentAccount/query 修改 查询座席账号信息接口,请求参数、响应参数均新增:transparentDisplayFlag(座席透显特性标记) 2 https://域名/apiaccess/rest/cc-management/v1/importVoiceFile/upload 新增 上传IVR语音文件 3 https://域名/apiaccess/rest/voiceNotification/v1/queryVoiceNotificationRecording 新增 查询语音通知的录音文件 4 https://域名/apiaccess/rest/voiceNotification/v1/createVoiceNotification 新增 创建语音通知 5 https://域名/apiaccess/CC-Management/v1/mobileAgent/createCall 修改 创建双呼呼叫 (V1.0.0)接口,新增请求参数:callBackUrl(回调URL) 6 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresultdetail/{callId} 新增 查询单个外呼结果详情 7 https://ip:port/CCFS/resource/ccfs/getRecordFileUrlFromObs 修改 录音下载和播放URL的接口,响应参数url支持如果一个callid有多个录音文件,将会返回多个录音文件的播放和下载路径。
  • Issue 07(2022-08-31) 本次随MicroService 1.0.9 版本发布,变更如下接口。 表6 接口修改记录 序号 接口 类型 备注 1 https://域名/apiaccess/CC-Management/v1/mobileAgent/createCall 修改 创建双呼呼叫 (V1.0.0)接口,新增请求参数:agentWorkNo 2 https://域名/apiaccess/CC-Management/v1/openapp/agentsettings/create 新增 创建APP个人设置(create) 3 https://域名/apiaccess/CC-Management/v1/openapp/agentsettings/update 新增 更新app个人设置(update) 4 https://域名/apiaccess/CC-Management/v1/openapp/agentsettings/query 新增 查询app个人设置 (query) 5 https://域名/apiaccess/CC-Management/v1/openapp/agentsettings/delete 新增 删除app个人设置 (delete) 6 https://域名/service-cloud/rest/isales/v1/openapi/campaigns/{vdnId}/callresult/{campaignId} 修改 查询外呼结果接口,新增请求参数:beginTime、endTime
  • Issue 05(2022-05-30) 本次随MicroService 1.0.7 版本发布,变更如下接口。 表8 接口修改记录 序号 接口 类型 备注 1 https://域名/apiaccess/rest/voiceNotification/v2/createVoiceNotification 修改 创建语音通知(V2)接口,请求参数新增可选参数: voiceFileName(IVR语音名称) 2 https://域名/apiaccess/rest/cc-management/v1/importVoiceFile/upload 修改 上传IVR语音文件接口,请求参数新增可选参数: voiceFileName(IVR语音名称) 3 https://域名/apiaccess/rest/cc-management/v1/createVoiceTemplate 新增 上传语音通知的 文字转语音 模板文件接口 4 https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callRecord 新增 查询自动外呼和智能外呼的通话记录接口
  • Issue 09(2022-12-05) 本次随MicroService 1.11.0 版本发布,变更如下接口。 表4 接口修改记录 序号 接口 类型 备注 1 https://域名/apiaccess/rest/new_case/v2/cases 新增 创建工单 2 https://域名/apiaccess/rest/new_case/v2/cases/modify 新增 修改工单属性 3 https://域名/apiaccess/rest/new_case/v2/cases/casetypes 新增 查询工单类型信息 4 https://域名/apiaccess/rest/new_case/v2/cases/casedetails 新增 查询工单详情 5 https://域名/apiaccess/rest/new_case/v2/cases/dealCase 新增 处理工单操作 6 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/create 新增 创建任务 7 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/queryByTaskItemId 新增 查询任务项信息 8 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/queryByTaskId 新增 根据任务id查询任务信息 9 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/dynamicCondition/query?mode=all 新增 根据条件查询任务信息 10 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/transfer 新增 任务转派 11 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/release 新增 任务释放 12 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/claim 新增 任务认领 13 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/done 新增 任务处理 14 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/recall 新增 任务撤回 15 https://域名/apiaccess/service-cloud/rest/new_case/v2/task/return 新增 任务退回 16 https://域名/oifde/rest/crs/process 修改 对话交互后接口V1(inaction=9) 17 https://域名/oifde/rest/crs/process 修改 对话交互后接口V2(inaction=9) 18 释放事件回调接口 修改 新增请求体参数的releaseReason
  • Issue 08(2022-10-20) 本次随MicroService 1.10.0 版本发布,变更如下接口。 表5 接口修改记录 序号 接口 类型 备注 1 https://域名/apiaccess/rest/cc-management/v1/agentAccount/create 修改 请求体参数phone长度改为不超过25位 2 https://域名/apiaccess/rest/cc-management/v1/agentAccount/update 新增 请求体参数phone长度改为不超过25位 3 https://域名/apiaccess/ccmessaging/queryHistoryChatMessage 新增 查询历史消息 4 https://域名/apiaccess/ccmessaging/send,例如域名是https://service.besclouds.com 修改 请求参数mediaType支持位置消息(LOCATE)。
  • Issue 12(2023-05-13) 本次随MicroService 2.2.0.0 版本发布,变更如下接口。 表1 接口修改记录 序号 接口 类型 备注 1 华为工业云平台IMC回调接口https://域名/apiaccess/rest/oma/v1/imcopenapi/callback 新增 华为工业云平台IMC回调接口 2 软件云查询试用租户基本信息https://域名/rest/oma/softwareconsole/trialtenant/querytenantinfo 新增 软件云查询试用租户基本信息 3 软件云查询系统参数 新增 查询系统参数,该接口开放给软件云官网调用。 4 客户信息查询接口 修改 响应体增加四个参数vdn、createDate、tenantSpaceStatus、portalUrl
  • 话单记录文件(yyyymmddhhmmssSSS+3位随机数_call_文件序号.csv)定义 导出的话单记录csv文件中每一行表示一条数据,在该条数据下每行数据按列排序,每行数据描述说明请参考下表。 顺序 参数名称 数据类型 参数说明 1 developer String(1-64) 开发者ID。 2 account_id String(1-64) 企业帐号。 3 cc_id String(1-64) 呼叫中心ID。 4 agent_id String(1-32) 座席ID。 5 call_id String(1-25) 呼叫标识。 6 caller_no String(1-26) 主叫号码。 7 callee_no String(1-26) 被叫号码。 8 wait_begin DATE 等待开始时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 9 wait_end DATE 等待结束时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 10 ack_begin DATE 应答开始时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 11 ack_end DATE 应答结束时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 12 call_begin DATE 呼叫开始时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 13 call_end DATE 呼叫截止时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 14 device_type Int(1-4) 设备类型。 1:技能队列,2:座席,3:IVR流程 15 device_no Int(1-5) 设备号。 如果设备类型为技能队列,设备号为技能队列ID; 如果设备类型为座席,设备号为座席ID; 如果设备类型为IVR,设备号为IVR流程ID。 16 call_type Int(1-4) 呼叫类型。详见呼叫类型说明。 17 release_cause Int(1-5) 呼叫释放原因。详见呼叫释放原因码 对CallIDNUM = -1的话单(参考本表第18项),表示呼叫的释放原因,其他情况下无意义。 18 call_id_num Int(1-4) 呼叫标识的序列。其中: 若相同呼叫标识只有一条,即该呼叫标识是唯一的,则该序列为-1。 若相同呼叫标识为多条,则最后一条是-1,其他的按顺序排列。如:相同呼叫标识有4条,callidnum为1、2、3以及-1。 19 vdn_id String(1-32) 指处理呼叫的虚拟呼叫中心编号。 20 pre_device_type String(1-32) 呼叫经历的上一个设备的设备类型。取值范围:1:队列 2:座席 3:IVR 21 pre_device_no String(1-32) 呼叫经历的上一个设备的设备编号。 22 skill_id String(1-32) 呼叫所属技能队列的ID。当溢出转和无人上班转时,为呼入的第一个技能队列的ID 23 current_skill_id String(1-32) 当前处理呼叫的技能队列的编号。
  • 录音记录索引文件(yyyymmddhhmmssSSS+3位随机数_record_文件序号.csv)定义 导出的录音记录csv文件中每一行表示一条数据,在该条数据下每行数据按列排序,每行数据描述说明请参考下表。 顺序 参数名称 数据类型 参数说明 1 developer String(1-64) 开发者ID。 2 account_id String(1-64) 企业帐号。 3 cc_id String(1-64) 呼叫中心ID。 4 agent_id String(1-32) 座席ID。 5 call_id String(1-25) 呼叫标识。 6 caller_no String(1-25) 主叫号码。 7 callee_no String(1-25) 被叫号码。 8 call_begin DATE 开始时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 9 call_end DATE 结束时间。 时间格式为:YYYY-MM-DD hh:mm:ss,例如:2015-02-08 20:23:30 10 file_name String(1-255) 录音文件名。例如:/10/1/record/100/13533/0903379.wav 11 task_status String(1-20) 是否有将录音文件转为文字文件(1:是,0:否)。 12 task_result String(1-20) 录音文件转为文字文件是否成功的状态信息(success:成功,failed:失败)。 13 original_file_name String(1-129) 原始录音文件路径。例如:X:\17\0\20180903\15470\2043295.V3 14 vdn_id String(1-64) 指处理呼叫的虚拟呼叫中心编号。 15 call_type String(1-64) 呼叫类型。详见呼叫类型说明。 16 media_type String(1-64) 媒体类型。详见媒体类型。 17 user_wanted_skill_id String(1-64) 引导技能。 18 current_skill_id String(1-64) 当前处理呼叫的技能队列的编号。
  • 请求消息样例 { "userid": "1528780879-9581", "inaction": 13, "inparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "auth_token":"eyJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1MzgwMzg5MzUsImV4cCI6MTUzODA0MjUzNSwian" }} ODFS接收到inaction为13的请求后,检索该呼叫从宇高上报识别结果队列是否有数据,如果有数据,就给IVR返回1,否则返回0:
  • 相关术语 表1 术语表 名词 描述 VDN 虚拟呼叫中心,为CTI侧的概念。在云客服中,一个租户创建配置完毕后即对应一个虚拟呼叫中心,虚拟呼叫中心等同于租户、租间。 技能队列 技能队列指处理同类问题或解答同类疑问的座席分组,区分技能队列可提高座席的工作效率,缩短服务时长。技能队列包含语音、多媒体、视频、语音点击通话和视频点击通话,5种类型,用于处理不同的问题。 当用户请求某种媒体服务时,用户呼叫先进入到该媒体下的某个技能队列,由签入技能队列的座席为呼叫用户提供服务。 接入码 面向客户提供的客服热线,客户通过拨打接入码接通到座席侧。 扩展码 如果希望一个接入码能设置多个目的设备。这种情况下可通过配置扩展码的方式来实现,例如,接入码为12345,我们可以添加扩展码1,路由到技能队列A,扩展码2,路由到技能队列B。这样客户可直接拨打123451实现直接接入技能队列A。 软电话号码 即为您OpenEye的登录账号,Openeye是一个多媒体软终端产品。 APPKey 即AK,也可写作APP ID,开发者账号。当第三方调用云客服系统的对外开放接口时,需要通过AK和SK 获取Token 认证信息。 APPSecret 即SK,认证密钥。当第三方调用云客服系统的对外开放接口时,需要通过AK和SK获取Token认证信息。 IP:PORT 用户登录云客服时,登录页面的域名。接口文档中URL会涉及到此术语,例如URL为“https://IP:PORT/oifde/rest/api/spellcheck”,云客服登录页面域名为“southvideo.aicccloud.com”,则IP:PORT可以用对应的域名“southvideo.aicccloud.com”替换。
  • 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值。
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 0或者null:成功 非0表示失败 或可通过状态码为200判断为成功 errorMsg String body False 错误描述 domains domain[] body True 领域信息,数组形式输出 表3 domain 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID domainId int body True 领域ID domainName String body True 领域名称 language String body True 语言。选项如下: zh_CN:中文 en_US:英文 es_ES:西班牙语 ar:阿拉伯语 如果没有该字段,则返回所有语言的domain,如果有,只返回指定语言的domain。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 表2 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID。 language String body False 语言。选项如下: zh_CN:中文 en_US:英文 es_ES:西班牙语 ar:阿拉伯语 如果language为空或者为""都是返回全部的领域结果,如果有,只返回指定语言的domain。 authToken String body True 认证Token 请参见C3 智能助手平台接口鉴权方式。
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 errorCode int body True 错误码 0:成功 非0表示失败 或可通过状态码为200判断为成功 errorMsg String body False 错误描述 authToken String body True 认证token expireTime int body False 令牌有效期,单位是秒数,默认 3600 秒; 错误码非0时,无返回。
共100000条