Views: 911
Last Modified: 23.03.2022
Deleting notification |
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 |
Required |
Description |
Revision |
| USER_ID |
123 |
Yes |
Notification ID |
18 |
| TAG |
TEST |
Yes* |
Notification tag, unique within the system. |
18 |
| SUB_TAG |
SUB|TEST |
Yes* |
Additional tag, without duplicate check |
18 |
|
* You need to indicate one of three required parameters for selection: ID (notification ID), TAG (notification tag) or SUB_TAG (additional tag).
Related links
How to handle attachments
Called method and response
PHP
$result = restCommand('im.notify.delete', Array(
'ID' => 13,
'TAG' => 'TEST',
'SUB_TAG' => 'SUB|TEST'
), $_REQUEST["auth"]);
Response example
{
"result": true
}
Response:
true or error.
Example of response on error
{
"error": "PARAMS_ERROR",
"error_description": "Error deleting notification"
}
Key description:
error – error codeerror_description – error brief description
Possible error codes
| Code |
Description |
| PARAMS_ERROR |
Error deleting notification |
|