华为云用户手册

  • 请求说明 表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!" }
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/createObResult 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。
  • 错误结果码 表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 参数个数不能大于规定个数
  • 响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功,其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 defId String 创建的外显结果ID。 4 returnCode String 原因码。0200000表示成功,其他表示失败。 具体见表5。 5 returnDesc String 描述。
  • 报文样例 请求头 POST /CCFS/resource/ccfs/downloadRecordFile HTTP/1.1 Authorization: auth-v2/ak/2018-07-02T02:45:50Z/content-length;content-type;host/ eb453f68e858******************196c509c4913 Accept: */* Content-Type: application/json;charset=UTF-8 Content-Length: 193 请求参数 { "request": { "version": "2.0" }, "msgBody": { "fileName": "Y:/39/record/20201015/10233946082696733.wav" } }
  • 接口URI https://ip:port/CCFS/resource/ccfs/downloadIVRRecordFile?locationId={locationId} 其中,ip为CC-FS安装的服务器IP地址,port为CC-FS的HTTPS端口号。 如果经过NSLB路由,ip为NSLB的服务器IP地址,port为CC-FS服务在NSLB映射的HTTPS端口号。 表1 URL中携带的参数说明 序号 名称 参数类型 是否必选 说明 1 locationId int False 节点Id,通过调用会话记录查询接口(https://IP:PORT/oifde/rest/api/queryRecordHistory)查询locationId。
  • 响应说明 当调用本接口响应成功,则从httpresponse消息中获取文件的二进制数据生成录音文件,文件后缀名为.wav,响应中content-type字段为Application/Octet-stream;charset=UTF-8。 当调用本接口响应失败,则返回相应的错误码信息,错误码响应数据结构请查看下表,resultData为保留字段,默认为空字符串。 表5 响应消息参数说明 序号 名称 参数类型 说明 1 resultCode String 请求返回的结果码,详见错误码参考。 2 resultDesc String 请求结果描述。 3 resultData Object 请求响应数据
  • 保持成功 标示符 AgentEvent_Hold 作用 表示当前座席已处于保持状态。 附带信息 content:文本型,呼叫所属于的CallId(呼叫标示)。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_Hold","workNo":"49999","content":"1456402370-7"}} 父主题: 音视频通话事件
  • 请求说明 消息头 表2 请求头参数说明 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息主体编码方式,缺省值:application/json; charset=UTF-8 2 Guid string True 静态鉴权(AUTHMODE = 1)签入接口返回的Guid;动态鉴权(AUTHMODE = 2)轮询事件接口返回的Guid。 消息体 表3 消息体参数说明 序号 名称 参数类型 是否必选 说明 1 addresses array True 批量邀请的与会者信息。 数组最大长度为120。 该对象的参数说明请参考表4。 2 beepTone boolean False 有用户加入会议时是否对该用户播放欢迎语。 默认值为false。 3 playMode int False 放音模式。 2:播放指定文件音。 默认值为2。 4 voicePath String False 文件绝对路径名。文件格式为: 盘符/conf/vdn编号/放音文件名,例如: y:/conf/120/1136287.V3 当“BeepTone”设置为“true”时,此参数必须设置并且playMode需要为2;当“BeepTone”设置为“false”时,此参数设置无效。 最大长度为127个字符。 5 caller String False 主叫号码。在VDN有号码限制的情况,需要号码在限制范围内。 最大长度为24个字符。 表4 与会者对象参数说明 序号 名称 参数类型 是否必选 说明 1.1 addressType String True 地址类型。 6:电话号码 9:座席工号 1.2 address String True 地址标识。 最大长度为24个字符。 1.3 deviceCallType int False 自定义的设备呼叫类型,详细见表3。 不填或者填null,使用默认值,默认值为0。 取值范围为0-255。 1.4 deviceType int False 自定义的设备类型,详细见表2。 不填或者填null,使用默认值,默认值为0。 取值范围为0-255。
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 { "addresses": [ { "address": "2002", "addressType": "9", "deviceCallType": 1, "deviceType": 66 } ], "beepTone": false, "playMode": 2, "voicePath": "y:/conf/120/1136287.V3", "caller": "1111" } 响应参数 { "result": {}, "message": "success", "retcode": "0" }
  • 接口URI https://ip:port/agentgateway/resource/agentconf/{agentid}/batchaddparticipant 其中,ip为agentgateway服务器地址,port为agentgateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "ccId":1, "vdnIds":[170,185], "indexIds":["IDX_COUNT_REAL_VDN_CONNECT","IDX_COUNT_REAL_VDN_CALL"] } 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": 0, "id": "IDX_COUNT_REAL_VDN_CONNECT" }, { "val": 0, "id": "IDX_COUNT_REAL_VDN_CALL" } ], "id": "170" }, { "idxs": [ { "val": 0, "id": "IDX_COUNT_REAL_VDN_CONNECT" }, { "val": 0, "id": "IDX_COUNT_REAL_VDN_CALL" } ], "id": "185" } ], "resultDesc": [ { "idxs": [ { "val": 0, "id": "IDX_COUNT_REAL_VDN_CONNECT" }, { "val": 0, "id": "IDX_COUNT_REAL_VDN_CALL" } ], "id": "170" }, { "idxs": [ { "val": 0, "id": "IDX_COUNT_REAL_VDN_CONNECT" }, { "val": 0, "id": "IDX_COUNT_REAL_VDN_CALL" } ], "id": "185" } ] }
  • 报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "message": "", "retcode": "0", "result": { "callfeature": 0, "callid": "1476070409-38", "caller": "70001", "called": "10086", "callskill": "voice_jst", "callskillid": 3, "orgicallednum": "12345678", "calldata": "", "begintime": 1476070413000, "endtime": null, "userPriority": 0, "trunkNo": 65535, "logontimes": 0, "mediaType": 5, "mediaAbility": 1, "waitTime": 0, "trace": null } }
  • 响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下: 0:成功 非0:失败 3 result list 查询成功后,返回呼叫信息对象。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 callfeature int 呼叫类型,请参考表1 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 "x-app-key": ***** "Authorization": Bearer **** } 请求参数: { "voiceContent": "1133*********999~$李先生$~2225*********149", "callerPresent": null, "called": "88880000" } 响应参数: { "result": { "callSerialNo": "11827********7090" }, "retCode": "0", "retMsg": "Created successfully." }
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1 schema object True - 1.1 retCode string True 返回码,0 成功 1 有未完成的任务,请稍后重试 2 callData长度超出1024 3 创建失败,未生成呼叫流水号 4 softPhone格式与规则不匹配 5 caller或者called未传递,或者格式与规则不匹配 6 vdn未启用 7 callerPresent或者agentPresent校验失败 8 voiceContent为空或者超出限制或者不存在该录音数据 9 callBackUrl不符合条件 16 租户为试商用状态,被叫号码不在白名单中 36 priority字段值格式不符合要求 1.2 retMsg string False 返回描述 1.3 result object False retCode为0时,必返回 1.3.1 callSerialNo string True 呼叫流水号 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值
  • 响应说明 响应状态码: 200 表3 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 returnCode string True 返回码 0:成功 1:失败 1.2 description string True 描述 1.3 data object False 返回数据,失败时参数workNo返回空字符串 1.3.1 workNo integer False 座席工号 1.3.2 agentType integer False 座席类型 1.3.3 agentStatus string False 座席状态,默认可用为0 响应状态码: 400 错误的请求:请检查请求路径及参数 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 403 鉴权失败 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求头: x-app-Key:f**********************************e Authorization:Bearer a******************************2 请求参数: { "accountCode": "Agents" } 响应参数: { "returnCode": "0", "data": { "workNo": 7094, "agentType": 5, "agentStatus": "0" }, "description": "query success" } 场景描述:用户名密码登录 请求头: Content-Type:application/json 请求参数: { "accountCode": "Agents", "username": "itau_group", "password": "****************" } 响应参数: { "returnCode": "0", "data": { "workNo": 7094, "agentType": 5, "agentStatus": "0" }, "description": "query success" }
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1.1 accountCode string(64) True 登录账号,最长64个字符串 1.2 password string(64) False 鉴权用户密码,最长64个字符串 1.3 username string(64) False 鉴权用户名,最长64个字符串
  • 保持 标示符 AgentEvent_linkagePhoneHold 作用 表示某个呼叫被话机保持。 附带信息 callId:表示被保持的呼叫的唯一标记。 示例: {"message":"","retcode":"0","event":{"eventType":"AgentEvent_linkagePhoneHold","workNo":"120","content":{"callId":"1474269843-24"}}} 父主题: 话机联动事件
  • 接口URI https://ip:port/agentgateway/resource/voicecall/{agentid}/seconddialex?number={number} 其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。 表1 URI中携带的参数说明 序号 参数名 数据类型 选取原则 说明 1 agentid string True 座席的工号,取值范围:101~59999。 2 number string True 二次拨号号码,取值范围:1-24位数字或*或#
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token,参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度(字节) 是否必选 说明 1 taskInfo TaskInfo - True 任务详情信息,该对象的参数说明请参见表3 表3 TaskInfo任务详情参数说明 序号 名称 参数类型 长度(字节) 是否必选 说明 1 title string 128 True 任务标题 2 description string 20000 False 任务描述 3 type string - False 任务关联类型 取值: Case 4 relateId string 20 False 如果关联任务类型有值,这里也必须有值 5 ownerId string 20 True 处理人id 6 contactId string 20 False 联系人id 7 creatorId string 20 True 创建人id 8 priority string 128 False 优先级 取值: Critical High Medium Low 9 dueDate DateTime - False 期望完成时间,格式为YYYY-MM-DD HH:mm:ss 10 attachment string 255 False 任务附件
  • 消息样例 场景描述:创建任务 URL:https://域名/service/AICC__Case/1.0.0/openapi/task 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体: { "taskInfo":{ "title": "test002", "description": "test001", "type": "Case", "ownerId": "10gg00000148QvgpaLAm", "relateId": "c6m80000014iXKHqDw3c", "dueDate": "2023-07-08 00:00:00", "contactId": "ciIy0000013y7cC8T2rA", "priority": "Low", "creatorId": "10gg00000148QvgpaLAm" } } 响应头: { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数: { "resCode": "0", "resMsg": "成功", "result": {"taskId":"ccqG0000014iXvGKONQO"} }
共100000条