Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Difusiones

Listar difusiones

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.

GET
/broadcasts

Permiso requerido: conversations:read

Autorización

http
headerAuthorizationBearer <clave>

Parámetros de consulta

name?string|null
device_id?integer|null
status[]?array<>
Valor en"0""1""2""3""4""5""6""7""8""9"
folder_id?integer|null
unclassified?string|null
send_type?|
Valor en"immediate""scheduled"null
device_type?|
Valor en"business""api"null
send_at_from?|
Formatodate-time
send_at_to?|
Formatodate-time
perPage?integer
Rango1 <= value <= 100
Por defecto25
orderBy?string
Valor en"name""created_at""updated_at"
orderByMethod?string
Valor en"asc""desc"

Cuerpo de la respuesta

OK

application/json
  1. response
data*array<>
links*
meta*
curl -X GET "https://example.com/broadcasts"
{  "data": [    {      "id": "string",      "name": "string",      "device_id": "string",      "template_id": "string",      "folder_id": "string",      "value": "string",      "date_from": "string",      "date_to": "string",      "send_at": "string",      "contacts_count": "string",      "created_at": "string",      "updated_at": "string",      "status": "string",      "shipping_speed": "string",      "delivered_messages_count": "string",      "readed_messages_count": "string",      "replied_messages_count": "string",      "failure_reason": {        "reason": "string"      },      "send_mode": "string",      "protect_template_category": true    }  ],  "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  }}

Difusiones

Una difusión es un envío masivo de una plantilla (template_id) desde uno de tus números a una audiencia segmentada por etiquetas, países, etapa de un tablero o lead score.

Buscar contactos para una difusión POST

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.