AIRUDDER API

Send template message

POST

/api/v1/template/send

Chatbot

For sending template message to targets.

请求参数

Header 参数

X-AIRudder-Sign-Key

string

可选

示例值:

X-AIRudder-Sign

string

可选

Body 参数application/json

template_id

integer

必需

The id of template

timestamp

integer

必需

Timestamp of the request

channel

string

必需

Channel name, must be WhatsApp

channel_id

string

必需

Channel id, the WABA account that owns the template

receivers

array [object {1}]

必需

Message sending target

string

可选

WhatsApp account of the target user

template

array [object {1}]

可选

Template information that needs to be replaced

variable

object

可选

Key-value pairs of template variables to be replaced, where the key is the variable name and the value is the value to be replaced with. If the variable name in the template does not match the actual variable name provided, the example value provided during template application will be used for replacement.

custom

string

必需

Custom parameters, can be used to specify the robot field to start. If you want to use it, you need to fill in the json formatted string. The robot related information is provided offline.

示例

{
  "template_id": 28,
  "timestamp": 1668112245,
  "channel": "WhatsApp",
  "channel_id": "62895422536400",
  "receivers": [
    {
      "id": "8613112345678"
    }
  ],
  "template": [
    {
      "variable": {
        "date": "2024-01-17",
        "name": "tttt001"
      }
    }
  ],
  "custom": "{\"robot_id\":3927,\"robot_version_id\":2612}"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.airudder.com/api/v1/template/send' \
--header 'X-AIRudder-Sign-Key: {{api_key}}' \
--header 'X-AIRudder-Sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "template_id": 28,
    "timestamp": 1668112245,
    "channel": "WhatsApp",
    "channel_id": "62895422536400",
    "receivers": [
        {
            "id": "8613112345678"
        }
    ],
    "template": [
        {
            "variable": {
                "date": "2024-01-17",
                "name": "tttt001"
            }
        }
    ],
    "custom": "{\"robot_id\":3927,\"robot_version_id\":2612}"
}'

返回响应

🟢200Success

application/json

Body

request_id

string

必需

Request unique identifier

code

integer

必需

Error code

message

string

必需

Error message

data

object

必需

Response data

task_id

string

Task ID

必需

示例

{
  "request_id": "7b50b74e5ec2910fe9b250c9fda7085e",
  "code": 200,
  "message": "Success",
  "data": {
    "task_id": "3b36592db276377cf65fe22337cc2bff"
  }
}

修改于 2024-10-31 07:30:48

Template details

Query the template message sending result