notifications
POST /v1/notification-connections/{connection_id}/verify
Send a real test message to a destination.
ਪ੍ਰਮਾਣੀਕਰਨ
ਇੱਕ API ਕੁੰਜੀ ਨੂੰ ਬੀਅਰ ਟੋਕਨ ਵਜੋਂ ਭੇਜੋ। ਇਹ ਐਂਡਪੁਆਇੰਟ ਸਪੈਸੀਫਿਕੇਸ਼ਨ ਵਿੱਚ ਕਿਸੇ ਖਾਸ ਇਜਾਜ਼ਤ ਨੂੰ ਨਹੀਂ ਦਰਸਾਉਂਦਾ, ਇਸ ਲਈ ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਘੱਟੋ-ਘੱਟ ਲੋੜੀਂਦੀਆਂ ਇਜਾਜ਼ਤਾਂ ਦਿਓ ਅਤੇ ਮੰਨਣ ਦੀ ਬਜਾਏ ਜਵਾਬ ਦੀ ਜਾਂਚ ਕਰੋ।
ਜਿੱਥੇ ਤੁਹਾਡੀ ਸੰਸਥਾ ਦੀ ਆਈਡੀ ਆਉਂਦੀ ਹੈ
ਇਹ ਐਂਡਪੁਆਇੰਟ org_id ਨੂੰ ਇੱਕ ਕੌਂਸਲ ਪੈਰਾਮੀਟਰ ਵਜੋਂ ਲੈਂਦਾ ਹੈ। ਇਸਨੂੰ ਛੱਡ ਦਿਓ ਅਤੇ ਕਾਲ ਤੁਹਾਡੇ ਪੂਰੇ ਟੈਨੈਂਸੀ ਸਬਟ੍ਰੀ ਨੂੰ ਕਵਰ ਕਰੇਗੀ; ਕਾਲ ਨੂੰ ਇੱਕ ਸੰਸਥਾ ਤੱਕ ਸੀਮਤ ਕਰਨ ਲਈ ਇਸਨੂੰ ਭੇਜੋ।
ਤੁਹਾਡੀ ਸੰਸਥਾ ਦੀ ਆਈਡੀ ਤੁਹਾਡੇ ਡੈਸ਼ਬੋਰਡ 'ਤੇ API ਕੁੰਜੀਆਂ ਵਾਲੀ ਸਕ੍ਰੀਨ 'ਤੇ, ਕੁੰਜੀ ਦੇ ਬਿਲਕੁਲ ਨਾਲ ਮੌਜੂਦ ਹੈ। ਇਹ ਤੁਹਾਡੇ ਵੱਲੋਂ ਕੀਤੀ ਜਾਣ ਵਾਲੀ ਹਰ ਕਾਲ ਵਿੱਚ ਉਹੀ ਆਈਡੀ ਹੁੰਦੀ ਹੈ।
ਕੋਸ਼ਿਸ਼ ਕਰੋ
ਕੋਈ ਵੀ ਚੀਜ਼ ਜੋ ਕੋਣ ਵਾਲੇ ਬਰੈਕਟਾਂ ਵਿੱਚ ਹੈ ਉਸਨੂੰ ਆਪਣੇ ਖੁਦ ਦੇ ਮੁੱਲਾਂ ਨਾਲ ਬਦਲੋ, ਅਤੇ ਕੁੰਜੀ ਪਲੇਸਹੋਲਡਰ ਨੂੰ ਆਪਣੇ ਡੈਸ਼ਬੋਰਡ ਦੀ ਇੱਕ ਕੁੰਜੀ ਨਾਲ ਬਦਲੋ।
curl -X POST https://api.zinndigital.com/v1/notification-connections/{connection_id}/verify \
-H "Authorization: Bearer zdk_live_…"ਲੌਗ ਇਨ ਕੀਤਾ ਹੋਇਆ ਹੈ? ਤੁਹਾਡੇ ਡੈਸ਼ਬੋਰਡ ਵਿੱਚ API ਕੰਸੋਲ ਤੁਹਾਡੀ ਅਸਲ ਸੰਸਥਾ ਆਈਡੀ (organisation id) ਅਤੇ ਤੁਹਾਡੀ ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਭਰਦਾ ਹੈ, ਅਤੇ ਲਾਈਵ 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.
ਪੈਰਾਮੀਟਰ
| ਨਾਮ | ਕਿਸਮ | ਲਾਜ਼ਮੀ | ਕੀ ਹੈ ਇਹ |
|---|---|---|---|
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… |
ਜਵਾਬ
| ਨਾਮ | ਕਿਸਮ | ਲਾਜ਼ਮੀ | ਕੀ ਹੈ ਇਹ |
|---|---|---|---|
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. |