Skip to Content
1MSG
ReferenceCampaigns API

Análise por destinatário

GET
/api/v1/campaigns/{campaignId}/analytics/recipients

Uma linha por destinatário. filter é uma lista separada por vírgulas de sent, delivered, read, replied, failed, skipped ou cancelled. filter=clicked é recusado; use filter=replied com replyType=button. fields limita as colunas. conversationId é a conversa no Inbox. providerConversationId é o id do chat no provedor. messageId e providerMessageId são o id da mensagem no provedor. limit máximo 100. cursor é o nextCursor.

Authorization

bearer
headerAuthorizationBearer <API key>

Chave gerada em Settings → Developer → API key. Os métodos do Inbox precisam do escopo Inbox. Os métodos de Campaigns precisam do escopo Campaigns.

Path Parameters

campaignId*string

id da campanha retornado na criação ou na lista.

Query Parameters

filter?string

Separados por vírgula: sent, delivered, read, replied, failed, skipped, cancelled. filter=clicked é recusado — use replied com replyType=button.

replied?string

true mantém só quem respondeu. false mantém quem não respondeu.

Value in"true""false"
replyType?string

button mantém os toques em botões. text mantém as respostas em texto livre.

Value in"button""text"
buttonId?string

id de um botão do template. Use com replyType=button.

reason?string

Motivo exato de pulo ou de falha, da lista de erros.

fields?string

Colunas a retornar, separadas por vírgula. Inclua providerConversationId e providerMessageId quando precisar dos ids do provedor. conversationId é o id da conversa no Inbox. messageId é o id da mensagem no provedor.

limit?number

Tamanho da página, de 1 a 100. Padrão 50.

cursor?string

nextCursor da página anterior. Deixe vazio para a primeira página.

Response Body

application/json
  1. response
items*array<>

Destinatários desta página. Quando o parâmetro fields está definido, cada item traz só as chaves indicadas.

nextCursor*|

Cursor da próxima página, ou null na última página.

Example Request
curl -X GET 'https://api.1msg.io/api/v1/campaigns/string/analytics/recipients'
Example Response200
{  "items": [    {      "phone": "+15551234567",      "bsuid": "ab.abc123xyz",      "name": "Ana",      "conversationId": "cm3dialog01",      "providerConversationId": "[email protected]",      "messageId": "wamid.HBgM",      "providerMessageId": "wamid.HBgM",      "status": "queued",      "sentAt": "2026-11-01T09:00:00.000Z",      "deliveredAt": "2026-11-01T09:00:00.000Z",      "readAt": "2026-11-01T09:00:00.000Z",      "replies": [        {          "type": "button",          "buttonId": "shop",          "text": "string",          "receivedAt": "2026-11-01T09:00:00.000Z",          "messageId": "wamid.HBgM",          "providerMessageId": "wamid.HBgM"        }      ],      "error": {        "code": "string",        "title": "string",        "failedAt": "2026-11-01T09:00:00.000Z"      }    }  ],  "nextCursor": null}