mail

GET /v1/mail/services

List the organization's email services.

mail အားလုံးသော အဆုံးသတ်များ

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

API သော့တစ်ခုကို bearer token အဖြစ် ပို့ပါ။ သော့တွင် mail.view ခွင့်ပြုချက် ပါရှိရမည်ဖြစ်ပြီး၊ ၎င်းမပါရှိသော သော့ကို 404 အစား 403 ဖြင့် ငြင်းပယ်ပါမည်။

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

ဤအစွန်အဖျား (endpoint) သည် org_id ကို မေးမြန်းချက် ကန့်သတ်ဘောင် (query parameter) အဖြစ် လက်ခံပါသည်။ ၎င်းကို ချန်လှပ်ထားပါက ခေါ်ဆိုမှုသည် သင်၏ ငှားရမ်းမှု လက်အောက်ခံသစ်ပင် (tenancy subtree) တစ်ခုလုံးကို လွှမ်းခြုံမည်ဖြစ်ပြီး၊ အဖွဲ့အစည်းတစ်ခုတည်းသို့ ကန့်သတ်ခေါ်ဆိုရန် ၎င်းကို ပေးပို့ပါ။

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

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

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

curl -X GET https://api.zinndigital.com/v1/mail/services \
  -H "Authorization: Bearer zdk_live_…"

ဝင်ရောက်ပြီးပြီလား။ သင့်ဒက်ရှ်ဘုတ်ရှိ API ကွန်ဆိုးလ်တွင် သင့်၏ တကယ့်အဖွဲ့အစည်း ID နှင့် သင့်ကိုယ်ပိုင်သော့ချက်တို့ဖြင့် ဖြည့်သွင်းပေးပြီး တကယ့်တုံ့ပြန်ချက်ကို သင်မြင်နိုင်ရန် တိုက်ရိုက် API (live API) ကို အသုံးပြု၍ တောင်းဆိုမှုကို လုပ်ဆောင်ပေးပါသည်။ ဤအဆုံးသတ်အမှတ် (endpoint) ကို API ကွန်ဆိုးလ်တွင် ဖွင့်ပါ

အသေးစိတ်အချက်အလက်များ

Every domain the organization has email on, cursor-paginated and RLS-scoped. Requires `mail.view`.

ကန့်သတ်ဘောင်များ

နာမည်အမျိုးအစားလိုအပ်သည်ဘာလဲဆိုတာ
cursor (query)stringမဟုတ်ပါOpaque cursor from a previous page's `page.next_cursor`.
limit (query)integerမဟုတ်ပါMaximum items to return (page size).
org_id (query)Uuidမဟုတ်ပါRestrict to one organization in scope. **Narrowing only** — the value is intersected with what the caller may already read, so an organization outside their subtree filters to n…
fqdn (query)stringမဟုတ်ပါReturn only the service on this exact hostname (normalised: lowercased, trailing dot stripped). ⛔ **A site surface must use this rather than searching the list.** The list is pa…
site_id (query)stringမဟုတ်ပါReturn only the mail services on the hostnames this **site** serves. Resolved through the site's domains, not through a stored column — mail attaches to a domain and a domain ou…
worker_id (query)stringမဟုတ်ပါReturn only the mail services belonging to the sites on this **fleet worker**. Mail has no server of its own — it runs at the mail backend, not on the box serving the website —…
compute_server_id (query)stringမဟုတ်ပါAs `worker_id`, for a cloud `ComputeServer` rather than a fleet worker. The two are different machine kinds and are not interchangeable.

တုံ့ပြန်ချက်

နာမည်အမျိုးအစားလိုအပ်သည်ဘာလဲဆိုတာ
dataMailService[]ဟုတ်ကဲ့
pagePageMetaဟုတ်ကဲ့

ဤအမှတ်ဆက်မှ ပြန်ပေးနိုင်သော အမှားများ

401 · 403 · 429