华为云用户手册

  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/{campaignId}/pause 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 campaignId int True 外呼任务的ID。
  • 错误结果码 表4 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 0200007 外呼活动已经不存在。 4 0200011 当前状态不允许暂停。 5 02000001 参数值为空 6 02000002 参数包含非法字符 7 02000003 参数长度不能大于规定长度 8 02000004 参数长度不能小于规定长度 9 02000005 参数长度需要介于规定长度之间 10 02000006 参数值类型不正确 11 02000007 参数值大小不正确 12 02000008 参数转换异常,请检查请求参数 13 02000009 参数组合不正确,请检查请求参数 14 02000010 hour和minute必须同时存在 15 02000011 参数个数不能大于规定个数
  • 错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 02000001 参数值为空 4 02000002 参数包含非法字符 5 02000003 参数长度不能大于规定长度 6 02000004 参数长度不能小于规定长度 7 02000005 参数长度需要介于规定长度之间 8 02000006 参数值类型不正确 9 02000007 参数值大小不正确 10 02000008 参数转换异常,请检查请求参数 11 02000009 参数组合不正确,请检查请求参数 12 02000010 hour和minute必须同时存在 13 02000011 参数个数不能大于规定个数
  • 报文样例 该接口的请求消息体举例如下: { "name": "呼叫失败", "code": "123456", "description": "呼叫失败", "children": [ { "name": "客户直接挂断", "code": "100001", "description": "客户直接挂断" }, { "name": "客户关机", "code": "100002", "description": "客户关机" } ] } 该接口的响应消息体举例如下: { "resultCode": "0200000", "resultDesc": "addBusinessResult success", "returnCode": "0200000", "returnDesc": "addBusinessResult success" }
  • 请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 name String True 业务结果名称。 取值范围:最大长度50,不包含特殊字符。 2 code String False 业务结果编码。 取值范围:最大长度50,有效字符为:数字、字母、-。 3 description Sring False 业务结果描述。 取值范围:最大长度200,不包含特殊字符。 4 children List False 子业务结果。 该对象的参数说明请参见表4。 表4 children参数说明 序号 参数名 参数类型 是否必选 说明 4.1 name String True 子业务结果名称。 取值范围:最大长度50,不包含特殊字符。 4.2 code String False 子业务结果编码。 取值范围:最大长度50,有效字符为:数字、字母、-。 4.3 description String False 子业务结果描述。 取值范围:最大长度200,不包含特殊字符。
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/addBusinessResult 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。
  • 报文样例 场景描述:更新敏感词分类的接口。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "name": "违禁语1", "category_id": "894378241379274752" } 响应参数: { "resultCode": "0401000", "id": "1071490109427159040", "resultDesc": "操作成功" }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 id string False 敏感词分类的唯一标识 1.2 resultCode string False 返回码 0401000 表示成功 其他表示失败 1.3 resultDesc string False 返回描述 1.4 statusCode number 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 True 操作员标识 可在登录后,进入员工管理页面,查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 name string True 修改后的敏感词分类名称 1.2 category_id string True 需要修改的敏感词分类的唯一标识
  • 报文样例 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "queryParam": { "ccId":1 } } 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "vdn": 1, "vdnName": "social cc" }, { "vdn": 2, "vdnName": "信用卡" }, { "vdn": 3, "vdnName": "95558_2" }, { "vdn": 4, "vdnName": "VDN4" }, { "vdn": 5, "vdnName": "测试VDN" } ], "resultDesc": [ { "vdn": 1, "vdnName": "social cc" }, { "vdn": 2, "vdnName": "信用卡" }, { "vdn": 3, "vdnName": "95558_2" }, { "vdn": 4, "vdnName": "VDN4" }, { "vdn": 5, "vdnName": "测试VDN" } ] }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 ccId int True 呼叫中心编号。 取值范围:1~65535
  • 响应说明 表3 响应体参数 序号 名称 参数类型 说明 1 result String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 2 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 3 resultDatas array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 4 resultDesc array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 表4 resultDesc/resultDatas对象参数说明 序号 名称 参数类型 说明 2.1 vdn int 虚拟呼叫中心编号。 2.2 vdnName string 虚拟呼叫中心名称。
  • 报文样例 请求消息样例 { "tenantId": "tenant001", "accessIdList": ["10001","..." ], "accessCodeList": ["10086","..." ], "authToken": "0***************************" } 响应消息样例 删除成功: 无响应体报文。 删除失败场景: { "errorCode" : 100000, // int, 错误码,成功时通过状态码为200判断 "errorMsg" : "" }
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 tenantId String body True 租户ID accessIdList String[] body True 对话绑定关系ID的列表(字符串数组结构) accessCodeList String[] body False 对话绑定关系Code的列表 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "ccId":1, "vdn":4, "skillIds":[11,12], "indexIds":["IDX_DURATION_SKILL_AVG_ABANDON_ACK","IDX_COUNT_SKILL_REQUEST"], "beginMonthTime":"202007", "endMonthTime":"202008", "mediaType":53, "subMediaType":3 } 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "35", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "11" }, { "idxs": [ { "val": "10", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "35", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "12" } ], "resultDesc": [ { "idxs": [ { "val": "3", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "35", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "11" }, { "idxs": [ { "val": "10", "id": "IDX_COUNT_SKILL_REQUEST" }, { "val": "35", "id": "IDX_DURATION_SKILL_AVG_ABANDON_ACK" } ], "id": "12" } ] }
  • 响应说明 该接口的响应说明体举例如下: 下载失败时: 消息头Content-Type: application/json;charset=UTF-8 消息体示例请参见报文样例 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下: 0:成功 非0:失败 3 result object 预留字段 下载成功时: 消息头 Content-Type: application/octet-stream;charset=utf-8 消息体 文件流
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "retcode": "000-003", "message": "no right to invite resource", "result": "" }
  • 接口URI https://ip:port/agentgateway/resource/recordfile/{agentid}?recordId= xxx&filetype=1 例:https://ip:port/agentgateway/resource/recordfile/102?recordId=y:/1/0/20181217/120/1524488.V3 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 agentid string True 签入的座席id。 2 recordId string True 录音文件的路径和名称。 录音文件的路径和名称是在触发了AgentMediaEvent_Record时生成的,在fileName中返回。 录音文件路径格式详见下方说明。 3 filetype string False 录音文件类型: 1:座席通话录音 2:IVR留言录音或者第三方留言录音文件 说明: 座席通话录音文件路径格式为:盘符:/vdn编号/目录号/****。例:y:/1/0/20181217/120/1524488.V3 IVR录音留言录音文件路径格式为:盘符:/vdn编号/record/****。例:y:/1/record/20190412/playvoice1551276018824.wav 第三方留言录音文件路径格式为:盘符:/3rdfile/vdn编号/record/***。例:y:/3rdfile/1/record/20190408/515/1633022.V3 默认为座席通话录音 4 locationId number False 节点Id(CTI POOL模式下为必选),在触发了AgentMediaEvent_Record时生成。
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultCode string False 返回码 0408000 表示成功 其他表示失败 1.2 resultDesc string False 返回描述 1.3 objId string False 定时抽检计划ID,最大长度20位。 同regularQualityTaskId、qiqId 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:更新定时抽检计划 请求头: Content-Type:application/json x-app-key:xxxx-xxxx-xxxx-xxxx-xxxx x-UserId:xxxx Authorization:Bearer ******************************** 请求参数: { "extractionRange": { "customColumns": null, "fixedColumns": { "durationEnd": "100", "durationStart": 1, "interactionType": 0, "maxNum": "10", "qualityCondition": 2, "qualityNum": "100", "qualityType": 1, "staffIds": [], "scoreStart": "0", "scoreEnd": "100" }, "currentRole": "qualityDirector" }, "appointQuality": { "setCounts": [ { "personID": "1679888547924121791", "count": 0 } ], "setCountsType": 0 }, "cronStructure": { "qiqtCycleType": "1", "qiqtStartTime": 1692171720, "qiqtEndType": "2", "qiqtTotalTimes": 1, "qiqtEndTime": 1692258120 }, "qiqtName": "changetest082103", "currentRole": "qualityDirector", "qiqtId": "16925871657096773608" } 响应头: Content-Type: application/json;charset=UTF-8 响应参数: { "resultCode": "0408000", "objId": "16625163654676154791", "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 True 操作员标识 可在登录后,进入员工管理页面,查看接口返回的userId 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 appointQuality object True 指派质检员 1.1.1 setCounts array[object] True 设置质检员 1.1.1.1 count number False 数量。 setCountsType!=2时,count必填。 setCountsType==2时,setCounts中所有count总和为100。 1.1.1.2 personID string True 质检员ID 1.1.2 setCountsType integer True 设置数量的类别:0-平均分配,2-百分比 1.2 cronStructure object True 设置周期 1.2.1 qiqtCycleType string True 重复方式: 1,每天,2.每周,3.每月 1.2.2 qiqtEndTime integer False 结束时间:当qiqtEndType 为2 时有效,秒级,最大长度10位 1.2.3 qiqtEndType string True 结束条件: 1.次数 2.时间 1.2.4 qiqtStartTime integer True 开始时间,秒级,最大长度10位 1.2.5 qiqtTotalTimes string False 总计次数,最大长度8位。 qiqtEndType==1时,qiqtTotalTimes必填。 1.3 currentRole string False 用户角色 1.4 extractionRange object True 设定抽检范围 1.4.1 currentRole string False 用户角色 1.4.2 fixedColumns object True 抽检范围条件设定 1.4.2.1 qualityNum string True 抽检数量,最大数量10000 1.4.2.2 qualityType integer True 抽检类型:1.通话范围 2.座席抽检数量类型 3.座席抽检百分比类型 1.4.2.3 durationStart integer False 通话最短时间,毫秒级,最大长度11位 1.4.2.4 qualityCondition integer True 抽检状态:0.不限制 1.未抽检 2.已抽检 1.4.2.5 durationEnd string False 通话最长时间,毫秒级,最大长度11位 1.4.2.6 maxNum string False 最大抽检量,最大数量10000 qualityType!=2时,maxNum参数必填且参数值大于等于1。 1.4.2.7 scoreEnd string False 最高分数,最大分数10000 1.4.2.8 scoreStart string False 最低分数,最大分数10000 1.4.2.9 staffIds array[string] False 座席人员 1.4.2.10 interactionType integer True 交互类型 0:录音 2:文本 1.4.3 userId string False 用户ID 1.5 qiqtName string True 抽检任务名称,最大长度64位 1.6 userId string False 用户ID 1.7 qiqtId string True 定时抽检计划ID,最大长度20位。 同regularQualityTaskId、qiqId
  • 咨询失败 标示符 AgentEvent_Consult_Fail 作用 座席内部求助咨询失败。 附带信息 content:文本型,呼叫所属于的CallId(呼叫标示)。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Consult_Fail","workNo":"49999","content":"1456404043-39"}} 父主题: 音视频通话事件
  • 消息样例 场景描述:查询任务详情 URL:https:// 域名 /service/AICC__Case/1.0.0/openapi/task/{id} 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "id":"ccqG00000138H6u8bTwe" } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: { "resCode": "0", "resMsg": "成功", "result": { "caseInfos": [ { "attachment": "", "caseNo": "000000000000000000000000000006", "closedDate": null, "contactId": "ciIy0000013y7cC8T2rA", "contactPhone": null, "createdDate": "2023-07-07 14:43:15", "creatorId": "10gg00000148QvgpaLAm", "description": "0704test", "dueDate": "2023-07-22 00:00:00", "extternalNo": null, "id": "c6m80000014iXKHqDw3c", "isUpgraded": false, "origin": "Voice", "ownerId": "10gg00000148QvgpaLAm", "parentId": null, "priority": "Low", "reason": null, "state": "Processing", "status": "tttttt", "stayDate": null, "suspendAccumulatedTime": null, "suspendDate": null, "title": "0704test", "type": "cvmC0000014ddysLTCZk" } ], "customerInfo": { "customerInfo": { "address": { "addressLine1": null, "addressLine2": null, "addressLine3": null, "addressLine4": null, "addressLine5": null, "addtionalAddress": null, "area": null, "block": null, "buildingNo": null, "city": null, "country": null, "defaultBillingAddress": false, "defaultShippingAddress": false, "firstName": null, "id": "cw8O0000013y7cCDIE4G", "label": null, "lastName": null, "middleName": null, "phoneNumber1": null, "phoneNumber2": null, "province": null, "roomNo": null, "street": null, "subjectId": "ciIy0000013y7cC8T2rA", "title": null, "town": null, "zip": null }, "age": null, "bindAccount": [], "birthDay": null, "cellPhone1": "15005167393", "cellPhone2": null, "cellPhone3": null, "channel": null, "createdDate": "2023-06-09 15:33:35", "customFied": null, "customerName": "客户1", "description": null, "email": "customer@huawei.com", "email1": null, "email2": null, "fax": null, "firstName": null, "gender": null, "id": "ciIy0000013y7cC8T2rA", "lastModifiedDate": "2023-06-09 15:33:35", "lastName": null, "level": null, "middleName": null, "name": null, "nickName": null, "organization": { "description": null, "email": null, "fax": null, "fixedPhone": null, "id": "cBbs0000013y7cBnkKMS", "industry": null, "logo": null, "organizationName": "公司", "scale": null, "summary": null, "website": null }, "organizationId": "cBbs0000013y7cBnkKMS", "phone": null, "phone1": null, "phone2": null, "phone3": null, "picture": null, "remark": null, "status": null, "title": null, "website": null } }, "taskInfo": { "attachment": "", "closedDate": null, "contactId": "ciIy0000013y7cC8T2rA", "createdDate": "2023-07-07 14:51:35", "creatorId": "10gg00000148QvgpaLAm", "creatorName": "10gg00000148QvgpaLAm", "description": "test001", "dueDate": "2023-07-08 00:00:00", "id": "ccqG0000014iXvGKONQO", "ownerId": "10gg00000148QvgpaLAm", "ownerName": "liuhuqiong001", "priority": "Low", "relateId": "c6m80000014iXKHqDw3c", "status": "Pending", "stayDate": null, "taskNo": "000000000000000000000000001002", "title": "test002", "type": "Case" }, "taskTrace": [ { "creatorId": "10gg00000148QvgpaLAm", "creatorName": "10gg00000148QvgpaLAm", "description": null, "relatedId": null, "title": null, "type": "CreateTask" } ] } }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 taskInfo TaskInfo True 任务信息,该对象的参数说明请参见表4 2 taskTrace CaseTrace[] False 任务轨迹,该对象的参数说明请参见表5 3 customerInfo Object False 联系人信息,该对象的参数说明请参见表6 4 caseInfos Case False 关联工单信息,该对象的参数说明请参见表6 表4 TaskInfo参数说明 序号 名称 参数类型 是否必选 说明 1 title string True 任务标题 2 description string False 任务描述 3 type string False 任务关联类型 4 relateId string False 如果关联任务类型有值,这里也必须有值 5 ownerId string True 处理人id 6 contactId string False 联系人id 7 priority string False 优先级 8 dueDate Datetime False 期望完成时间,时间格式为YYYY-MM-DD HH:mm:ss 9 creatorId string True 创建人 10 creatorName string True 创建人姓名 11 createdDate Datetime True 创建时间,时间格式为YYYY-MM-DD HH:mm:ss 12 closedDate Datetime False 关闭时间,时间格式为YYYY-MM-DD HH:mm:ss 13 stayDate Datetime False 停留时间,时间格式为YYYY-MM-DD HH:mm:ss 14 taskNo string False 任务编码 15 ownerName string False 处理人名 16 id string False 任务id 17 status string False 任务状态 18 attachment string False 任务附件 表5 CaseTrace参数说明 序号 名称 参数类型 是否必选 说明 1 creatorId string True 工单处理者id 2 creatorName string True 工单处理者名称 3 type string True 处理类型: CreateTask、StatusUpdate 4 relatedId string False 关联记录id 5 title string False 标题 6 description string False 处理描述 表6 Case参数说明 序号 名称 参数类型 是否必选 说明 1 id string True 工单id 2 caseNo string True 工单编号 3 status string True 工单当前流程节点 dataType : SingleSelect 枚举值: 0.Completed(默认值) 其他值业务自定义 4 title string False 工单标题 5 priority string False 优先级 dataType : SingleSelect 枚举值: Critical High Medium Low 6 parentId string False 父工单id 7 ownerId string True 处理人id 8 origin string True 优先级 dataType : SingleSelect 枚举值: Voice Whatsapp webchat Email 9 isUpgraded Boolean True 工单是否升级 10 extternalNo string True 外部工单编号 11 dueDate Datetime False 期望完成时间,时间格式为YYYY-MM-DD HH:mm:ss 12 description string True 工单描述 13 creatorId string True 工单处理者id 14 createdDate Datetime True 创建时间,时间格式为YYYY-MM-DD HH:mm:ss 15 contactId string False 联系人id 16 reason string True 工单原因分类 17 contactPhone string False 联系人电话 18 state string True 任务状态 dataType : SingleSelect 枚举值: Completed Pending Processing 19 stayDate string True 工单当前状态停留时间,时间格式为YYYY-MM-DD HH:mm:ss 20 suspendAccumulatedTime int True 工单停留时长,单位分钟,范围1~1439999 21 suspendDate string True 工单暂停时间,时间格式为YYYY-MM-DD HH:mm:ss 22 type string True 工单类型id,关联CaseType表 23 closedDate Datetime False 关闭时间 24 attachment string False 工单附件
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 resultDesc string False 返回的描述信息 1.2 resultCode string False 返回码 0表示成功,其他表示失败 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 场景描述:更新对话规则。 请求头: x-app-key:************************************ X-UserID:1611917095665261978 Authorization:Bearer ******************************** 请求参数: { "severity": "normal", "rule_id": "923084039932350464", "score": 1, "other": {}, "min": 1, "method": "positive", "rule_name": "tesat3", "flows": [], "resultCode": "0405000", "description": "4", "completeness": { "hasConversationFlow": false, "sentenceComplete": false, "ruleComplete": false, "hasDescription": true }, "resultDesc": "操作成功", "score_type": "valid" } 响应参数: { "resultCode": "0405000", "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 severity string True 规则级别一般规则和重要规则:"normal" "critical" 1.2 rule_id string True 规则标识 1.3 score number True 规则分数 1.4 other object True 附加条件 1.4.1 call_end number False 呼叫开始时间:填写时间戳,单位秒 1.4.2 call_from number False 呼叫结束时间:填写时间戳,单位秒 1.5 min number True 对话逻辑至少要出现几个 1.6 method string True "positive" "negative" 规则是正面表列 or 负面表列 1.7 rule_name string False 规则名称 1.8 resultCode string False 返回码,0405000表示成功,其他表示失败 1.9 description string False 规则描述 1.10 resultDesc string False 返回的描述信息 1.11 score_type string True 规则分数类型 valid invalid
  • 报文样例 该接口的请求消息体举例如下: {"resultCode":"007", "displayResult":"就是不接电话7", "obsCodes":["00602","00606"]} 该接口的响应消息体举例如下: { "defId": "1645244637", "returnCode": "0200000", "resultCode": "0200000", "resultDesc": "createObResult Success!", "returnDesc": "createObResult Success!" }
  • 响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功,其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 defId String 创建的外显结果ID。 4 returnCode String 原因码。0200000表示成功,其他表示失败。 具体见表5。 5 returnDesc String 描述。
  • 错误结果码 表5 错误原因码说明 序号 错误码 说明 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 参数个数不能大于规定个数
共100000条