Campaigns

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

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

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Mahali ambapo kitambulisho cha shirika lako huwekwa

Sehemu hii ya mwisho inachukua org_id kama uwanja katika mwili wa JSON.

Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`campaignId (path)`	`string`	Ndiyo	—

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`to`	`string`	Hapana	Required when the campaign sends by e-mail; ignored otherwise.
`org_id`	`string`	Hapana	—

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`sent`	`boolean`	Ndiyo	—
`provider`	`string`	Ndiyo	—
`channel`	`string`	Ndiyo	The channel the test actually went out on.
`to`	`string`	Ndiyo	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`	Ndiyo	Empty on a connected channel, which has no From header.

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422