ການພິສູດຕົວຕົນ
ສົ່ງລະຫັດ API ເປັນ bearer token. ລະຫັດຕ້ອງມີສິດ livechat.manage; ລະຫັດທີ່ບໍ່ມີສິດດັ່ງກ່າວຈະຖືກປະຕິເສດດ້ວຍລະຫັດ 403, ບໍ່ແມ່ນ 404.
ບ່ອນທີ່ລະບົບຈັດການອົງກອນຂອງທ່ານໄປ
ຈຸດສິ້ນສຸດນີ້ຮັບເອົາ org_id ເປັນຊ່ອງຂໍ້ມູນໃນ JSON body.
ລະຫັດອົງກອນຂອງທ່ານແມ່ນຢູ່ໜ້າກະແຈ API ໃນແຜງຄວບຄຸມຂອງທ່ານ, ຖັດຈາກກະແຈ itself. ມັນແມ່ນລະຫັດດຽວກັນໃນທຸກໆການໂທທີ່ທ່ານເຮັດ.
ລອງໃຊ້ເບິ່ງ
ປ່ຽນແທນທຸກຢ່າງທີ່ຢູ່ໃນວົງເລັບມຸມດ້ວຍຄ່າຂອງທ່ານເອງ, ແລະ ປ່ຽນແທນຕົວແທນບ່ອນວ່າງຄີດ້ວຍຄີຈາກແຜງຄວບຄຸມຂອງທ່ານ.
curl -X POST https://api.zinndigital.com/v1/chat/widgets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'ເຂົ້າສູ່ລະບົບແລ້ວບໍ? ໂຄງສົນທະນາ API ໃນໜ້າັດສະຫຼອງຂອງທ່ານຈະຕື່ມຂໍ້ມູນລະຫັດອົງກອນຕົວຈິງ ແລະ ລະຫັດລັບສ່ວນຕົວຂອງທ່ານໂດຍອັດຕະໂນມັດ, ແລະ ປະຕິບັດການຮ້ອງຂໍຜ່ານ 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