华为云用户手册

接口URL 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。

响应说明 表3 消息体参数说明 序号 名称 参数类型 说明 1 message string 描述 2 retcode string 错误码。取值如下： 0：成功 非0：失败 3 result list 查询成功后，返回结果列表。 该对象的参数说明请参见表4。 表4 result对象参数说明 序号 名称 参数类型 说明 3.1 skillMediaType int 技能队列媒体类型。其中： 1：文字交谈 2：点击通话 4：回呼请求 5：普通音视频电话 15：预测呼出 16：预浏览呼出 17：消息呼叫 19：视频普通呼叫 51：多媒体Web Chat 53：Social Chat 3.2 skillId int 技能队列id 3.3 agent list 座席详细信息 该对象的参数说明请参见表5。 表5 agent对象参数说明 序号 名称 参数类型 说明 3.3.1 workno string 座席工号 3.3.2 name string 座席名称 3.3.3 status int 座席状态，参见表1 3.34 ctiStatus int 座席平台状态，请参考表2 3.3.5 groupid int 座席班组ID 3.3.6 groupname string 未使用该返回参数 3.3.7 skilllist list 未使用该返回参数 3.3.8 callids list 未使用该返回参数 3.3.9 mediatype string 签入媒体服务器是否成功，T表示成功，F表示失败，三位分别表示CTIServer、WebM、MailM。只有签入CTIServer成功，才能进行音视频呼叫业务处理；只有签入WebM成功，才能进行文字交谈业务处理；当前不支持签入MailM。 3.3.10 vdnid int 所属VDN ID 3.3.11 phonenumber string 座席电话号码 3.3.12 currentstatetime long 当前状态时长（秒） 3.3.13 logindate long 签入时间，时间戳（毫秒） 3.3.14 inMultimediaConf int 未使用该返回参数 3.3.15 currentStateReason int 当前状态原因码

报文样例 消息头 Content-Type:application/json; charset=UTF-8 Guid：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1 请求参数 无 响应参数 { "result": [ { "skillId": 1, "agent": [ { "workno": "2005", "name": "liukai011", "status": "4", "ctiStatus": "1", "groupid": 0, "groupname": null, "skilllist": [], "mediatype": "TFF", "vdnid": 214, "phonenumber": "88880026", "currentstatetime": 527, "logindate": 1616510142000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 }, { "workno": "2007", "name": "", "status": "4", "ctiStatus": "1", "groupid": 0, "groupname": null, "skilllist": [], "mediatype": "TTF", "vdnid": 214, "phonenumber": "88880027", "currentstatetime": 28, "logindate": 1616510634000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 } ], "skillMediaType": 5 }, { "skillId": 2, "agent": [ { "workno": "2007", "name": "", "status": "4", "ctiStatus": "1", "groupid": 0, "groupname": null, "skilllist": [], "mediatype": "TTF", "vdnid": 214, "phonenumber": "88880027", "currentstatetime": 28, "logindate": 1616510634000, "callids": [], "inMultimediaConf": 0, "currentStateReason": 0 } ], "skillMediaType": 53 } ], "message": "success", "retcode": "0" }

报文样例 请求样例 { "request": { "sentence":"查询3月账单", "targetIntentCount":1, "confidence2Top":0.2, "accessCode":"10086", "channel":"OIFDE", "tenantId":"NJ_001", "language":"zh_CN", "userId":"123456789" } } 响应成功样例：

请求说明 表1 请求体参数 名称 是否必选 参数类型 说明 request True requestBody 请求体 表2 requestBody 名称 是否必选 参数类型 长度 说明 userId True String 64 用户ID accesscode False String 32 接入码（用户通过拨打什么号码接入的） channel False String 32 渠道（目前固定填OIFDE） sentence True String 1024 客户输入的文本信息 tenantId True String 64 租户ID language True String 20 语言 中文：zh_CN 英文：en_US context False String 64 意图识别需要的上下文 targetIntentCount False int 4 需要chatbot返回多个意图时的意图数量,一般用于客户输入一句话可以匹配多个意图的情况 范围：1——5 confidence2Top False float 4 置信度间距 如果返回多个意图,要求后面的意图与第一个置信度最高的意图的置信度间距,这个值越小表示返回的意图越接近。 范围：0——1 timeZone False String 10 时区,8表示东8区。

响应参数 名称 是否必选 参数类型 长度 说明 errorMsg False String 512 错误信息 errorCode False String 20 错误码 intentsResponses False Intents[] - 意图数组,成功时必须返回。 nonce False String 128 token认证失败时返回,服务端随机生成的字符串,同时需要返回状态码401。 表3 Intents 名称 是否必选 参数类型 长度 说明 responses False String[] 4096 Chatbot返回的应答信息,字符串数组,可以有多个。 confidence True float 4 置信度 机器人回复的可靠度,取值范围０～１,最小值是０,最大值是１,例如基于你的一个问题1,有10个回答,其中6个回答是相同的Answer１,那么Answer１的置信度是0.6 commands True String[] 64 意图命令字 params False Map - 命令字参数信息,一般意图的槽位信息都通过这个返回。例如{"Number":"3"}。 一般意图操作具体详情参考添加意图章节。 scenarioName False String 64 意图名 scenarioType False int 4 场景类型,辅助场景=1, 业务场景=0, 无场景= -1 scenarioStatus False String 64 场景状态（暂不使用）

错误结果码 表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":"12345678901234","priority":1}, {"accessCode":"525245","priority":2} ]} 该接口的响应消息体举例如下： { "resultCode": "0200000", "resultDesc": "create callerNo success", "returnCode": "0200000", "returnDesc": "create callerNo success" }

接口URL 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 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 callerNo List True 支持多主叫号码。最多100个号码。 该对象的参数说明请参见表4 表4 callerNo参数说明 序号 参数名 参数类型 是否必选 说明 1.1 accessCode String True 主叫号码。 呼通客户后，客户的电话终端上显示的号码。 最大长度为24个字符，有效字符为：0~9。 1.2 priority int True 主叫号码优先级。 取值范围：1-5。数字越小，优先级越高

报文样例 该接口的请求消息体举例如下： 无 该接口的响应消息体举例如下： { "returnCode": "0200000", "data": { "retryPolicyId": "1871694313", "policyType": 0, "policyJson": "[{'retryTimes':1,'retryDay':2,'type':0,'policy':[]}]" }, "returnDesc": null }

错误结果码 表8 错误原因码说明 序号 错误码 说明 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 参数个数不能大于规定个数

接口URL 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。

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 无请求消息体。

响应说明 表3 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表8。 2 resultDesc String 描述。 3 data Object 外呼重试策略。具体参见表4。 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表8。 5 returnDesc String 描述。 表4 data参数说明 序号 参数名 参数类型 说明 3.1 retryPolicyId String 重试策略ID。 3.2 policyType int 重试策略类型： 0为全局策略 1为号码分类策略 3.3 policyJson String 重试策略参数。具体见表5 3.4 noRetryPolicy String 不重试的结果码。即配置不重试的结果码，该结果码来源于“查询外呼结果定义列表”中的“data”属性下的“resultCode”字段。 3.5 busiPolicy String False 业务结果策略的json串。 该对象的参数说明请参见表6。 表5 policyJson参数说明 序号 参数名 参数类型 说明 3.3.1 dataType String 号码类型。 3.3.2 policy String 按照结果匹配的策略json串。 该对象的参数说明请参见表 policy参数说明 3.3.3 retryDay int 普通策略，试呼天数。 3.3.4 retryTimes int 普通策略，每天试呼次数。 3.3.5 type int 重试逻辑策略类型： 0：普通策略 1：结果策略 表6 busiPolicy参数说明 序号 参数名 参数类型 是否必选 说明 14.7.1 busiResultCode String True 业务结果编码。 14.7.2 busiResultSubCode String -- 业务结果子编码。（跟业务结果编码关联） 14.7.3 busiResultPolicy int True 业务结果呼叫策略。 0-停止呼叫，1-呼叫下个号码，2-呼叫当前号码。 14.7.4 callInterval int -- 呼出间隔(秒)。 呼叫策略为0时不用填写，其他为True。取值范围：1-3600。 表7 policy参数说明 序号 参数名 参数类型 说明 3.3.2.1 callInterval int 延迟时间。 3.3.2.2 result int 结果类型。 3.3.2.3 retryNumber int 重试次数。

响应说明 表5 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 serverId String 生成文件服务ID 全局唯一 4 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表6 5 returnDesc String 描述。

错误结果码 表6 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200033 外呼数据不存在。 3 0200034 子状态与业务结果不匹配。 4 02000005 参数长度超过指定范围 5 02000001 参数值为空 6 02000002 参数包含非法字符 7 02000003 参数长度不能大于规定长度 8 02000004 参数长度不能小于规定长度 9 02000005 参数长度需要介于规定长度之间 10 02000006 参数值类型不正确 11 02000007 参数值大小不正确 12 02000008 参数转换异常，请检查请求参数 13 02000009 参数组合不正确，请检查请求参数 14 02000010 hour和minute必须同时存在

报文样例 该接口的请求消息体举例如下： { "userName":"zhangsan", "serverInfo":{ "ip":"1.2.3.4", "port":"22", "filePath":"/home/sftp" }, "serverPwd":"******" } 该接口的响应消息体举例如下： { "resultCode": "02000005", "description": " 参数长度需要介于8和80之间" }

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 serverInfo JsonObject True 文件服务器信息。 2 userName String True 用户名 3 serverPwd String True 服务密码，明文传递，后台密文保存 表4 serverInfo参数说明 序号 参数名 参数类型 是否必选 说明 1 ip String True 文件服务器IP。客户自备ip地址。 2 port String True port 3 filePath String True 文件服务器默认路径 示例：/home/sftp

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/file/addServer 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。

请求说明 表1 请求头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type string True 消息正文的类型为JSON 2 access-token string True 用户访问租间token，参见调用鉴权接口 表2 请求体参数 序号 名称 参数类型 长度（字节） 是否必选 说明 1 id string 20 True 工单id 2 creatorId string 20 True 操作处理人id 3 remark string 2000 True 描述信息

消息样例 场景描述：取消工单 URL：https:// 域名 /service/AICC__Case/1.0.0/openapi/case/cancel 请求头: { "Content-Type": "application/json", "access-token": "0000000000************7bm63KsRmEztTvyA=" } 请求体： {"id": "c6m80000013LvTIsdeJU","creatorId":"10gg000000sLj1ytR70C","remark": "10330013wbIvo30bk"} 响应头： { "connection": "keep-alive", "Content-Length": "16", "Content-Type": "application/json%3Bcharset=UTF-8"} 响应参数： {"resCode": "0","resMsg": "成功"}

错误结果码 表5 错误原因码说明 序号 错误码 说明 1 0200001 参数异常，异常详情在resultDesc中描述。 2 0200006 数据库操作异常。 3 0200007 外呼活动不存在。 4 0200028 当前状态不允许删除号码。 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 参数个数不能大于规定个数

响应说明 表4 消息体参数说明 序号 参数名 参数类型 说明 1 resultCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 2 resultDesc String 描述。 3 returnCode String 原因码。0200000表示成功，其他表示失败。 具体见表5。 4 returnDesc String 描述。 5 successCount int 成功数量

请求说明 表2 请求消息头参数 序号 名称 参数类型 是否必选 说明 1 Content-Type String True 固定填 application/json; charset=UTF-8。 2 Authorization String True 生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。 3 locale String False i18n（internationalization，国际语言代码），如zh_CN表示中文、en_US表示英文等，默认zh_CN。 表3 请求消息体参数说明 序号 参数名 参数类型 是否必选 说明 1 sessionId String False 标识用户的ID，外呼结果中会回传用户。 最大长度为32个字符。 2 called String False 被叫号码。 最大长度为24个字符，有效字符为：0~9、*、#。 3 customField String False 用户自定义字段，删除时可根据该字段批量删除，最大长度为200个字符。 4 recycleTime String False 回收时间，格式为yyyy-mm-dd hh:mm:ss。 5 recycleType String False 回收类型。只在传入recycleTime的同时传入，该参数有效。 取值范围： 1：删除早于传入的recycleTime（精确到天）的外呼号码。 例如，传入2020-12-04 17:57:00，会将指定外呼活动下，recycleTime在12月4日及以前的外呼号码都删除 2：删除传入的recycleTime当天的外呼号码。 例如，传入2020-12-04 17:57:00，会删除指定外呼活动下，recycleTime在2020-12-04 00:00:00到2020-12-04 23:59:59之间的外呼号码 3：删除与传入的recycleTime相等的外呼号码。 6 archiveHistory int False 是否移历史表。 取值范围：0，1。 0：不移历史表，直接删除。1：移入历史表。默认为0。

接口URL https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId}/delete 其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。 表1 URL中携带的参数说明 序号 参数名 参数类型 是否必选 说明 1 vdnId int True 虚拟呼叫中心ID。 取值的类型为整数，取值范围为1～9999。 2 campaignId int True 外呼活动的ID。

响应消息样例 { "outaction": 12, "outparams": { "call_id": "1528780879-9581", "prompt_type": "1", "inter_idx": "1", "moduleName":"查询", "xxx":"xxx" //扩展 } }

响应消息样例3 { "userid": "1528780879-9581", "outaction": 10, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "call_dst_id": "10086", "start_time": "2018090407:16:24", "end_time": "2018090407:30:24", "release_reason": "0", "region_id": "025", "entrance_id": "03", "exit_id": "05", "user_type_id": "01", "suilu_region_id":"025" } }

响应消息样例2 { "userid": "1528780879-9581", "outaction": 11, "outparams": { "call_id": "1528780879-9581", "call_sor_id": "13500000001", "calling_num":"1234567890", "trans_type": "1", "route_value": "123456789", "inter_idx": "1", "trans_idx": "1", "question_id": "Q1", "question_name": "问题1", "answer_id": "Y" } }

inparams 参数 参数名称 数据类型 参数位置 必选/可选 描述 call_id String body True 呼叫唯一标志,与userid 取值相同，给流程使用。 不超过64位 call_dst_id String body True 接入标识 1、语音导航场景传入被叫号码； 2、语音外呼问卷场景时为问卷类型id； 3、其他交互场景时传入接入标识。 不超过20位 flow_result_type String body True 结果类型。 1： 语音识别 输入或者文字输入 2：语音按键输入 3：正常无输入(只播放) 4：录音结束 -1：其他 5：数字人流媒体服务 input String body True 对话交互结果。 语音识别结果或者文字输入：语音识别结果为id值，格式为redis值编号key+@+inter_no；文字输入结果则直接为文字内容 语音按键结果：按键值，如"1","201801"等 playover：放音结束 timeout：超时 nomatch：识别或按键失败 sys_err：系统异常 hangup：挂机 recordend：录音结束 当结果为hangup时，可触发ODFS的拆线响应。 不超过1024位 auth_token String body True 授权信息,取接入控制系统返回的token值。 请参见C3 智能助手平台接口鉴权方式。 recordFileName String body False(支持全流程录音的语音导航场景特有字段) 全流程录音的路径文件名，例如：Y:/record/1/20200421/xxxxxx.wav inter_idx String body False(语音导航场景特有字段) 交互次数,直接取上一次ODFS返回的inter_idx值即可。 begin_play String body False(语音导航场景特有字段) 放音开始时间 end_play String body False(语音导航场景特有字段) 放音结束时间 result_time String body False(语音导航场景特有字段) 结果产生的时间 inter_no String body False(语音导航场景特有字段) 识别标识 IACmd String body False(语音导航场景特有字段) 智能匹配和智能工单填写专用字段 智能匹配时，只支持值为match 智能工单时，可取值如下： match：请求填单 rematch：当识别的事项分类错误时,重新识别 confirm：当座席点选某字段时,告知odfs该字段已确认 TextSource String body False(语音导航场景特有字段) 当IACmd为match时，用于区分输入文本来自座席还是用户（智能匹配、智能工单相同）,值为staff或customer staff：座席 customer：用户 当IACmd为confirm时，传入座席点选的字段名,如：对象二级 当IACmd为rematch时，可不填 feedback int body False 反馈的满意度: 1(满意)；0(不满意) feedbackContent String body False 反馈的不满意原因(如果反馈为满意则为空) mediaType String body False 媒体类型（文本,音频,视频... 例如：audio,video...） call_media_type String body False 呼入ivr的呼叫类型，文本：0 音频：1视频：3 channelType String body False 渠道类型 WEB（Web） INSTAG RAM （Instagram） TELEGRAM(Telegram) WECHAT(微信) FACEBOOK（Facebook） TWITTER（X (Twitter)） EMAIL（邮件） LINE WHATSAPP（WhatsApp） 5G（5G消息） SMS （短信）。 说明： 括号里为界面字段,区别于接口传参字段。 refeedbackContentcordFileName String body False 录音文件名 action String body 数字人回复图元 操作类型。 3: interrupt 4：callback action_result int body False 0：流 媒体处理 成功 1：流媒体处理失败 2：流媒体处理异常