为workflow任务新增名单

POST

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

往已创建的workflow任务中新增名单，适用于名单的拨打/触达流程相同，且名单是短时间内先后由您的业务系统产生的；在添加名单时请注意原workflow任务状态，若已结束或者已取消则无法添加名单；同时请注意原workflow任务的结束时间，若结束时间临近，可能导致新增的名单无法按照预期走完所有流程。

请求参数

Header 参数

Authorization

string

必需

默认值:

Token 3Ksb9EkFDQHBhAbvYDTq4+pGGjNRAuLtPF9MMt9E97hX+OgLWTmeZtdGZyjR+YqU

Content-Type

string

必需

默认值:

application/json

User-Agent

string

可选

默认值:

Airudder

Body 参数application/json

workflow_id

string

必需

创建Workflow任务时返回的workflow_id。

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_id": "e958b74daf3e4c1c9e438d82db4c9999",
    "details": [
        {
            "variables": {
                "customer_name": "test-user1",
                "borrow_total_money": "100",
                "borrowed_amount": "80",
                "due_date":"2022-09-08",
                "borrowed_date":"2022-09-01"
                
            },
            "platform": "TEMP1",
            "callee": "+8618116123456",
            "caseid": "test-caseid-1"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.airudder.com/service/cloud/workflow/uploaddetails' \
--header 'Authorization;' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflow_id": "e958b74daf3e4c1c9e438d82db4c9999",
    "details": [
        {
            "variables": {
                "customer_name": "test-user1",
                "borrow_total_money": "100",
                "borrowed_amount": "80",
                "due_date":"2022-09-08",
                "borrowed_date":"2022-09-01"
                
            },
            "platform": "TEMP1",
            "callee": "+8618116123456",
            "caseid": "test-caseid-1"
        }
    ]
}'

返回响应

🟢200success

application/json

Body

data

object

必需

workflow_id

string

必需

status

enum<string>

必需

枚举值:

code

enum<integer>

必需

枚举值:

200403500401

示例

{
    "data": {
        "workflow_id": "f3696213b60c4debae668f4defd1e60d"
    },
    "status": "OK",
    "code": 200
}

🟢200Error

🟢200error

获取workflow模板列表

更新workflow任务内的名单信息