Ricky logorickyDocs

Previsualizar la audiencia de una campaña

POST
/broadcasts/preview

Cuenta los números a los que llega una audiencia en este momento, con las reglas de POST /broadcasts, sin crear nada. La lista puede cambiar antes de que crees la campaña.

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.

Cuerpo de la solicitud

application/json
  1. body

La audiencia a contar, como la enviarías a POST /broadcasts.

audience*||

Quién la recibe. filter toma cada contacto que cumple todos los filtros que envías (sin filtros: todos los contactos); contacts y phones toman los que listas. Ricky usa el teléfono de cada contacto, o su número de WhatsApp, omite los contactos sin uno y envía una vez por número, hasta 5.000.

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*

A cuántos números llega una audiencia en este momento.

curl -X POST 'https://getricky.ai/api/v1/broadcasts/preview' \  -H 'Content-Type: application/json' \  -d '{  "audience": {    "type": "filter",    "tag_id": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f"  }}'
{  "data": {    "recipients": 118,    "skipped": 3  }}