Push

This API enables the Push functionality in the mobile application.

Note

The integration described in this article may not be implemented in your environment or enabled for all your clients. Contact your admin for assistance.

Technical Details

API ID

123

API Code

PUSH

Call API version

App Version

6.3.3

Objective

Push notifications for mobile

Classification

Notifications

Available for

iOS	For iOS, Firebase Support requires the PUSH_FCM and PUSH_WRAPPER modules, supported from the 6.3.7-stable branch onwards. To use Firebase and Apple Push (APN), it is necessary to add the PUSH_FCM, PUSH and PUSH_WRAPPER modules. To use Apple push (APN) without using Firebase, the PUSH module is required and, from the 6.3.7-stable branch onwards, it is also necessary to add the PUSH_WRAPPER module.
Android	To use the HMS (Huawei Mobile Services) Push Kit in Huawei devices that do not support Google services, add the PUSH_FCM and PUSH_WRAPPER modules, as required by Firebase Support. No additional permissions are required.
Harmony

Use the Push Integration in Studio

The following functions are available for use in your legacy processes, and you can also use them as blocks in Lambda processes. Click each function to see more details.

Get Status (Push)	Get the current status (registered or not registered) of the Push functionality in the application.
Register for Notifications	Perform the Push registration, using the necessary input parameters for each platform, and generate the Registration ID.
Unregister for Notifications	Perform the Push de-registration, using the necessary input parameters for each platform.
Set Badge Number	Set the Badge Number (external number displayed on some platforms, generally above the application icon).
Increment Badge Number	Increase or decrease the Badge Number.
Get Badge Number	Get the Badge Number (external number displayed on some platforms, generally above the application icon).
Synchronization Notified
Define Badge Channel	Define the channel that will be used for the Badge Number.
Add Push Structure	Add an expected structure to Push notifications, so that they can be displayed on the device.
Remove Push Structure	Delete the expected structure of Push notifications.

Get Status (Push)

This function is used to get the current status (registered or not registered) of the Push functionality in the application.

Parameter Configuration

This function requires you to complete the input register value with the channel name.

Function ID

Register	Value
110	1

Input Registers

Register	Description	Mandatory	Value
344	Channel Name	X	<<CHANNEL_NAME>>
390	Name of the additional channel registered in FCM (added in version 3)		<<ADDITIONAL_CHANNEL>>

Output Registers

Description

Value

112

Call Result

000	NO_ERROR
001	GENERIC_ERROR

231

Status

0	Not registered
1	Registered

Register For Notifications

This function performs the Push registration, using the necessary input parameters for each platform, and generates the Registration ID.

Parameter Configuration

This function requires you to complete the input register values with the Sender ID, the Channel Name and the Service Name. These registers are mandatory for some devices and optional for others, refer to the Input Registers section below to learn more.

Function ID

Register	Value
110	2

Input Registers

Register	Description	Mandatory	Value
336	Sender ID	X (only for Android and Harmony)	<<SENDER_ID>>
344	Channel Name	X (only for Windows Phone)	<<CHANNEL_NAME>>
345	Service Name	X (only for Windows Phone)	<<SERVICE_NAME>>
390	Name of the additional channel registered in FCM (added in version 3)		<<ADDITIONAL_CHANNEL>>
391	Additional Registration Data in JSON format registered in FCM (added in version 3)	Input 391 is not required to register additional channels when using HMS (Huawei Mobile Services) for Harmony, as additional channels are registered in the HMS project from the Huawei Developer console. In these cases, the only field required to obtain the Registration ID as output is the additional channel Sender ID.	<<REGISTRATION_DATA>>

{  "project_info": {

    "project_number": "754305972713",

    "firebase_url": "https://codipruebasvt19.firebaseio.com",

    "project_id": "codipruebasvt19",

    "storage_bucket": "codipruebasvt19.appspot.com"

  },

  "client": [

    {

      "client_info": {

        "mobilesdk_app_id": "1:754305972713:android:bd2af22444bfbc59",

        "android_client_info": {

          "package_name": "mx.com.banjercito.model.common.VTUserApplicationBJCTMB"

        }

      },

      "oauth_client": [

        {

          "client_id": "754305972713-ab58eqaqjtrcvfi2fdcflc252fmdhh3e.apps.googleusercontent.com",

          "client_type": 3

        }

      ],

      "api_key": [

        {

          "current_key": "AIzaSyA0D4wiPlkO4TYB_O7bXkhBY0MgFP3iK9k"

        }

      ],

      "services": {

        "analytics_service": {

          "status": 1

        },

        "appinvite_service": {

          "status": 1,

          "other_platform_oauth_client": []

        },

        "ads_service": {

          "status": 2

        }

      }

    },

    {

      "client_info": {

        "mobilesdk_app_id": "1:754305972713:android:3d5ba88cf5463012",

        "android_client_info": {

          "package_name": "net.veritran.bnbj.mb.s.vtdev"

        }

      },

      "oauth_client": [

        {

          "client_id": "754305972713-ab58eqaqjtrcvfi2fdcflc252fmdhh3e.apps.googleusercontent.com",

          "client_type": 3

        }

      ],

      "api_key": [

        {

          "current_key": "AIzaSyA0D4wiPlkO4TYB_O7bXkhBY0MgFP3iK9k"

        }

      ],

      "services": {

        "analytics_service": {

          "status": 1

        },

        "appinvite_service": {

          "status": 1,

          "other_platform_oauth_client": []

        },

        "ads_service": {

          "status": 2

        }

      }

    },

    {

      "client_info": {

        "mobilesdk_app_id": "1:#S{751}:ios:85632e49a3b970f5",

        "android_client_info": {

          "package_name": "net.veritran.bnbj.qa"

        }

      },

      "oauth_client": [

        {

          "client_id": "533741858338-2h0usdl9vfqpncrccnj3jbughn378ih8.apps.googleusercontent.com",

          "client_type": 3

        }

      ],

      "api_key": [

        {

          "current_key": "AIzaSyDqtaEtfDIBey4utUCLTJoi3Yjs7SFFDvg"

        }

      ]

    }

  ],

  "configuration_version": "1"

}

Output Registers

Description

Value

112

Call Result

000	NO_ERROR
001	GENERIC_ERROR
002	API_NOT_IMPLEMENTED_ERROR
003	FUNCTION_NOT_IMPLEMENTED_ERROR
100	GENERAL_EXCEPTION
101	WRONG_JSON_FORMAT
103	SENDER_ID_NULL

232

Registration ID

<<REGISTRATION_ID>>

234

Registration Platform

<<REGISTRATION_PLATFORM>>

Unregister For Notifications

This function performs the Push registration, using the necessary input parameters for each platform.

Parameter Configuration

This function requires you to complete the input register value with the channel name.

Function ID

Register	Value
110	3

Input Registers

Register	Description	Mandatory	Value
344	Channel Name	X	<<CHANNEL_NAME>>
390	Name of the additional channel registered in FCM (added in version 3)		<<ADDITIONAL_CHANNEL>>

Output Registers

Description

Value

112

Call Result

000	NO_ERROR
001	GENERIC_ERROR
102	FIREBASE_CHANNEL_DOESNT_EXIST

Set Badge Number

This function sets the Badge Number (external number displayed on some platforms, generally above the application icon).

Parameter Configuration

This function requires you to complete the input register value with the badge number to be set.

Function ID

Register	Value
110	4

Input Registers

Register	Description	Mandatory	Value
337	Badge Number	X	<<BADGE_NUMBER>>

Output Registers

Description

Value

112

Call Result

000	NO_ERROR
001	GENERIC_ERROR

Increment Badge Number

This function increases or decreases the Badge Number depending on the value entered as a parameter.

Parameter Configuration

This function requires you to complete the input register value with the badge number difference.

Function ID

Register	Value
110	5

Input Registers

Register	Description	Mandatory	Value
338	Badge Number difference	X	<<BADGE_NUMBER_DIFF>>

Output Registers

Description

Value

112

Call Result

000	NO_ERROR
001	GENERIC_ERROR

Get Badge Number

This function gets the Badge Number (external number displayed on some platforms, generally above the application icon).

Parameter Configuration

This function doesn't require the configuration of any parameters.

Function ID

Register	Value
110	6

Output Registers

Description

Value

112

Call Result

000	NO_ERROR
001	GENERIC_ERROR

236

Badge Number

<<BADGE_NUMBER>>

Synchronization Notified

This function

Parameter Configuration

This function doesn't require the configuration of any parameters.

Function ID

Register	Value
110	7

Input Registers

Register	Description	Mandatory	Value

Output Registers

Description

Value

112

Call Result

000	NO_ERROR
001	GENERIC_ERROR

Define Badge Channel

This function defines the channel that will be used for the Badge Number (external number displayed on some platforms, generally above the application icon).

Parameter Configuration

This function requires you to complete the input register value with the name of the channel registered in FCM.

Function ID

Register	Value
110	8

Input Registers

Register	Description	Mandatory	Value
390	Name of the channel registered in FCM	X	<<ADDITIONAL_CHANNEL>>

Output Registers

Description

Value

112

Call Result

000	NO_ERROR
001	GENERIC_ERROR
102	FIREBASE_CHANNEL_DOESNT_EXIST

Add Push Structure

This function is used to add an expected structure to Push notifications, so that they can be displayed on the device.

Parameter Configuration

This function requires you to complete the input register values with the name of the additional channel registered in FCM, the Message ID and the expected structure in JSON format.

Function ID

Register	Value
110	9

Input Registers

Register	Description	Mandatory	Value
390	Name of the additional channel registered in FCM.	X	<<ADDITIONAL_CHANNEL>>
391	Message ID	X	<<MESSAGE_STRUCTURE_ID>>
392	Expected structure (in JSON format)	X	<<STRUCTURE>>

{
   "notification_dialog_data":

    { 

        "message":"[expected body message tag, separated by dots (.) if included in an object]",

        "subject":"[expected body title tag, separated by dots (.) if included in an object]"

    },
    "notification_structure_identifier" : "[tag that differentiates the structure from others, separated by dots (.) if included in an object]"
    "notification_internal_data":

    {         

          "[name shown in the generic data group]" : "[body message tag, separated by dots (.), to be sent to the application]", 

"[name shown in the generic data group]" : "[body subject tag, separated by dots (.), to be sent to the application]"

     }

}

Output Registers

Description

Value

112

Call Result

000	NO_ERROR
001	WRONG_PARAMETERS_ERROR
101	WRONG_JSON_FORMAT

Remove Push Structure

This function is used to delete the expected structure of Push notifications, so that they can be displayed on the device.

Parameter Configuration

This function requires you to complete the input register values with the name of the additional channel registered in FCM and the Message ID.

Function ID

Register	Value
110	10

Input Registers

Register	Description	Mandatory	Value
390	Name of the additional channel registered in FCM.	X	<<ADDITIONAL_CHANNEL>>
391	Message ID	X	<<MESSAGE_STRUCTURE_ID>>

Output Registers

Description

Value

112

Call Result

000	NO_ERROR
001	WRONG_PARAMETERS_ERROR

In this section:

Veritran Docs

Push

Note

Technical Details

Use the Push Integration in Studio

Get Status (Push)

Parameter Configuration

Function ID

Input Registers

Output Registers

Register For Notifications

Parameter Configuration

Function ID

Input Registers

Output Registers

Unregister For Notifications

Parameter Configuration

Function ID

Input Registers

Output Registers

Set Badge Number

Parameter Configuration

Function ID

Input Registers

Output Registers

Increment Badge Number

Parameter Configuration

Function ID

Input Registers

Output Registers

Get Badge Number

Parameter Configuration

Function ID

Output Registers

Synchronization Notified

Parameter Configuration

Function ID

Input Registers

Output Registers

Define Badge Channel

Parameter Configuration

Function ID

Input Registers

Output Registers

Add Push Structure

Parameter Configuration

Function ID

Input Registers

Output Registers

Remove Push Structure

Parameter Configuration

Function ID

Input Registers

Output Registers

Search results