AurexManager

用户接口文档

面向对接方的公开说明页。未登录可以直接访问，已登录用户也可以从个人中心下方的菜单进入。

返回首页进入控制台
公开访问
无需登录
与当前系统配置保持一致
用户信息接口

根据来电号码查询 CRM / 业务系统用户资料，并把返回的 JSON 注入 Omni 上下文。

用户信息接口/dashboard/ai-config/user-info-api
回调地址

在机器人实例里填写接收交互记录的 URL，平台会把地址写入机器人 JSON 的 callback_addr 字段。

回调地址/dashboard/ai-config/robot

用户信息接口

该配置用于在呼入发生时，根据主叫号码查询外部客户资料。当前系统中，用户信息接口由「用户信息接口」页面维护，并由 Omni 配置进行关联。

接入流程
  1. 在「用户信息接口」页面新增一条配置。
  2. 填写接口地址、查询参数名、认证方式、超时时间与失败策略。
  3. 在 Omni 配置中关联这条用户信息接口。
  4. 运行端收到呼入后发起 GET 请求，并把返回的 JSON 作为上下文使用。
请求方式

系统约定固定使用 GET 请求，主叫号码会拼接到查询参数中。

GET https://crm.example.com/api/customer?phone=13800138000
Authorization: Bearer sk_live_xxx
对接时只需要先确认这 3 项

接口地址

填写外部系统的完整 URL，例如 https://crm.example.com/api/customer。

查询参数名

告诉对方系统“来电号码”放在哪个参数里。大多数场景直接用默认值 phone 即可。

认证方式

只需确认对方接口使用 Bearer Token 还是自定义 Header；只有自定义 Header 模式才需要额外提供名称。

其余配置建议

  • 超时时间通常保持默认 3000 毫秒即可。

  • 失败策略一般建议保持“继续对话”，避免外部接口偶发失败时中断服务。

  • 启用开关保持开启；只有临时停用对接时才需要关闭。

认证方式

Bearer Token

适合 OAuth / JWT 风格接口，请求头格式为 Authorization: Bearer <api_key>。

自定义 Header

适合 API Key 风格接口，请求头格式为 <auth_header_name>: <api_key>。

失败策略建议

continue

接口失败时继续对话，但当前轮没有用户资料上下文。适合“有资料更好，没有资料也能继续服务”的场景。

abort

接口失败时中止对话。适合必须先核验客户身份或必须依赖外部资料的业务场景。

推荐响应示例

建议直接返回 JSON 对象。字段无需强绑定，运行端会将返回结果整体注入上下文。

{
  "customer_id": "CUS123456",
  "name": "张三",
  "phone": "13800138000",
  "level": "VIP",
  "tags": ["高价值客户", "长期合作"]
}
落地建议
  • 生产环境建议使用 HTTPS。
  • 超时时间建议控制在 3000 到 5000 毫秒之间。
  • 404 通常可以按“未找到客户”处理，不必直接判定系统故障。
  • 联调时可优先使用 /api/v1/config/user-info-api/test 测试接口。

回调地址

回调地址是机器人实例上的一个可选配置项。填写后，平台会在生成机器人 JSON 时输出 callback_addr，供运行端按自己的协议把交互记录推送给你的业务系统。

配置位置

进入「机器人实例」页面编辑目标机器人，在表单中填写“回调地址”。如果留空，生成的机器人 JSON 中不会包含 callback_addr 字段。

JSON 输出示例
{
  "id": "123",
  "type": "sip",
  "call_type": "inbound",
  "callback_addr": "https://crm.example.com/api/aurex/callback"
}
接入注意事项
  • 建议准备一个可公网访问的 HTTP / HTTPS 地址。
  • 接收端建议自行增加签名、鉴权或来源校验。
  • 回调接口最好具备幂等处理能力和日志记录能力。
  • 字段长度上限为 255 个字符，建议使用稳定的正式地址。

已登录用户可从个人中心下方的“用户接口文档”菜单再次进入此页。