This endpoint allows you to send new message broadcasts and list existing broadcasts in your account.

Listing Broadcasts

A GET returns the outgoing message activity for your organization, listing the most recent messages first.

• uuid - the id of the broadcast (string), filterable as uuid.
• urns - the URNs that received the broadcast (array of strings).
• contacts - the contacts that received the broadcast (array of objects).
• groups - the groups that received the broadcast (array of objects).
• text - the message text translations (dict of strings).
• attachments - the attachment translations (dict of lists of strings).
• quick_replies - the quick_replies translations (dict of lists of objects).
• base_language - the default translation language (string).
• status - the status, one of pending, queued, started, completed, failed, interrupted.
• created_on - when this broadcast was either created (datetime) (filterable as before and after).

Example:

GET /api/v2/broadcasts.json

Response is a list of recent broadcasts:

{
    "next": null,
    "previous": null,
    "results": [
        {
            "uuid": "0199bb98-3637-778d-9dfc-0ab85c950d7c",
            "urns": ["tel:+250788123123", "tel:+250788123124"],
            "contacts": [{"uuid": "09d23a05-47fe-11e4-bfe9-b8f6b119e9ab", "name": "Joe"}]
            "groups": [],
            "text": {"eng", "hello world"},
            "attachments": {"eng", []},
            "quick_replies": {"eng", [{"text": "Hey"}, {"text": "Hello!"}]},
            "base_language": "eng",
            "created_on": "2013-03-02T17:28:12.123456Z"
        },
        ...

Sending Broadcasts

A POST allows you to create and send new broadcasts. Attachments are media object UUIDs returned from POSTing to the media endpoint.

• urns - the URNs of contacts to send to (array of up to 100 strings, optional)
• contacts - the UUIDs of contacts to send to (array of up to 100 strings, optional)
• groups - the UUIDs of contact groups to send to (array of up to 100 strings, optional)
• text - the message text translations (dict of strings)
• attachments - the attachment translations (dict of lists of strings)
• quick_replies - the quick_replies translations (dict of lists of objects)
• base_language - the default translation language (string, optional)

Example:

POST /api/v2/broadcasts.json
{
    "urns": ["tel:+250788123123", "tel:+250788123124"],
    "contacts": ["09d23a05-47fe-11e4-bfe9-b8f6b119e9ab"],
    "text": {
        "eng": "Hello @contact.name! Burger or pizza?",
        "spa": "Hola @contact.name! Hamburguesa o pizza?"
    },
    "quick_replies": {
        "eng": [{"text": "Burger", "extra": "With cheese"}, {"text": "Pizza"}],
        "spa": [{"text": "Hamburguesa", "extra": "Con queso"}, {"text": "Pizza"}]
    },
    "base_language": "eng"
}

You will receive a response containing the message broadcast created:

{
    "uuid": "0199bb98-3637-778d-9dfc-0ab85c950d7c",
    "urns": ["tel:+250788123123", "tel:+250788123124"],
    "contacts": [{"uuid": "09d23a05-47fe-11e4-bfe9-b8f6b119e9ab", "name": "Joe"}]
    "groups": [],
    "text": {
        "eng": "Hello @contact.name! Burger or pizza?",
        "spa": "Hola @contact.name! Hamburguesa o pizza?"
    },
    "attachments": {"eng": [], "spa": []},
    "quick_replies": {
        "eng": [{"text": "Burger", "extra": "With cheese"}, {"text": "Pizza"}],
        "spa": [{"text": "Hamburguesa", "extra": "Con queso"}, {"text": "Pizza"}]
    },
    "base_language": "eng",
    "created_on": "2013-03-02T17:28:12.123456Z"
}