华为云用户手册

  • 响应说明 表2 响应体参数 参数名称 数据类型 参数位置 必选/可选 描述 errorCode Int body True 错误码 返回0:成功 其他值:失败 errorMsg String body False 错误信息 jobDetail RpaDetailJobResult[] body False 队列详情 表3 RpaDetailJobResult参数说明 参数名称 数据类型 参数位置 必选/可选 描述 uid string body True 任务UUID jobName string body True 任务的名称 startTime string body False 作业开始时间, 格式:yyyy-mm-dd HH:mm:ss createTime string body True 作业创建时间, 格式:yyyy-mm-dd HH:mm:ss workstationName string body False 执行器名称 clusterName string body False 集群名称 runMode string body True 运行模式:在线online mode string body True 执行方式:once、repeat、queueTrigger jobType string body True 任务类型固定为procedure status string body True 任务状态条件搜索,如下: init:待执行 running:运行 suspend:暂停 success:完成 procedureName string body True 脚本包名称 procedureVersion string body True 脚本包版本 description string body True 任务描述 timeout int body False 任务超时时间 recentTaskStatus string body False 最近一次作业状态,没有生成作业的任务不会返回该字段 queueUid string body False 队列的UUID queueName string body False 队列名称
  • 报文样例 请求消息样例 { "tenantId": "202201072597", "authToken": "hjbLfhU*******************Fv3nq", "uid": "0c9358552188478a8d5ff9203db8791f" } 响应消息样例 { "errorCode": 0, "errorMsg": null, "jobDetail": { "jobName": "AICC_RPA", "queueUid": "00019cad3dd5c71d4696b209d7024fa04d3a", "workstationName": "AICC_RPA", "runMode": "online", "timeout": 120, "mode": "queueTrigger", "uid": "0c9358552188478a8d5ff9203db8791f", "procedureVersion": "1.0.5", "queueName": "创建工单", "createTime": "2022-04-24 17:12:02", "procedureName": "AICC_RPA", "startTime": "2022-04-29 11:47:25", "jobType": "procedure", "recentTaskStatus": "failed", "status": "running" } }
  • 响应消息 表3 响应消息体参数说明 参数名 数据类型 说明 result String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode String 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 resultDatas array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 返回值为空时,表示当前座席未签入。 resultDesc array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表4。 说明: 返回值为空时,表示当前座席未签入。 表4 resultDesc/resultDatas对象参数说明 参数名 数据类型 说明 id String 座席工号。 idxs array 指标结果集。 该对象的参数说明请参见表5。 表5 idx对象参数说明 参数名 数据类型 说明 id String 指标ID。 val Object 指标结果,该时间为零时区时间。
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "ccId":1, "vdn":22, "agentIds":[295], "timeGrain":"15MIN", "indexIds":["IDX_COUNT_AGENT_COLLATION","IDX_COUNT_AGENT_SET_BUSY","IDX_DURATION_AGENT_CALL_IN"], "mediaType":53, "subMediaType":3 } 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "11" }, { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "12" } ], "resultDesc": [ { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "11" }, { "idxs": [ { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_DURATION_AGENT_AVG_COLLATION" }, { "val": { "2020-08-24 10:30:00.0": "15", "2020-08-24 10:45:00.0": "19" }, "id": "IDX_COUNT_AGENT_SET_BUSY" } ], "id": "12" } ] }
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "ofcNo": [0,1], "ccId": 1 } 响应参数: { "resultCode": "0100000", "resultDesc": { "10.xx.xx.xx#0": [ { "RET": "2021-02-04 10:05:00 +00:00", "RNAT12": "0", "busy circuits (TIMES)": "0", "ASD32": "0.000000", "ITAR19": "0.000000", "CLBT40": "-1", "MEID": "5", "UBC43": "-1", "CCT34": "-1", "LCOICT7": "0", "IOCS44": "0", "MOIID": "0", "CCT3": "0", "CDA9": "-1", "AART11": "0", "TAT6": "0", "Period": "5", "TCAT5": "0", "AR21": "0.000000", "TCAT2": "0", "TCAT1": "0", "ICN13": "0", "ECT35": "0", "incoming direction": "0(anonymous)", "IBCN16": "0", "ACN14": "0", "TCT42": "-1", "IAT36": "0", "Credible": "Credible", "CFORT39": "-1", "RT": "2021-02-04 10:00:00 +00:00", "ST26": "0.000000", "Time": "1000", "average answer duration (SECOND)": "0", "AT30": "0.000000", "TUT37": "-1", "BCN15": "0", "BBCR23": "0.000000", "CTBT41": "-1", "BTST24": "0.000000", "BTSTA25": "-1", "ABCN17": "0", "CTA29": "-1", "AT4": "0", "EROC46": "0.000000", "TET38": "-1", "CT28": "0.000000", "SOIC45": "0", "ST0": "0", "BCR22": "0.000000", "ABRT33": "0", "CR20": "0.000000", "BBCN18": "0", "CD8": "0", "ATA31": "-1", "CBT10": "0", "STA27": "-1", "average connection duration (MILLISECOND)": "0", "answer duration aux (TIMES)": "-1" } ] } }
  • 响应消息 表3 响应消息体参数说明 参数名 数据类型 说明 resultCode String 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 resultDesc List 查询成功后,返回结果信息的对象列表。 该数组中对象的参数说明请参见下表。 10.xx.xx.xx#0 String 10.xx.xx.xx:UAP IP “#”:固定分隔符 “0”:UAP编号 表4 resultDesc对象参数说明 参数名 数据类型 说明 RET String 采集该数据结束时间 RNAT12 String 久叫不应次数 busy circuits (TIMES) String 忙电路数 ASD32 String 平均占用时长(秒) ITAR19 String 入中继可用率 CLBT40 String 被叫忙(市话或称本地通话) MEID String 设备ID UBC43 String 电路闭塞个数 CCT34 String 对端拥塞造成呼叫失败数 LCOICT7 String 本局内部拥塞呼损 IOCS44 String 入局CAPS统计值 MOIID String 测量对象类ID CCT3 String 接通次数 CDA9 String 拥塞时长辅助量 AART11 String 振铃早释次数,即主叫用户在呼叫接通或结束前挂机的次数。 TAT6 String 转接应答次数。 转接应答,指接听应答的用户非本局用户。 Period String 周期 TCAT5 String 落地应答次数 落地应答,指接听应答的用户为本局用户。 AR21 String 应答率 TCAT2 String 转接试占次数 TCAT1 String 落地试占次数 ICN13 String 安装电路数 ECT35 String 拨打空号的次数 incoming direction String 0(anonymous):0表示入局ID,anonymous表示名称 IBCN16 String 安装双向电路数 ACN14 String 可用电路数 TCT42 String 转接占用次数 IAT36 String 无效的地址的次数 Credible String 是否可信 CFORT39 String 被叫没有权限 RT String 采集改数据时间 ST26 String 占用话务量 Time String 次数 average answer duration (SECOND) String 平均接通响应时长 AT30 String 应答话务量 TUT37 String 终端不兼容的次数 BCN15 String 闭塞电路数 BBCR23 String 双向电路闭塞率 CTBT41 String 被叫长忙次数 BTST24 String 双向中继占用话务量 BTSTA25 String 双向中继占用话务量辅助量 ABCN17 String 可用双向电路数 CTA29 String 接通话务量辅助量 AT4 String 应答次数 EROC46 String 电路占用率 TET38 String 终端错误的次数 CT28 String 接通话务量 SOIC45 String 空闲电路数 ST0 String 占用次数 BCR22 String 闭塞率 ABRT33 String 呼叫早释次数 CR20 String 接通率 BBCN18 String 闭塞双向电路数 CD8 String 拥塞时长 ATA31 String 应答话务量辅助量 CBT10 String 被叫忙 STA27 String 占用话务量辅助量 average connection duration (MILLISECOND) String 平均连接时长 answer duration aux (TIMES) String 应答响应总时长辅助量
  • 请求说明 表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
  • 报文样例 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "ccId":1, "vdn":170 } 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "acId": 289, "mediatypeId": 5, "accessCode": "650114", "codeDescription": "语音接入" }, { "acId": 288, "mediatypeId": 5, "accessCode": "650115", "codeDescription": "语音接入" } ], "resultDesc": [ { "acId": 289, "mediatypeId": 5, "accessCode": "650114", "codeDescription": "语音接入" }, { "acId": 288, "mediatypeId": 5, "accessCode": "650115", "codeDescription": "语音接入" } ] }
  • 响应说明 表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 acId int 接入码编号。 2.2 mediatypeId int 媒体类型。该对象请参考表1 2.3 accessCode String 接入码值 2.4 codeDescription String 接入码描述
  • 报文样例 该接口的请求消息体举例如下: 可以根据业务需要选择不同的策略组合。 全局策略+普通策略policyType=0,type=0。 { "policyJson":"[{'type':0,'retryTimes':1,'retryDay':1}]", "policyType": 0 } 全局策略+结果策略policyType=0,type=1。 { "policyJson":"[{'type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':60}]}]", "policyType": 0 } 号码类型匹配策略+普通策略policyType=1,type=0。 { "policyJson" : "[{'dataType':'ST','type':0,''policy':{'retryTimes':2,'retryDay':1}}]", "policyType": 1 } 号码类型匹配策略+结果策略policyType=1,type=1。 { "policyJson":"[{'dataType':'ST','type':1,'policy':[{'result':4,'retryNumber':3,'callInterval':60}]}]", "policyType": 1 } 该接口的响应消息体举例如下: { "resultCode": "0200000", "resultDesc": "", "returnCode": "0200000", "returnDesc": "" }
  • 错误结果码 表7 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200-01 外呼活动不存在。 3 02000001 参数值为空 4 02000002 参数包含非法字符 5 02000003 参数长度不能大于规定长度 6 02000004 参数长度不能小于规定长度 7 02000005 参数长度需要介于规定长度之间 8 02000006 参数值类型不正确 9 02000007 参数值大小不正确 10 02000008 参数转换异常,请检查请求参数 11 02000009 参数组合不正确,请检查请求参数 12 02000010 hour和minute必须同时存在 13 02000011 参数个数不能大于规定个数
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/retryPolicy/{campaignId} 其中,ip为CC-iSales服务器地址,port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数,取值范围为1~9999。 2 campaignId int True 外呼活动ID
  • 响应消息 表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 callId string 呼叫ID 2.2 customerLevel int 呼叫客户级别 序号从1到254,编号越大,表明客户的地位越高,越重要。 2.3 requestType int 呼叫特征 该对象请参考表1
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数: { "ccId":1, "vdn":170, "flowId":1 } 响应参数: { "result": "0", "resultCode": "0100000", "resultDatas": [ { "callId": "1453724606-576", "customerLevel": 1, "requestType": 0 } ], "resultDesc": [ { "callId": "1453724606-576", "customerLevel": 1, "requestType": 0 } ] }
  • 请求URL https://ip:port/rest/cmsapp/v1/openapi/configures/agents/{ccId}/{vdn}/{offset}/{limit} 其中,公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。 非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。 {ccId}为呼叫中心ID,取值范围:1~65535,{vdn}为虚拟呼叫中心ID,取值范围:1~5000,{offset}为查询起始偏移量,非必填,{limit}表示每页的查询数量,最大100,非必填,{offset}和{limit}需同时传递才生效。
  • 响应消息 表2 响应消息体参数说明 参数名 数据类型 说明 result String 查询结果。取值如下: 0:成功 其他:失败 失败的原因说明请参见错误码参考。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultCode string 查询结果。取值如下: "0100000":成功 其他:失败 失败的原因说明请参见错误码参考。 count int 座席总数,请求中{offset}和{limit}生效才会返回。 resultDatas array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表3。 说明: 当前字段为兼容8.13及其之前版本接口响应参数使用。 resultDesc array 查询成功后,返回结果信息的对象数组。 该数组中对象的参数说明请参见表3。 表3 resultDesc/resultDatas对象参数说明 参数名 数据类型 说明 agentNo string 座席工号。 agentName string 座席名称。 roleId string 座席角色。 skillId string 技能ID集合,多个技能ID之间以";"进行分割。例如1;3;10;11;25;31;32;40
  • 样例报文 请求头: Content-Type: application/json;charset=UTF-8 Authorization: ****************** 请求参数 无。 响应参数: { "result": "0", "resultCode": "0100000", "count": 101, "resultDatas": [ { "agentNo": "10000", "agentName": "z1", "roleId": "1", "skillId": "" }, { "agentNo": "101", "agentName": "z2", "roleId": "1", "skillId": "2;3" } ], "resultDesc": [ { "agentNo": "10000", "agentName": "z1", "roleId": "1", "skillId": "" }, { "agentNo": "101", "agentName": "z2", "roleId": "1", "skillId": "2;3" } ] }
  • 请求说明 表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的值不同,Inparams的参数也不相同,根据下面细分的场景详细了解参数介绍。 inaction=8 inaction=9 inaction=11 inaction=7 inaction=13 extparams Object body False 用于向ODFS传递参数,可选的扩展参数,当前只有初始化场景使用。 Inaction的值不同,extparams的参数也不相同,根据下面细分的场景详细了解参数介绍。 inaction=8 inaction=9 inaction=11 inaction=7 inaction=13
  • 响应说明 参数名称 数据类型 参数位置 必选/可选 描述 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 outparams参数(outaction=9:对话交互类操作) 表4 表3 表2 表2
  • 报文样例 请求头: x-app-key:9******************************3 Authorization:Bearer e******************************e Content-Type:application/json 请求参数: { "startTime": "1562786332000", "endTime": "1563391072000", "taskType": "0", "offset": "0", "limit": "10" } 响应头: { "connection": "keep-alive", "content-type": "application/json;charset=UTF-8" } 响应参数: { "result": { "total": 11, "callInfo": [{ "releaseTime": 1621577022000, "called": "88889060", "callerPresent": "640003", "agentAlertingTime": 1621576992000, "agentPresent": "640060", "talkingTime": 1621576995000, "alertingTime": 1621576994000, "caller": "88889050", "agentTalkingTime": 1621576994000, "agentReleaseTime": 1621577022000, "agentTalkDuration": 27, "callSerialNo": "1037058396471308289", "startTime": 1621576992000, "endTime": 1621577022000, "talkDuration": 26, "state": 3, "reasonCode": 1 }] }, "retCode": "0", "retMsg": "Query call detail record successfully" }
  • 响应说明 响应状态码: 200 表4 响应体参数 序号 名称 参数类型 是否必选 说明 1.1 retCode string True 返回码。0表示成功,其他为失败。 1:未查询到数据 2:起止时间格式不符 4:limit或offset分页数据格式不符 12:主叫号码不可用 1.2 retMsg string True 失败原因的描述 1.3 result object False 返回结果 1.3.1 total number False 总记录数 1.3.2 callInfo array[object] False 记录列表 1.3.2.1 callSerialNo string False 呼叫流水号 1.3.2.2 caller string False 主叫号码 长度限制:string (32) 1.3.2.3 called string False 被叫号码 长度限制:string (32) 1.3.2.4 startTime string False 外呼开始时间,时间戳,如1572794607000 1.3.2.5 endTime string False 通话结束时间,时间戳,如1572794607000 1.3.2.6 state number False 呼叫状态: 0:待呼叫 1:正在呼叫 2:通话中 3:通话结束 长度限制:number(1) 1.3.2.7 reasonCode number False 通话结束原因码: 0~65535, 0: 被叫挂机,通话结束 1:主叫挂机,通话结束 2:外呼主叫失败 3:外呼被叫失败 4:外呼主叫无应答 5:外呼被叫无应答 6:启动呼叫失败 xxx:其他异常 长度限制:number(5) 针对ITA双呼还有一些reasonCode,请参见表5 1.3.2.8 callData string False 第三方自定义的呼叫数据信息 长度限制:string(1024) 1.3.2.9 callerPresent string False 外显号码,来电显示的号码 长度限制:string(32) 1.3.2.10 alertingTime string False 客户振铃时间,时间戳,如1572794607000 1.3.2.11 talkingTime string False 客户通话时间,时间戳,如1572794607000 1.3.2.12 releaseTime string False 客户释放时间,时间戳,如1572794607000 1.3.2.13 talkDuration string False 用户通话时长(秒) 1.3.2.14 agentAlertingTime string False 座席振铃时间,时间戳,如1572794607000 1.3.2.15 agentTalkingTime string False 座席通话时间,时间戳,如1572794607000 1.3.2.16 agentReleaseTime string False 座席释放时间,时间戳,如1572794607000 1.3.2.17 agentTalkDuration string False 座席通话时长(秒) 1.3.2.18 taskType string False 0:全部类型任务(除ITA双呼) 1:云客服双呼任务 2:查询匿名外呼任务 3:语音通知 4:ITA双呼 1.3.2.19 agentPresent string False 外显号码,客户经理来电显示的号码 长度限制:string(32) 表5 针对ITA双呼的reasonCode说明 retCode 原因值描述 0 不涉及 1 无法找到号码 2 无法路由到网络 3 无法路由到目的地 4 发送特殊消息 5 中继前缀出错 6 通道无法接入 7 已经建立频道 8 抢先占有 9 抢先占有保留 16 正常呼叫清除 17 用户忙 18 无应答 19 无用户应答 20 用户不可及 21 拒绝呼叫 22 号码已改变 23 重定向 25 交换路由错误 26 无用户准许 27 目标无序 28 非法号码格式 29 设备拒绝 30 状态查询 31 正常 34 路由不可达 38 网络状态不好 39 服务链接不上 40 链接进行中 41 暂时失败 42 设备拥塞 43 信息丢弃 44 通道无法接入 46 呼叫阻塞 47 无可用资源 49 品质无效 50 设备没预订 53 闭合群OCB呼出受限 55 闭合群ICB呼入受限 57 无权限发送 58 发送无效 62 等级不一致 63 服务无效 65 发送无法执行 66 通道无法执行 69 设备无效 70 发送有效 79 CV服务没设置 81 引用非法值 82 通道不存在 83 ID不存在 84 呼叫ID不存在 85 无呼叫等待 86 隐藏号码呼叫 87 CUG无成员 88 目标冲突 90 CUG不存在 91 无效网络 95 无效信息 96 非托管元素 97 类型不存在 98 信息没执行 99 信息单元不存在 100 无效的信息单元 101 呼叫状态不一致 102 定时器超时 103 参数不存在 110 消息中带有未识别的参数 111 协议错误 127 未指定的交互 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 X-APP-Key string False appKey字段,用户标识 2 Authorization string True 鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) 表2 请求体参数 序号 名称 参数类型 是否必选 说明 1 body body False 请求体参数 表3 body参数结构 序号 名称 参数类型 是否必选 说明 1 body object False 请求体 1.1 endTime string True 结束时间,开始时间到结束时间不超过7天,时间戳,如1572794607000 1.2 offset string False 分页查询偏移量,默认值0,即不需要偏移 ,非必选 1.3 limit string False 分页查询时单页最多的记录条数,默认值100,即每页显示100条,非必选 1.4 startTime string True 起始时间,时间戳,如1572794607000 1.5 caller string False 主叫号码,可选,不填写默认查询所有 长度限制:string (32) 1.6 taskType string False 0:全部类型任务(除ITA双呼) 1:云客服双呼任务 2:查询匿名外呼任务 3:语音通知 4:ITA双呼
  • 错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常,异常详情在resultDesc中描述。 2 0200007 外呼活动不存在。 3 02000001 参数值为空 4 02000002 参数包含非法字符 5 02000003 参数长度不能大于规定长度 6 02000004 参数长度不能小于规定长度 7 02000005 参数长度需要介于规定长度之间 8 02000006 参数值类型不正确 9 02000007 参数值大小不正确 10 02000008 参数转换异常,请检查请求参数 11 02000009 参数组合不正确,请检查请求参数 12 02000010 hour和minute必须同时存在 13 02000011 参数个数不能大于规定个数
  • 报文样例 该接口的请求消息体举例如下: {"callerNo":[ {"accessCode":"5245241"} ]} 该接口的响应消息体举例如下: { "resultCode": "0200000", "resultDesc": "delete callerNo success.num:1", "returnCode": "0200000", "returnDesc": "delete callerNo success.num:1" }
  • 接口URI https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callerNo/{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 callerNo List True 支持多主叫号码。最多100个号码。 该对象的参数说明请参见表4 表4 callerNo参数说明 序号 参数名 参数类型 是否必选 说明 1.1 accessCode String True 主叫号码。 呼通客户后,客户的电话终端上显示的号码。 最大长度为24个字符,有效字符为:0~9。
  • 请求说明 表1 请求体参数 参数名称 数据类型 参数位置 必选/可选 描述 type String body True 查询类型 day: 按天查询,特定日期的报表数据 month: 按月查询,以timestamp往后一天作为结束时间,三十日内的报表数据 tenantId String body True 租户ID timestamp long body True 查询日期的毫秒时间戳 authToken String body True 认证token。 请参见C3 智能助手平台接口鉴权方式。
  • 报文样例 请求样例 { "tenantId":"202104237142", "timestamp":1630684800000, "type":"month", "authToken":"0kQl*******************FhoyDy" } 响应样例 [ { "name": "947988117535592448", "count": 19 }, { "name": "943382168053223424", "count": 10 }, { "name": "943372803514568704", "count": 4 }, { "name": "940757366746386432", "count": 4 }, { "name": "943218432118099968", "count": 4 }, { "name": "947918435541585920", "count": 4 }, { "name": "942949731485618176", "count": 3 }, { "name": "950966390083293184", "count": 3 }, { "name": "943370855474270208", "count": 2 }, { "name": "942919556320464896", "count": 1 } ]
  • 响应说明 响应状态码: 200 表7 响应体参数 序号 参数名 参数类型 说明 1 retCode String 0,成功,其他为失败。 2 retMsg String 失败原因的描述。 响应状态码: 400 错误的请求:请检查请求路径及参数。 响应状态码: 401 未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。 响应状态码: 404 请求的内容未找到:请检查请求的路径。 响应状态码: 500 业务失败:请依次确认您请求中各参数的取值。
  • 报文样例 请求消息头 Content-Type:application/json; charset=UTF-8 userName:ODFS_SYS_OPENAPI token:******************** 请求体消息 { "body": { "state": { "code": 0, "success": true }, "body": { "aid": "FJKkMeepk8l", "lattices": [{ "begin": 4360, "end": 5970, "lid": 0, "onebest": "喂接通了吗?", "spk": 0 }] } } } 响应体消息 { "retCode": "0", "retMsg": "success" }
共100000条