语聚AI
    语聚AI
    • 语聚AI应用助手API使用说明
    • AI助手 API
      • 验证apiKey
        GET
      • 查询指定AI助手下的动作列表(工具列表)
        GET
      • 执行动作(文本格式)
        POST
      • 执行动作(NLP方式)
        POST
      • 获取动作配置页面地址
        GET
      • 查询执行日志记录
        GET
      • 创建会话消息
        POST
    • 外部联系人API
      • 查询外部联系人(详情)
        GET
      • 查询外部联系人(列表)
        POST
      • 删除外部联系人
        DELETE
      • 创建外部联系人
        POST
      • 更新外部联系人
        PUT
    • 知识库
      • 查询文本知识库列表
        GET
      • 现有文本知识库中同步新内容
        POST
      • 查询知识库内容
        GET
      • 更新知识库内容
        PUT
      • 查询文本知识库文档文件列表
        GET
    • 通用功能API
      • 查询账户当前余额
        GET
      • 查询助手列表
        GET
      • 发送消息给指定用户
        POST
      • 费用明细查询接口
        GET
    • AI营销
      • AI外呼
        • 添加号码到外呼任务中
        • 获取外呼任务列表
        • 添加CRM公海线索后同步到外呼任务
        • 添加CRM公海线索
        • 重置指定号码外呼状态
        • 添加指定号码到黑名单
        • 查询通话记录
        • 下载通话录音
        • 黑名单组列表
        • 查询通话记录ID列表
        • 查询联系人字段列表
      • 企业微信代运营/托管
        • 对话消息接收与发送
          • 对话消息回调
          • 发送消息
        • 群管理
          • 创建企业微信群
          • 获取群列表信息
          • 查询指定用户下所在群信息
          • 入群事件回调
          • 离群事件回调
        • 外部联系人
          • 获取企业联系人列表
          • 创建好友添加任务
          • 好友通过事件回调
        • 基础设置
          • 获取当前企业托管账号列表
          • 获取企业员工列表

    语聚AI应用助手API使用说明

    在使用语聚AI的API接口前,请先生成

    1 预先准备#

    创建一个AI助手,在助手的集成页签下,找到API集成:
    image.png
    📌
    任意类型助手,任意一个助手都可以
    在API界面点击创建APIKey
    image.png
    📌
    目前并没有API权限区分功能,此APIkey可调用所有接口,请妥善保管。AI助手下有成员管理功能,可设置查看助手API的成员列表,但不能阻止APIkey被使用。(除非关闭、删除APIKey)
    可以通过导航菜单 “费用”查看消费明细,来源选择API可筛选出API的调用记录。如果发现被滥用请及时关闭被滥用的APIkey

    2 API接口调用#

    语聚AI提供了两种不同的调用方式:
    传入文本格式调用应用助手:将用户的命令文本传入,由应用助手自行决定使用哪些已配置的应用动作去完成任务。此方式适合第三方软件(非LLM模型)直接API调用。
    自行决定如何使用应用助手下动作(NLP方式):查询应用助手下可配置的应用动作和字段设置,然后自行决定要调用哪个应用动作,字段匹配如何使用。此方式适合LLM模型根据自己的模型能力调用。

    2.1 直接传入文本调用应用助手流程#

    2.2 第三方决定如何使用应用助手下动作流程 (NLP方式)#

    下一页
    验证apiKey
    Built with