身份验证
请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 livechat.manage 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。
您的组织 ID 应填在此处
此端点接受 org_id 作为 JSON 正文中的一个字段。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Requires `livechat.manage`. The new widget is created **switched off**: a chat window that starts talking to a customer's visitors before they have asked for one is a consent problem, not a feature.
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
org_id | string | 否 | — |
site_id | string | 否 | — |
name | string | 是 | — |
team_name | string | 否 | — |
allowed_origins | string[] | 否 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | string | 是 | — |
site_id | string | 是 | — |
name | string | 是 | — |
public_key | string | 是 | — |
enabled | boolean | 是 | Whether the chat renders. Created FALSE always: the plugin ships in the deploy footprint of every WordPress site we host, so a widget may exist for a customer who never asked fo… |
allowed_origins | string[] | 是 | Origins the widget may be embedded on. An EMPTY list refuses every page rather than allowing any — this is the only control stopping somebody else's site opening conversations a… |
tier | string | 是 | — |
greeting | string | 是 | — |
team_name | string | 是 | — |
accent_colour | string | 是 | — |
position | string<left, right> | 是 | — |
hide_branding | boolean | 是 | — |
ai_enabled | boolean | 是 | — |
offline_email | string | 是 | — |
business_hours | object | 否 | — |
open_now | boolean | 是 | — |
ai_allowance | ChatAiAllowance | 是 | — |
limits | object | 是 | — |
premium_extra_code | string | 是 | The catalogue code to buy for the premium tier. |
此端点可能返回的错误
401 · 403 · 422