Uthibitishaji
Tuma ufunguo wa API kama tokeni ya kubeba. Ufunguo lazima uwe na ruhusa ya livechat.manage; ufunguo usio nayo unakataliwa kwa 403, si 404.
Mahali ambapo kitambulisho cha shirika lako huwekwa
Sehemu hii ya mwisho inachukua org_id kama uwanja katika mwili wa JSON.
Kitambulisho cha shirika lako kipo kwenye skrini ya funguo za API katika dashibodi yako, kando ya ufunguo wenyewe. Ni kitambulisho kile kile katika kila ombi unalofanya.
Jaribu
Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API
Maelezo
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.
Mwili wa ombi
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
org_id | string | Hapana | — |
site_id | string | Hapana | — |
name | string | Ndiyo | — |
team_name | string | Hapana | — |
allowed_origins | string[] | Hapana | — |
Majibu
| Jina | Aina | Inayohitajika | Kilicho hiki |
|---|---|---|---|
id | string | Ndiyo | — |
site_id | string | Ndiyo | — |
name | string | Ndiyo | — |
public_key | string | Ndiyo | — |
enabled | boolean | Ndiyo | 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[] | Ndiyo | 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 | Ndiyo | — |
greeting | string | Ndiyo | — |
team_name | string | Ndiyo | — |
accent_colour | string | Ndiyo | — |
position | string<left, right> | Ndiyo | — |
hide_branding | boolean | Ndiyo | — |
ai_enabled | boolean | Ndiyo | — |
offline_email | string | Ndiyo | — |
business_hours | object | Hapana | — |
open_now | boolean | Ndiyo | — |
ai_allowance | ChatAiAllowance | Ndiyo | — |
limits | object | Ndiyo | — |
premium_extra_code | string | Ndiyo | The catalogue code to buy for the premium tier. |
Hitilafu ambazo mwisho huu unaweza kurudisha
401 · 403 · 422