创建批量执行任务

功能说明

可以通过这个接口创建批量执行的任务，每一个任务实际会在一个给定的会话上执行指定的事件

这个批量执行的任务会一次性提交，系统会进行排队执行，以确保系统不会因为并发流量而出现稳定性问题，以及因为并发流量而带来的模型调用限频

使用方式

这个接口有两种使用方式

简洁调用

这种调用方式比较简单，适合用来进行测试验证，通过这种方式调用接口无法创建超过 1000 个会话的批量任务

在调用参数中传入tasks数组参数，并确保这个数组至少有一个元素，这样就可以快速创建出来一个任务

完整调用

这种调用方式比较复杂，但是可以支持无上限的会话数量，调用过程中需要组合三个接口来完整整个任务的创建

在调用参数中不传入tasks数组参数，会在调用完这个接口之后获得到一个jobId的返回值，后续可以使用jobId这个值来多次调用追加子任务

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

botId

string

机器人 ID

必需

执行批量任务的机器人

eventId

string

事件 ID

必需

批量任务需要执行的对应事件

name

string

任务名

必需

scheduledTimestamp

number

定时执行时间戳

可选

当传入此参数时，任务不会立刻执行，而是定时执行

tasks

array[object (批量任务子任务) {5}]

可选

sessionId

string

会话ID

可选

执行任务对应的会话 ID

receiverId

string

接受者 ID

可选

contactId

string

联系人 ID

可选

roomId

string

群聊 ID

可选

params

object

任务执行参数

必需

示例

{
    "botId": "string",
    "eventId": "string",
    "name": "string",
    "scheduledTimestamp": 0,
    "tasks": [
        {
            "sessionId": "string",
            "receiverId": "string",
            "contactId": "string",
            "roomId": "string",
            "params": {}
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Body

code

number

必需

data

object

必需

jobId

string

任务ID

必需

创建后的任务 ID

示例

{
    "code": 0,
    "data": {
        "jobId": "string"
    }
}

功能说明#

使用方式#

简洁调用#

完整调用#

请求参数

示例代码

返回响应

功能说明

使用方式

简洁调用

完整调用