Recuperar mensajes integrados en la aplicación para un punto de conexión mediante programación con Amazon Pinpoint - Amazon Pinpoint

Aviso de fin de soporte: el 30 de octubre de 2026, AWS finalizará el soporte para Amazon Pinpoint. Después del 30 de octubre de 2026, ya no podrá acceder a la consola de Amazon Pinpoint ni a los recursos de Amazon Pinpoint (puntos de conexión, segmentos, campañas, recorridos y análisis). Para obtener más información, consulte Fin de soporte de Amazon Pinpoint. Nota: en lo APIs que respecta a los SMS, este cambio no afecta a los mensajes de voz, a las notificaciones push móviles, a las OTP y a la validación de números de teléfono, y son compatibles con la mensajería para el usuario AWS final.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Recuperar mensajes integrados en la aplicación para un punto de conexión mediante programación con Amazon Pinpoint

Las aplicaciones pueden llamar a la API GetInAppMessages para recuperar todos los mensajes integrados en la aplicación a los que tiene derecho un punto de conexión determinado. Cuando se llama a la API de GetInAppMessages, se proporcionan los siguientes parámetros:

  • ApplicationId: el ID único del proyecto de Amazon Pinpoint con el que está asociada la campaña del mensaje integrada en la aplicación.

  • EndpointId: el ID único del punto de conexión para el que estás recuperando los mensajes.

Cuando se llama a la API con estos valores, devuelve una lista de mensajes. Para obtener más información acerca de la respuesta producida por esta operación, consulte Ejemplo de JSON de respuesta de la API GetInAppMessages de Amazon Pinpoint.

Puede utilizar los AWS SDK para llamar a la operación GetInAppMessages. Los siguientes ejemplos de código incluyen funciones que recuperan mensajes integrados en la aplicación.

JavaScript

Cree el cliente en un módulo separado y expórtelo:

import { PinpointClient } from "@aws-sdk/client-pinpoint";
const REGION = "us-east-1";
const pinClient = new PinpointClient({ region: REGION });
export { pinClient };

Recupere mensajes dentro de la aplicación para un punto de conexión:


// Import required AWS SDK clients and commands for Node.js
import { PinpointClient, GetInAppMessagesCommand } from "@aws-sdk/client-pinpoint";
import { pinClient } from "./lib/pinClient.js";

("use strict");

//The Amazon Pinpoint application ID.
const projectId = "4c545b28d21a490cb51b0b364example";

//The ID of the endpoint to retrieve messages for.
const endpointId = "c5ac671ef67ee3ad164cf7706example";

const params = {
  ApplicationId: projectId,
  EndpointId: endpointId
};

const run = async () => {
  try {
    const data = await pinClient.send(new GetInAppMessagesCommand(params));
    console.log(JSON.stringify(data, null, 4));
    return data; 
  } catch (err) {
    console.log("Error", err);
  }
};
run();
Python
import logging
import boto3
from botocore.exceptions import ClientError

logger = logging.getLogger(__name__)

def retrieve_inapp_messages(
            pinpoint_client, project_id, endpoint_id):
    """
    Retrieves the in-app messages that a given endpoint is entitled to.

    :param pinpoint_client: A Boto3 Pinpoint client.
    :param project_id: An Amazon Pinpoint project ID.
    :param endpoint_id: The ID of the endpoint to retrieve messages for.
    :return: A JSON object that contains information about the in-app message.
    """

    try:
        response = pinpoint_client.get_in_app_messages(
            ApplicationId=project_id,
            EndpointId=endpoint_id)
    except ClientError:
        logger.exception("Couldn't retrieve messages.")
        raise
    else:
        return response

def main():
    project_id = "4c545b28d21a490cb51b0b364example"
    endpoint_id = "c5ac671ef67ee3ad164cf7706example"
    inapp_response = retrieve_inapp_messages(
        boto3.client('pinpoint'), project_id, endpoint_id)
    print(inapp_response)

if __name__ == '__main__':
    main()