ReferenceCampaigns API
Ошибки по причинам
GET
Группирует получателей с ошибкой и пропущенных по причине. type — failed или skipped. recipientsLimit — сколько получателей показать на каждую причину, по умолчанию 20, максимум 100. У каждого получателя есть providerConversationId и providerMessageId.
bearerheader
AuthorizationBearer <API key>Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.
campaignId*stringid рассылки из ответа на создание или из списка.
recipientsLimit?numberСколько получателей показать на каждую причину. По умолчанию 20, максимум 100.
type?stringfailed оставляет ошибки отправки. skipped — получателей, которым не отправили. Без параметра вернутся оба вида.
Value in
"failed""skipped"application/json- response
campaignId*stringid рассылки.
items*array<>Ошибки, сгруппированные по причине, коду, заголовку и типу.
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 } ]}