Skip to content

API 开发

通过标准 HTTP API,把灵谐分身接入你自己的网页、App、客服系统或业务流程。

只需要网站对话入口?

如果不需要自定义聊天界面和服务端流程,请使用嵌入网站。复制一行代码即可接入,也不需要管理 API Key。

5 分钟快速开始创建密钥并完成第一轮对话选择接口被动回复、主动消息与批量任务如何选择查看接口参考直接查请求字段、响应和示例

开始前准备

  1. 在灵谐客户端进入「开放平台」,开启 API 访问。
  2. 创建 API Key。密钥只在创建时完整展示,请立即保存。
  3. 确认分身状态正常且账户余额充足。
  4. 根据部署环境取得 API 地址。
API Base URL正在读取部署配置…

密钥安全

API Key 只能保存在服务端。不要写入网页、客户端安装包、公开仓库或日志。

能力边界

能力接口适用场景
用户发来消息后即时回复POST /open/v1/message客服、站内助手、聊天入口
由业务主动生成一条消息POST /open/v1/outbound-message欢迎、提醒、跟进、召回
面向多位用户创建异步任务/open/v1/outbound-message-batches批量触达、运营任务

所有接口都返回 requestId。排查问题时,请在不泄露 API Key 的前提下保存它。