Campaigns

POST `/v1/campaigns/{campaignId}/test`

Send one real message on the channel the campaign will actually use.

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Където отива идентификаторът на вашата организация

Този краен пункт приема org_id като поле в JSON тялото.

ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

curl -X POST https://api.zinndigital.com/v1/campaigns/{campaignId}/test \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

A real send through the real provider, not a preview. The value of a test send is that it proves the account, the domain, the From header and the rendering all work together — which a preview cannot, because it touches none of them. ⛔ It goes out on the channel the CAMPAIGN uses. A campaign whose channels are `["slack"]` has no account, no domain and no From header to prove, so an e-mailed test would exercise nothing the send would do; it posts to a verified connected destination instead. `to` is therefore required only when the campaign sends by e-mail — for a connected channel the destination is the organisation's own verified connection and is never accepted from the caller.

Параметри

Име	Тип	Задължително	Какво представлява
`campaignId (path)`	`string`	Да	—

Тяло на заявката

Име	Тип	Задължително	Какво представлява
`to`	`string`	Не	Required when the campaign sends by e-mail; ignored otherwise.
`org_id`	`string`	Не	—

Отговор

Име	Тип	Задължително	Какво представлява
`sent`	`boolean`	Да	—
`provider`	`string`	Да	—
`channel`	`string`	Да	The channel the test actually went out on.
`to`	`string`	Да	Where it went. ⛔ Not `format: email` — on a connected channel this is the destination (`#announcements`, a chat id), and declaring it an e-mail address would make a truthful res…
`from`	`string`	Да	Empty on a connected channel, which has no From header.

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422