node crisp api Скачать - загрузка node crisp api Скачать

Хрустящая обертка API

Хрустящая обертка узел API. Проверка подлинности, отправляйте сообщения, выбирайте разговоры, получайте доступ к учетным записям вашего агента из кода JavaScript.

Орушения : Справочник по API REST (V1) при пересмотре: 17/10/2024
? Содействия : @baptistejamin, @eliottvincent, @valeriansaliou

Установка

npm install --save crisp-api

Аутентификация

Для аутентификации против API получите класс токена аутентификации, следуя руководству аутентификации API REST. Вы получите токен -клавиш, сделанный из 2 значений.

Держите свои значения клавиш токена в частном порядке и храните их безопасно для долгосрочного использования.

Затем добавьте параметры аутентификации в экземпляр client сразу после его создания:

 var Crisp = require ( "crisp-api" ) ;
var CrispClient = new Crisp ( ) ;

// Authenticate to API with your plugin token (identifier, key)
// eg. CrispClient.authenticate("7c3ef21c-1e04-41ce-8c06-5605c346f73e", "cc29e1a5086e428fcc6a697d5837a66d82808e65c5cce006fbf2191ceea80a0a");
CrispClient . authenticateTier ( "plugin" , identifier , key ) ;

// Now, you can use authenticated API sections.

Обзор

Вы можете следовать руководству REST API QuickStart, которое заставит вас работать с REST API за считанные минуты.

 var Crisp = require ( "crisp-api" ) ;
var CrispClient = new Crisp ( ) ;

CrispClient . authenticateTier ( "plugin" , identifier , key ) ;

CrispClient . website . listConversations ( websiteID , 1 )
  . then ( function ( conversations ) {
    console . log ( "Listed conversations:" , conversations ) ;
  } )
  . catch ( function ( error ) {
    console . error ( "Error listing conversations:" , error ) ;
  } ) ;

Примеры

Создайте свой собственный бот!

 var Crisp = require ( "crisp-api" ) ;
var CrispClient = new Crisp ( ) ;

CrispClient . authenticateTier ( "plugin" , identifier , key ) ;

// Notice: make sure to authenticate before listening for an event
CrispClient . on ( "message:send" , function ( message ) {
  CrispClient . website . sendMessageInConversation (
    message . website_id , message . session_id ,

    {
      type    : "text" ,
      content : "I'm a bot" ,
      from    : "operator" , // or user
      origin  : "chat"
    }
  )
    . then ( function ( message ) {
      console . log ( "Message sent:" , message ) ;
    } )
    . catch ( function ( error ) {
      console . error ( "Error sending message:" , error ) ;
    } ) ;
} )
  . then ( function ( ) {
    console . error ( "Requested to listen to sent messages" ) ;
  } )
  . catch ( function ( error ) {
    console . error ( "Failed listening to sent messages:" , error ) ;
  } ) ;

Методы ресурсов

Все доступные ресурсы для API полностью реализованы. Имена программных методов названы в честь их названия метки в ссылке на API REST .

Все методы, которые вам, скорее всего, понадобятся при создании четкой интеграции, предварительно профиксированы с помощью звездного символа ().

️ Обратите внимание, что, в зависимости от вашего уровня токена аутентификации, который является либо user , либо plugin , вам может быть не разрешено использовать все методы из библиотеки. В случае сомнений обратитесь к описаниям методов библиотеки ниже. Скорее всего, вы используете токен plugin .

Веб -сайт

Веса веб -сайта
Сайт разговор
Сайт Люди
Веб -сайт helpdesk
Оператор веб -сайта
Доступность веб -сайта
Аналитика веб -сайта
Партия веб -сайта
Веб -сайт проверить
Кампании веб -сайта
Кампания веб -сайта

Плагин

Подключение плагина
Подписка на плагин

СМИ

СМИ анимация

Ведро

ВЕРКЕ URL

RTM события

Сессионные события
События сообщений
Люди события
Кампания
Просмотр событий
Позвонить событиям
События виджета
Статусные события
Веб -события
Коврик
СМИ
События по электронной почте
Плагиновые события

Веб -сайт

Веса веб -сайта

Списки разговоров [ user , plugin ]: ссылка

CrispClient.website.listConversations(websiteID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listConversations ( websiteID , pageNumber ) ;

Список предлагаемых сегментов разговора [ user , plugin ]: ссылка
- CrispClient.website.listSuggestedConversationSegments(websiteID, pageNumber)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSuggestedConversationSegments ( websiteID , pageNumber ) ;
```
Удалить предлагаемый сегмент разговора [ user , plugin ]: ссылка
- CrispClient.website.deleteSuggestedConversationSegment(websiteID, segment)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var segment = "bug" ;

CrispClient . website . deleteSuggestedConversationSegment ( websiteID , segment ) ;
```
Список предлагаемых ключей данных разговора [ user , plugin ]: ссылка
- CrispClient.website.listSuggestedConversationDataKeys(websiteID, pageNumber)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSuggestedConversationDataKeys ( websiteID , pageNumber ) ;
```
Удалить предлагаемый ключ данных разговора [ user , plugin ]: ссылка
- CrispClient.website.deleteSuggestedConversationDataKey(websiteID, key)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var key = "price" ;

CrispClient . website . deleteSuggestedConversationDataKey ( websiteID , key ) ;
```

Список разговоров спама [ user ]: Ссылка

CrispClient.website.listSpamConversations(websiteID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSpamConversations ( websiteID , pageNumber ) ;

Разрешить содержимое спам -разговора [ user ]: ссылка

CrispClient.website.resolveSpamConversationContent(websiteID, spamID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10" ;

CrispClient . website . resolveSpamConversationContent ( websiteID , spamID ) ;

Отправить решение о спам -разговоре [ user ]: Ссылка

CrispClient.website.submitSpamConversationDecision(websiteID, spamID, action)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var spamID = "b45e7d75-61ab-416c-858b-1919b5fcfd10" ;

var action = "reject" ;

CrispClient . website . submitSpamConversationDecision ( websiteID , spamID , action ) ;

Сайт разговор

Создайте новый разговор [ user , plugin ]: ссылка
- CrispClient.website.createNewConversation(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . createNewConversation ( websiteID ) ;
```

Проверьте, существует ли разговор [ user , plugin ]: ссылка

CrispClient.website.checkConversationExists(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . checkConversationExists ( websiteID , sessionID ) ;

Получить разговор [ user , plugin ]: ссылка

CrispClient.website.getConversation(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getConversation ( websiteID , sessionID ) ;

Удалить разговор [ user , plugin ]: ссылка

CrispClient.website.removeConversation(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . removeConversation ( websiteID , sessionID ) ;

Инициировать разговор с существующим сеансом [ user , plugin ]: ссылка

CrispClient.website.initiateConversationWithExistingSession(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . initiateConversationWithExistingSession ( websiteID , sessionID ) ;

Получить сообщения в разговоре [ user , plugin ]: ссылка

CrispClient.website.getMessagesInConversation(websiteID, sessionID, timestampBefore)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var timestampBefore = 1641206011000 ;

CrispClient . website . getMessagesInConversation ( websiteID , sessionID , timestampBefore ) ;

Отправить сообщение в разговоре [ user , plugin ]: ссылка

CrispClient.website.sendMessageInConversation(websiteID, sessionID, message)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var message = {
  "type" : "text" ,
  "from" : "operator" ,
  "origin" : "chat" ,
  "content" : "Hey there! Need help?"
} ;

CrispClient . website . sendMessageInConversation ( websiteID , sessionID , message ) ;

Получите сообщение в разговоре [ user , plugin ]: ссылка

CrispClient.website.getMessageInConversation(websiteID, sessionID, fingerprint)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var fingerprint = 524653764345 ;

CrispClient . website . getMessageInConversation ( websiteID , sessionID , fingerprint ) ;

Обновите сообщение в разговоре [ user , plugin ]: ссылка

CrispClient.website.updateMessageInConversation(websiteID, sessionID, fingerprint, content)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var fingerprint = 524653764345 ;

var content = "Hey there! Need help?" ;

CrispClient . website . updateMessageInConversation ( websiteID , sessionID , fingerprint , content ) ;

Удалить сообщение в разговоре [ user , plugin ]: ссылка

CrispClient.website.removeMessageInConversation(websiteID, sessionID, fingerprint)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var fingerprint = 524653764345 ;

CrispClient . website . removeMessageInConversation ( websiteID , sessionID , fingerprint ) ;

Составьте сообщение в разговоре [ user , plugin ]: ссылка

CrispClient.website.composeMessageInConversation(websiteID, sessionID, compose)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var compose = {
  "type" : "start" ,
  "from" : "operator"
} ;

CrispClient . website . composeMessageInConversation ( websiteID , sessionID , compose ) ;

Отметьте сообщения как прочитание в разговоре [ user , plugin ]: ссылка

CrispClient.website.markMessagesReadInConversation(websiteID, sessionID, read)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var read = {
  "from" : "operator" ,
  "origin" : "urn:crisp.im:slack:0" ,
  "fingerprints" : [
    "5719231201"
  ]
} ;

CrispClient . website . markMessagesReadInConversation ( websiteID , sessionID , read ) ;

Отметьте сообщения, доставленные в разговоре [ user , plugin ]: ссылка

CrispClient.website.markMessagesDeliveredInConversation(websiteID, sessionID, delivered)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var delivered = {
  "from" : "operator" ,
  "origin" : "urn:crisp.im:slack:0" ,
  "fingerprints" : [
    "5719231201"
  ]
} ;

CrispClient . website . markMessagesDeliveredInConversation ( websiteID , sessionID , delivered ) ;

Обновить разговор открытый состояние [ user , plugin ]: ссылка

CrispClient.website.updateConversationOpenState(websiteID, sessionID, opened)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var opened = true ;

CrispClient . website . updateConversationOpenState ( websiteID , sessionID , opened ) ;

Получить маршрутизацию разговора. Назначить [ user , plugin ]: ссылка

CrispClient.website.getConversationRoutingAssign(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getConversationRoutingAssign ( websiteID , sessionID ) ;

Назначить маршрутизацию разговора [ user , plugin ]: ссылка

CrispClient.website.assignConversationRouting(websiteID, sessionID, assign)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var assign = {
  "assigned" : {
    "user_id" : "a4c32c68-be91-4e29-8a05-976e93abbe3f"
  }
} ;

CrispClient . website . assignConversationRouting ( websiteID , sessionID , assign ) ;

Обновление входящего входного ящика [ user , plugin ]: ссылка

CrispClient.website.updateConversationInbox(websiteID, sessionID, inboxID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var inboxID = "bf6935c9-43b3-4f8e-87ea-175c1e1ed1a9" ;

CrispClient . website . updateConversationInbox ( websiteID , sessionID , inboxID ) ;

Получите разговор metas [ user , plugin ]: ссылка

CrispClient.website.getConversationMetas(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getConversationMetas ( websiteID , sessionID ) ;

Обновление Metas Conternult Metas [ user , plugin ]: ссылка

CrispClient.website.updateConversationMetas(websiteID, sessionID, metas)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var metas = {
  "nickname" : "John Doe" ,
  "email" : "[email protected]" ,
  "segments" : [
    "happy" ,
    "customer" ,
    "love"
  ] ,
  "data" : {
    "type" : "customer" ,
    "signup" : "finished"
  }
} ;

CrispClient . website . updateConversationMetas ( websiteID , sessionID , metas ) ;

Получить исходное сообщение в разговоре [ user , plugin ]: ссылка

CrispClient.website.getOriginalMessageInConversation(websiteID, sessionID, originalID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var originalID = "2325a3c0-9b47-4fc6-b00e-111b752e44cd" ;

CrispClient . website . getOriginalMessageInConversation ( websiteID , sessionID , originalID ) ;

Список страниц разговора [ user , plugin ]: ссылка

CrispClient.website.listConversationPages(websiteID, sessionID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pageNumber = 1 ;

CrispClient . website . listConversationPages ( websiteID , sessionID , pageNumber ) ;

Список событий разговора [ user , plugin ]: ссылка

CrispClient.website.listConversationEvents(websiteID, sessionID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pageNumber = 1 ;

CrispClient . website . listConversationEvents ( websiteID , sessionID , pageNumber ) ;

Список файлов разговора [ user , plugin ]: ссылка

CrispClient.website.listConversationFiles(websiteID, sessionID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pageNumber = 1 ;

CrispClient . website . listConversationFiles ( websiteID , sessionID , pageNumber ) ;

Получить состояние разговора [ user , plugin ]: ссылка

CrispClient.website.getConversationState(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getConversationState ( websiteID , sessionID ) ;

Изменить состояние разговора [ user , plugin ]: ссылка

CrispClient.website.changeConversationState(websiteID, sessionID, state)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var state = "unresolved" ;

CrispClient . website . changeConversationState ( websiteID , sessionID , state ) ;

Получить участников разговора [ user , plugin ]: ссылка

CrispClient.website.getConversationParticipants(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getConversationParticipants ( websiteID , sessionID ) ;

Сохранить участников разговора [ user , plugin ]: ссылка

CrispClient.website.saveConversationParticipants(websiteID, sessionID, participants)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var participants = {
  "participants" : [
    {
      "type" : "email" ,
      "target" : "[email protected]"
    }
  ]
} ;

CrispClient . website . saveConversationParticipants ( websiteID , sessionID , participants ) ;

Получить статус блока для разговора [ user , plugin ]: ссылка

CrispClient.website.getBlockStatusForConversation(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getBlockStatusForConversation ( websiteID , sessionID ) ;

Блок входящих сообщений для разговора [ user , plugin ]: ссылка

CrispClient.website.blockIncomingMessagesForConversation(websiteID, sessionID, blocked)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var blocked = true ;

CrispClient . website . blockIncomingMessagesForConversation ( websiteID , sessionID , blocked ) ;

Получить статус проверки для разговора [ user , plugin ]: ссылка

CrispClient.website.getVerifyStatusForConversation(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getVerifyStatusForConversation ( websiteID , sessionID ) ;

Обновление проверки статуса для разговора [ user , plugin ]: ссылка

CrispClient.website.updateVerifyStatusForConversation(websiteID, sessionID, verified)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var verified = true ;

CrispClient . website . updateVerifyStatusForConversation ( websiteID , sessionID , verified ) ;

Запросить стенограмму электронной почты для разговора [ user , plugin ]: ссылка

CrispClient.website.requestEmailTranscriptForConversation(websiteID, sessionID, to, email)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var email = {
  "to" : "operator" ,
  "email" : "[email protected]"
} ;

CrispClient . website . requestEmailTranscriptForConversation ( websiteID , sessionID , to , email ) ;

Запросить чистку привязки чата для разговора [ user , plugin ]: ссылка

CrispClient.website.requestChatboxBindingPurgeForConversation(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . requestChatboxBindingPurgeForConversation ( websiteID , sessionID ) ;

Запросить отзывы пользователя для разговора [ user , plugin ]: ссылка

CrispClient.website.requestUserFeedbackForConversation(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . requestUserFeedbackForConversation ( websiteID , sessionID ) ;

Список сеансов просмотра для разговора [ user , plugin ]: ссылка

CrispClient.website.listBrowsingSessionsForConversation(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . listBrowsingSessionsForConversation ( websiteID , sessionID ) ;

Инициировать сеанс просмотра для разговора [ user , plugin ]: ссылка

CrispClient.website.initiateBrowsingSessionForConversation(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . initiateBrowsingSessionForConversation ( websiteID , sessionID ) ;

Отправить действие в существующий сеанс просмотра [ user , plugin ]: ссылка

CrispClient.website.sendActionToExistingBrowsingSession(websiteID, sessionID, browsingID, action)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa" ;

var action = "start" ;

CrispClient . website . sendActionToExistingBrowsingSession ( websiteID , sessionID , browsingID , action ) ;

Помощь существующему сеансу просмотра [ user , plugin ]: ссылка

CrispClient.website.assistExistingBrowsingSession(websiteID, sessionID, browsingID, assist)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var browsingID = "browsing_05a9392d-ff3f-45e7-b021-1179c45668fa" ;

var assist = {
  "action" : "mouse" ,
  "mouse" : {
    "x" : 0 ,
    "y" : 784
  }
} ;

CrispClient . website . assistExistingBrowsingSession ( websiteID , sessionID , browsingID , assist ) ;

Инициировать новый сеанс вызовов для разговора [ user , plugin ]: ссылка

CrispClient.website.initiateNewCallSessionForConversation(websiteID, sessionID, mode)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var mode = "audio" ;

CrispClient . website . initiateNewCallSessionForConversation ( websiteID , sessionID , mode ) ;

Получить постоянный сеанс вызова для разговора [ user , plugin ]: ссылка

CrispClient.website.getOngoingCallSessionForConversation(websiteID, sessionID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

CrispClient . website . getOngoingCallSessionForConversation ( websiteID , sessionID ) ;

Прервать текущий сеанс вызова для разговора [ user , plugin ]: ссылка

CrispClient.website.abortOngoingCallSessionForConversation(websiteID, sessionID, callID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56" ;

CrispClient . website . abortOngoingCallSessionForConversation ( websiteID , sessionID , callID ) ;

Передача передачи сигналов на продолжающемся сеансе вызовов [ user , plugin ]: ссылка

CrispClient.website.transmitSignalingOnOngoingCallSession(websiteID, sessionID, callID, payload)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var callID = "call_35a0c062-72fa-4095-a2a0-f9911d47ee56" ;

var payload = {
  "type" : "sdp" ,
  "payload" : { }
} ;

CrispClient . website . transmitSignalingOnOngoingCallSession ( websiteID , sessionID , callID , payload ) ;

Доставьте действие кнопки виджета для разговора [ user ]: ссылка

CrispClient.website.deliverWidgetButtonActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data, value)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;
var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292" ;
var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785" ;

var value = {
  "section_id" : "payments" ,
  "item_id" : "refund_on_stripe" ,
  "data" : {
    "invoice" : "D-1929-X"
  }
} ;

CrispClient . website . deliverWidgetButtonActionForConversation ( websiteID , sessionID , pluginID , sectionID , itemID , data , value ) ;

Доставьте действие извлечения данных виджета для разговора [ user ]: Ссылка

CrispClient.website.deliverWidgetDataFetchActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, data)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;
var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292" ;
var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785" ;

var data = {
  "section_id" : "payments" ,
  "item_id" : "unpaid_balance" ,
  "action" : "fetch" ,
  "data" : { }
} ;

CrispClient . website . deliverWidgetDataFetchActionForConversation ( websiteID , sessionID , pluginID , sectionID , itemID , data ) ;

Доставьте действие редактирования данных виджета для разговора [ user ]: ссылка

CrispClient.website.deliverWidgetDataEditActionForConversation(websiteID, sessionID, pluginID, sectionID, itemID, value)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;
var sectionID = "8f8d3041-6698-43b8-a559-ae93211e6292" ;
var itemID = "7631d7d8-4fe7-4ef8-9a36-31183dcd4785" ;

var data = {
  "section_id" : "payments" ,
  "item_id" : "unpaid_balance" ,
  "action" : "fetch" ,
  "data" : { }
} ;

CrispClient . website . deliverWidgetDataFetchActionForConversation ( websiteID , sessionID , pluginID , sectionID , itemID , data ) ;

Запланируйте напоминание для разговора [ user , plugin ]: ссылка

CrispClient.website.scheduleReminderForConversation(websiteID, sessionID, date, note)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var sessionID = "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881" ;

var note = {
  "date" : "2018-05-29T09:00:00Z" ,
  "note" : "Call this customer."
} ;

CrispClient . website . scheduleReminderForConversation ( websiteID , sessionID , date , note ) ;

Люди сайта (это ваши конечные пользователи)

Получить статистику людей [ user , plugin ]: ссылка
- CrispClient.website.getPeopleStatistics(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . getPeopleStatistics ( websiteID ) ;
```
Список предложенных людей сегментам [ user , plugin ]: ссылка
- CrispClient.website.listSuggestedPeopleSegments(websiteID, pageNumber)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSuggestedPeopleSegments ( websiteID , pageNumber ) ;
```

Удалить предложенные люди сегмент [ user , plugin ]: ссылка

CrispClient.website.deleteSuggestedPeopleSegment(websiteID, segment)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var segment = "poweruser" ;

CrispClient . website . deleteSuggestedPeopleSegment ( websiteID , segment ) ;

Список предложенных людей Ключи данных [ user , plugin ]: ссылка
- CrispClient.website.listSuggestedPeopleDataKeys(websiteID, pageNumber)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSuggestedPeopleDataKeys ( websiteID , pageNumber ) ;
```
Удалить предлагаемые люди Ключ данных [ user , plugin ]: ссылка
- CrispClient.website.deleteSuggestedPeopleDataKey(websiteID, key)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var key = "price" ;

CrispClient . website . deleteSuggestedPeopleDataKey ( websiteID , key ) ;
```
Список предложенных событий People [ user , plugin ]: ссылка
- CrispClient.website.listSuggestedPeopleEvents(websiteID, pageNumber)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listSuggestedPeopleEvents ( websiteID , pageNumber ) ;
```

Удалить предложенное событие People [ user , plugin ]: ссылка

CrispClient.website.deleteSuggestedPeopleEvent(websiteID, text)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var text = "Removed item from basket" ;

CrispClient . website . deleteSuggestedPeopleEvent ( websiteID , text ) ;

Перечислите профили людей [ user , plugin ]: ссылка

CrispClient.website.listPeopleProfiles(websiteID, pageNumber, searchField, searchOrder, searchOperator, searchFilter, searchText)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listPeopleProfiles ( websiteID , pageNumber , searchField , searchOrder , searchOperator , searchFilter , searchText ) ;

Добавить New People Profile [ user , plugin ]: ссылка

CrispClient.website.addNewPeopleProfile(websiteID, peopleProfile)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var peopleProfile = {
  "email" : "[email protected]" ,
  "person" : {
    "nickname" : "Valerian Saliou"
  }
} ;

CrispClient . website . addNewPeopleProfile ( websiteID , peopleProfile ) ;

Проверьте, существует ли профиль людей [ user , plugin ]: ссылка

CrispClient.website.checkPeopleProfileExists(websiteID, peopleID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

CrispClient . website . checkPeopleProfileExists ( websiteID , peopleID ) ;

Получить People Profile [ user , plugin ]: ссылка

CrispClient.website.getPeopleProfile(websiteID, peopleID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

CrispClient . website . getPeopleProfile ( websiteID , peopleID ) ;

Сохранить People Profile [ user , plugin ]: ссылка

CrispClient.website.savePeopleProfile(websiteID, peopleID, peopleProfile)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleProfile = {
  "email" : "[email protected]" ,
  "person" : {
    "nickname" : "Valerian Saliou"
  }
} ;

CrispClient . website . savePeopleProfile ( websiteID , peopleID , peopleProfile ) ;

Обновить People Profile [ user , plugin ]: ссылка

CrispClient.website.updatePeopleProfile(websiteID, peopleID, peopleProfile)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleProfile = {
  "email" : "[email protected]" ,
  "person" : {
    "nickname" : "Valerian Saliou"
  }
} ;

CrispClient . website . updatePeopleProfile ( websiteID , peopleID , peopleProfile ) ;

Удалить профиль людей [ user , plugin ]: ссылка

CrispClient.website.removePeopleProfile(websiteID, peopleID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

CrispClient . website . removePeopleProfile ( websiteID , peopleID ) ;

Перечислите люди разговоры [ user , plugin ]: ссылка

CrispClient.website.listPeopleConversations(websiteID, peopleID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;
var pageNumber = 1 ;

CrispClient . website . listPeopleConversations ( websiteID , peopleID , pageNumber ) ;

Перечислить кампании людей [ user ]: Ссылка

CrispClient.website.listPeopleCampaigns(websiteID, peopleID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;
var pageNumber = 1 ;

CrispClient . website . listPeopleCampaigns ( websiteID , peopleID , pageNumber ) ;

Добавить событие People [ user , plugin ]: ссылка

CrispClient.website.addPeopleEvent(websiteID, peopleID, peopleEvent)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleEvent = {
  "text" : "Added item to basket" ,
  "data" : {
    "price" : 10.99 ,
    "currency" : "USD"
  } ,
  "color" : "red"
} ;

CrispClient . website . addPeopleEvent ( websiteID , peopleID , peopleEvent ) ;

Перечислите события People [ user , plugin ]: ссылка

CrispClient.website.listPeopleEvents(websiteID, peopleID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;
var pageNumber = 1 ;

CrispClient . website . listPeopleEvents ( websiteID , peopleID , pageNumber ) ;

Получить данные людей [ user , plugin ]: ссылка

CrispClient.website.getPeopleData(websiteID, peopleID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

CrispClient . website . getPeopleData ( websiteID , peopleID ) ;

Сохранить данные людей [ user , plugin ]: ссылка

CrispClient.website.savePeopleData(websiteID, peopleID, peopleData)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleData = {
  "data" : {
    "type" : "customer" ,
    "signup" : "finished"
  }
} ;

CrispClient . website . savePeopleData ( websiteID , peopleID , peopleData ) ;

Обновление данных людей [ user , plugin ]: ссылка

CrispClient.website.updatePeopleData(websiteID, peopleID, peopleData)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleData = {
  "data" : {
    "signup" : "finished"
  }
} ;

CrispClient . website . updatePeopleData ( websiteID , peopleID , peopleData ) ;

Получить статус подписки People [ user , plugin ]: ссылка

CrispClient.website.getPeopleSubscriptionStatus(websiteID, peopleID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

CrispClient . website . getPeopleSubscriptionStatus ( websiteID , peopleID ) ;

Обновить статус подписки People [ user , plugin ]: ссылка

CrispClient.website.updatePeopleSubscriptionStatus(websiteID, peopleID, peopleSubscription)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var peopleID = "c5a2f70c-f605-4648-b47f-8c39d4b03a50" ;

var peopleSubscription = {
  "email" : true
} ;

CrispClient . website . updatePeopleSubscriptionStatus ( websiteID , peopleID , peopleSubscription ) ;

Экспорт людей профили [ user ]: Ссылка
- CrispClient.website.exportPeopleProfiles(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . exportPeopleProfiles ( websiteID ) ;
```

Импортные профили людей [ user ]: Ссылка

CrispClient.website.importPeopleProfiles(websiteID, profileImportSetup)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var profileImportSetup = {
  "url" : "https://storage.crisp.chat/users/processing/import/aa0b64dd-9fb4-4db9-80d6-5a49eb84087b/19d956c7-0294-45ad-89e1-58ce45e7008f.csv" ,
  "mapping" : [
    {
      "column" : 1 ,
      "field" : "email"
    } ,
    {
      "column" : 2 ,
      "field" : "person.nickname"
    }
  ] ,
  "options" : {
    "column_separator" : ";" ,
    "skip_header" : true
  }
} ;

CrispClient . website . importPeopleProfiles ( websiteID , profileImportSetup ) ;

Примечание: Arpeid peopleID может быть электронным письмом или peopleID .

Веб -сайт helpdesk

Проверьте, существует ли HelpDesk [ user , plugin ]: ссылка
- CrispClient.website.checkHelpdeskExists(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . checkHelpdeskExists ( websiteID ) ;
```

Resolve helpdesk [ user , plugin ]: ссылка

CrispClient.website.resolveHelpdesk(websiteID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . resolveHelpdesk ( websiteID ) ;

Инициализировать helpdesk [ user ]: ссылка

CrispClient.website.initializeHelpdesk(websiteID, name, domainBasic)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var name = "Valerian Helpdesk" ;
var domainBasic = "valerian" ;

CrispClient . website . initializeHelpdesk ( websiteID , name , domainBasic ) ;

Удалить helpdesk [ user ]: ссылка

CrispClient.website.deleteHelpdesk(websiteID, verify)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var verify = {
  "method" : "password" ,
  "secret" : "MySuperSecurePassword" ;
} ;

CrispClient . website . deleteHelpdesk ( websiteID , verify ) ;

Список helpdesk locales [ user , plugin ]: ссылка

CrispClient.website.listHelpdeskLocales(websiteID, pageNumber, options={})

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskLocales ( websiteID , pageNumber , {
  order_visits : "1"
} ) ;

Добавить helpdesk locale [ user , plugin ]: ссылка

CrispClient.website.addHelpdeskLocale(websiteID, locale)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . addHelpdeskLocale ( websiteID , locale ) ;

Проверьте, существует ли Helpdesk Locale [ user , plugin ]: ссылка
- CrispClient.website.checkHelpdeskLocaleExists(websiteID, locale)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . checkHelpdeskLocaleExists ( websiteID , locale ) ;
```

Resolve Helpdesk Locale [ user , plugin ]: ссылка

CrispClient.website.resolveHelpdeskLocale(websiteID, locale)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . resolveHelpdeskLocale ( websiteID , locale ) ;

Удалить Helpdesk Locale [ user , plugin ]: ссылка

CrispClient.website.deleteHelpdeskLocale(websiteID, locale)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . deleteHelpdeskLocale ( websiteID , locale ) ;

Список статей Helpdesk Locale [ user , plugin ]: ссылка

CrispClient.website.listHelpdeskLocaleArticles(websiteID, locale, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskLocaleArticles ( websiteID , locale , pageNumber ) ;

Добавить новую статью Helpdesk Locale [ user , plugin ]: ссылка

CrispClient.website.addNewHelpdeskLocaleArticle(websiteID, locale, title)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var title = "How to use $crisp JavaScript SDK?" ;

CrispClient . website . addNewHelpdeskLocaleArticle ( websiteID , locale , title ) ;

Проверьте, существует ли статья Helpdesk Locale [ user , plugin ]: ссылка

CrispClient.website.checkHelpdeskLocaleArticleExists(websiteID, locale, articleId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . checkHelpdeskLocaleArticleExists ( websiteID , locale , articleId ) ;

Разрешить статью Helpdesk Locale [ user , plugin ]: ссылка

CrispClient.website.resolveHelpdeskLocaleArticle(websiteID, locale, articleId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . resolveHelpdeskLocaleArticle ( websiteID , locale , articleId ) ;

Сохранить статью Helpdesk Locale [ user , plugin ]: ссылка

CrispClient.website.saveHelpdeskLocaleArticle(websiteID, locale, articleId, article)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

var article = {
  "title" : "How to use $crisp JavaScript SDK?" ,
  "description" : null ,
  "content" : "Crisp lets you create your customized chatbox easily. **It's easy to setup**." ,
  "featured" : false ,
  "order" : 1
} ;

CrispClient . website . saveHelpdeskLocaleArticle ( websiteID , locale , articleId , article ) ;

Обновить статью HelpDesk Locale [ user , plugin ]: ссылка

CrispClient.website.updateHelpdeskLocaleArticle(websiteID, locale, articleId, article)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

var article = {
  "content" : "Crisp lets you create your customized chatbox easily. **It's easy to setup**."
} ;

CrispClient . website . updateHelpdeskLocaleArticle ( websiteID , locale , articleId , article ) ;

Удалить статью Helpdesk Locale [ user , plugin ]: ссылка

CrispClient.website.deleteHelpdeskLocaleArticle(websiteID, locale, articleId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . deleteHelpdeskLocaleArticle ( websiteID , locale , articleId ) ;

Страница статьи о предоставлении helpdesk locale [ user , plugin ]: ссылка

CrispClient.website.resolveHelpdeskLocaleArticlePage(websiteID, locale, articleId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . resolveHelpdeskLocaleArticlePage ( websiteID , locale , articleId ) ;

Разрешить Helpdesk Locale Category [ user , plugin ]: ссылка

CrispClient.website.resolveHelpdeskLocaleArticleCategory(websiteID, locale, articleId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . resolveHelpdeskLocaleArticleCategory ( websiteID , locale , articleId ) ;

Обновить Helpdesk Locale Category [ user , plugin ]: ссылка

CrispClient.website.updateHelpdeskLocaleArticleCategory(websiteID, locale, articleId, categoryId, sectionId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;
var categoryId = "00d344a3-8948-45b5-9bc4-82ec249fcd44" ;

CrispClient . website . updateHelpdeskLocaleArticleCategory ( websiteID , locale , articleId , categoryId ) ;

Список helpdesk locale article alternaties [ user , plugin ]: ссылка

CrispClient.website.listHelpdeskLocaleArticleAlternates(websiteID, locale, articleId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . listHelpdeskLocaleArticleAlternates ( websiteID , locale , articleId ) ;

Проверьте, существует ли статья Helpdesk Locale Alternate [ user , plugin ]: ссылка

CrispClient.website.checkHelpdeskLocaleArticleAlternateExists(websiteID, locale, articleId, localeLinked)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;
var localeLinked = "fr" ;

CrispClient . website . checkHelpdeskLocaleArticleAlternateExists ( websiteID , locale , articleId , localeLinked ) ;

Resolve Helpdesk Locale статья alternate [ user , plugin ]: ссылка

CrispClient.website.resolveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;
var localeLinked = "fr" ;

CrispClient . website . resolveHelpdeskLocaleArticleAlternate ( websiteID , locale , articleId , localeLinked ) ;

Сохранить helpdesk locale article alternate [ user , plugin ]: ссылка

CrispClient.website.saveHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked, articleIdLinked)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;
var localeLinked = "fr" ;
var articleIdLinked = "9dc0e823-56b0-43ca-9ca3-47e25a8eb543" ;

CrispClient . website . saveHelpdeskLocaleArticleAlternate ( websiteID , locale , articleId , localeLinked , articleIdLinked ) ;

Удалить helpdesk locale article alternate [ user , plugin ]: ссылка

CrispClient.website.deleteHelpdeskLocaleArticleAlternate(websiteID, locale, articleId, localeLinked)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;
var localeLinked = "fr" ;

CrispClient . website . deleteHelpdeskLocaleArticleAlternate ( websiteID , locale , articleId , localeLinked ) ;

Опубликовать статью Helpdesk Locale [ user , plugin ]: ссылка

CrispClient.website.publishHelpdeskLocaleArticle(websiteID, locale, articleId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . publishHelpdeskLocaleArticle ( websiteID , locale , articleId ) ;

Неупубликационная статья Helpdesk Locale [ user , plugin ]: ссылка

CrispClient.website.unpublishHelpdeskLocaleArticle(websiteID, locale, articleId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var articleId = "fd036d68-c619-4c63-9deb-e2ce91733dd6" ;

CrispClient . website . unpublishHelpdeskLocaleArticle ( websiteID , locale , articleId ) ;

Список категорий локализации Helpdesk [ user , plugin ]: ссылка

CrispClient.website.listHelpdeskLocaleCategories(websiteID, locale, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskLocaleCategories ( websiteID , locale , pageNumber ) ;

Добавить категорию локали Helpdesk [ user , plugin ]: ссылка

CrispClient.website.addHelpdeskLocaleCategory(websiteID, locale, name)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var name = "Chatbox" ;

CrispClient . website . addHelpdeskLocaleCategory ( websiteID , locale , name ) ;

Проверьте, существует ли категория локали Helpdesk [ user , plugin ]: ссылка

CrispClient.website.checkHelpdeskLocaleCategoryExists(websiteID, locale, categoryId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;

CrispClient . website . checkHelpdeskLocaleCategoryExists ( websiteID , locale , categoryId ) ;

Решить категорию локализации Helpdesk [ user , plugin ]: ссылка

CrispClient.website.resolveHelpdeskLocaleCategory(websiteID, locale, categoryId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;

CrispClient . website . resolveHelpdeskLocaleCategory ( websiteID , locale , categoryId ) ;

Сохранить категорию локализации helpdesk [ user , plugin ]: ссылка

CrispClient.website.saveHelpdeskLocaleCategory(websiteID, locale, categoryId, category)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;

var category = {
  "name" : "Chatbox" ,
  "description" : "Help on how to setup and use the Crisp chatbox." ,
  "color" : "#377FEA" ,
  "image" : null ,
  "order" : 1
} ;

CrispClient . website . saveHelpdeskLocaleCategory ( websiteID , locale , categoryId , category ) ;

Обновить категорию локализации helpdesk [ user , plugin ]: ссылка

CrispClient.website.updateHelpdeskLocaleCategory(websiteID, locale, categoryId, category)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;

var category = {
  "color" : "#377FEA"
} ;

CrispClient . website . updateHelpdeskLocaleCategory ( websiteID , locale , categoryId , category ) ;

Удалить категорию локализации Helpdesk [ user , plugin ]: ссылка

CrispClient.website.deleteHelpdeskLocaleCategory(websiteID, locale, categoryId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;

CrispClient . website . deleteHelpdeskLocaleCategory ( websiteID , locale , categoryId ) ;

Список разделов локализации helpdesk [ user , plugin ]: ссылка

CrispClient.website.listHelpdeskLocaleSections(websiteID, locale, categoryId, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskLocaleSections ( websiteID , locale , categoryId , pageNumber ) ;

Добавить раздел локализации helpdesk [ user , plugin ]: ссылка

CrispClient.website.addHelpdeskLocaleSection(websiteID, locale, categoryId, name)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var name = "Integrate with our SDKs" ;

CrispClient . website . addHelpdeskLocaleSection ( websiteID , locale , categoryId , name ) ;

Проверьте, существует ли раздел локали Helpdesk [ user , plugin ]: ссылка

CrispClient.website.checkHelpdeskLocaleSectionExists(websiteID, locale, categoryId, sectionId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263" ;

CrispClient . website . checkHelpdeskLocaleSectionExists ( websiteID , locale , categoryId , sectionId ) ;

Разрешить раздел локализации helpdesk [ user , plugin ]: ссылка

CrispClient.website.resolveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263" ;

CrispClient . website . resolveHelpdeskLocaleSection ( websiteID , locale , categoryId , sectionId ) ;

Сохранить раздел локализации helpdesk [ user , plugin ]: ссылка

CrispClient.website.saveHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263" ;

var section = {
  "name" : "Integrate with our SDKs" ,
  "order" : 1
} ;

CrispClient . website . saveHelpdeskLocaleSection ( websiteID , locale , categoryId , sectionId , section ) ;

Обновить раздел локализации helpdesk [ user , plugin ]: ссылка

CrispClient.website.updateHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId, section)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263" ;

var section = {
  "name" : "Integrate with our SDKs" ,
  "order" : 1
} ;

CrispClient . website . updateHelpdeskLocaleSection ( websiteID , locale , categoryId , sectionId , section ) ;

Удалить раздел локализации helpdesk [ user , plugin ]: ссылка

CrispClient.website.deleteHelpdeskLocaleSection(websiteID, locale, categoryId, sectionId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var categoryId = "33bc73b7-b7db-40a9-80fc-fcba8ebd1067" ;
var sectionID = "14886b8c-faf6-4967-af0a-2d90b3419263" ;

CrispClient . website . deleteHelpdeskLocaleSection ( websiteID , locale , categoryId , sectionId ) ;

Map HelpDesk Locale Ratings [ user , plugin ]: ссылка
- CrispClient.website.mapHelpdeskLocaleFeedbackRatings(websiteID, locale, filterDateStart, filterDateEnd)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . mapHelpdeskLocaleFeedbackRatings ( websiteID , locale ) ;
```
Список Helpdesk Locale обратные связи [ user , plugin ]: ссылка
- CrispClient.website.listHelpdeskLocaleFeedbacks(websiteID, locale, pageNumber, filterDateStart, filterDateEnd)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskLocaleFeedbacks ( websiteID , locale , pageNumber ) ;
```

Импорт External Helpdesk в Locale [ user ]: ссылка

CrispClient.website.importExternalHelpdeskToLocale(websiteID, locale, helpdeskUrl)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;
var helpdeskUrl = "https://docs.acme.com/" ;

CrispClient . website . importExternalHelpdeskToLocale ( websiteID , locale , helpdeskUrl ) ;

Export HelpDesk Locale статьи [ user ]: Ссылка

CrispClient.website.exportHelpdeskLocaleArticles(websiteID, locale)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var locale = "en" ;

CrispClient . website . exportHelpdeskLocaleArticles ( websiteID , locale ) ;

Список helpdesk перенаправления [ user , plugin ]: ссылка

CrispClient.website.listHelpdeskRedirections(websiteID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listHelpdeskRedirections ( websiteID , pageNumber ) ;

Добавить helpdesk перенаправление [ user , plugin ]: ссылка

CrispClient.website.addHelpdeskRedirection(websiteID, redirectionPath, redirectionTarget)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var redirectionPath = "/en/article/how-can-i-automatically-set-custom-user-data/" ;
var redirectionTarget = "/en/article/how-can-i-automatically-set-custom-user-data-1xh7pqk/" ;

CrispClient . website . addHelpdeskRedirection ( websiteID , redirectionPath , redirectionTarget ) ;

Проверьте, существует ли helpdesk перенаправление [ user , plugin ]: ссылка

CrispClient.website.checkHelpdeskRedirectionExists(websiteID, redirectionId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25" ;

CrispClient . website . checkHelpdeskRedirectionExists ( websiteID , redirectionId ) ;

Resolve HelpDesk перенаправление [ user , plugin ]: ссылка

CrispClient.website.resolveHelpdeskRedirection(websiteID, redirectionId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25" ;

CrispClient . website . resolveHelpdeskRedirection ( websiteID , redirectionId ) ;

Удалить helpdesk перенаправление [ user , plugin ]: ссылка

CrispClient.website.deleteHelpdeskRedirection(websiteID, redirectionId)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var redirectionId = "7ebf2e39-1780-45c9-aa81-fa7a7078cb25" ;

CrispClient . website . deleteHelpdeskRedirection ( websiteID , redirectionId ) ;

Разрешить настройки helpdesk [ user , plugin ]: ссылка
- CrispClient.website.resolveHelpdeskSettings(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . resolveHelpdeskSettings ( websiteID ) ;
```

Сохранить настройки helpdesk [ user , plugin ]: ссылка

CrispClient.website.saveHelpdeskSettings(websiteID, settings)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var settings = {
  "name" : "Valerian Helpdesk" ,

  "appearance" : {
    "logos" : {
      "header" : null ,
      "footer" : null
    } ,

    "banner" : null
  } ,

  "behavior" : {
    "frequently_read" : true ,
    "show_category_images" : true ,
    "show_chatbox" : true ,
    "ask_feedback" : false ,
    "locale_picker" : false ,
    "refer_link" : true ,
    "forbid_indexing" : false ,
    "status_health_dead" : true
  } ,

  "include" : {
    "html" : null
  } ,

  "access" : {
    "password" : null
  }
} ;

CrispClient . website . saveHelpdeskSettings ( websiteID , settings ) ;

Разрешить домен HELLDESK [ user ]: ссылка
- CrispClient.website.resolveHelpdeskDomain(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . resolveHelpdeskDomain ( websiteID ) ;
```

Запрос helpdesk Изменение домена [ user ]: Ссылка

CrispClient.website.requestHelpdeskDomainChange(websiteID, basic, custom)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var basic = "valerian" ;
var custom = "help.valeriansaliou.name" ;

CrispClient . website . requestHelpdeskDomainChange ( websiteID , basic , custom ) ;

Генерировать поток настройки домена helpdesk [ user ]: ссылка

CrispClient.website.generateHelpdeskDomainSetupFlow(websiteID, custom)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var custom = "help.valeriansaliou.name" ;

CrispClient . website . generateHelpdeskDomainSetupFlow ( websiteID , custom ) ;

БАСА САЙТА
- Проверьте, существует ли веб -сайт [ user , plugin ]: ссылка
  - CrispClient.website.checkWebsiteExists(domain)
  - Смотрите пример
    CrispClient . website . checkWebsiteExists ( domain ) ;
- Создать веб -сайт [ user ]: ссылка
  - CrispClient.website.createWebsite(websiteData)
  - Смотрите пример
    CrispClient . website . createWebsite ( websiteData ) ;
- Получить веб -сайт [ user , plugin ]: ссылка
  - CrispClient.website.getWebsite(websiteID)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getWebsite ( websiteID ) ;
- Удалить веб -сайт [ user ]: ссылка
  - CrispClient.website.deleteWebsite(websiteID, verify)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; var verify = { "method" : "password" , "secret" : "MySuperSecurePassword" ; } ; CrispClient . website . deleteWebsite ( websiteID , verify ) ;
- Прервать удаление веб -сайта [ user ]: ссылка
  - CrispClient.website.abortWebsiteDeletion(websiteID)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . abortWebsiteDeletion ( websiteID ) ;

Настройки веб -сайта

Получить настройки веб -сайта [ user , plugin ]: ссылка
- CrispClient.website.getWebsiteSettings(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . getWebsiteSettings ( websiteID ) ;
```

Обновить настройки веб -сайта [ user , plugin ]: ссылка

CrispClient.website.updateWebsiteSettings(websiteID, settings)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var settings = {
  "name" : "Crisp" ,
  "domain" : "crisp.chat" ,
  "logo" : "https://storage.crisp.chat/users/avatar/website/8c842203-7ed8-4e29-a608-7cf78a7d2fcc/b6c2948d-b061-405e-91a9-2fdf855d1cc0.png" ,
  "audit" : {
    "log" : true
  } ,
  "contact" : {
    "email" : "[email protected]" ,
    "phone" : "+33757905447"
  } ,
  "inbox" : {
    "lock_removal" : false ,
    "force_operator_token" : false
  } ,
  "emails" : {
    "rating" : true ,
    "transcript" : true ,
    "enrich" : true ,
    "junk_filter" : true
  } ,
  "chatbox" : {
    "tile" : "default" ,
    "wait_game" : false ,
    "website_logo" : true ,
    "last_operator_face" : false ,
    "ongoing_operator_face" : true ,
    "activity_metrics" : true ,
    "operator_privacy" : false ,
    "availability_tooltip" : true ,
    "hide_vacation" : false ,
    "hide_on_away" : false ,
    "hide_on_mobile" : false ,
    "position_reverse" : false ,
    "email_visitors" : false ,
    "phone_visitors" : false ,
    "force_identify" : false ,
    "ignore_privacy" : false ,
    "visitor_compose" : false ,
    "file_transfer" : true ,
    "overlay_search" : true ,
    "overlay_mode" : false ,
    "helpdesk_link" : true ,
    "helpdesk_only" : false ,
    "status_health_dead" : true ,
    "check_domain" : false ,
    "color_theme" : "blue" ,
    "text_theme" : "default" ,
    "welcome_message" : "default" ,
    "locale" : "en" ,
    "allowed_pages" : [ ] ,
    "blocked_pages" : [
      "status/*/" ,
      "docs.crisp.chat/*" ,
      "crisp.chat/terms/" ,
      "https://crisp.chat/privacy/"
    ] ,
    "blocked_countries" : [
      "IT"
    ] ,
    "blocked_locales" : [
      "fa" ,
      "he"
    ] ,
    "blocked_ips" : [
      "8.8.8.8" ,
      "2001:0db8:85a3:0000:0000:8a2e:0370:7334" ,
      "192.168.1.1/24"
    ]
  }
} ;

CrispClient . website . updateWebsiteSettings ( websiteID , settings ) ;

Оператор веб -сайта

Список операторов веб -сайта [ user , plugin ]: ссылка
- CrispClient.website.listWebsiteOperators(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . listWebsiteOperators ( websiteID ) ;
```
Список последних активных операторов веб -сайта [ user , plugin ]: ссылка
- CrispClient.website.listLastActiveWebsiteOperators(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . listLastActiveWebsiteOperators ( websiteID ) ;
```

Flush Last Active Operators [ user ]: ссылка

CrispClient.website.flushLastActiveWebsiteOperators(websiteID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . flushLastActiveWebsiteOperators ( websiteID ) ;

Отправить электронное письмо операторам веб -сайта [ user , plugin ]: ссылка

CrispClient.website.sendEmailToWebsiteOperators(websiteID, emailData)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var emailData = {
  "recipient" : "owners" ,
  "subject" : "Plugin limits reached" ,
  "message" : "Hi, you've reached the Slack plugin limits. Please contact our support team."
} ;

CrispClient . website . sendEmailToWebsiteOperators ( websiteID , emailData ) ;

Получить оператор веб -сайта [ user , plugin ]: ссылка

CrispClient.website.getWebsiteOperator(websiteID, userID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f" ;

CrispClient . website . getWebsiteOperator ( websiteID , userID ) ;

Пригласить оператора веб -сайта [ user ]: ссылка

CrispClient.website.inviteWebsiteOperator(websiteID, email, role, verify)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var email = "[email protected]" ;
var role = "member" ;

var verify = {
  "method" : "password" ,
  "secret" : "MySuperSecurePassword" ;
} ;

CrispClient . website . inviteWebsiteOperator ( websiteID , email , role , verify ) ;

Изменить членство оператора [ user ]: ссылка

CrispClient.website.changeOperatorMembership(websiteID, userID, role, title)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f" ;

var title = {
  "role" : "owner" ,
  "title" : "CTO"
} ;

CrispClient . website . changeOperatorMembership ( websiteID , userID , role , title ) ;

Оператор Unlink с веб -сайта [ user ]: ссылка

CrispClient.website.unlinkOperatorFromWebsite(websiteID, userID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var userID = "a4c32c68-be91-4e29-8a05-976e93abbe3f" ;

CrispClient . website . unlinkOperatorFromWebsite ( websiteID , userID ) ;

Посетители сайта
- Посетители Count [ user , plugin ]: ссылка
  - CrispClient.website.countVisitors(websiteID)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . countVisitors ( websiteID ) ;
- Список посетителей [ user , plugin ]: ссылка
  - CrispClient.website.listVisitors(websiteID, pageNumber)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; var pageNumber = 1 ; CrispClient . website . listVisitors ( websiteID , pageNumber ) ;
- Посетители на карте [ user , plugin ]: ссылка
  - CrispClient.website.pinpointVisitorsOnMap(websiteID, centerLongitude, centerLatitude, centerRadius)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . pinpointVisitorsOnMap ( websiteID , centerLongitude , centerLatitude , centerRadius ) ;
- Получить идентификатор сеанса от токена [ user , plugin ]: ссылка
  - CrispClient.website.getSessionIdentifierFromToken(websiteID, tokenID)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; var tokenID = "d3c17241-1327-47d7-9d8e-b89ff7bd2904" ; CrispClient . website . getSessionIdentifierFromToken ( websiteID , tokenID ) ;
- Count Blocked посетителей [ user ]: ссылка
  - CrispClient.website.countBlockedVisitors(websiteID)
- Count Blocked посетителей в правиле [ user ]: ссылка
  - CrispClient.website.countBlockedVisitorsInRule(websiteID, rule)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . countBlockedVisitorsInRule ( websiteID , rule ) ;
- Очистить заблокированные посетители в правиле [ user ]: ссылка
  - CrispClient.website.clearBlockedVisitorsInRule(websiteID, rule)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . clearBlockedVisitorsInRule ( websiteID , rule ) ;
Доступность веб -сайта
- Получить статус доступности веб -сайта [ user , plugin ]: ссылка
  - CrispClient.website.getWebsiteAvailabilityStatus(websiteID)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getWebsiteAvailabilityStatus ( websiteID ) ;
- Список доступности оператора веб -сайта [ user , plugin ]: ссылка
  - CrispClient.website.listWebsiteOperatorAvailabilities(websiteID)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . listWebsiteOperatorAvailabilities ( websiteID ) ;
Аналитика веб -сайта
- Генерировать аналитику [ user ]: ссылка
  - CrispClient.website.generateAnalytics(websiteID, query)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . generateAnalytics ( websiteID , query ) ;

Партия веб -сайта

Разговоры user

CrispClient.website.batchResolveConversations(websiteID, operation)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var operation = {
  "inbox_id" : null ,

  "sessions" : [
    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9" ,
    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
  ]
} ;

CrispClient . website . batchResolveConversations ( websiteID , operation ) ;

Партийное чтение разговоров [ user ]: Ссылка

CrispClient.website.batchReadConversations(websiteID, operation)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var operation = {
  "inbox_id" : null ,

  "sessions" : [
    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9" ,
    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
  ]
} ;

CrispClient . website . batchReadConversations ( websiteID , operation ) ;

Партия удалить разговоры [ user ]: ссылка

CrispClient.website.batchRemoveConversations(websiteID, operation)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var operation = {
  "inbox_id" : null ,

  "sessions" : [
    "session_19e5240f-0a8d-461e-a661-a3123fc6eec9" ,
    "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
  ]
} ;

CrispClient . website . batchRemoveConversations ( websiteID , operation ) ;

Партия Удалить людей [ user ]: ссылка

CrispClient.website.batchRemovePeople(websiteID, people)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var sessions = [
  "session_19e5240f-0a8d-461e-a661-a3123fc6eec9" ,
  "session_700c65e1-85e2-465a-b9ac-ecb5ec2c9881"
] ;

CrispClient . website . batchRemoveConversations ( websiteID , sessions ) ;

Веб -сайт проверить
- Получить настройки проверки [ user , plugin ]: ссылка
  - CrispClient.website.getVerifySettings(websiteID)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getVerifySettings ( websiteID ) ;
- Обновление проверки настроек [ user , plugin ]: ссылка
  - CrispClient.website.updateVerifySettings(websiteID, settings)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; var settings = { "enabled" : true } ; CrispClient . website . updateVerifySettings ( websiteID , settings ) ;
- Получить ключ проверки [ user , plugin ]: ссылка
  - CrispClient.website.getVerifyKey(websiteID)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . getVerifyKey ( websiteID ) ;
- Клавиша проверки броска [ user , plugin ]: ссылка
  - CrispClient.website.rollVerifyKey(websiteID)
  - Смотрите пример
    var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ; CrispClient . website . rollVerifyKey ( websiteID ) ;

Кампании веб -сайта

Список кампаний [ user ]: Ссылка

CrispClient.website.listCampaigns(websiteID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listCampaigns ( websiteID , pageNumber ) ;

Список тегов кампании [ user ]: Ссылка
- CrispClient.website.listCampaignTags(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . website . listCampaignTags ( websiteID ) ;
```

Список шаблонов кампании [ user , plugin ]: ссылка

CrispClient.website.listCampaignTemplates(websiteID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pageNumber = 1 ;

CrispClient . website . listCampaignTemplates ( websiteID , pageNumber ) ;

Создайте новый шаблон кампании [ user , plugin ]: ссылка

CrispClient.website.createNewCampaignTemplate(websiteID, templateFormat, templateName)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var templateName = {
  "name" : "HTML Template" ,
  "format" : "html"
} ;

CrispClient . website . createNewCampaignTemplate ( websiteID , templateFormat , templateName ) ;

Проверьте, существует ли шаблон кампании [ user , plugin ]: ссылка

CrispClient.website.checkCampaignTemplateExists(websiteID, templateID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2" ;

CrispClient . website . checkCampaignTemplateExists ( websiteID , templateID ) ;

Получить шаблон кампании [ user , plugin ]: ссылка

CrispClient.website.getCampaignTemplate(websiteID, templateID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2" ;

CrispClient . website . getCampaignTemplate ( websiteID , templateID ) ;

Сохранить шаблон кампании [ user , plugin ]: ссылка

CrispClient.website.saveCampaignTemplate(websiteID, templateID, template)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2" ;

var template = {
  "name" : "HTML Template" ,
  "format" : "html" ,
  "content" : "<html><body><a href="{{url.unsubscribe}}"></a></body></html>"
} ;

CrispClient . website . saveCampaignTemplate ( websiteID , templateID , template ) ;

Обновите шаблон кампании [ user , plugin ]: ссылка

CrispClient.website.updateCampaignTemplate(websiteID, templateID, template)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2" ;

var template = "<html><body><a href="{{url.unsubscribe}}"></a></body></html>" ;

CrispClient . website . updateCampaignTemplate ( websiteID , templateID , template ) ;

Удалить шаблон кампании [ user , plugin ]: ссылка

CrispClient.website.removeCampaignTemplate(websiteID, templateID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var templateID = "a4876300-4dae-47f7-8599-3bf9283f36c2" ;

CrispClient . website . removeCampaignTemplate ( websiteID , templateID ) ;

Кампания веб -сайта

Создать новую кампанию [ user ]: ссылка

CrispClient.website.createNewCampaign(websiteID, campaignType, campaignName)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

var campaignName = {
  "type" : "one-shot" ,
  "name" : "Welcome!"
} ;

CrispClient . website . createNewCampaign ( websiteID , campaignType , campaignName ) ;

Проверьте, существует ли кампания [ user ]: ссылка

CrispClient.website.checkCampaignExists(websiteID, campaignID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . checkCampaignExists ( websiteID , campaignID ) ;

Получить кампанию [ user ]: ссылка

CrispClient.website.getCampaign(websiteID, campaignID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . getCampaign ( websiteID , campaignID ) ;

Сохранить кампанию [ user ]: ссылка

CrispClient.website.saveCampaign(websiteID, campaignID, campaign)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

var campaign = {
  "type" : "one-shot" ,
  "format" : "markdown" ,
  "name" : "Welcome!" ,
  "sender" : {
    "user_id" : "aa0b64dd-9fb4-4db9-80d6-5a49eb84087b"
  } ,
  "recipients" : {
    "type" : "all"
  } ,
  "message" : "*Hey there*, welcome on Crisp!" ,
  "options" : {
    "deliver_to_chatbox" : true ,
    "deliver_to_email" : true ,
    "sender_name_website" : false ,
    "sender_email_reply" : null ,
    "tracking" : true
  }
} ;

CrispClient . website . saveCampaign ( websiteID , campaignID , campaign ) ;

Обновить кампанию [ user ]: ссылка

CrispClient.website.updateCampaign(websiteID, campaignID, campaign)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

var campaign = {
  "message" : "*Hey there*, welcome on Crisp folks!"
} ;

CrispClient . website . updateCampaign ( websiteID , campaignID , campaign ) ;

Удалить кампанию [ user ]: ссылка

CrispClient.website.removeCampaign(websiteID, campaignID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . removeCampaign ( websiteID , campaignID ) ;

Отправить кампанию [ user ]: ссылка

CrispClient.website.dispatchCampaign(websiteID, campaignID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . dispatchCampaign ( websiteID , campaignID ) ;

Возобновить кампанию [ user ]: ссылка

CrispClient.website.resumeCampaign(websiteID, campaignID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . resumeCampaign ( websiteID , campaignID ) ;

Приостановите кампанию [ user ]: ссылка

CrispClient.website.pauseCampaign(websiteID, campaignID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . pauseCampaign ( websiteID , campaignID ) ;

Проверьте кампанию [ user ]: ссылка

CrispClient.website.testCampaign(websiteID, campaignID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;

CrispClient . website . testCampaign ( websiteID , campaignID ) ;

Список получателей кампании [ user ]: Ссылка

CrispClient.website.listCampaignRecipients(websiteID, campaignID, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;
var pageNumber = 1 ;

CrispClient . website . listCampaignRecipients ( websiteID , campaignID , pageNumber ) ;

Список статистики кампании [ user ]: Ссылка

CrispClient.website.listCampaignStatistics(websiteID, campaignID, action, pageNumber)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var campaignID = "355d805f-a72f-457e-a3e5-5d01521f3cd8" ;
var pageNumber = 1 ;

CrispClient . website . listCampaignStatistics ( websiteID , campaignID , action , pageNumber ) ;

Плагин

Подключение плагина
- Получить учетную запись Connect [ plugin ]: ссылка
  - CrispClient.plugin.getConnectAccount()
  - Смотрите пример
    CrispClient . plugin . getConnectAccount ( ) ;
- Проверьте достоверность сеанса подключения [ plugin ]: ссылка
  - CrispClient.plugin.checkConnectSessionValidity()
  - Смотрите пример
    CrispClient . plugin . checkConnectSessionValidity ( ) ;
- Список всех сайтов подключения [ plugin ]: ссылка
  - CrispClient.plugin.listAllConnectWebsites(pageNumber, filterConfigured)
  - Смотрите пример
    var pageNumber = 1 ; CrispClient . plugin . listAllConnectWebsites ( pageNumber , filterConfigured ) ;
- Список подключения веб -сайтов с тех пор, как [ plugin ]: ссылка
  - CrispClient.plugin.listConnectWebsitesSince(dateSince, filterConfigured)
  - Смотрите пример
    var dateSince = "2023-08-16T09:00:00Z" ; CrispClient . plugin . listConnectWebsitesSince ( dateSince , filterConfigured ) ;
- Получить конечные точки подключения [ plugin ]: ссылка
  - CrispClient.plugin.getConnectEndpoints()
  - Смотрите пример
    CrispClient . plugin . getConnectEndpoints ( ) ;

Подписка на плагин

Перечислите все активные подписки [ user ]: ссылка
- CrispClient.plugin.listAllActiveSubscriptions()
- Смотрите пример
```
 CrispClient . plugin . listAllActiveSubscriptions ( ) ;
```
Список подписок на веб -сайт [ user ]: ссылка
- CrispClient.plugin.listSubscriptionsForWebsite(websiteID)
- Смотрите пример
```
 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;

CrispClient . plugin . listSubscriptionsForWebsite ( websiteID ) ;
```

Получить сведения о подписке [ user , plugin ]: ссылка

CrispClient.plugin.getSubscriptionDetails(websiteID, pluginID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

CrispClient . plugin . getSubscriptionDetails ( websiteID , pluginID ) ;

Подпишитесь на веб -сайт на плагин [ user ]: ссылка

CrispClient.plugin.subscribeWebsiteToPlugin(websiteID, pluginID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var pluginID = "98454664-9f7d-4d95-a9ce-f37356f5e65a" ;

CrispClient . plugin . subscribeWebsiteToPlugin ( websiteID , pluginID ) ;

Плагин отписать с подписания с веб -сайта [ user ]: ссылка

CrispClient.plugin.unsubscribePluginFromWebsite(websiteID, pluginID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

CrispClient . plugin . unsubscribePluginFromWebsite ( websiteID , pluginID ) ;

Получить настройки подписки [ user , plugin ]: ссылка

CrispClient.plugin.getSubscriptionSettings(websiteID, pluginID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

CrispClient . plugin . getSubscriptionSettings ( websiteID , pluginID ) ;

Сохранить настройки подписки [ user , plugin ]: ссылка

CrispClient.plugin.saveSubscriptionSettings(websiteID, pluginID, settings)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var settings = {
  "chatbox" : {
    "25" : "#bbbbbb"
  }
} ;

CrispClient . plugin . saveSubscriptionSettings ( websiteID , pluginID , settings ) ;

Обновление настройки подписки [ user , plugin ]: ссылка

CrispClient.plugin.updateSubscriptionSettings(websiteID, pluginID, settings)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var settings = {
  "chatbox" : {
    "25" : "#bbbbbb"
  }
} ;

CrispClient . plugin . updateSubscriptionSettings ( websiteID , pluginID , settings ) ;

Получить счета за использование плагинов [ user , plugin ]: ссылка

CrispClient.plugin.getPluginUsageBills(websiteID, pluginID)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

CrispClient . plugin . getPluginUsageBills ( websiteID , pluginID ) ;

Сообщите об использовании плагинов в Билл [ plugin ]: ссылка

CrispClient.plugin.reportPluginUsageToBill(websiteID, pluginID, usage)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var usage = {
  "name" : "Paid messages sent" ,
  "units" : 250 ,
  "price" : 0.10
} ;

CrispClient . plugin . reportPluginUsageToBill ( websiteID , pluginID , usage ) ;

Полезная нагрузка плагина вперед в канал [ user , plugin ]: ссылка

CrispClient.plugin.forwardPluginPayloadToChannel(websiteID, pluginID, payload)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var payload = {
  "namespace" : "bot:step" ,
  "payload" : {
    "step" : 1
  }
} ;

CrispClient . plugin . forwardPluginPayloadToChannel ( websiteID , pluginID , payload ) ;

Событие плагина для отправки [ user , plugin ]: ссылка

CrispClient.plugin.dispatchPluginEvent(websiteID, pluginID, payload)

Смотрите пример

 var websiteID = "8c842203-7ed8-4e29-a608-7cf78a7d2fcc" ;
var pluginID = "c64f3595-adee-425a-8d3a-89d47f7ed6bb" ;

var payload = {
  "name" : "bot-is-running" ,
  "data" : {
    "bot" : "Sales" ,
    "email" : "[email protected]"
  }
} ;

CrispClient . plugin . dispatchPluginEvent ( websiteID , pluginID , payload ) ;

СМИ

СМИ анимация

Список анимации Medias [ user ]: ссылка

CrispClient.media.listAnimationMedias(pageNumber, listID, searchQuery)

Смотрите пример

 var listID = "f7fb43da-1cd8-49c1-ade0-9f5b71d034e3" ;
var pageNumber = 1 ;

CrispClient . media . listAnimationMedias ( pageNumber , listID , searchQuery ) ;

Ведро

ВЕРКЕ URL
- Генерировать URL -адрес ведра [ user , plugin ]: ссылка
  - CrispClient.bucket.generateBucketURL(data)
  - Смотрите пример
    CrispClient . bucket . generateBucketURL ( data ) ;

События в реальном времени

Вы можете связаться с событиями в реальном времени от Crisp, чтобы получить уведомление о входящих сообщениях и обновлениях на веб -сайтах.

Вы не получите никакого события, если вы не подписытесь на события в реальном времени, так как библиотека не подключается к бэкэнд в реальном времени автоматически.

Есть два способа получить события в реальном времени:

Использование веб -крючков ( рекомендуется )
Использование WebSockets с RTM API

Перед началом событий RTM, пожалуйста, рассмотрите следующее:

Вы не получите никакого события, если вы не подписытесь на события в реальном времени, используя CrispClient.on() , поскольку библиотека не подключается к бэкэнд в реальном времени автоматически. Этот метод возвращает объект Promise .
Всякий раз, когда список веб -сайтов, которые ваш токен аутентификации имеет право на получение событий для изменений, вам нужно будет позвонить CrispClient.rebindSocket() . Этот метод также возвращает объект Promise . Это распространяется только на веб -питания с API RTM .

Получить события в реальном времени

Получить события по веб -крючкам

Чтобы начать прослушивание событий и привязать обработчик, ознакомьтесь с примером событий по веб -крючкам.

Вам нужно будет настроить свой код так, чтобы:

Режим событий RTM установлен на веб -крючки: CrispClient.setRtmMode(Crisp.RTM_MODES.WebHooks)
Ваша конечная точка HTTP поднимает маршрут, прослушивая запросы на почту и после получения запросов:
1. Он проверяет запросы с помощью: CrispClient.verifyHook(secret, body, timestamp, signature)
2. Он получает веб -крюк с: CrispClient.receiveHook(body)

Сначала необходимо настроить плагин -крючки для работы. Проверьте наше руководство QuickStart Web Hooks и нашу ссылку Web Hooks, чтобы начать работу.

Получить события по веб -окетам (RTM API)

Чтобы начать прослушивание событий и привязать обработчик, ознакомьтесь с примером событий над веб -окетами.

Вам нужно будет настроить свой код так, чтобы:

Режим событий RTM установлен на WebSockets: CrispClient.setRtmMode(Crisp.RTM_MODES.WebSockets)

Доступные события в реальном времени

Доступные события перечислены ниже:

Сессионные события : ссылка
- Доступность обновления сеанса [ user , plugin ]:
  - session:update_availability
- Обновление сеанса проверка [ user , plugin ]:
  - session:update_verify
- Инициирован запрос сеанса [ user , plugin ]:
  - session:request:initiated
- Набор сеанса по электронной почте [ user , plugin ]:
  - session:set_email
- Набор сеанса на установление телефона [ user , plugin ]:
  - session:set_phone
- Адрес набора сеанса [ user , plugin ]:
  - session:set_address
- Набор сеанса набор субъекта [ user , plugin ]:
  - session:set_subject
- Набор сеанса avatar [ user , plugin ]:
  - session:set_avatar
- Набор сеанса прозвище [ user , plugin ]:
  - session:set_nickname
- Набор данных сеанса [ user , plugin ]:
  - session:set_data
- Санхронизированные страницы сеанса [ user , plugin ]:
  - session:sync:pages
- События синхронизации сеанса [ user , plugin ]:
  - session:sync:events
- Возможности синхронизации сеанса [ user , plugin ]:
  - session:sync:capabilities
- Session Sync Geolocation [ user , plugin ]:
  - session:sync:geolocation
- Session Sync System [ user , plugin ]:
  - session:sync:system
- Сеанс Sync Network [ user , plugin ]:
  - session:sync:network
- Сессионная синхронизация часового пояса [ user , plugin ]:
  - session:sync:timezone
- Session Sync Locales [ user , plugin ]:
  - session:sync:locales
- Рейтинг синхронизации сеанса [ user , plugin ]:
  - session:sync:rating
- Тема синхронизации сеанса [ user , plugin ]:
  - session:sync:topic
- Состояние набора сеанса [ user , plugin ]:
  - session:set_state
- Сеанс SET BLOCK [ user , plugin ]:
  - session:set_block
- Сегменты сеанса [ user , plugin ]:
  - session:set_segments
- Набор сеанса открыт [ user , plugin ]:
  - session:set_opened
- Набор сеанса закрыт [ user , plugin ]:
  - session:set_closed
- Набор сеанса Участники [ user , plugin ]:
  - session:set_participants
- Набор сеанса упоминает [ user , plugin ]:
  - session:set_mentions
- Набор сеанса маршрутизация [ user , plugin ]:
  - session:set_routing
- Набор сеанса входящего [ user , plugin ]:
  - session:set_inbox
- СЕССИТЕЛЬ УДАЛЕН [ user , plugin ]:
  - session:removed
События сообщений : ссылка
- Обновлено сообщение [ user , plugin ]:
  - message:updated
- Сообщение Отправить [ user , plugin ]:
  - message:send
- Полученное сообщение [ user , plugin ]:
  - message:received
- Сообщение удалено [ user , plugin ]:
  - message:removed
- Сообщение Compose Send [ user , plugin ]:
  - message:compose:send
- Соединение сообщений приема [ user , plugin ]:
  - message:compose:receive
- Сообщение подтверждение чтение Отправить [ user , plugin ]:
  - message:acknowledge:read:send
- plugin user чтение
  - message:acknowledge:read:received
- Сообщение подтверждение доставлено [ user , plugin ]:
  - message:acknowledge:delivered
- Сообщение уведомить Unroad Send [ user , plugin ]:
  - message:notify:unread:send
- plugin user Unroaded
  - message:notify:unread:received
События спама : ссылка
- Сообщение о спаме [ user ]:
  - spam:message
- Решение о спаме [ user ]:
  - spam:decision
События людей : ссылка
- Профиль людей создал [ user , plugin ]:
  - people:profile:created
- Профиль людей обновлен [ user , plugin ]:
  - people:profile:updated
- Люди профиль удален [ user , plugin ]:
  - people:profile:removed
- Люди связывают сеанс [ user , plugin ]:
  - people:bind:session
- Люди синхронизируют профиль [ user , plugin ]:
  - people:sync:profile
- Люди импортируют прогресс [ user ]:
  - people:import:progress
- Люди импортируют [ user ]:
  - people:import:done
Кампания события : ссылка
- Прогресс кампании [ user ]:
  - campaign:progress
- Кампания отправлена [ user ]:
  - campaign:dispatched
- Запуск кампании [ user ]:
  - campaign:running
Просмотр событий : ссылка
- Запрос на просмотр инициирован [ user , plugin ]:
  - browsing:request:initiated
- Запрос на просмотр отклонил [ user , plugin ]:
  - browsing:request:rejected
События звонка : ссылка
- Инициирован запрос на вызов [ user , plugin ]:
  - call:request:initiated
- Запрос вызова отклонен [ user , plugin ]:
  - call:request:rejected
События виджетов : ссылка
- Действие виджета обработано [ user ]:
  - widget:action:processed
Статусные события : ссылка
- Статус здоровье изменилось [ user ]:
  - status:health:changed
События веб -сайта : ссылка
- Обновление сайта Посетители Count [ user , plugin ]:
  - website:update_visitors_count
- Доступность операторов обновления веб -сайта [ user , plugin ]:
  - website:update_operators_availability
- Пользователи веб -сайта доступны [ user , plugin ]:
  - website:users:available
События ведра : ссылка
- Сгенерированная загрузка URL -адреса ведра [ user , plugin ]:
  - bucket:url:upload:generated
- Веденный URL -аватар сгенерирован [ user , plugin ]:
  - bucket:url:avatar:generated
- Сгенерированный веб -сайт URL -адреса ведра [ user , plugin ]:
  - bucket:url:website:generated
- Кампания URL -адреса сгенерирована [ user , plugin ]:
  - bucket:url:campaign:generated
- Ведение URL HelpDesk Gened [ user , plugin ]:
  - bucket:url:helpdesk:generated
- Сгенерировано статус URL -адреса ведра [ user , plugin ]:
  - bucket:url:status:generated
- Сгенерирована обработка URL -адреса ведра [ user , plugin ]:
  - bucket:url:processing:generated
СМИ : Ссылка
- СМИ Анимация перечислена [ user ]:
  - media:animation:listed
События по электронной почте : ссылка
- Электронная почта подписывается [ user , plugin ]:
  - email:subscribe
- Просмотр трека по электронной почте [ user , plugin ]:
  - email:track:view
События плагина : ссылка
- Канал плагина [ user , plugin ]:
  - plugin:channel
- Плагин событие [ user , plugin ]:
  - plugin:event
- Настройки плагина сохранили [ user , plugin ]:
  - plugin:settings:saved

Расширять

node crisp api

Хрустящая обертка API

Установка

Аутентификация

Обзор

Примеры

Создайте свой собственный бот!

Методы ресурсов

Веб -сайт

Веса веб -сайта

Сайт разговор

Люди сайта (это ваши конечные пользователи)

Веб -сайт helpdesk

БАСА САЙТА

Настройки веб -сайта

Оператор веб -сайта

Посетители сайта

Доступность веб -сайта

Аналитика веб -сайта

Партия веб -сайта

Веб -сайт проверить

Кампании веб -сайта

Кампания веб -сайта

Плагин

Подключение плагина

Подписка на плагин

СМИ

СМИ анимация

Ведро

ВЕРКЕ URL

События в реальном времени

Получить события в реальном времени

Получить события по веб -крючкам

Получить события по веб -окетам (RTM API)

Доступные события в реальном времени

Сессионные события : ссылка

События сообщений : ссылка

События спама : ссылка

События людей : ссылка

Кампания события : ссылка

Просмотр событий : ссылка

События звонка : ссылка

События виджетов : ссылка

Статусные события : ссылка

События веб -сайта : ссылка

События ведра : ссылка

СМИ : Ссылка

События по электронной почте : ссылка

События плагина : ссылка