创建一个新的Workflow任务

POST

https://api.airudder.com/service/cloud/workflow/createinstance

创建一个新的Workflow任务

请求参数

Header 参数

Authorization

string

必需

默认值:

Token 3Ksb9EkFDQHBhAbvYDTq4+pGGjNRAuLtPF9MMt9E97hX+OgLWTmeZtdGZyjR+YqU

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

workflow_template_id

integer

必需

workflow 模板 ID

workflow_template_name

string

可选

workflow 模板名称（与 workflow_template_id 二选一）

name

string

必需

workflow 任务名，不可重复，长度限制为 54

workflow_name

string

可选

workflow 任务名（与 name 二选一）

auto_finish

integer

可选

是否自动完成。1=是（代表workflow内流程结束后，若时间还未到设定的end time，则该workflow任务自动结束）；2=不是（代表workflow任务必须等到设定的end time才会结束）。默认值为2，推荐使用1。

默认值:

end_time

string

必需

workflow 任务的结束时间。
1.当达到结束时间时，workflow 状态将会变成finished， workflow 中的子任务都会标记为结束。
2.格式为YYYY-MM-DD HH:MM:SS+TIMEZONE例如：2022-12-31 12:34:56+07:00。
3.其中TIMEZONE请取您账户业务所在地的时区，若没有设定TIMEZONE，则我们会当做+00:00处理。

holiday_pause

integer

可选

是否节假日暂停。1=是（代表该workflow任务内的所有流程在遇到时间节点时都会自动判断是否触发了节假日，如果是节假日则暂停一天） 2=不是（代表不使用节假日暂停功能）。默认值为2，节假日在web端进行配置。

默认值:

holiday_pause_category

array [object {2}]

可选

执行暂停的节假日分类，若holiday_pause值为1，则此数据必填。

type

string

可选

节假日类型，共分为四类。
1.Working Days=工作日
2.Weekends=周末
3.Statutory Holiday=法定假日
4.Custom Holiday=自定义假日
其中Working Days、Weekends、Statutory Holiday为系统自动生成，Custom Holiday需要在web端管理。

group

array[string]

可选

当type选择Custom Holiday时，需要填写group，代表日历中的自定义假日分组，例如：["双十一"]。组名是在web端进行自定义假日管理时由您自定义的。

details

array [object {5}]

必需

传入workflow内执行流程的名单信息，每个任务最多可以包含10000个名单。

callee

string

必需

客户电话，带有前缀'+'和国际区号，例如“+6212345678”或者“+5212345678”等。

platform

string

必需

平台名称，应不超过40个字符，请联系我们获得可用平台名称列表。

caseid

string

可选

名单唯一编号，一般用于上传具有业务含义的唯一标识，如account id、user id、order id等，方便基于这个字段做数据落库或者数据分析。

variables

object

必需

workflow任务变量，每个workflow任务的变量不一致，分为机器人变量、SMS变量、WA变量和workflow内的流程变量等。
1.键为变量名，由我们提供；值为变量内容，类型为String
2.list中例举了催收场景常见的机器人变量（营销和电商场景除customer_name为必填外，其他字段均为可选字段，请根据机器人要求进行上传），具体使用的变量请联系我们获取。
3.其他未列举的自定义变量请按照key、value的方式上传。

pds_variables

object

可选

PDS 变量，适用于在workflow内执行非实时转人工的流程，具体变量key请联系我们获取。

示例

{
  "workflow_template_id": 1,
  "name": "workflow-test-1",
  "auto_finish": 1,
  "end_time": "2022-10-30 05:05:14+08:00",
  "holiday_pause": 2,
  "details": [
    {
      "callee": "+8612345678",
      "platform": "platform-name",
      "caseid": "test-caseid",
      "variables": {
        "customer_name": "test-user1",
        "borrow_total_money": "120000",
        "borrow_money": "10000",
        "due_date": "2022-10-10",
        "borrowed_date": "2022-10-08",
        "extra_a": "hello world",
        "gender": "male",
        "comments": "comments "
      }
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.airudder.com/service/cloud/workflow/createinstance' \
--header 'Authorization;' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflow_template_id": 1,
    "name": "workflow-test-1",
    "auto_finish": 1,
    "end_time": "2022-10-30 05:05:14+08:00",
    "holiday_pause": 2,
    "details": [
        {
            "callee": "+8612345678",
            "platform": "platform-name",
            "caseid": "test-caseid",
            "variables": {
                "customer_name": "test-user1",
                "borrow_total_money": "120000",
                "borrow_money": "10000",
                "due_date": "2022-10-10",
                "borrowed_date": "2022-10-08",
                "extra_a": "hello world",
                "gender": "male",
                "comments": "comments "
            }
        }
    ]
}'

返回响应

🟢200success

application/json

Body

data

object

必需

workflow_id

string

必需

status

enum<string>

必需

枚举值:

code

enum<integer>

必需

枚举值:

200403500401

示例

{
  "data": {
    "workflow_id": "3ded16efa3174c6c8bc1e462e9573826"
  },
  "status": "OK",
  "code": 200
}

🟢200error1

🟢200error2

修改于 2024-05-27 10:21:00

PDS 任务状态更改回调

获取workflow模板列表