Отправить тестовое сообщение
Отправляет содержимое черновика одному получателю. Статус и аналитика рассылки не меняются. Передайте ровно одно из двух: phone (E.164) или bsuid (формат провайдера). Отказ провайдера — это ошибка, а не принятая отправка. conversationId — диалог в Inbox. messageId и providerMessageId — один и тот же id сообщения у провайдера или null, если провайдер принял отправку без id.
bearerAuthorizationBearer <API key>Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.
campaignId*stringid рассылки из ответа на создание или из списка.
application/json- body
phone?stringТелефон в формате E.164, например +15551234567. Передайте ровно одно: phone или bsuid. Статус и аналитика рассылки не меняются.
bsuid?stringBSUID у провайдера, например ab.abc123xyz. Окончание @lid допускается. Передайте ровно одно: phone или bsuid.
application/json- response
accepted*booleanВсегда true, если тест принят.
campaignId*stringid рассылки.
campaignStatus*stringСтатус рассылки после теста. Тест его не меняет.
"draft""sending""pause""completed""failed""scheduled"excludedFromAnalytics*booleanВсегда true. Эта отправка не попадает в аналитику.
conversationId*|id диалога в Inbox или null, если провайдер его не вернул.
messageId*|id сообщения у провайдера или null, если провайдер принял отправку без id.
providerMessageId*|То же значение, что messageId.
phone?stringТелефон в формате E.164. Есть, если тест отправлен на телефон. Возвращается ровно одно: phone или bsuid.
bsuid?stringBSUID у провайдера. Есть, если тест отправлен на BSUID. Возвращается ровно одно: phone или bsuid.
curl -X POST 'https://api.1msg.io/api/v1/campaigns/string/test' \ -H 'Content-Type: application/json' \ -d '{}'{ "accepted": true, "campaignId": "cm3campaign01", "campaignStatus": "draft", "excludedFromAnalytics": true, "conversationId": "cm3dialog01", "messageId": "wamid.HBgM", "providerMessageId": "wamid.HBgM", "phone": "+15551234567", "bsuid": "ab.abc123xyz"}