Campaigns

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

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

စစ်မှန်ကြောင်း အတည်ပြုခြင်း

API သော့တစ်ခုကို bearer token အဖြစ် ပေးပို့ပါ။ ဤ အမှတ်အသားအဆုံး (endpoint) သည် သတ်မှတ်ချက်တွင် တိကျသော ခွင့်ပြုချက်တစ်ခုကို မဖော်ပြထားပါသဖြင့်၊ သင့်သော့ကို အနည်းဆုံး လိုအပ်သည်များသာ ပေးအပ်ပြီး မူလအခြေအနေကို ယူဆမည့်အစား တုံ့ပြန်မှုကို စစ်ဆေးပါ။

သင့်အဖွဲ့အစည်း၏ id ထည့်သွင်းရမည့်နေရာ

ဤအစွန်းဆုံးနေရာသည် JSON ခန္ဓာကိုယ်အတွင်းရှိ ကွင်းတစ်ခုအနေဖြင့် org_id ကို ယူပါသည်။

သင့်အဖွဲ့အစည်း id သည် သင်၏ ဒက်ရှ်ဘုတ်ရှိ API သော့များ မျက်နှာပြင်တွင်၊ သော့၏ ဘေး၌ ရှိပါသည်။ ၎င်းသည် သင်ပြုလုပ်သည့် ခေါ်ဆိုမှုတိုင်းတွင် တူညီသော id ဖြစ်ပါသည်။

စမ်းကြည့်ရန်

ထောင့်ချိတ်များအတွင်းရှိ မည်သည့်အရာကိုမဆို သင်၏ကိုယ်ပိုင်တန်ဖိုးများဖြင့် အစားထိုးပြီး သင့်ဒက်ရှ်ဘုတ်မှ သော့ချက်တစ်ခုဖြင့် key ကို အစားထိုးပါ။

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 (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို 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