华为云用户手册

  • 响应消息 表3 消息体参数说明 参数名 数据类型 说明 result String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 resultDatas List 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc List 查询成功后,返回结果信息的对象列表。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 参数名 数据类型 说明 id string 配置ID callId string 呼叫ID phoneNo string 座席电话号码或会议id subCcNo int 子系统号 currentAgentId int 业务代表的工号 currentSkillId int 处理呼叫的技能队列ID mediaType int 媒体类型,请参见表1 beginTime string 统计操作开始的时间,零时区 endTime string 统计操作结束的时间,零时区 vdn int 处理呼叫的虚拟呼叫中心编号 callType int 呼叫类型,请参见表1 serviceNo int 业务类型ID operateType int 操作类型,请参见表1 operateObject int 操作对象,请参见表1 operateCause int 操作原因,请参见表1 agentType int 座席类型,请参见表1 locationId int 分布式节点编号 logonSn string 签入序列号 skillInfoSn string 座席拥有技能列表的索引 当取值为空时,表示座席不拥有任务技能。例如:座席签入时,此字段则为空。
  • 响应消息 表3 响应体参数说明 参数名 数据类型 说明 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 resultDesc array 查询成功后,返回结果信息的对象数组。 该接口的响应消息体参数说明请参考表4 表4 响应消息体参数说明 参数名 数据类型 说明 statDate String 日结日期。 totalCount int 日外呼量。 succCount int 成功呼叫数(接通量)。 succRate String 成功率(接通率)。
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "vdn": 222, "ccId":89, "taskId": "1176499974", "beginDayTime": "2021-01-21", "endDayTime": "2021-01-23" } 响应参数: { "resultCode": "0100000", "resultDesc": [ { "statDate": "2021-01-17", "totalCount": 200, "succCount": 101, "succRate": "50.5%" }, { "statDate": "2021-01-18", "totalCount": 320, "succCount": 248, "succRate": "77.5%" } ] }
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "callid":"1552524689-16797284", "userType":"agent" } 响应参数 { "message": "success", "retcode": "0", "result": { "userId": "坐席工号", "ctime": "过期时间", "channelId": "15945185-345", "appId": "8345234631", "ip": "xxx.xxx.xxx.xxx", "port": "6500", "role": "0", "signalingDomainIn": "https: //in.isdpdomain.com", "signalingDomainOut": "https: //out.isdpdomain.com", "locationId": "65535", "signature": "xxx", "appId": "sdcp0BPcVGymItWppGX6XqrZGTCYa13d" } }
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 userType string True 用户类型。 默认为“agent”代表座席 2 callid string True 呼叫标识。
  • 接口URI https://ip:port/agentgateway/resource/mediacall/{agentid}/getconnectinfo 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 响应说明 表4 消息体参数说明 序号 名称 参数类型 说明 1 retcode string 消息发送结果。 0:成功 非0:失败 2 message string 描述 3 result object 查询成功后,返回连接信息对象。 该对象的参数说明请参见表5。 表5 result对象参数说明 序号 名称 参数类型 说明 1 userId string 坐席工号 2 ctime string 过期时间 3 channelId string 频道ID(房间ID) 4 role string 角色 5 ip string 媒体服务器接入点IP地址 6 port string 媒体服务器接入点端口 7 signalingDomainIn string 内侧信令domain; 格式:https:// 域名 :端口 8 signalingDomainOut string 外侧信令domain; 格式:https://域名:端口 9 locationId string 节点 10 signature string 签名 11 appId string 用户标识
  • 报文样例 该接口的请求消息体举例如下: { "name": "中秋节", "type": 2, "week": null, "beginTime": "2018-09-22", "endTime": "2018-09-24" } 该接口的响应消息体举例如下: { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "", "returnObject": { "id": 1318795089 } }
  • 响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功,其他表示失败。 具体见表6 2 resultDesc String 描述。 3 returnObject Object 参见表5。 4 returnCode String 原因码。0200000表示成功,其他表示失败。 具体见表6 5 returnDesc String 描述。 表5 returnObject参数说明 序号 参数名 参数类型 说明 1 id int 特殊日期id。
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/holiday/{campaignId} 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 campaignId int True 外呼活动的ID。
  • 请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 name String True 特殊日期名称。 名称不能重复,最大长度为30个字符。 2 type int True 特殊日期的类型。 取值范围: 1:按周设置 2:按日期设置 3:按日期重复 3 week String False 星期,特殊日期的类型为按周设置时为True。 取值范围: 1:星期一 2:星期二 3:星期三 4:星期四 5:星期五 6:星期六 7:星期天 同时选择多天时以逗号分隔,例如“6,7”表示星期六、星期天 4 beginTime String False 开始时间,特殊日期的类型为按日期设置或按日期重复时为True。 特殊日期的类型为2时,数据格式:yyyy-MM-dd 特殊日期的类型为3时,数据格式:MM-dd 5 endTime String False 结束时间,特殊日期的类型为按日期设置或按日期重复时为True。 特殊日期的类型为2时,数据格式:yyyy-MM-dd 特殊日期的类型为3时,数据格式:MM-dd
  • 错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200007 外呼活动不存在。 3 0200013 特殊日期名称已存在。 4 0200015 外呼活动的特殊日期数量已达上限。 5 0200030 时间格式不正确。 6 02000001 参数值为空 7 02000002 参数包含非法字符 8 02000003 参数长度不能大于规定长度 9 02000004 参数长度不能小于规定长度 10 02000005 参数长度需要介于规定长度之间 11 02000006 参数值类型不正确 12 02000007 参数值大小不正确 13 02000008 参数转换异常,请检查请求参数 14 02000009 参数组合不正确,请检查请求参数 15 02000010 hour和minute必须同时存在 16 02000011 参数个数不能大于规定个数
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "queryParam": { "callerNos": ["120002"], "beginLogDay": "2021-10-26", "endLogDay": "2021-10-26", "callTypes": [7], "skillIds": [1,6], "subCcNo": 1, "vdn": 32 } } 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "failTimeGt10": 0, "outSuccWaitAnsNum": 2, "callType": 7, "callerNo": "120002", "maxCallTime": 38, "callTimeLt60": 2, "preViewedTransferNum": 0, "failTimeLt10": 0, "succAckTimeGt10": 1, "minWaitAnsTime": 1, "autoCallSuccNum": 0, "hangUpNum": 0, "preOccupiedSuccNum": 0, "preAgentNum": 0, "zeroNum": 0, "subCcNo": 1, "ivrOnlyTime": 0, "succAckTimeLt30": 2, "serviceNo": 1, "maxWaitAnsTime": 15, "obsServiceNo": "-1", "failTimeLt5": 0, "reservedCol3": 2, "ivrOnlyNum": 0, "reservedCol2": 0, "failTimeLt3": 0, "reservedCol1": 0, "reservedCol7": 0, "reservedCol6": 0, "reservedCol5": 0, "reservedCol4": 0, "preOccupiedAgentSuccNum": 0, "autoCallNum": 0, "hangUpReleaseNum": 0, "preTotalTime": 0, "preFailQueueWaitTime": 0, "preAbortQueueWaitNum": 0, "failTimeGt60": 0, "orgCcNo": 1, "succWaitAnsTime": 16, "callTimeGt60": 0, "outVdnTime": 105, "callTimeLt5": 0, "callTimeLt3": 0, "succAckTimeLt5": 1, "ivrCallSuccNum": 0, "preCallNum": 0, "succAckTimeLt10": 1, "outCallSuccNum": 2, "succAckTimeLt3": 1, "callTimeGt10": 2, "vdn": 32, "preAgentSuccNum": 0, "reservedCol10": 0, "outOccupyNum": 2, "ivrOccupyNum": 0, "beginLogDay": "2021-10-26", "reservedCol18": 0, "reservedCol17": 0, "reservedCol16": 0, "reservedCol15": 0, "reservedCol14": 0, "reservedCol13": 0, "reservedCol12": 0, "failTimeLt60": 0, "reservedCol11": 0, "hangUpTime": 0, "preOccupiedSuccAckTime": 0, "ivrOnlySuccNum": 0, "reservedCol19": 0, "autoAnsTime": 0, "callTimeLt10": 0, "outWaitAnsTime": 16, "currentSkillId": 1, "failQueueWaitNum": 0, "reservedCol20": 0, "reservedCol9": 0, "reservedCol8": 0, "outCallCostMinute": 2, "currentAgentId": 40002, "succAckTimeGt60": 0, "agentHangUpLt3": 0, "preQueueWaitTime": 0, "preQueueWaitNum": 0, "preViewedCallSuccNum": 0, "minCallTime": 26, "preOccupiedCallNum": 0, "agentTransferNum": 1, "succAckTimeLt60": 2, "preTransferNum": 0, "preViewedSuccAckTime": 0, "preFailQueueWaitNum": 0, "endLogDay": "2021-10-26", "preNoAckNum": 0, "ivrCallTime": 0, "failTimeLt30": 0, "preViewedCallNum": 0, "callTimeLt30": 1, "serCcNo": 1, "preCallSuccNum": 0, "outCallTime": 64, "preOccupiedTransferNum": 0, "failQueueWaitTime": 0, "preOccupiedAgentSuccTime": 0, "outCallAllCostMinute": 1, "autoTransferNum": 0 }, {......} ], "resultDesc": [ { "failTimeGt10": 0, "outSuccWaitAnsNum": 2, "callType": 7, "callerNo": "120002", "maxCallTime": 38, "callTimeLt60": 2, "preViewedTransferNum": 0, "failTimeLt10": 0, "succAckTimeGt10": 1, "minWaitAnsTime": 1, "autoCallSuccNum": 0, "hangUpNum": 0, "preOccupiedSuccNum": 0, "preAgentNum": 0, "zeroNum": 0, "subCcNo": 1, "ivrOnlyTime": 0, "succAckTimeLt30": 2, "serviceNo": 1, "maxWaitAnsTime": 15, "obsServiceNo": "-1", "failTimeLt5": 0, "reservedCol3": 2, "ivrOnlyNum": 0, "reservedCol2": 0, "failTimeLt3": 0, "reservedCol1": 0, "reservedCol7": 0, "reservedCol6": 0, "reservedCol5": 0, "reservedCol4": 0, "preOccupiedAgentSuccNum": 0, "autoCallNum": 0, "hangUpReleaseNum": 0, "preTotalTime": 0, "preFailQueueWaitTime": 0, "preAbortQueueWaitNum": 0, "failTimeGt60": 0, "orgCcNo": 1, "succWaitAnsTime": 16, "callTimeGt60": 0, "outVdnTime": 105, "callTimeLt5": 0, "callTimeLt3": 0, "succAckTimeLt5": 1, "ivrCallSuccNum": 0, "preCallNum": 0, "succAckTimeLt10": 1, "outCallSuccNum": 2, "succAckTimeLt3": 1, "callTimeGt10": 2, "vdn": 32, "preAgentSuccNum": 0, "reservedCol10": 0, "outOccupyNum": 2, "ivrOccupyNum": 0, "beginLogDay": "2021-10-26", "reservedCol18": 0, "reservedCol17": 0, "reservedCol16": 0, "reservedCol15": 0, "reservedCol14": 0, "reservedCol13": 0, "reservedCol12": 0, "failTimeLt60": 0, "reservedCol11": 0, "hangUpTime": 0, "preOccupiedSuccAckTime": 0, "ivrOnlySuccNum": 0, "reservedCol19": 0, "autoAnsTime": 0, "callTimeLt10": 0, "outWaitAnsTime": 16, "currentSkillId": 1, "failQueueWaitNum": 0, "reservedCol20": 0, "reservedCol9": 0, "reservedCol8": 0, "outCallCostMinute": 2, "currentAgentId": 40002, "succAckTimeGt60": 0, "agentHangUpLt3": 0, "preQueueWaitTime": 0, "preQueueWaitNum": 0, "preViewedCallSuccNum": 0, "minCallTime": 26, "preOccupiedCallNum": 0, "agentTransferNum": 1, "succAckTimeLt60": 2, "preTransferNum": 0, "preViewedSuccAckTime": 0, "preFailQueueWaitNum": 0, "endLogDay": "2021-10-26", "preNoAckNum": 0, "ivrCallTime": 0, "failTimeLt30": 0, "preViewedCallNum": 0, "callTimeLt30": 1, "serCcNo": 1, "preCallSuccNum": 0, "outCallTime": 64, "preOccupiedTransferNum": 0, "failQueueWaitTime": 0, "preOccupiedAgentSuccTime": 0, "outCallAllCostMinute": 1, "autoTransferNum": 0 }, {......} ] }
  • 响应消息 表3 消息体参数说明 参数名 数据类型 说明 result String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 resultDatas array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc array 查询成功后,返回结果信息的对象。 该对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 参数名 数据类型 说明 beginLogDay string 统计的开始通话时间,与入参一致。 endLogDay string 统计的结束通话时间,与入参一致。 callerNo string 呼叫的主叫号码。 callType int 呼叫类型。 vdn int 虚拟呼叫中心编号。 serviceNo int 业务类型。 orgCcNo int 原始呼叫中心子系统号。 subCcNo int 子系统号。 serCcNo int 服务方的子系统号。 currentAgentId int 外呼座席工号。 一通呼叫的最后一条话单的外呼座席工号(指标结算时不建议使用) currentSkillId int 技能队列编号。 一通呼叫的最后一条话单的技能队列编号(指标结算时不建议使用) obsServiceNo string 外呼活动编号。 failQueueWaitNum int 呼损等待次数。 failQueueWaitTime int 呼损等待时长(秒)。 outOccupyNum int 人工呼出次数。 outSuccWaitAnsNum int 人工呼出应答次数。 outCallSuccNum int 人工呼出成功次数。 outWaitAnsTime int 呼出等待应答时长(秒)。 outCallTime int 呼出通话时长(秒)。 maxWaitAnsTime int 最大等待应答时长(秒)。 minWaitAnsTime int 最小等待应答时长(秒)。 maxCallTime int 最大通话时长(秒)。 minCallTime int 最小通话时长(秒)。 succAckTimeLt3 int 应答短于3秒的成功通话量。 callTimeLt3 int 通话时间短于3秒的成功通话量。 failTimeLt3 int 等待时长短于3秒的失败量。 succAckTimeLt5 int 应答短于5秒的成功通话量。 callTimeLt5 int 通话时间短于5秒的成功通话量。 failTimeLt5 int 等待时长短于5秒的失败量。 succAckTimeLt10 int 应答短于10秒的成功通话量。 callTimeLt10 int 通话时间短于10秒的成功通话量。 failTimeLt10 int 等待时长短于10秒的失败量。 succAckTimeLt30 int 应答短于30秒的成功通话量。 callTimeLt30 int 通话时间短于30秒的成功通话量。 failTimeLt30 int 等待时长短于30秒的失败量。 succAckTimeLt60 int 应答短于60秒的成功通话量。 callTimeLt60 int 通话时间短于60秒的成功通话量 failTimeLt60 int 等待时长短于60秒的失败量 succAckTimeGt10 int 应答大于10秒的成功通话量 callTimeGt10 int 通话时间大于10秒的成功通话量 failTimeGt10 int 等待时长大于10秒的失败量 succAckTimeGt60 int 应答大于60秒的成功通话量 callTimeGt60 int 通话时间大于60秒的成功通话量。 failTimeGt60 int 等待时长大于60秒的失败量。 agentHangUpLt3 int 短于3秒的主叫挂断通话量。 preAgentSuccNum int 预测外呼时转人工服务通话次数。 preViewedTransferNum int 预览外呼时座席转出次数。 hangUpTime int 人工转IVR总时间。 preOccupiedSuccAckTime int 预占外呼接通前等待时长(秒)。 autoAnsTime int 系统级IVR外呼振铃时长(秒)。 autoCallSuccNum int 系统级IVR外呼通话次数。 preOccupiedSuccNum int 预占外呼接通前等待时长(秒)。 hangUpNum int 人工转IVR次数。 preAgentNum int 预测呼出转人工服务次数。 zeroNum int 零话单数。 preQueueWaitTime int 预测外呼时排队等待时长(秒)。 preQueueWaitNum int 预测外呼时排队等待次数。 preViewedCallSuccNum int 预览外呼接通次数。 preOccupiedCallNum int 预占外呼总次数。 preOccupiedAgentSuccNum int 预占外呼人工通话数。 agentTransferNum int 人工外呼转出数。 autoCallNum int 系统级IVR外呼数。 hangUpReleaseNum int 人工转IVR挂机数。 preTransferNum int 预测外呼转出数。 preTotalTime int 预测外呼总时长(秒)。 preFailQueueWaitNum int 预测外呼呼损排队等待次数。 preViewedSuccAckTime int 预览外呼接通前等待时长(秒)。 preFailQueueWaitTime int 预测外呼呼损排队等待时长(秒) preAbortQueueWaitNum int 预测外呼呼叫释放排队等待次数。 preNoAckNum int 预测外呼用户摘机请求人工服务无应答次数。 succWaitAnsTime int 成功通话应答时长(秒)。 outVdnTime int 呼出呼叫占用VDN总时长(秒)。 preViewedCallNum int 预览外呼总次数。 preCallSuccNum int 预测外呼接通数。 preOccupiedTransferNum int 预占外呼时座席转出次数。 preCallNum int 预测外呼发起数。 preOccupiedAgentSuccTime int 预占外呼人工通话时长(秒)。 autoTransferNum int 系统级IVR外呼转出数。 outCallCostMinute int 人工通话计费时长(分钟) ivrCallSuccNum int IVR外呼通话次数 ivrCallTime int IVR外呼通话时长(秒) ivrOccupyNum int IVR外呼请求次数 ivrOnlyNum int IVR唯一呼出数 ivrOnlySuccNum int IVR唯一接通数 ivrOnlyTime int IVR唯一呼出时长(秒) outCallAllCostMinute int 每通通话计费总时长(分钟),包括人工通话计费时长和IVR通话计费时长。 reserved_col1-reserved_col20 int 预留字段,业务含义根据表t_cms_custom_indicator_config配置确定 ;默认预留字段3为呼出通话时长大于等于15秒的呼出数。
  • 主席变更事件 标示符 AgentConf_PresidentChanged 作用 表示当前座席被变更为会议主席。 附带信息 confId表示会议ID。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentConf_PresidentChanged","workNo":"154","content":{"confId":1031168}} 父主题: 座席会议事件
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": { "agentState": 4, "isWorking": false } }
  • 接口URI https://ip:port/agentgateway/resource/onlineagent/{agentid}/agentstatus 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下: 0:成功 非0:失败 3 result array 请参考表4 表4 座席状态信息 序号 名称 参数类型 说明 3.1 agentState int 座席状态。请参考表1 3.2 isWorking boolean false表示没有正在通话。 true表示正在通话。
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/holiday/{campaignId}/{holidayId} 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 campaignId int True 外呼活动的ID。 3 holidayId int True 特殊日期ID。
  • 错误结果码 表4 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200007 外呼活动不存在。 3 0200014 特殊日期不存在。 4 02000001 参数值为空 5 02000002 参数包含非法字符 6 02000003 参数长度不能大于规定长度 7 02000004 参数长度不能小于规定长度 8 02000005 参数长度需要介于规定长度之间 9 02000006 参数值类型不正确 10 02000007 参数值大小不正确 11 02000008 参数转换异常,请检查请求参数 12 02000009 参数组合不正确,请检查请求参数 13 02000010 hour和minute必须同时存在 14 02000011 参数个数不能大于规定个数
  • 报文样例 场景描述:更新话术 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "sentences": ["14171"], "role": "any", "position": "any", "SGType": "must", "sg_id": "923004925930115072", "sg_name": "话术名称98", "dialogue_flow_id": "923004925523267584", "position_distance": 0 } 响应参数: { "resultCode": "0405000", "resultDesc": "操作成功" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0405000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表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 sentences array[string] False 话术使用的句子 1.2 role string True 话术对应的角色,取值如下: any:不限制 staff:坐席 customer:用户 1.3 position string True 通话的位置,取值如下: any:不限制位置 top:通话开头 bottom:通话结尾 set:设定距离 1.4 SGType string True 句子的逻辑关系运算符,取值如下: must:必须说出 if:如果说出 must_say:一定要说 must_not_say:一定不能说 then:再说出 and:还要说出 1.5 position_distance number False 句子的偏移量,取值范围:1~9999 1.6 sg_id string True 话术标识 1.7 sg_name string(128) False 话术名称 1.8 dialogue_flow_id string True 对话逻辑id
  • 消息样例 场景描述:处理任务状态。 URL:https://域名/service/AICC__Case/1.0.0/openapi/task/process 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "taskId": "ccqG0000014iXvGKONQO", "processInfo": { "type": "Iternal", "title": "test0707", "description": "test0707" }, "creatorId":"10gg00000148QvgpaLAm" } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: {"resCode": "0","resMsg": "成功"}
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 taskId string 20 True 任务 id 2 creatorId string 20 True 操作处理人 3 processInfo ProcessInfo - True 处理信息,该对象的参数说明请参见表3 表3 ProcessInfo参数说明 序号 名称 参数类型 长度(字节) 是否必选 说明 1 type string - True 处理类型 取值: Iternal 2 title string 128 True 标题。 3 description string 20000 True 处理描述。 4 attachment string 255 False 附件大小不能超过5M,数量不超过5个,支持jpg 、png 、pdf 、jpeg 、gif、doc、docx格式
  • 请求说明 表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 silence_id string True 静默规则标识
  • 报文样例 场景描述:根据ID删除静默规则 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "silence_id": "922988537635147776" } 响应参数: { "resultCode": "0405000", "resultDesc": "操作成功" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码,0405000表示成功,其他表示失败 1.2 resultDesc string False 返回描述 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表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 category_id string True 敏感词分类的唯一标识 1.2 sensitiveWordIds string True 敏感词的唯一标识,多个用逗号隔开
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 callid string True 呼叫标识。 2 caller string False 主叫号码。 3 devicetype int True 转出的设备类型。 1:技能队列 2:座席 4:系统接入码 4 mode int True 转出的模式,详细释义见表4。 当devicetype值为1时取值: 0:释放转 2:成功转 当devicetype值为2时取值: 0:释放转。 2:成功转。 当devicetype值为4时取值: 0:释放转。 2:成功转。 5 address string True 转移地址,即转移设备类型对应的设备ID。最大长度24。 当devicetype为1时,此处为技能队列编号;当devicetype为2时,此处为座席平台工号;当devicetype为4时,此处为系统接入码。 6 calldata string False 携带数据给转接的座席,最大不能超过2048个字节。 7 skillId Integer 可选 技能ID。当devicetype为业务代表为2时,设置该字段才有效。
共100000条