notifications
POST /v1/notification-connections/{connection_id}/verify
Send a real test message to a destination.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树;发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上,就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/notification-connections/{connection_id}/verify \
-H "Authorization: Bearer zdk_live_…"已登录?您仪表板中的 API 控制台会自动填入您真实的组织 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. |