87  /  122

im.recent.pin

Просмотров: 843
Дата последнего изменения: 07.10.2020
Александр Суворов
Сложность урока:
4 уровень - сложно, требуется сосредоточится, внимание деталям и точному следованию инструкции.
1
2
3
4
5

Закрепление диалога в избранном

Ревизия: 18
Получить информацию о текущей ревизии API (версии платформы) – im.revision.get.

Обратите внимание! Метод указан с использованием функции restCommand - это метод отправки данных в Битрикс24, данный метод есть в примере ЭхоБота, и представлен здесь в качестве примера. Вы можете использовать свою функцию или javascript-метод BX24.callMethod или bitrix24-php-sdk.

Параметры

Параметр Пример Обязат. Описание Ревизия
DIALOG_ID chat17
или
256
Да Идентификатор диалога. Формат:
chatXXX – чат получателя, если сообщение для чата
или XXX – идентификатор получателя, если сообщение для приватного диалога
19
PIN Y Нет Закрепить или открепить диалог 19
  • Если указать параметр PIN = N, то закрепленный диалог будет откреплен.


Вызов метода и ответ

JavaScript

BX24.callMethod('im.recent.pin', {
	'DIALOG_ID': 'chat17'
	'PIN': 'Y'
}, function(result){
	if(result.error())
	{
		console.error(result.error().ex);
	}
	else
	{
		console.log(result.data());
	}
});

PHP

$result = restCommand('im.recent.pin', Array(
	'DIALOG_ID' => 'chat17',
	'PIN' => 'Y'
), $_REQUEST["auth"]);	

Пример ответа

{
	"result": true
}      


Пример ответа при возникновении ошибки

{
    "error": "DIALOG_ID_EMPTY",
    "error_description": "Dialog ID can't be empty"
}

Описание ключей:

  • error – код возникшей ошибки
  • error_description – краткое описание возникшей ошибки

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

Код Описание
DIALOG_ID_EMPTY Не передан идентификатор диалога.


0
Курсы разработаны в компании «1С-Битрикс»