Ricky logorickyDocs

Listar destinatarios de una campaña

GET
/broadcasts/{broadcast_id}/recipients

Cada número de la campaña y en qué va su mensaje, en orden de número. Los estados cambian a medida que WhatsApp los informa.

Permiso: broadcasts:read.

Autorización

bearerAuth
headerAuthorizationBearer <clave>

Una clave de API de la organización, rky_live_…, creada en Configuración → API. Envíala solo desde un servidor.

Parámetros de ruta

broadcast_id*string

ID de la campaña.

Formatouuid

Parámetros de consulta

page_size?integer

Elementos por página.

Rango1 <= value <= 100
Predeterminado50
cursor?string

next_cursor de la página anterior. Úsalo sin cambios.

Longitudlength <= 2048
status?string

Solo destinatarios en este estado de entrega.

Uno de"pending""sent""delivered""read""failed"

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*array<>
next_cursor*|

Pásalo como cursor para la página siguiente; null en la última página.

curl -X GET 'https://getricky.ai/api/v1/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08/recipients'
{  "data": [    {      "id": "1d2e3f4a-5b6c-4d7e-9f8a-0b1c2d3e4f5a",      "phone": "+50760001234",      "contact_id": "3f6c2b1e-8d4a-4b7e-9a51-2c7d8e9f0a1b",      "status": "pending",      "failure_reason": null,      "conversation_id": "9b2e4c61-7a3f-4d18-b5c2-6e0f1a2b3c4d",      "message_id": "c41d7e2a-5b6f-4a89-8c3d-0e1f2a3b4c5d",      "processed_at": "2026-10-14T15:30:00.000Z",      "status_updated_at": "2026-10-14T15:30:00.000Z"    }  ],  "next_cursor": "string"}