Send push notifications to a mobile device using the method pull.application.push.add

We are still updating this page

Some data may be missing — we will complete it soon.

Scope: pull

Who can execute the method: administrator

The method pull.application.push.add is used to send a push notification to a mobile device within the Bitrix24 application.

Parameters

Parameter

Description

USER_ID*

Identifiers of the users receiving the push notifications.

TEXT

Custom text.

AVATAR

Link to an image.

Required parameters are marked with *

Examples

BX24.callMethod('pull.application.push.add', {
            'USER_ID': [1,2,3],
            'TEXT': 'Hello, world!',
            'AVATAR': 'https://files.shelenkov.com/images/avatar-johnson.jpg',
        }, function(result){
            if(result.error())
            {
                console.error(result.error().ex);
            }
            else
            {
                console.log(result.data());
            }
        });
        
$result = restCommand('pull.application.push.add', [
            'USER_ID' => [1,2,3],
            'TEXT' => 'Hello, world!',
            'AVATAR' => 'https://files.shelenkov.com/images/avatar-johnson.jpg',
        ], $_REQUEST["auth"]);
        

How to Use Examples in Documentation

Successful response

200 OK

{
            "result": true
        }
        

Error response

200 Error, 50x Error

{
            "error": "WRONG_AUTH_TYPE",
            "error_description": "Send push notifications available only for application authorization."
        }
        

Keys:

  • error - code of the occurred error
  • error_description - brief description of the occurred error

Possible error codes

Code

Description

TEXT_ERROR

Message text was not provided.

EMPTY_APP_NAME

Error occurs if your application does not have a name assigned.

ACCESS_ERROR

The method can only be used by a user with administrator rights.

WRONG_AUTH_TYPE

The method can only be used within OAuth 2.0.

See also