Skip to Content
1MSG
ReferenceCampaigns API

Ошибки по причинам

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

Группирует получателей с ошибкой и пропущенных по причине. type — failed или skipped. recipientsLimit — сколько получателей показать на каждую причину, по умолчанию 20, максимум 100. У каждого получателя есть providerConversationId и providerMessageId.

Authorization

bearer
headerAuthorizationBearer <API key>

Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.

Path Parameters

campaignId*string

id рассылки из ответа на создание или из списка.

Query Parameters

recipientsLimit?number

Сколько получателей показать на каждую причину. По умолчанию 20, максимум 100.

type?string

failed оставляет ошибки отправки. skipped — получателей, которым не отправили. Без параметра вернутся оба вида.

Value in"failed""skipped"

Response Body

application/json
  1. response
campaignId*string

id рассылки.

items*array<>

Ошибки, сгруппированные по причине, коду, заголовку и типу.

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    }  ]}