notifications
POST /v1/notification-connections/{connection_id}/verify
Send a real test message to a destination.
Аутентификация
API кілтін bearer токені ретінде жіберіңіз. Бұл соңғы нүкте сипаттамада арнайы рұқсатты көрсетпейді, сондықтан болжағаннан гөрі кілтіңізге қажетті ең аз рұқсатты беріп, жауапты тексеріңіз.
Ұйымыңыздың идентификаторы орналасатын жер
Бұл соңғы нүкте сұрау параметрі ретінде org_id мәнін қабылдайды. Оны бос қалдырсаңыз, шақыру бүкіл жалға алушы тармағын қамтиды; шақыруды бір ұйымға шектеу үшін оны жіберіңіз.
Сіздің ұйым идентификаторыңыз басқару панеліндегі API кілттері экранында, кілттің өзінің жанында орналасқан. Бұл сіз жасайтын әрбір шақырудағы бірдей идентификатор.
Әрекет етіп көру
Бұрыштық жақшалардағы кез келген нәрсені өз мәндеріңізбен, ал кілт орналастырушысын басқару тақтасынан алынған кілтпен алмастырыңыз.
curl -X POST https://api.zinndigital.com/v1/notification-connections/{connection_id}/verify \
-H "Authorization: Bearer zdk_live_…"Жүйеге кіргенсіз бе? Бақылау тақтасындағы API консолі ұйымыңыздың нақты идентификаторы мен жеке кілтіңізді автоматты түрде толтырады да, нақты жауапты көре алуыңыз үшін сұрауды тікелей жұмыс істеп тұрған API арқылы орындайды. Бұл соңғы нүктені API консолінде ашыңыз
Мәліметтер
Sends an actual message and records what happened. It does not check that the destination looks plausible; nothing may be routed to a connection until this has succeeded.
Параметрлер
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
connection_id (path) | string | Иә | — |
org_id (query) | string | Жоқ | The organization to act on. Omitted resolves to your own ONLY when you belong to exactly one organisation; a principal in more than one must name it, or the call is refused `422… |
Жауап
| Аты | Tүрі | Міндетті | Мазмұны |
|---|---|---|---|
verified | boolean | Жоқ | — |
awaiting_confirmation | boolean | Жоқ | An e-mail destination has been sent its confirmation link and is waiting for the recipient to click it. Not verified, and not a failure. |
unknown | boolean | Жоқ | ⛔⛔ We could not CHECK - which is not the same as *it failed*, and until W39-AM this response could not say the difference. Both were `verified: false`, so a credential-store bli… |
error | string | Жоқ | Safe to display - never contains a credential. |