Campaigns

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

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

ప్రమాణీకరణ

ఒక API కీని బేరర్ టోకెన్‌గా పంపండి. ఈ ఎండ్‌పాయింట్ స్పెసిఫికేషన్‌లో నిర్దిష్ట అనుమతిని పేర్కొనలేదు, కాబట్టి ఊహించడం కంటే మీ కీకి అవసరమైన కనిష్ట అనుమతిని ఇవ్వండి మరియు ప్రతిస్పందనను తనిఖీ చేయండి.

మీ సంస్థ ఐడీ ఎక్కడ ఉందో అక్కడ

ఈ ఎండ్‌పాయింట్ JSON బాడీలో ఫీల్డ్‌గా org_id ని తీసుకుంటుంది.

మీ సంస్థ ఐడి (organisation id) మీ డాష్‌బోర్డ్‌లోని API కీస్ స్క్రీన్‌పై, కీ పక్కనే ఉంటుంది. మీరు చేసే ప్రతి కాల్‌లోనూ ఇదే ఐడి ఉపయోగించబడుతుంది.

ప్రయత్నించండి

కోణీయ బ్రాకెట్‌లలో ఉన్న దేన్నైనా మీ స్వంత విలువలతో భర్తీ చేయండి, మరియు కీ ప్లేస్‌హోల్డర్‌ను మీ డాష్‌బోర్డ్ నుండి తీసుకున్న కీతో భర్తీ చేయండి.

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

సైన్ ఇన్ చేశారా? మీ డ్యాష్‌బోర్డ్‌లోని API కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ API ద్వారా ఆభ్యర్థనను రన్ చేస్తుంది. ఈ ఎండ్‌పాయింట్‌ను 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.

ఈ ఎండ్‌పాయింట్ తిరిగి ఇవ్వగల లోపాలు

401 · 403 · 404 · 422

POST /v1/campaigns/{campaignId}/test