语聚AI
  1. AI助手 API
语聚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列表
      • 查询联系人字段列表
    • 企业微信代运营/托管
      • 对话消息接收与发送
        • 对话消息回调
        • 发送消息
      • 群管理
        • 创建企业微信群
        • 获取群列表信息
        • 查询指定用户下所在群信息
        • 入群事件回调
        • 离群事件回调
      • 外部联系人
        • 获取企业联系人列表
        • 创建好友添加任务
        • 好友通过事件回调
      • 基础设置
        • 获取当前企业托管账号列表
        • 获取企业员工列表
  1. AI助手 API

查询指定AI助手下的动作列表(工具列表)

GET
/v1/openapi/exposed
智能助手NLA API
查询指定账户当前可操作的动作列表。

请求参数

Query 参数
apiKey
string 
必需
接口请求凭证(apiKey)。应用助手集成配置页面获取
ibotID
string 
可选

助手id, 可使用<查询助手列表>接口获取

platform
string 
可选
生成function call格式时候的平台名称,如: wenxin, doubao, chatgpt
type
string 
可选
返回格式类型,如为functions,则返回function call格式的数据

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://chat.jijyun.cn/v1/openapi/exposed?apiKey=&ibotID&platform&type'

返回响应

🟢200成功
application/json
非functions格式返回
Body
configuration_link
string 
必需
动作意图配置页面地址。
results
array [object {4}] 
动作列表
必需
description
string 
动作描述
必需
id
string 
动作标识ID
必需
operation_id
string 
动作意图
必需
params
object 
必需
动作参数。jsonschema格式
示例
{
    "configuration_link": "",
    "results": [
        {
            "description": "企业微信群机器人:发送消息到企业微信群中",
            "id": "1_198_jjyibotID_jjy_robot_1001",
            "operation_id": "发送消息到企业微信群中",
            "params": {
                "properties": {
                    "content": {
                        "description": "请输入文本内容,支持插入动态变量",
                        "title": "文本内容",
                        "type": "text"
                    }
                },
                "required": [
                    "content"
                ],
                "type": "object"
            }
        },
        {
            "description": "明道云应用:可以使用明道云查询明道云中的企业信息",
            "id": "4_483_jjyibotID_jjy_robot_1001",
            "operation_id": "可以使用明道云查询明道云中的企业信息",
            "params": {
                "properties": {
                    "keywords": {
                        "description": "请输入关键词,启动搜索后将按照关键词对表中所有字段进行搜索,并列出匹配的数据行。",
                        "title": "搜索关键词",
                        "type": "string"
                    }
                },
                "required": [
                    "worksheetId"
                ],
                "type": "object"
            }
        },
        {
            "description": "明道云应用:可以添加数据到明道云的工作表,命令示例:添加数据,创建记录,创建数据",
            "id": "7_478_jjyibotID_jjy_robot_1001",
            "operation_id": "可以添加数据到明道云的工作表,命令示例:添加数据,创建记录,创建数据",
            "params": {
                "properties": {
                    "6421534daf531d85be297994": {
                        "description": "",
                        "title": "名称",
                        "type": "string"
                    },
                    "6421534daf531d85be297995": {
                        "description": "",
                        "title": "网站",
                        "type": "string"
                    },
                    "6421534daf531d85be297996": {
                        "description": "",
                        "title": "国家",
                        "type": "string"
                    },
                    "6421534daf531d85be297997": {
                        "description": "",
                        "title": "描述",
                        "type": "string"
                    }
                },
                "required": [
                    "worksheetId"
                ],
                "type": "object"
            }
        },
        {
            "description": "SMTP邮件发送:向指定邮箱地址发送邮件",
            "id": "62_326_jjyibotID_jjy_robot_1001",
            "operation_id": "向指定邮箱地址发送邮件",
            "params": {
                "properties": {
                    "content": {
                        "description": "展现在收件人邮箱上的邮件标题",
                        "title": "邮件标题",
                        "type": "text"
                    },
                    "message": {
                        "description": "邮件内容",
                        "title": "邮件内容",
                        "type": "string"
                    },
                    "receivers": {
                        "description": "收件人邮件地址,可添加多个,示例:test@test.com",
                        "items": {
                            "type": "string"
                        },
                        "title": "收件人邮箱地址",
                        "type": "array"
                    }
                },
                "required": [
                    "receivers",
                    "content",
                    "message"
                ],
                "type": "object"
            }
        },
        {
            "description": "启信宝:查询企业工商照面信息",
            "id": "123_1002022_jjyibotID_jjy_robot_1001",
            "operation_id": "查询企业工商照面信息",
            "params": {
                "properties": {
                    "keyword": {
                        "description": "请填写企业名称全称或企业注册号",
                        "title": "公司全名或企业注册号",
                        "type": "string"
                    }
                },
                "required": [
                    "keyword"
                ],
                "type": "object"
            }
        },
        {
            "description": "OpenAI DALL·E:可以用于创作图像,生成图片和封面",
            "id": "137_3670_jjyibotID_jjy_robot_1001",
            "operation_id": "可以用于创作图像,生成图片和封面",
            "params": {
                "properties": {
                    "prompt": {
                        "description": "请尽可能准确具体地描述您对图像生成的需求指令;最大支持1000字",
                        "title": "指令",
                        "type": "string"
                    }
                },
                "required": [
                    "prompt"
                ],
                "type": "object"
            }
        },
        {
            "description": "微软Bing搜索(内置):可以使用搜索引擎搜索页面",
            "id": "278_1006895_jjyibotID_jjy_robot_1001",
            "operation_id": "可以使用搜索引擎搜索页面",
            "params": {
                "properties": {
                    "q": {
                        "description": "您要搜索的关键词",
                        "title": "搜索关键词",
                        "type": "string"
                    }
                },
                "required": [
                    "q"
                ],
                "type": "object"
            }
        },
        {
            "description": "企业信息查询:股东信息查询",
            "id": "311_1005399_jjyibotID_jjy_robot_1001",
            "operation_id": "股东信息查询",
            "params": {
                "properties": {
                    "keyword": {
                        "description": "企业全名/注册号/统一社会信用代码",
                        "title": "关键字",
                        "type": "string"
                    }
                },
                "required": [
                    "keyword"
                ],
                "type": "object"
            }
        }
    ]
}
🟠401没有权限
🟢200成功
🟢200成功
上一页
验证apiKey
下一页
执行动作(文本格式)
Built with