Skip to Content
1MSG
ReferenceCampaigns API

Respostas

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

replyType é button ou text. buttonId filtra um botão. phone e bsuid filtram um destinatário. dateFrom e dateTo são ISO-8601. providerConversationId é o id do chat no provedor. messageId e providerMessageId são o id da mensagem no provedor.

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

replyType?string

button mantém os toques em botões. text mantém as respostas em texto livre. Sem o parâmetro, vêm os dois.

Value in"button""text"
buttonId?string

id de um botão do template.

phone?string

Telefone E.164 de um destinatário.

bsuid?string

BSUID de um destinatário no provedor, por exemplo ab.abc123xyz.

dateFrom?string

Início em ISO-8601, inclusivo, por exemplo 2026-11-01T00:00:00Z.

dateTo?string

Fim em ISO-8601, inclusivo, por exemplo 2026-11-02T00:00:00Z.

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
campaignId*string

id da campanha.

totalReplies*number

Total de respostas da campanha inteira, não só desta página.

uniqueRepliers*number

Quantos destinatários responderam pelo menos uma vez na campanha inteira.

items*array<>

Respostas desta página, as mais antigas primeiro.

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/replies'
Example Response200
{  "campaignId": "cm3campaign01",  "totalReplies": 4,  "uniqueRepliers": 3,  "items": [    {      "type": "button",      "buttonId": "shop",      "text": "string",      "phone": "+15551234567",      "bsuid": "ab.abc123xyz",      "name": "Ana",      "conversationId": "cm3dialog01",      "providerConversationId": "[email protected]",      "receivedAt": "2026-11-01T09:00:00.000Z",      "messageId": "wamid.HBgM",      "providerMessageId": "wamid.HBgM"    }  ],  "nextCursor": null}