Views: 3430
Last Modified: 23.03.2022
Pins dialog in favorites |
Revision
Get current information about current API revision (platform version) – im.revision.get
: 18 |
Attention:
restCommand function is used here for illustration purposes only. It is taken from the
EchoBot example. You can send a REST command with your own function, or use the
BX24.callMethod or
bitrix24-php-sdk methods.
Parameters
Parameter |
Example |
Req. |
Description |
Revision |
DIALOG_ID |
chat17 |
Yes |
Dialog ID. Format: chatXXX – recipient chat, when sending message to chat
| 19 |
PIN |
Y |
No |
Pin or unpin a dialog |
19 |
|
- If the
PIN = N
parameter is specified, the pinned dialog will be unpinned.
Called method and response
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"]);
Example of response
{
"result": true
}
Example of response when error occurs
{
"error": "DIALOG_ID_EMPTY",
"error_description": "Dialog ID can't be empty"
}
Description of keys:
error
– error code
error_description
– brief description of error
Possible error codes
Code |
Description |
DIALOG_ID_EMPTY |
Dialog ID not passed. |
|