imopenlines-crm-chat-get.md

Получить чат для объекта CRM imopenlines.crm.chat.get

{% note warning "Мы еще обновляем эту страницу" %}

Тут может не хватать некоторых данных — дополним в ближайшее время

{% endnote %}

{% if build == 'dev' %}

{% note alert "TO-DO не выгружается на prod" %}

• отсутствует ответ в случае ошибки

{% endnote %}

{% endif %}

Scope: imopenlines

Кто может выполнять метод: любой пользователь

Метод получает чаты для объекта CRM.

Параметры метода

{% include Сноска о параметрах %}

#| || Название Тип | Описание || || CRM_ENTITY_TYPE* string | Тип объекта CRM:

• lead — лид
• deal — сделка
• company — компания
• contact — контакт || || CRM_ENTITY_ID* integer | Идентификатор объекта CRM || || ACTIVE_ONLY boolean | Вернуть только активные чаты.

Возможные значения:

• Y — вернет только активные чаты
• N — вернет все чаты

По умолчанию — Y || |#

Примеры кода

{% include Сноска о примерах %}

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"CRM_ENTITY_TYPE":"deal","CRM_ENTITY":288,"ACTIVE_ONLY":"N"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/imopenlines.crm.chat.get

• cURL (OAuth)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"CRM_ENTITY_TYPE":"deal","CRM_ENTITY":288,"ACTIVE_ONLY":"N","auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/imopenlines.crm.chat.get

• JS

  BX24.callMethod(
      'imopenlines.crm.chat.get',
      {
          CRM_ENTITY_TYPE: 'deal'
          CRM_ENTITY: 288,
          ACTIVE_ONLY: 'N'
      },
      function(result) {
          if(result.error())
          {
              console.error(result.error().ex);
          }
          else
          {
              console.log(result.data());
          }
      }
  );

• PHP

  require_once('crest.php');
  
  $result = CRest::call(
      'imopenlines.crm.chat.get',
      [
          'CRM_ENTITY_TYPE' => 'deal',
          'CRM_ENTITY' => 288,
          'ACTIVE_ONLY' => 'N'
      ]
  );
  
  echo '<PRE>';
  print_r($result);
  echo '</PRE>';

{% endlist %}

Обработка ответа

HTTP-статус: 200

{
    "result": [
        {
            "CHAT_ID": "9852",
            "CONNECTOR_ID": "livechat",
            "CONNECTOR_TITLE": "Онлайн-чат"
        }
    ]
}

Возвращаемые данные

#| || Название тип | Описание || || result object | Массив объектов. Каждый объект содержит описание чата || || CHAT_ID string | Идентификатор чата || || CONNECTOR_ID string | Идентификатор коннектора || || CONNECTOR_TITLE string | Название коннектора || |#

Обработка ошибок

Возможные коды ошибок

#| || Код | Описание || || ACCESS_DENIED | У текущего пользователя нет доступа || || ERROR_ARGUMENT | Один из аргументов не указан или указан неверно || |#