Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Difusiones

Buscar contactos para una difusión

Sirve para previsualizar la audiencia de una difusión antes de crearla: le pasás los filtros (etiquetas, países, etapa del kanban, lead score) y te devuelve, paginados, los contactos que entrarían.

POST
/broadcasts/contacts

Permiso requerido: conversations:write

Autorización

http
headerAuthorizationBearer <clave>

Parámetros de consulta

perPage?integer
Rango1 <= value <= 100
Por defecto25

Cuerpo del pedido

application/json
  1. body
tags?array<string>
some_tags?array<string>
exclude_tags?array<string>
countries?array<string>
date_from?|
Formatodate-time
date_to?|
Formatodate-time
only_with_phone?boolean
only_paused?boolean
kanban_setting_id?integer|null
kanban_stage_ids?array<integer>|null
only_stagnant?boolean|null
exclude_never_replied?boolean
lead_score_categories?array<>|null
lead_score_min?|
Rango0 <= value <= 100
lead_score_max?|
Rango0 <= value <= 100
per_page?|
Rango1 <= value

Cuerpo de la respuesta

OK

application/json
  1. response
data*array<>
links*
meta*
curl -X POST "https://example.com/broadcasts/contacts" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": [    {      "id": "string",      "name": "string",      "phone": "string",      "whatsapp_id": "string",      "email": "string",      "image": "string"    }  ],  "links": {    "first": "string",    "last": "string",    "prev": "string",    "next": "string"  },  "meta": {    "current_page": 0,    "from": 0,    "last_page": 0,    "links": [      {        "url": "string",        "label": "string",        "active": true      }    ],    "path": "string",    "per_page": 0,    "to": 0,    "total": 0  }}

Listar difusiones GET

Usalo para armar un panel o reporte de tus difusiones: filtrá por número, estado, carpeta, tipo de envío o fecha programada y ubicá rápido la que te interesa.

Contar contactos para una difusión POST

Usalo para dimensionar una difusión antes de lanzarla: con los mismos filtros de segmentación te dice cuántos contactos entran, cuántos no son alcanzables y cuántos están pausados.