Batch Sending

POST /v1/whatsapp-plugin/message/send-by-list/catalog-start

Request Headers

{
    "Content-Type": "application/json",
    "x-api-key": "{{api_key}}"
}

Request Body

[
    {
        "customerName": "Austin Bu",    
        "phone": "11987654321",  
        "countryCallingCode": "55"
    }
]

status code 200status code 400status code 500

Content-Type: application/json

{

}

Content-Type: application/json

{
    "errors": [
        {
           "code": "400",
            "errorMessage": "Invalid request message"
        }
    ]
}

Content-Type: application/json

{
    "errors": [
        {
            "code": "500",
            "errorMessage": "Server internal error."
        }
    ]
}

Key	Value
x-api-key	{{api_key}}

Parameter	Type	Description
customerName	String	customer full name.
phone	String	phone number without country code. "15298765431"
countryCallingCode	String	country calling code. such as "86" in China

POST /v1/whatsapp-plugin/message/send-by-excel/catalog-start

Request Headers

{
    "x-api-key": "{{api_key}}"
}

Form Data

    file=@"/Users/java/Downloads/message.xlsx"

status code 200status code 500

Content-Type: application/json

{
}

Content-Type: application/json

{
    "errors": [
        {
            "code": "500",
            "errorMessage": "Server internal error."
        }
    ]
}

Parameter	Required	Type	Description
file		File	Files with .xlsx or .xls extension. The data in the table can be divided into two cases, the first is two columns, and the second is three columns. When the table has only two columns, the first column is the phone number with country code, and the second column is the customer name. When the table has three columns, the first column is the country code, the second column is the phone number without the country code, and the third column is the customer name. The first row of table data is the header, and the second to last rows are the text.