List a broadcast’s recipients

Each person in a broadcast with where their text stands.

Needs a key with the messages:read scope. Keys and scopes

Path parameters

• idstringrequired

  The broadcast’s id.

  Starts with bc_.

Query parameters

• statestring

  Only recipients in this state.

  One of pending, queued, skipped, sent, delivered, read, failed, unconfirmed, expired, canceled.

• limitinteger

  How many to return, 1 to 100. Default 25.

  1 to 100.Default 25.

• cursorstring

  The next_cursor of the page before. Leave it out for the first page.

  Up to 200 characters.

Example

curl "https://usebluebot.com/api/v1/broadcasts/bc_1Hq2LxW9cVbN3mKpRtYs0a/recipients" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY"

Response

200: A page of recipients.

• object"list"required
• dataarray of BroadcastRecipientrequired
  Show its 7 fieldsHide its fields

  • object"broadcast_recipient"required
  • contact_idstringrequired

    A ct_ id.

    Starts with ct_.

  • handlestringrequired

    A phone number in E.164 (+15555550123) or an email address an Apple ID uses (iMessage only).

  • namestring or nullrequired

    The person’s name, when known.

  • statestringrequired

    pending until their text is queued, then the text’s own state; skipped when they won’t get it.

    One of pending, queued, skipped, sent, delivered, read, failed, unconfirmed, expired, canceled.

  • skip_reasonstring or nullrequired

    stopped (on your stop list), invalid, duplicate or deleted.

    One of stopped, invalid, duplicate, deleted.

  • message_idstring or nullrequired

    A msg_ id.

    Starts with msg_.

• has_morebooleanrequired

  Whether another page follows.

• next_cursorstring or nullrequired

  Send as cursor for the next page; null on the last.

{
  "object": "list",
  "data": [
    {
      "object": "broadcast_recipient",
      "contact_id": "ct_1Hq2LxW9cVbN3mKpRtYs0a",
      "handle": "+15555550123",
      "name": "Maria Alvarez",
      "state": "delivered",
      "skip_reason": null,
      "message_id": "msg_1Hq2LxW9cVbN3mKpRtYs0a"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Errors

Every refusal has the same envelope and a page of its own. These are the ones this operation can give.

Try it