Docs Cari Mangsa

Broadcast Media

POST

URL/whatsapp/broadcast-api/send?token=TOKEN&url=APPS_URL

PARAMS

token

TOKEN

url

APPS_URL

BODY formdata

0811xxxxx900 (Target Number)

context

Sending Hello (Broadcast Context or Description)

message

Hello from BotNotify (Broadcast Message)

priority

5 (1- 9, less number get more priority)

file

Image-001.png (Media or File Attachment)

Based on Whatsapp regulation about max upload size, image and video max upload size is 16 MB and for document is 30 MB.

File extension will be restricted by setting, you can update them in web administrator Settings -> Media & Assets.

RESPONSE

Success

{
    "success": true,
    "message": "Success to request broadcast",
    "data": [
        {
            "id": 1001,
            "sender_number": "0820xxxxx001",
            "receiver_number": "0811xxxxx900",
            "receiver_name": null,
            "message": {
                "context": "Sending Hello",
                "type": "text",
                "content": "Hello from BotNotify",
                "media": {
                    "file_url": "http://url.com/Image-001.png",
                    "file_name": "Image-001.png",
                    "file_size": 700
                }
            },
            "requested_at": "2023-01-01 08:00:00"
        }
    ]
}

POST

URL/whatsapp/broadcast-api/send?token=TOKEN&url=APPS_URL

PARAMS

token

TOKEN

url

APPS_URL

BODY formdata

to[1]

0811xxxxx900 (Target Number)

to[2]

0811xxxxx901 (Target Number)

to[3]

0811xxxxx902 (Target Number)

context

Sending Hello (Broadcast Context or Description)

message

Hello from BotNotify (Broadcast Message)

priority

5 (1- 9, less number get more priority)

file

Image-001.png (Media or File Attachment)

Based on Whatsapp regulation about max upload size, image and video max upload size is 16 MB and for document is 30 MB.

File extension will be restricted by setting, you can update them in web administrator Settings -> Media & Assets.

RESPONSE

Success

{
    "success": true,
    "message": "Success to request broadcast",
    "data": [
        {
            "id": 1001,
            "sender_number": "0820xxxxx001",
            "receiver_number": "0811xxxxx900",
            "receiver_name": null,
            "message": {
                "context": "Sending Hello",
                "type": "text",
                "content": "Hello from BotNotify",
                "media": {
                    "file_url": "http://url.com/Image-001.png",
                    "file_name": "Image-001.png",
                    "file_size": 700
                }
            },
            "requested_at": "2023-01-01 08:00:00"
        },
        {
            "id": 1002,
            "sender_number": "0820xxxxx001",
            "receiver_number": "0811xxxxx901",
            "receiver_name": null,
            "message": {
                "context": "Sending Hello",
                "type": "text",
                "content": "Hello from BotNotify",
                "media": {
                    "file_url": "http://url.com/Image-001.png",
                    "file_name": "Image-001.png",
                    "file_size": 700
                }
            },
            "requested_at": "2023-01-01 08:00:00"
        },
        {
            "id": 1003,
            "sender_number": "0820xxxxx001",
            "receiver_number": "0811xxxxx902",
            "receiver_name": null,
            "message": {
                "context": "Sending Hello",
                "type": "text",
                "content": "Hello from BotNotify",
                "media": {
                    "file_url": "http://url.com/Image-001.png",
                    "file_name": "Image-001.png",
                    "file_size": 700
                }
            },
            "requested_at": "2023-01-01 08:00:00"
        }
    ]
}

POST

URL/whatsapp/broadcast-api/send?token=TOKEN&url=APPS_URL

PARAMS

token

TOKEN

url

APPS_URL

BODY formdata

to[number]

0811xxxxx900 (Target Number)

to[name]

John Doe (Target Name)

context

Sending Hello (Broadcast Context or Description)

message

Hello from BotNotify (Broadcast Message)

priority

5 (1- 9, less number get more priority)

file

Image-001.png (Media or File Attachment)

Based on Whatsapp regulation about max upload size, image and video max upload size is 16 MB and for document is 30 MB.

File extension will be restricted by setting, you can update them in web administrator Settings -> Media & Assets.

RESPONSE

Success

{
    "success": true,
    "message": "Success to request broadcast",
    "data": [
        {
            "id": 1001,
            "sender_number": "0820xxxxx001",
            "receiver_number": "0811xxxxx900",
            "receiver_name": "John Doe",
            "message": {
                "context": "Sending Hello",
                "type": "text",
                "content": "Hello from BotNotify",
                "media": {
                    "file_url": "http://url.com/Image-001.png",
                    "file_name": "Image-001.png",
                    "file_size": 700
                }
            },
            "requested_at": "2023-01-01 08:00:00"
        }
    ]
}

POST

URL/whatsapp/broadcast-api/send?token=TOKEN&url=APPS_URL

PARAMS

token

TOKEN

url

APPS_URL

BODY formdata

to[1][number]

0811xxxxx900 (Target Number)

to[1][name]

John Doe (Target Name)

to[2][number]

0811xxxxx900 (Target Number)

to[2][name]

Jesicca Doe (Target Name)

context

Sending Hello (Broadcast Context or Description)

message

Hello from BotNotify (Broadcast Message)

priority

5 (1- 9, less number get more priority)

file

Image-001.png (Media or File Attachment)

Based on Whatsapp regulation about max upload size, image and video max upload size is 16 MB and for document is 30 MB.

File extension will be restricted by setting, you can update them in web administrator Settings -> Media & Assets.

RESPONSE

Success

{
    "success": true,
    "message": "Success to request broadcast",
    "data": [
        {
            "id": 1001,
            "sender_number": "0820xxxxx001",
            "receiver_number": "0811xxxxx900",
            "receiver_name": "John Doe",
            "message": {
                "context": "Sending Hello",
                "type": "text",
                "content": "Hello from BotNotify",
                "media": {
                    "file_url": "http://url.com/Image-001.png",
                    "file_name": "Image-001.png",
                    "file_size": 700
                }
            },
            "requested_at": "2023-01-01 08:00:00"
        },
        {
            "id": 1002,
            "sender_number": "0820xxxxx001",
            "receiver_number": "0811xxxxx901",
            "receiver_name": "Jessica Doe",
            "message": {
                "context": "Sending Hello",
                "type": "text",
                "content": "Hello from BotNotify",
                "media": {
                    "file_url": "http://url.com/Image-001.png",
                    "file_name": "Image-001.png",
                    "file_size": 700
                }
            },
            "requested_at": "2023-01-01 08:00:00"
        }
    ]
}

Failed (Target number empty)

{
    "success": false,
    "message": "Receiver message cannot be empty"
}

Failed (Target number not valid)

{
    "success": false,
    "message": "Please provide valid whatsapp numbers"
}

Failed (Message empty)

{
    "success": false,
    "message": "Text message cannot be empty"
}

Failed (File cannot multiple)

{
    "success": false,
    "message": "File cannot be multiple, please provide single file"
}

Failed (File extension not allowed)

{
    "success": false,
    "message": "File upload not allowed, please check file extension"
}

Failed (Limit size of uploading image or video)

{
    "success": false,
    "message": "Max upload size of image / video is 16 MB, please check again"
}

Failed (Limit size of uploading document)

{
    "success": false,
    "message": "Max upload size of document is 30 MB, please check again"
}

Failed (Any errors)

{
    "success": false,
    "message": "Failed to request broadcast"
}