Skip to Content
1MSG
ReferenceCampaigns API

Erros por motivo

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

Agrupa por motivo os destinatários com falha e os pulados. type é failed ou skipped. recipientsLimit é quantos destinatários incluir por motivo, padrão 20, máximo 100. Cada destinatário inclui providerConversationId e providerMessageId.

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

recipientsLimit?number

Destinatários mostrados por motivo. Padrão 20, máximo 100.

type?string

failed mantém os erros de envio. skipped mantém os destinatários que não receberam o envio. Sem o parâmetro, vêm os dois.

Value in"failed""skipped"

Response Body

application/json
  1. response
campaignId*string

id da campanha.

items*array<>

Erros agrupados por motivo, código, título e tipo.

Example Request
curl -X GET 'https://api.1msg.io/api/v1/campaigns/string/analytics/errors'
Example Response200
{  "campaignId": "cm3campaign01",  "items": [    {      "reason": "closed_window",      "code": "string",      "title": "string",      "type": "failed",      "count": 2,      "share": 0.1667,      "recipients": [        {          "id": "cm3recipient01",          "phone": "+15551234567",          "bsuid": "ab.abc123xyz",          "name": "Ana",          "conversationId": "cm3dialog01",          "messageId": "wamid.HBgM",          "providerConversationId": "[email protected]",          "providerMessageId": "wamid.HBgM"        }      ],      "hasMore": false    }  ]}