开始 - AI动作集成平台

请求参数

Header 参数

Authorization

string

必需

用户token. 固定结构"bearer + 空格 + token"

示例值:

bearer xeoYWPcn7WXdAFrEkPjffRN5BS1ZSIDiFXbuWf4DFMuJyEIt9qFseEvqG7bKez9S

Body 参数application/json

step

string

动作前期准备阶段

必需

当前请求的生命周期所处阶段

user_id

string

嵌入方的用户唯一标识

必需

（例如:用户ID,企业ID,用户手机号等），如果您的用户体系包含多个维度，比如一个用户可在多个企业中，一个企业下又可有多个项目或者空间，可尝试使用用户ID和企业ID，项目项目ID拼接为一个用户ID, 示例 7889-EUHJJK-EQ89901(user_id-space_id-company-id)

content

string

用户的对话内容

必需

集简云默认使用上下文格式(集简云根据用户唯一标识进行，也可以直接传递上下文内容给集简云。

return_amount

integer

最大返回几个匹配动作

可选

默认为：3，最大10个，当匹配动作数量为1时，则直接执行此动作

app_name_filter

string

用于排除指定应用(关键词包含）

可选

输入应用名称，支持输入多个，用英文逗号,分隔

示例

{
  "step": "ACTION_PREPARE",
  "user_id": "bai-du-123",
  "return_amount": "3",
  "app_name_filter": "webhook,钉钉自建",
  "content": "将你好发送到企业微信群机器人的发送文本消息"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v1/api/AI-action/ai_actions' \
--header 'Authorization: bearer xeoYWPcn7WXdAFrEkPjffRN5BS1ZSIDiFXbuWf4DFMuJyEIt9qFseEvqG7bKez9S' \
--header 'Content-Type: application/json' \
--data-raw '{
    "step": "ACTION_PREPARE",
    "user_id": "bai-du-123",
    "return_amount": "3",
    "app_name_filter": "webhook,钉钉自建",
    "content": "将你好发送到企业微信群机器人的发送文本消息"
}'

返回响应

🟢200成功

application/json

Body

Code

integer

必需

Data

object

必需

chat_id

string

会话id

必需

data

array [object {7}]

必需

description

string

描述信息

必需

status

string

请求状态

必需

action_found: 找到多个可用动作需返回给用户请求、

action_not_found：没有找到可匹配的动作

auth_required: 执行可用动作时，需要用户进行账户授权

auth_account_select: 用户同一个应用下授权过多个账户，需要选择

action_field_required:执行动作时有必填字段需要用户提供信息

action_preview: 用户设置了动作预览后执行，返回动作执行预览，等待用户确认。

action_done:动作成功执行，返回成功信息

action_error:动作执行失败，返回失败信息

step

string

必需

user_id

string

嵌入方的用户唯一标识

必需

Msg

string

必需

示例

{
  "Code": 2000,
  "Data": {
    "chat_id": "InNrOTE2N18xNzI0MDM4Mjk1MDQ1XzAi.tJIj3cOZ8oUJuulhlypC859kPB4",
    "data": [
      {
        "actionIdentkey": "198",
        "actionName": "发送文本消息",
        "actionType": "action",
        "actionkey": "198",
        "appName": "企业微信群机器人",
        "appkey": "84",
        "description": "发送文本消息到企业微信群"
      },
      {
        "actionIdentkey": "2978",
        "actionName": "发送文件",
        "actionType": "action",
        "actionkey": "2978",
        "appName": "企业微信群机器人",
        "appkey": "84",
        "description": "通过填写文件URL发送文件到指定群聊"
      },
      {
        "actionIdentkey": "199",
        "actionName": "发送图文消息",
        "actionType": "action",
        "actionkey": "199",
        "appName": "企业微信群机器人",
        "appkey": "84",
        "description": "发送图文消息到企业微信群"
      }
    ],
    "description": "根据您的需求已为您找到了以下多个匹配动作，请选择：\n                    文本处理：文本分隔\n                    文本处理：文本分隔-自定义分隔符\n                    文本处理：HTML文本转换为Markdown文本\n                    如果您认为匹配结果不准确，您可以重新提问，尽量详细的内容，比如软件名称，希望通过这个软件做的事情等。\n                ",
    "status": "action_found",
    "step": "ACTION_PREPARE",
    "user_id": "bai-du-123"
  },
  "Msg": "成功"
}