API

ჩატის ინტეგრაციების სიის მიღება

GET/api/crm/v2/integration_chatsv2
operationId: integrationChats.default

აბრუნებს ჩატის სერვისებს. თითოეული სერვისისთვის გადმოიცემა პარამეტრები: პარამეტრების ველები, ბმულები ვებგვერდზე და ვიკიზე, ასევე ვებჰუკის URL, რომელიც შექმნილია ფილიალისთვის. პარამეტრი branch_id სავალდებულოა.

ავტორიზაცია

api-token + language + role

მოთხოვნის პარამეტრები

branch_idinteger

მაგალითი: 1

პასუხები

OK

object
statusstringსავალდებულო

მნიშვნელობები:successerror

მაგალითი: success

dataobject
filtersobjectსავალდებულო
branch_idobject (FilterSelectInteger)
valueinteger

მაგალითი: 8920

typestringსავალდებულო

მაგალითი: select

optionarray of object
valueintegerსავალდებულო

მაგალითი: 8920

namestringსავალდებულო

მაგალითი: Green Basket | Kaliningrad

modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

settingsobject
idintegerსავალდებულო

მაგალითი: 1

namestringსავალდებულო

მაგალითი: google

chat_enabledboolean

მაგალითი: true

listarray of object
idintegerსავალდებულო

მაგალითი: 1

namestringსავალდებულო

მაგალითი: Google

system_namestring

მაგალითი: Google

sitestringსავალდებულო

მაგალითი: https://developer.tech.yandex.ru

wikistring

მაგალითი: https://wiki.foodsoul.pro/i/97

fieldsarray of objectსავალდებულო
encryptedbooleanსავალდებულო

დაშიფრული ველი; შესაყვანად გამოიყენეთ „პაროლის“ ტიპის ველი

მაგალითი: true

namestringსავალდებულო

მაგალითი: api_key

valuestring

მაგალითი: secretkey

webhookstringსავალდებულო

მაგალითი: https://ru.foodsoul.test/webhook/chat/verbox/?token=f20138c54eaaad6c00ac77d27b2f4cb4