使用本文档前，请确认您已经拥有集简云开发平台的账户权限，如果还没有，请访问：https://www.jijyun.cn/open.html

执行动作(嵌入方案)

POST

/api/openapi/action_run_nlp

最后修改时间：2024-08-08 02:34:36

请求参数

Body 参数application/json

corp_token

string

必需

嵌入方访问凭证（参考《获取企业访问凭证》接口

timestamp

integer

必需

当前时间戳(timestamp)（秒）

app_id

integer

应用id

必需

action_key

string

动作key

必需

account_id

integer

账户id

可选

data

object

动作参数

必需

app_version

string

可选

应用版本(默认为最新线上版本)

company_identification

string

企业唯一标识

必需

sign

string

可选

签名。请求参数（除sign, secret以外）按照ASCII码表的顺序排序（降序），生成加排序串（如key1=value1&key2=value2），然后secret拼接（secretkey1=value1&key2=value2）。最后对加密字符串进行MD5。如果传值为空串加密的时候不需要包含此key。如果value为对象或者数组类型，则应该先对value进行序列化，得到json格式字符串（紧凑格式，去掉':' ','前后空格），然后在进行拼接处理。

示例

{
  "corp_token": "proident Ut in velit",
  "timestamp": 818383959993,
  "app_id": 4,
  "action_key": "mollit in velit",
  "account_id": 50,
  "data": {},
  "preview_only": true,
  "app_version": "Ut laborum aliquip eu",
  "company_identification": "20",
  "sign": "incididunt aute in"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://developer.jijyun.cn/api/openapi/action_run_nlp' \
--header 'Content-Type: application/json' \
--data-raw '{
    "corp_token": "proident Ut in velit",
    "timestamp": 818383959993,
    "app_id": 4,
    "action_key": "mollit in velit",
    "account_id": 50,
    "data": {},
    "preview_only": true,
    "app_version": "Ut laborum aliquip eu",
    "company_identification": "20",
    "sign": "incididunt aute in"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

data

object

必需

action_used

string

必需

action_used_id

integer

必需

additional_results

array[string]

必需

assistant_hint

null

必需

error

null

必需

string

必需

input_params

object

必需

result

null

必需

result_field_labels

object

必需

review_url

string

必需

status

string

必需

msg

string

必需

示例

{
  "code": 0,
  "data": {
    "action_used": "AI将根据返回的字段名称，进行AI语义化处理并返回",
    "action_used_id": 1000925,
    "additional_results": [],
    "assistant_hint": null,
    "error": null,
    "id": "1cb59e57-92fa-49f4-bc6f-c2fc1dad69f5",
    "input_params": {
      "state": "success"
    },
    "result": null,
    "result_field_labels": {},
    "status": "success"
  },
  "msg": "成功"
}

修改于 2024-08-08 02:34:36

获取动作可用字段

使用说明