Skip to main content

创建并分配任务

域名

  • https://api.incsapp.com

请求路由

  • /external/tasks

请求方式

  • POST

请求头

  • Content-Type: application/json
  • Authorization: Bearer a06b3b2d7f762....

请求参数

请求参数列表

参数名 类型 必填 描述
name string 任务名称,限256字符
description string 任务描述,限256字符
descriptiontypeint任务类型,这里固定为3(消息任务类型)
auth_idintincs开通的 whatsapp 授权id
user_phonestring任务对象手机号,必须是区号开头的纯数字格式,例如:"6281512341234"
user_name string 任务描述,限256字符对象名称
descriptionassignee_username string任务被分配人账号
task_module_infoobject 任务聊天窗口展示信息的定制化展示,见下,限256字符示例
  • 每种消息需要的参数见请求示例

请求示例

OTP 消息请求示例
{
    "to"name": "85268411234"by api",
    "type": 3,
    "otp"auth_id": 30058,
    "description": "123",
    "otp"user_name": "路人A",
    "user_phone": "6281512345678",
    "assignee_username": "incs_1",
    "task_module_info": {
        "code"module_id": "123456"019d3dcd-f5a8-70e7-aff8-c54bde267f38", // 验证码定制模块ID,该模块类型固定传此ID
        "language"total_amount": "en", // 语言
        "code_expiration_minutes": 3 // 验证码失效时间
    }
}
text 消息示例
  • 最大长度 1000 个字符
{
    "to": "85268411234"20000.00",
        "type"orders": "text",
    "text": "Hello"
}
image 消息示例
  • 支持类型:png, jpeg, jpg, gif
  • 最大 200 MB
{
    "to": "85268411234",
    "type": "image",
    "image":[
                {
                    "link"order_number_display": "https://incs-saas.oss-ap-southeast-1.aliyuncs.com/chat/images/header-98403274893.png"
    }
}
video 消息示例
  • 支持类型:mp4
  • 最大 200 MB
  • 最长 10 分钟
  • 视频链接响应头必须包含 'Content-Length' 参数
{WD20260401001",
                    "to"username_display": "85268411234"张三",
                    "type"phone_number_display": "video"13800138000",
                    "video"loan_amount_display": "",
                    "due_amount_display": "",
                    "next_due_date_display": "2026-04-15",
                    "confirm_loan_time_display": "2026-03-01 10:00:00"
                },
                {
                    "link"order_number_display": "https://incs-saas.oss-ap-southeast-1.aliyuncs.com/chat/videos/687710788353f.mp4"WD20260401002",
                    "username_display": "李四",
                    "phone_number_display": "13900139000",
                    "loan_amount_display": "3000",
                    "due_amount_display": "1500",
                    "next_due_date_display": "2026-04-20",
                    "confirm_loan_time_display": "2026-03-10 14:30:00"
                }
            }
document 消息示例
  • 支持类型:doc(x), xls(x), csv, pdf
  • 最大 200 MB
{
    "to": "85268411234",
    "type": "document",
    "document": {
        "link": "https://incs-saas.oss-ap-southeast-1.aliyuncs.com/chat/files/template.xls"]
    }
}

响应

成功响应示例

{
    "status": "success",
    "code": 200,
    "message": "",
    "data": {
        "msg_id"creation_id": 123, // 任务批次号
        "02cda2a2-2cb2-3c47-861c-ab91f5c9872e"task_id": 456 // 任务id
    },
    "error": {}
}

失败响应示例

{
    "status": "error",
    "code": 10003,400,
    "message": "MessageUser failedis \u2013in detailedan reasonincomplete unknown"task.", // 用户被分配任务还未完成
    "data": {},
    "error": {}
}