Push

Esta API habilita la funcionalidad Push en la app móvil.

Nota

Es posible que la integración descrita en este artículo no esté implementada en tu ambiente ni esté habilitada para todos tus clientes. Contacta a tu administrador de sistema para recibir ayuda.

Ficha técnica

API ID

123

Código de la API

PUSH

Versión de la Call API

Versión de la app

6.3.3

Objetivo

Notificaciones Push para móvil

Clasificación

Notificaciones

Disponible para

iOS	Para iOS, Firebase Support requiere los módulos PUSH_FCM y PUSH_WRAPPER, compatibles desde la rama estable 6.3.7 en adelante. Para usar Firebase y Apple Push (APN), es necesario agregar los módulos PUSH_FCM, PUSH y PUSH_WRAPPER. Para usar Apple push (APN) sin usar Firebase, es necesario el módulo PUSH y, a partir de la rama estable 6.3.7, también es necesario agregar el módulo PUSH_WRAPPER.
Android	Para usar el Push Kit de HMS (Huawei Mobile Services) en los dispositivos Huawei que no son compatibles con los servicios de Google, agrega los módulos PUSH_FCM y PUSH_WRAPPER, según lo requiera Firebase Support. No se requieren permisos adicionales.
Harmony

Usa la integración Push en Studio

Las siguientes funciones están disponibles para que las uses en tus procesos legacy y también puedes usarlas como bloques en los procesos lambda. Haz clic en cada función para obtener más detalles.

Get Status (Push)	Obtén el estado actual (registrado o no registrado) de la funcionalidad Push en la app.
Register for Notifications	Realiza el registro Push mediante el uso de los parámetros de entrada necesarios para cada plataforma y genera el ID de registro.
Unregister for Notifications	Realiza la anulación del registro Push mediante el uso de los parámetros de entrada necesarios para cada plataforma.
Set Badge Number	Establece el contador de notificaciones (número externo que se muestra en algunas plataformas, generalmente, sobre el ícono de la app).
Increment Badge Number	Aumenta o disminuye el contador de notificaciones.
Get Badge Number	Obtén el contador de notificaciones (número externo que se muestra en algunas plataformas, generalmente, arriba del ícono de la app).
Synchronization Notified
Define Badge Channel	Define el canal que se utilizará para el contador de notificaciones.
Add Push Structure	Agrega una estructura esperada a las notificaciones Push para que puedan visualizarse en el dispositivo.
Remove Push Structure	Borra la estructura esperada de las notificaciones Push.

Get Status (Push)

Esta función se utiliza para obtener el estado actual (registrado o no registrado) de la funcionalidad Push en la app.

Configuración del parámetro

Esta función requiere que completes el valor del registro de entrada con el nombre del canal.

ID de la función

Registro	Valor
110	1

Registros de entrada

Registro	Descripción	Obligatorio	Valor
344	Nombre del canal	X	<<CHANNEL_NAME>>
390	Nombre del canal adicional registrado en FCM (agregado en la versión 3)		<<ADDITIONAL_CHANNEL>>

Registros de salida

Registro

Descripción

Valor

112

Resultado de la Call

000	NO_ERROR
001	GENERIC_ERROR

231

Estado

0	No registrado
1	Registrado

Register For Notifications

Esta función realiza el registro Push mediante el uso de los parámetros de entrada necesarios para cada plataforma y genera el ID de registro.

Configuración del parámetro

Esta función requiere que completes los valores del registro de entrada con el ID del emisor, el nombre del canal y el nombre del servicio. Estos registros son obligatorios para algunos dispositivos y opcionales para otros. Consulta la sección Registros de entrada que se muestra a continuación para obtener más información.

ID de la función

Registro	Valor
110	2

Registros de entrada

Registro	Descripción	Obligatorio	Valor
336	ID del emisor	X (solo para Android y Harmony)	<<SENDER_ID>>
344	Nombre del canal	X (solo para Windows Phone)	<<CHANNEL_NAME>>
345	Nombre del servicio	X (solo para Windows Phone)	<<SERVICE_NAME>>
390	Nombre del canal adicional registrado en FCM (agregado en la versión 3)		<<ADDITIONAL_CHANNEL>>
391	Datos del registro adicional en formato JSON registrado en FCM (agregado en la versión 3)	La entrada 391 no es necesaria para registrar canales adicionales cuando se utiliza HMS (Huawei Mobile Services) para Harmony, ya que los canales adicionales se registran en el proyecto HMS desde la consola Huawei Developer. En estos casos, el único campo necesario para obtener el ID de registro como salida es el ID de emisor del canal adicional.	<<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"

}

Registros de salida

Registro

Descripción

Valor

112

Resultado de la Call

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

ID del registro

<<REGISTRATION_ID>>

234

Plataforma de registro

<<REGISTRATION_PLATFORM>>

Unregister For Notifications

Esta función realiza el registro Push mediante el uso de los parámetros de entrada necesarios para cada plataforma.

Configuración del parámetro

Esta función requiere que completes el valor del registro de entrada con el nombre del canal.

ID de la función

Registro	Valor
110	3

Registros de entrada

Registro	Descripción	Obligatorio	Valor
344	Nombre del canal	X	<<CHANNEL_NAME>>
390	Nombre del canal adicional registrado en FCM (agregado en la versión 3)		<<ADDITIONAL_CHANNEL>>

Registros de salida

Registro

Descripción

Valor

112

Resultado de la Call

000	NO_ERROR
001	GENERIC_ERROR
102	FIREBASE_CHANNEL_DOESNT_EXIST

Set Badge Number

Esta función establece el contador de notificaciones (número externo que se muestra en algunas plataformas, generalmente arriba del ícono de la app).

Configuración del parámetro

Esta función requiere que completes el valor del registro de entrada con el contador de notificaciones para su configuración.

ID de la función

Registro	Valor
110	4

Registros de entrada

Registro	Descripción	Obligatorio	Valor
337	Contador de notificaciones	X	<<BADGE_NUMBER>>

Registros de salida

Registro

Descripción

Valor

112

Resultado de la Call

000	NO_ERROR
001	GENERIC_ERROR

Increment Badge Number

Esta función aumenta o disminuye el contador de notificaciones según el valor ingresado como parámetro.

Configuración del parámetro

Esta función requiere que completes el valor del registro de entrada con la diferencia del contador de notificaciones.

ID de la función

Registro	Valor
110	5

Registros de entrada

Registro	Descripción	Obligatorio	Valor
338	Diferencia del contador de notificaciones	X	<<BADGE_NUMBER_DIFF>>

Registros de salida

Registro

Descripción

Valor

112

Resultado de la Call

000	NO_ERROR
001	GENERIC_ERROR

Get Badge Number

Esta función obtiene el contador de notificaciones (número externo que se muestra en algunas plataformas, generalmente arriba del ícono de la app).

Configuración del parámetro

Esta función no requiere la configuración de ningún parámetro.

ID de la función

Registro	Valor
110	6

Registros de salida

Registro

Descripción

Valor

112

Resultado de la Call

000	NO_ERROR
001	GENERIC_ERROR

236

Contador de notificaciones

<<BADGE_NUMBER>>

Synchronization Notified

Esta función

Configuración del parámetro

Esta función no requiere la configuración de ningún parámetro.

ID de la función

Registro	Valor
110	7

Registros de entrada

Registro	Descripción	Obligatorio	Valor

Registros de salida

Registro

Descripción

Valor

112

Resultado de la Call

000	NO_ERROR
001	GENERIC_ERROR

Define Badge Channel

Esta función define el canal que se usará para el contador de notificaciones (número externo que se muestra en algunas plataformas, generalmente arriba del ícono de la app).

Configuración del parámetro

Esta función requiere que completes el valor del registro de entrada con el nombre del canal registrado en FCM.

ID de la función

Registro	Valor
110	8

Registros de entrada

Registro	Descripción	Obligatorio	Valor
390	Nombre del canal registrado en FCM	X	<<ADDITIONAL_CHANNEL>>

Registros de salida

Registro

Descripción

Valor

112

Resultado de la Call

000	NO_ERROR
001	GENERIC_ERROR
102	FIREBASE_CHANNEL_DOESNT_EXIST

Add Push Structure

Esta función se utiliza para agregar una estructura esperada a las notificaciones Push para que puedan visualizarse en el dispositivo.

Configuración del parámetro

Esta función requiere que completes los valores del registro de entrada con el nombre del canal adicional registrado en FCM, el ID del mensaje y la estructura esperada en formato JSON.

ID de la función

Registro	Valor
110	9

Registros de entrada

Registro	Descripción	Obligatorio	Valor
390	Nombre del canal adicional registrado en FCM	X	<<ADDITIONAL_CHANNEL>>
391	ID del mensaje	X	<<MESSAGE_STRUCTURE_ID>>
392	Estructura esperada (en formato JSON)	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]"

     }

}

Registros de salida

Registro

Descripción

Valor

112

Resultado de la Call

000	NO_ERROR
001	WRONG_PARAMETERS_ERROR
101	WRONG_JSON_FORMAT

Remove Push Structure

Esta función se utiliza para eliminar una estructura esperada de las notificaciones Push para que puedan visualizarse en el dispositivo.

Configuración del parámetro

Esta función requiere que completes los valores del registro de entrada con el nombre del canal adicional registrado en FCM y el ID del mensaje.

ID de la función

Registro	Valor
110	10

Registros de entrada

Registro	Descripción	Obligatorio	Valor
390	Nombre del canal adicional registrado en FCM	X	<<ADDITIONAL_CHANNEL>>
391	ID del mensaje	X	<<MESSAGE_STRUCTURE_ID>>

Registros de salida

Registro

Descripción

Valor

112

Resultado de la Call

000	NO_ERROR
001	WRONG_PARAMETERS_ERROR

Veritran Docs

Push

Nota

Ficha técnica

Usa la integración Push en Studio

Get Status (Push)

Configuración del parámetro

ID de la función

Registros de entrada

Registros de salida

Register For Notifications

Configuración del parámetro

ID de la función

Registros de entrada

Registros de salida

Unregister For Notifications

Configuración del parámetro

ID de la función

Registros de entrada

Registros de salida

Set Badge Number

Configuración del parámetro

ID de la función

Registros de entrada

Registros de salida

Increment Badge Number

Configuración del parámetro

ID de la función

Registros de entrada

Registros de salida

Get Badge Number

Configuración del parámetro

ID de la función

Registros de salida

Synchronization Notified

Configuración del parámetro

ID de la función

Registros de entrada

Registros de salida

Define Badge Channel

Configuración del parámetro

ID de la función

Registros de entrada

Registros de salida

Add Push Structure

Configuración del parámetro

ID de la función

Registros de entrada

Registros de salida

Remove Push Structure

Configuración del parámetro

ID de la función

Registros de entrada

Registros de salida