呼叫中心文档
首页
通讯文档
通讯对接
更新历史
公共接口
API外呼签入
API电话签出
API电话外呼
通讯话单
双呼对接
通讯机器人
公共接口
机器人外呼
机器人话单
AXB回拨
签名说明
呼叫请求
话单回调
录音下载
盒子
文本机器人文档
公共数据结构体
API对话
对话初始连接
对话文本消息
对话表单消息
对话底部菜单
-
+
首页
对话初始连接
### 1.接口描述 <span style="font-family:楷体">接口请求域名: xxxxx 此接口(v1/bot/connect)文本机器人连接认证并获取认证信息、<font color="red">在响应headers头中获取dialogid值,其它接口都需要此变量值</font></span> ### 2.输入参数 <span style="font-family:楷体">以下请求参数列表仅列出了接口请求参数和部分公共参数</span> | 参数名称 | 必选 | 类型 | 描述 | | --- | --- | --- | --- | | sn | 是 | String | 机器人编号 (枚举: XXXXX) | | channel | 是 | String | 渠道 (枚举: Test、Web、Wechat、MiniApp) | | platform | 是 | String | 接入号 (枚举: 网页测试) | | client | 是 | object | 客户信息 | | vars | 是 | object | 自定义变量 | client-结构体 | 参数名称 | 必选 | 类型 | 描述 | | --- | --- | --- | --- | | id | 是 | String | 客户ID(不填自动生成) | | nickname | 是 | String | 客户昵称(不填自动生成) | | ip | 是 | String | 客户IP(不填自动获取) | ### 3. 输出参数 | 参数名称 | 类型 | 描述 | | --- | --- | --- | | code | number | 状态编码 | | msg | string | 信息 | | data | object | 请参照公共数据结构体 | ### 4.示例 >i 输入示例 ``` POST /v1/bot/connect HTTP/1.1 Host: xxxxx Content-Type: application/json { "sn":"xxxxxxx", "channel":"Web", "platform":"网页测试", "client":{ "id":"", "nickname":"", "ip":"" } } ``` >i 输出示例 ``` { "code": 200, "message": "成功", "data": [ { "action": "question", "data": { "style": 1, "tabs": [ { "title": "系统", "questions": [ "系统xxx", "线xxx" ] }, { "title": "咨询", "questions": [ "xxxx", "xxx" ] }, { "title": "套餐类型", "questions": [] }, { "title": "行业分析", "questions": [] } ], "icon": "" } } ] } ```
照坤
2023年11月15日 11:03
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
分享
链接
类型
密码
更新密码