BotNotify Documentation

Broadcast History

POST

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

PARAMS

token

TOKEN

url

APPS_URL

BODY formdata

1001 (Broadcast Message ID)

RESPONSE

Success (Pending => Message still waiting to be broadcasted)

{
    "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": null,
                "file_name": null,
                "file_size": null
            }
        },
        "requested_at": "2023-01-01 08:00:00",
        "status": "Pending",
	"details": {
            "sending_at": null,
            "sent_at": null,
            "read_at": null,
            "log": null
	}
    }
}

Success (Sending => Processing to broadcast message)

{
    "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": null,
                "file_name": null,
                "file_size": null
            }
        },
        "requested_at": "2023-01-01 08:00:00",
        "status": "Sending",
    	"details": {
            "sending_at": "2023-01-01 08:00:00",
            "sent_at": null,
            "read_at": null,
            "log": null
    	}
    }
}

Success (Sent => Message has been sent to receiver whatsapp number)

{
    "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": null,
                "file_name": null,
                "file_size": null
            }
        },
        "requested_at": "2023-01-01 08:00:00",
        "status": "Sent",
	"details": {
            "sending_at": "2023-01-01 08:00:00",
            "sent_at": "2023-01-01 08:00:03",
            "read_at": null,
            "log": null
	}
    }
}

Success (Read => Receiver has read the broadcasted message)

{
    "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": null,
                "file_name": null,
                "file_size": null
            }
        },
        "requested_at": "2023-01-01 08:00:00",
        "status": "Sent",
	"details": {
            "sending_at": "2023-01-01 08:00:00",
            "sent_at": "2023-01-01 08:00:03",
            "read_at": "2023-01-01 08:00:10",
            "log": null
	}
    }
}

Success (Failed => Message failed to be broadcasted)

{
    "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": null,
                "file_name": null,
                "file_size": null
            }
        },
        "requested_at": "2023-01-01 08:00:00",
        "status": "Failed",
    	"details": {
	        "sending_at": "2023-01-01 08:00:00",
	        "sent_at": null,
	        "read_at": null,
	        "log": "Message unsent because: pending too long, receiver number not using whatsapp (invalid number), message expired, or others circumstances."
    	}
    }
}

Made with