Ingresar
DocumentaciónGuíasReferenciaWebhooksRecursos
Difusiones

Listar los mensajes de una difusión

Sirve para ver el detalle por destinatario de una difusión: estado de cada mensaje, motivo de omisión y fecha de envío. Ideal para detectar fallidos o ver quién leyó o respondió.

GET
/broadcasts/{broadcast}/messages

Permiso requerido: conversations:read

Autorización

http
headerAuthorizationBearer <clave>

Parámetros de la ruta

broadcast*integer

Parámetros de consulta

status[]*array<>
Valor en"0""1""2""3""4""5""6""7""8""9""10"
tab?|
Valor en"all""delivered""read""replied""failed""skipped"null
perPage?integer
Rango1 <= value <= 100
Por defecto25
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/0/messages?status%5B%5D=0"
{  "data": [    {      "contact_id": "string",      "contact_name": "string",      "contact_phone": "string",      "contact_image": "string",      "message_status": "string",      "message_info": {        "message": "string",        "error_code": "string",        "error": "string",        "error_category": "string",        "property1": null,        "property2": null      },      "skip_reason": "string",      "skipped_at": "string",      "recipient_state": "string",      "sent_at": "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  }}

Cancelar una difusión POST

Usalo para frenar una difusión programada o en curso antes de que siga enviando. Si ya no se puede cancelar, responde 409.

Listar carpetas de difusiones GET

Usalo para obtener las carpetas de difusiones con cuántas difusiones tiene cada una, por ejemplo para replicar esa organización en tu sistema.