语聚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

执行动作(NLP方式)

POST
/v1/openapi/exposed/{action_id}/execute_v2/
智能助手NLA API
根据动作输入参数执行动作。执行动作接口需要第三方(一般为LLM模型)自行选择要使用那个应用动作和如何传递应用动作需要的参数。 可用应用动作,应用动作的描述,应用动作可用使用传入参数,在”查询指定账户当前可用动作“接口获取。

请求参数

Path 参数
action_id
string 
必需
请从“查询指定应用助手下的动作列表”接口获取,其中的id字段或者functions格式返回中的name字段,示例“1_198_jjyibotID_jjy_robot_1001”
Query 参数
apiKey
string 
必需
接口请求凭证(apiKey)。应用助手集成配置页面获取
Body 参数application/json
data
object 
动作执行所需要的参数
必需
preview_only
boolean 
执行是否需要预览
可选
默认否
visitorId
string 
访问者ID
可选
ibotID
string 
助手id
可选

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

示例
{
    "data": {},
    "preview_only": true,
    "visitorId": "string",
    "ibotID": "string"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://chat.jijyun.cn/v1/openapi/exposed//execute_v2/?apiKey=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {},
    "preview_only": true,
    "visitorId": "string",
    "ibotID": "string"
}'

返回响应

🟢200成功
application/json
Body
action_used
string 
动作名称
必需
action_used_id
string 
动作ID
必需
action_used_fields
object 
动作字段schema
必需
error
null 
错误信息
必需
id
string 
执行日志记录ID
必需
input_params
object 
输入参数
必需
content
string 
必需
message
string 
必需
receivers
array[string]
必需
result
null 
执行结果
必需
result_field_labels
object 
返回数据中文翻译。
必需
review_url
string 
预览地址
必需
status
string 
执行状态
必需
状态。'success','error','preview','empty'
示例
{
    "action_used": "企业信息查询:工商照面查询",
    "action_used_fields": {
        "definitions": {},
        "properties": {
            "keyword": {
                "description": "企业名称/注册号/统一社会信用代码,输入字数大于等于2个或以上。",
                "title": "关键词",
                "type": "string"
            }
        },
        "required": [
            "keyword"
        ],
        "type": "object"
    },
    "action_used_id": "381_1007064_jjyibotID_jjy_robot_1001",
    "additional_results": [],
    "assistant_hint": null,
    "error": null,
    "id": "78ae63e2-8141-44e9-95ee-8b65db68cedc",
    "input_params": {
        "choice_mode": "1",
        "keyword": "集简云",
        "skip_number": 1
    },
    "result": [
        {
            "actualCapi": "60.7599 万人民币",
            "address": "北京市丰台区南三环西路16号2号楼19层2218",
            "belongOrg": "北京市丰台区市场监督管理局",
            "categoryNew": "0115601",
            "checkDate": "2023-08-29",
            "creditNo": "91110106MA04CP776C",
            "currency_unit": "CNY",
            "districtCode": "110106",
            "domain": "M7590",
            "econKind": "其他有限责任公司",
            "econKindCode": "1190",
            "endDate": "-",
            "fenname": "-",
            "format_name": "北京集简慧通互联科技有限公司",
            "historyNames": [],
            "id": "4a7227b0-3dc9-48b9-9363-b954cc596e95",
            "logout_reason": "-",
            "name": "北京集简慧通互联科技有限公司",
            "new_status": "存续",
            "operName": "陈迪",
            "orgNo": "MA04CP776",
            "regNo": "110106031449368",
            "registCapi": "160.7599 万人民币",
            "revoke_date": "-",
            "revoke_reason": "-",
            "scope": "一般项目:技术服务、技术开发、技术咨询、技术交流、技术转让、技术推广;会议及展览服务;企业管理咨询;企业管理;广告发布;广告设计、代理;广告制作;计算机系统服务;数据处理服务;软件开发;人工智能应用软件开发;人工智能基础软件开发;互联网数据服务;网络与信息安全软件开发;计算机软硬件及辅助设备零售;电子产品销售;办公设备销售;图文设计制作;软件外包服务;信息技术咨询服务;数据处理和存储支持服务;信息系统运行维护服务;信息系统集成服务;办公服务。(除依法须经批准的项目外,凭营业执照依法自主开展经营活动)许可项目:第二类增值电信业务。(依法须经批准的项目,经相关部门批准后方可开展经营活动,具体经营项目以相关部门批准文件或许可证件为准)(不得从事国家和本市产业政策禁止和限制类项目的经营活动。)",
            "startDate": "2021-07-12",
            "status": "存续(在营、开业、在册)",
            "tags": [],
            "termEnd": "2051-07-11",
            "termStart": "2021-07-12",
            "title": "法定代表人",
            "type_new": "01"
        }
    ],
    "result_field_labels": {},
    "review_url": "https://ai-plugin.jijyun.cn/execution/validation?id=78ae63e2-8141-44e9-95ee-8b65db68cedc",
    "status": "success",
    "visitorId": null
}
🟠401没有权限
上一页
执行动作(文本格式)
下一页
获取动作配置页面地址
Built with