华为云用户手册

  • 报文样例 请求样例 { "tenantId":"202104237142", "accessCode":"943370855474270208", "timestamp":1628784000000, "type":"hour", "authToken":"wEd*******************Q6VwYMj" } 响应样例 [ { "recordTime": 1628820000000, "tenantId": "202104237142", "accessCode": "943370855474270208", "callCount": 1, "exitNoConsultCount": 0, "callStaffNoConsultCount": 0, "callStaffConsultCount": 0, "exitConsultingCount": 1, "interactCount": 2, "autonomyRate": "1.0000", "averageInteractPerCall": "2.00", "dbRecordTime": 1628820000000, "type": "hour", "interfaceRequestCount": 0, "interfaceSuccessCount": 0, "interfaceSuccessRate": "-1.0000" } ]
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 - QueryCallStatisticsRes[] body True 呼叫统计报表信息 表2 QueryCallStatisticsRes 名称 是否必选 参数类型 说明 recordTime True long 记录日期的毫秒时间戳 tenantId True String 租户ID accessCode True String 接入标识(机器人接入码) callCount True long 接入量 exitNoConsultCount True long 直接退出量,用户和IVR只交互一次的量 callStaffNoConsultCount True long 直接转人工量,用户和IVR交互大于1次且小于等于3次,并且不在IVR挂机的量 callStaffConsultCount True long 咨询后转人工量,用户和IVR交互大于3次,并且不在IVR挂机的量 exitConsultingCount True long 仅咨询机器人量,用户和IVR交互大于1次,并且在IVR挂机的量 interactCount True long 对话轮次,总的用户和IVR交互次数 autonomyRate True String 净自助解决率 -1.000: 机器人总使用量为0(直接转人工量+咨询后转人工量+仅咨询机器人量) 0-1.000:仅咨询机器人量/机器人总使用量 averageInteractPerCall True String 平均对话轮次,平均每通对话,用户和IVR的交互次数 dbRecordTime True Date 数据库记录日期,未设置为null type True String 查询类型 hour: 按小时查询 day: 按天查询 interfaceRequestCount True long 接口调用总数 interfaceSuccessCount True long 接口调用成功数 interfaceSuccessRate True String 接口调用成功率 -1.000: 接口调用总数为0 0-1.000:接口调用成功数/接口调用总数
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 hour: 按小时查询,特定日期的报表数据 day: 按天查询,三十日内的报表数据 tenantId String body True 租户ID accessCode String body True 接入标识(机器人接入码) timestamp long body True 查询日期的毫秒时间戳 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "ccId":1, "vdn":4, "agentIds":[11,12], "indexIds":["IDX_DURATION_AGENT_REST","IDX_COUNT_AGENT_REQUEST"], "beginMonthTime":"202007", "endMonthTime":"202008", "mediaType":53, "subMediaType":3 } 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "35", "id": "IDX_DURATION_AGENT_REST" } ], "id": "11" }, { "idxs": [ { "val": "10", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "35", "id": "IDX_DURATION_AGENT_REST" } ], "id": "12" } ], "resultDesc": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "35", "id": "IDX_DURATION_AGENT_REST" } ], "id": "11" }, { "idxs": [ { "val": "10", "id": "IDX_COUNT_AGENT_REQUEST" }, { "val": "35", "id": "IDX_DURATION_AGENT_REST" } ], "id": "12" } ] }
  • 网页客户端接入 若网页端客户接入接口返回401,说明请求头中Authorization或ccmessaging-token已失效,需先调用C1 系统配置类接口鉴权方式刷新Authorization,调用第三方请求鉴权(applyToken)接口刷新cccmessaging-token后,再调用业务接口。 接口调用流程 第三方请求鉴权 (applyToken) 查询排队信息 (queryQueueInfo) 主动轮询座席侧发送的信息 (poll) 保存客户提交的满意度评价结果 (saveSatisfaction) 发送消息 (send) 客户发送文件 (uploadFileStream) 客户接收文件 (downloadFileStream) 根据客户输入联想常用语 (queryPhraseByKeyword) 检查当前租间是否支持点击通话 (checkClickToCallSupport) 创建点击通话 (createClickToCall) 获取点击通话事件 (getClickToCallEvents) 释放点击通话 (dropClickToCall) 创建匿名通话 (createcall) 客户提交留言 (doLeaveMessage) 提交客户对机器人满意度评价结果 (feedbacksatisfaction) 查询历史消息 (queryHistoryChatMessage) 丢弃邮件(chat_dropMail) 提供whatsapp发送下行消息(sendWhatsappMessage) 查询在线交谈工作台当前交谈的消息(getUserInfoBycallId) 查询满意度调查配置(getSatisfactionSurveyMode)
  • 报文样例 请求消息样例 { "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": "坐" } ] }
  • 场景描述 给第三方接入方调用,实现拼写检查能力。 当用户输入要查询的问题时,如果输入的句子中存在错别字(中文是同音错字,英文是拼写错误),系统能够具有对这些错误进行纠错的能力。 对接Customer Service Platform系统时,采取Headers头部的userName+token组合鉴权方式,其中userName为ipcc,token获取方式参见C3 智能助手平台接口鉴权方式。 对接其他第三方系统,采取请求体的authToken鉴权方式。
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID,默认为ipcc用户,即同获取token时,约定好的ipcc用户。 authToken String body True Token token失效后,需重新调用获取token接口。 请参见C3 智能助手平台接口鉴权方式。 sentence String body True 输入文本,长度限制1024位 language String body True 传入语言参数: zh_CN:中文 en_US:英文 pt_BR:葡萄牙语 传入语言参数类型要求与输入文本类型匹配。 【限制】中英葡语可正常纠错,其他语种文本不做纠错直接返回。再返回的对象中的“是否存在错别字”字段设置为false,即不存在纠错的情况 checkerType String body True 校验类型: 错字纠错: nonWordSpellChecker 别字纠错: realWordSpellChecker 中文仅存在别字纠错。 英文推荐使用错字纠错。 葡语推荐使用错字纠错。
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 hasMistake boolean body True 是否存在错别字: true 表示输入句子中存在错别字 false表示输入句子中不存在错别字 spellCheckerMatchList SpellCheckerMatch[] body True 纠错结果 表2 SpellCheckerMatch 参数名称 数据类型 参数位置 必选/可选 描述 word String spellCheckerMatchList True 原始输入中的字 startIndex int spellCheckerMatchList True word在句子中开始索引 endIndex int spellCheckerMatchList True word在句子中结束索引 hasMistake boolean spellCheckerMatchList True 该word是否为错别字 correctWord String spellCheckerMatchList True 若word为错别字,则为纠正后的字
  • 报文样例 请求消息样例 { "authToken": "e***************************", "model":{ "id": 10000, "tenantId": "00030010", "name": "Social Security Related FAQ2", "description": "This is a test group.", "language": "" } } 响应消息样例 { "errorCode" : "0", "errorMsg" : "" }
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 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 表6 表5 表4
  • 请求说明 表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传递参数,可选的扩展参数,当前只有初始化场景使用。
  • CC-Gateway返回结果码 结果码 说明 0 调用配置接口成功 000-000 未知错误 000-002 座席通过URL传递的参数或者地址错误或接口参数不合法,不符合定义。 104-001 未开启录音下载功能 104-002 用户无质检录音/质检放音权限 104-003 录音删除失败之文件名不合法 104-004 录音删除失败之没有配置映射盘符 104-005 录音删除失败之录音文件不存在 104-006 录音删除失败之空闲空间不足 104-007 录音文件格式不支持 104-008 录音格式系统参数未配置 104-009 录音转换失败 104-010 录音节点id参数未配置 104-011 录音文件删除失败 107-000 缓存登录信息失效,需要重新登录鉴权 107-001 调用配置接口抛了异常 107-002 输入参数不合法或必填字段为空 107-003 用户名或密码错误导致登录失败 107-004 配置失败 107-005 配置接口通信失败 107-007 配置接口配置前鉴权失败 107-010 增加座席或批量增加座席遇到异常 107-011 座席修改或批量座席修改遇到异常 107-012 座席查询异常 107-013 座席删除失败异常 107-014 角色增加失败异常 107-015 角色修改失败异常 107-016 角色查询失败异常 107-017 角色删除失败异常 107-018 被叫增加失败异常 107-019 被叫修改失败异常 107-020 被叫查询失败异常 107-021 被叫删除失败异常 107-022 VDN修改失败异常 107-023 VDN查询失败异常 107-024 IVR流程查询失败异常 107-025 IVR流程文件名为空 107-033 系统接入码增加失败异常 107-034 系统接入码修改失败异常 107-035 系统接入码查询失败异常 107-036 系统接入码删除失败异常 107-037 IVR服务进程增加失败异常 107-038 IVR服务进程修改失败异常 107-039 IVR服务进程查询失败异常 107-040 IVR服务进程删除失败异常 107-041 系统VDN新增失败异常 107-042 系统VDN修改失败异常 107-043 系统VDN查询失败异常 107-044 系统VDN删除失败异常 107-045 系统VDN删除VDNID与VDNName不匹配异常码 107-107~109 ipccbase的configproxy使用 107-064 系统UAP多媒体用户增加失败异常码 107-065 系统UAP多媒体用户查询失败异常码 107-066 UAP配置异常码 107-067 系统UAP多媒体用户修改密码失败异常码 107-068 系统UAP多媒体用户删除失败异常码 107-069 系统uap查询注册状态失败异常码 107-070 系统uap注销注册失败异常码 107-071 uap用户号码为null异常码 107-072 uap用户号码不合法异常码 107-073 IP地址为null异常码 107-074 密码为null异常码 107-075 密码长度不在范围异常码 107-076 密码与确认密码不一致异常码 107-077 IP地址类型不支持异常码 107-078 开始号码和结束号码长度不一致异常码 107-079 结束号码小于开始号码异常码 107-080 号码数量超出限制异常码 107-081 校验vdn权限失败、vdn不包含该用户号码异常码 107-082 签入uap失败或者与uap断连异常码 107-083 发送mml命令失败异常码 107-084 获取产品类型失败异常码 107-085 产品类型无法识别异常码 107-086 存在号码没有配置呼叫字冠异常码 107-087 注销号码未注册异常码 107-088 休息原因码新增失败异常 107-089 休息原因码修改失败异常 107-090 休息原因码查询失败异常 107-091 休息原因码删除失败异常 107-092 智能识别和双轨道录音开关只能选择一个开启 107-093 增加、修改技能队列参数不合法 107-094 authFlag参数不支持异常码 107-095 输入参数不合法,超出值域 CTI侧原因码见下面章节描述。 父主题: 错误码定义
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 说明 1.1 resultCode string 响应结果码 1.2 resultDesc string 响应结果描述。 如果resultCode返回0:成功 如果resultCode返回13:disconnect failed 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 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后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 channel string True 接收者渠道类型(WEB)
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "queryParam": { "ccId":1, "vdn":1, "skillId":1 } } 请求参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "workNo": 20011, "name": "20011", "status": 4, "ctiStatus": 1, "groupId": 1, "mediaType": 1, "vdnId": 1, "phoneNumber": "70942", "currentStateTime": 1505, "loginDate": 1501125758000 } ], "resultDesc": [ { "workNo": 20011, "name": "20011", "status": 4, "ctiStatus": 1, "groupId": 1, "mediaType": 1, "vdnId": 1, "phoneNumber": "70942", "currentStateTime": 1505, "loginDate": 1501125758000 } ] }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围:1~65535 2 vdn int True 虚拟呼叫中心编号。 取值范围:1~5000 3 skillId Int True 技能队列编号。 取值范围:1~2000
  • 响应消息 表3 消息体参数说明 序号 名称 参数类型 说明 1 result String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.12及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明: 当前字段为兼容8.12及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 workNo int 座席工号。 2.2 name string 座席名称。 2.3 status int 座席状态,参数说明请参考表5。 2.4 ctiStatus int 座席平台状态,参数说明请参考CTI平台座席状态码参考 2.5 groupId int 座席班组ID。 2.6 mediaType int 座席媒体类型,请参见表1 2.7 vdnId int 所属VDN ID。 2.8 phoneNumber string 座席电话号码。 2.9 currentStateTime long 当前状态时长。(秒) 2.10 loginDate long 签入时间。(毫秒级时间戳) 表5 座席状态 值 说明 0 未知。对应CTI平台状态的9。 2 表示调用该接口出现异常。 3 示忙状态。对应CTI平台状态的7。 4 空闲状态。对应CTI平台状态的1。 5 整理态。对应CTI平台状态的6。 7 通话态。对应CTI平台状态的2、3、4、5。 8 休息状态。对应CTI平台状态的8。
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "ccId": "89", "vdn":92, "taskId":"1122104910" } 响应参数: { "resultCode": "0100000", "resultDesc": { "compCount": "4", "failCount": "2", "compRate": "50%", "execCount": "0", "succCount": "2", "succRate": "50%", "totalCount": "4", "waitCount": "0" }
  • 响应消息 表3 消息体参数说明 参数名 数据类型 说明 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 resultDesc array 查询成功后,返回结果信息的对象数组。 该接口的响应消息体参数说明请参考表4 表4 响应消息体参数说明 参数名 数据类型 说明 totalCount int 日外呼量。 succCount int 成功呼叫数(接通量)。 failCount int 失败呼叫数。 succRate String 成功率(接通率)。 compCount int 完成呼叫数。 waitCount int 等待呼叫数。 execCount int 执行中呼叫数。 compRate String 完成率。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 0:成功,其他为失败 1 :添加外呼任务失败,外呼数据库中可能已存在相同外呼任务 2 :呼叫数据信息 3 :未查询出呼叫流水号字段 5 :主被叫或外显号码格式不符 6 :VDN不可用 8 :主叫号码不在租户所分配的移动座席使用的软电话号码范围内 9 :callBackUrl不符合条件 16 :试用租户的座席侧号码未在白名单内 21 :试用租户一键双呼超过每天10次限制 针对ITA双呼还有一些retCode,请参见表4 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 callSerialNo number False 呼叫流水号 表4 针对ITA双呼的retcode说明 retcode retMsg 说明 90100100 Invalid Input Parameter 请求报文不正确。如缺少参数或者不支持的参数 90100200 Auth Failed 请求的来源或者请求的签名未通过校验 90100300 Bad Request 错误请求 90100400 Not found 请求资源不存在 90100600 Internal Server Error 系统内部错误 90102001 Insufficient Balance 额度不足 90102002 Request Restriction 请求限制 90104001 Insufficient Permission 权限不足 90104003 Request Forbidden 请求被禁止 90104004 Service Unavailable 不支持的业务功能或者未实现 90104008 Service Process Failure 业务处理超时或者处理失败 90104029 Too Many Requests 请求过多 90106001 Binding relationship already exists 小号绑定关系已存在 90106002 Binding relationship not exists 小号绑定关系不存在 90106003 Insufficient Number resources 小号号码池资源不足 90106004 No corresponding number found 未找到可用小号 90106005 Inconsistent binding data 小号绑定数据不一致 90106006 Other Error 小号其他原因导致错误 90106010 Policy Forbid 策略禁止 90106011 Caller Forbid 主叫限制 90106012 Callee forbid 被叫限制 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: { "caller": "88889050", "called": "88889060", "agentWorkNo": "", "callerPresent": "640003", "agentPresent": "640060", "callData": "333333" } 响应头: { "connection": "keep-alive", "content-type": "application/json;charset=UTF-8" } 响应参数: { "result": { "callSerialNo": "1771078210739978242" }, "retCode": "0", "retMsg": "Created successfully." }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 caller string True 主叫号码,客户经理手机号码,或是软电话号码 长度限制:string(32) 2 called string True 被叫号码 长度限制:string(32) 3 agentWorkNo decimal False 发起双呼的座席的工号。 长度限制:decimal(5) 4 callData string False 呼叫数据 长度限制:string(1024) 说明: ITA双呼不支持callData字段。 5 callerPresent string False 用户侧主叫显示号码,用户看到的主叫号码,不携带的情况下默认采用租间的接入码,携带的情况下该号码必须传接入码。如果需要传非接入码号码,请联系运维人员开通主叫透显特性,该特性开通后号码校验规则为:接入码或者11-14位的数字。 说明: ITA双呼不支持callerPresent字段。 6 agentPresent string False 座席侧主叫显示号码,客户经理看到的主叫号码,不携带的情况下默认采用租间的接入码,携带的情况下该号码必须传接入码。如果需要传非接入码号码,请联系运维人员开通主叫透显特性,该特性开通后号码校验规则为:接入码或者11-14位的数字。 说明: ITA双呼不支持agentPresent字段。 7 callBackUrl string False 此参数请采用BASE64编码进行加密。 此字段用于设置客户接收状态上报的挂机回调URL。 云客服CEC平台将业务触发过程中通话的状态信息推送至此服务器,客户服务器根据通话状态信息确定用户状态。 URL可填写为https://IP:Port或域名,推荐使用域名,支持http和https。http为不安全协议,请谨慎使用。且该域名对应多个服务器,避免单点故障无法接收通知。 URL只能由大小写字母(a-z、A-Z),数字(0-9), - : . / _ # ? &组成,不支持其它字符。 回调URL的域名或IP端口已通过系统管理员加入手机客服回调的地址白名单中。 须知: 如果入参callBackUrl不生效,可能是因为您所在的云客服环境接口未正常升级,请联系运管理员确认当前的发布态的API名称是否为createCall_kugui,如果不是,则暂时不能使用callBackUrl入参。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识,请联系运营人员获取appKey 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 id string True 被叫ID 1.2 devicetype integer True 设备类型;1:技能队列 3:IVR 1.3 deviceId integer True 目前设备id(技能队列skillId、IVR的id)
  • 报文样例 请求头: Content-Type:application/json Authorization:Bearer XXXXXXXXXXXXXXXXXXXXXXX X-APP-Key:XXXXXXXXXXXXXXXXXXXXXXX 请求参数: { "id": "1125397061153369092", "devicetype": 1, "deviceId": 1 } 响应参数: { "returnCode": "0", "description": "data update success" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string False 返回码 0:成功 其他:失败 1.2 description string False 描述 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:第三方请求鉴权 请求头: X-APP-Key: b*************c7b Authorization: Bearer 1fea*************1d6a15 Content-Type: application/json 请求参数: { "userId": "XXXXXXXXX", "userName": "XXXXXXXX", "channelId": "XXXXXXXXXXXX", "locale": "zh" } 响应参数: { "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" }
  • 响应说明 响应状态码: 200 表4 applyTokenRspBody参数结构 序号 名称 参数类型 说明 1.1 token string 生成的token,后续发起其他请求时,需在Header中将该值赋给ccmessaging-token。 说明: 该Token有1小时有效期,如果系统返回鉴权失败(401)时,需要重新使用applyToken获取新Token。 在会话期间内,Token失效,AICC会自动在当次请求时返回新Token,企业需要自行在Header中更新ccmessaging-token的取值。 1.2 resultCode string 结果码 0:成功 1:失败 1.3 resultDesc string 结果描述 当前暂时没有返回。 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头 POST /CCFS/resource/ccfs/downloadBillFile HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:43:08Z/content-length;content-type;host /ae066c2f5d******************13a0afc161cb7e66f5d Accept: */* Content-Type: application/json;charset=UTF-8 Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "billFileName": "20180702_9239cb50a8384bb0ab503441bf089446.zip" } }
  • 请求说明 表1 请求Headers参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 Content-Type String True 无 固定填 application/json; charset=UTF-8。 2 Authorization String True 无 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求Body中request参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 version String(1-32) True 2.0 协议版本。当前固定值为2.0。 表3 请求Body中msgBody参数说明 序号 名称 参数类型 是否必选 默认值 说明 1 billFileName String(1-49) True 无 话单和录音索引文件名称,已调用“生成话单和录音索引”获取。 格式:yyyyMMdd_{responseId}.zip。 例如:已调用“生成话单和录音索引”接口,调用“生成话单和录音索引”接口的日期为2018-07-02,获取到的录音索引responseId为9239cb50a8384bb0ab503441bf08944,则该参数值为20180702_9239cb50a8384bb0ab503441bf089446.zip。
共100000条