云客智能语音客服接口文档

云客智能语音客服接口文档


1.1对接流程说明

<p>该流程说明:主要针对甲方系统对接外呼机器人系统导入外呼数据的流程说明,导入完成后机器人执行外呼,外呼完成后的结果推送到甲方系统的流程说明。</p> <p><img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=7da9471477402aaf89ee0266cec53f94&amp;amp;file=file.jpg" alt="" /></p> <p><strong>流程说明</strong>: <strong>1.公共参数:</strong>【接口1.2】 <strong>(1)字段url:</strong> ①明文示例:{&quot;api_access_id&quot;: &quot;a655f309e7d7b404f4b6b898688ff50d&quot;, &quot;from&quot;: &quot;1&quot;,&quot;sign&quot;: &quot;0bf4482eac6ac7ae68813905aa26b2b4&quot;,&quot;timestamp&quot;: &quot;2024-09-24 09:34:25&quot;} ②sign值 ③md5加密:a655f309e7d7b404f4b6b898688ff50d339168cd341bb57c45d9f45ea1f9bfdf2024-09-24 09:34:25 ④加密后返回示例值:0bf4482eac6ac7ae68813905aa26b2b4 ⑤加密格式:秘钥,生成方式:md5(api_access_id+api_access_secret+timestamp) ⑥具体请求示例可参考接口文档</p> <p><strong>1.公共参数:</strong>【接口1.3】 <strong>(1)字段url:</strong> ①明文示例:{&quot;username&quot;:&quot;xxx&quot;,&quot;password&quot;:&quot;xxx&quot;,&quot;from&quot;:&quot;2&quot;} ②Md5加密 ③密文示例:21dbe80df90f3be318cb7afda69b4f78 ④Url:1dbe80df(从第二个字符开始,截取8位生成) ⑤具体请求示例可参考接口文档</p> <p><strong>(2)字段user_sn和api_key</strong>(每个接口都需要传递这两个公共参数。) ①调用【接口1.2/1.3 {BaseUrl}/api/login】,登陆管理员账号获取账号的api_key和user_sn ②具体请求示例可参考接口文档</p> <p><strong>2.话术模板:7.1、7.1话术模板列表</strong>(获取project_sn应用于创建外呼任务) (1)字段project_sn: ①调用【7.1、7.1 {BaseUrl}/api/templatelist】,获取话术模板列表,截取相关话术sn</p> <p><strong>3.获取子账号:2.1.1、2.1.1子账号列表</strong>(获取user_sn应用于创建外呼任务) (注:5.7.2.ai_user_sn = 2.1.1、2.1.1.user_sn)</p> <p>(1)字段user_sn: ①调用【2.1.1、2.1.1 {BaseUrl}/api/aiUserDatasapi】,获取子账号列表,截取user_sn</p> <p><strong>4.外呼接口:5.1.2、5.7.2 新建外呼任务接口(json方式)</strong> (1)调用接口【5.1.2、5.7.2 {BaseUrl}/api/addJsonOfAsync】 请求参数: ①字段project_sn,取自于流程2 ②字段source,自定义外呼任务名称 ③client_info_json,客户信息导入(限json格式数据) ④ai_user_sn,取自于流程3.user_sn</p> <p><strong>5.获取任务;5.1任务管理列表</strong> (1)调用接口【/api/index】 请求参数: ①字段start_create_at,创建开始时间(时间段),为空请求当天数据。 ②字段end_create_at,创建结束时间(时间段),为空请求当天数据。 ③字段status,外呼状态:0 :发送中 1: 已发送 4: 暂停发送 6:终止发送 ④字段ai_user_sn,子账号的user_sn ⑤字段ai_user_name,子账号用户名 ⑥字段dial_task_main_sn;任务sn(页面上的任务ID) ⑦字段source_project:任务名称或者模板项目名称模糊搜索 以上内容都为非必填,必填内容为公共参数</p> <p><strong>6.获取通话详情:9.1、9.1设置回调地址 通话结束之后自动推送通话流水至第三方</strong> (1)调用接口【9.1、9.1 {BaseUrl}/api/setCallback】设置通话详情推送地址 (该内容可以通过页面设置)</p> <p><img src="https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=8568daf974d8db7612ed6ed14a2be65c&amp;amp;file=file.png" alt="" /></p> <p><strong>7.通话详情说明:1.1、1挂机后流水推送回调</strong></p> <p><strong>8.通话流水主动拉取:1获取通话流水</strong> {1}调用接口【{BaseUrl}/api/crmList】</p>

页面列表

ITEM_HTML