Enviar un mensaje de producto de un solo artículo

En este fragmento de código aprenderás a enviar un mensaje de producto que contenga un único artículo a un chat de WhatsApp utilizando la Messages API. Puedes obtener más información sobre Mensajes de productos para obtener más información sobre el uso de este fragmento de código.

Este tipo de mensaje utiliza el servicio de Vonage Objeto personalizado función. Encontrará más información sobre el formato específico de los mensajes en la página para desarrolladores de WhatsApp Mensajes de productos documentación.

Ejemplo

A continuación encontrará la descripción de todas las variables utilizadas en cada fragmento de código:

ClaveDescripción
VONAGE_APPLICATION_ID

The Vonage Application ID.

VONAGE_APPLICATION_PRIVATE_KEY_PATH

Private key path.

VONAGE_PRIVATE_KEY_PATH

Private key path.

BASE_URL

For production use the base URL is https://api.nexmo.com/. For sandbox testing the base URL is https://messages-sandbox.nexmo.com/.

MESSAGES_API_URL

There are two versions of the API, each with their own endpoints. For production the previous Messages API endpoint was https://api.nexmo.com/v0.1/messages, the new one is https://api.nexmo.com/v1/messages. For sandbox testing the Messages API endpoint is https://messages-sandbox.nexmo.com/v0.1/messages or https://messages-sandbox.nexmo.com/v1/messages, depending on which version you have set in the sandbox dashboard.

WHATSAPP_NUMBER

The WhatsApp number that has been allocated to you by Vonage. For sandbox testing the number is 14157386102.

VONAGE_WHATSAPP_NUMBER

Refer to WHATSAPP_NUMBER above.

VONAGE_NUMBER

Refer to WHATSAPP_NUMBER above.

TO_NUMBER

Replace with the number you are sending to. E.g. 447700900001

NOTA: No utilice un + o 00 Al introducir un número de teléfono, empieza por el código de país; por ejemplo, 447700900000.

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

Escriba el código

Añada lo siguiente a send-single-product.sh:

curl -X POST "${MESSAGES_API_URL}" \
  -H "Authorization: Bearer "$JWT\
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "to": "'${MESSAGES_TO_NUMBER}'",
    "from": "'${WHATSAPP_SENDER_ID}'",
    "channel": "whatsapp",
    "message_type": "custom",
    "custom": {
      "type": "interactive",
      "interactive": {
        "type": "product",
        "body": {
          "text": "Check out this cool product"
        },
        "footer": {
          "text": "Sale now on!"
        },
        "action": {
          "catalog_id": "'${WHATSAPP_CATALOG_ID}'",
          "product_retailer_id": "'${WHATSAPP_PRODUCT_ID_1}'"
        }
      }
    }

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

bash send-single-product.sh

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

Añada lo siguiente a build.gradle:

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

Crea un archivo llamado SendWhatsappSingleProduct y añade el siguiente código al método main:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

Ver fuente completa

Escriba el código

Añada lo siguiente al método main del archivo SendWhatsappSingleProduct:

val messageId = client.messages.send(
    whatsappSingleProduct {
        to(MESSAGES_TO_NUMBER)
        from(WHATSAPP_SENDER_ID)
        catalogId(WHATSAPP_CATALOG_ID)
        productRetailerId(WHATSAPP_PRODUCT_ID)
        bodyText("Check out this cool product")
        footerText("Sale now on!")
    }
)

Ver fuente completa

Ejecute su código

Podemos utilizar el plugin aplicación para Gradle para simplificar la ejecución de nuestra aplicación. Actualiza tu build.gradle con lo siguiente:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Ejecute el siguiente comando gradle para ejecutar su aplicación, sustituyendo com.vonage.quickstart.kt.messages.whatsapp por el paquete que contiene SendWhatsappSingleProduct:

gradle run -Pmain=com.vonage.quickstart.kt.messages.whatsapp.SendWhatsappSingleProduct

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

Añada lo siguiente a build.gradle:

implementation 'com.vonage:server-sdk:9.3.1'

Crea un archivo llamado SendWhatsappSingleProduct y añade el siguiente código al método main:

VonageClient client = VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build();

Ver fuente completa

Escriba el código

Añada lo siguiente al método main del archivo SendWhatsappSingleProduct:

var response = client.getMessagesClient().sendMessage(
		WhatsappSingleProductRequest.builder()
			.from(WHATSAPP_SENDER_ID).to(MESSAGES_TO_NUMBER)
			.catalogId(WHATSAPP_CATALOG_ID)
			.productRetailerId(WHATSAPP_PRODUCT_ID)
			.bodyText("Check out this cool product")
			.footerText("Sale now on!")
			.build()
);
System.out.println("Message sent successfully. ID: "+response.getMessageUuid());

Ver fuente completa

Ejecute su código

Podemos utilizar el plugin aplicación para Gradle para simplificar la ejecución de nuestra aplicación. Actualiza tu build.gradle con lo siguiente:

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Ejecute el siguiente comando gradle para ejecutar su aplicación, sustituyendo com.vonage.quickstart.messages.whatsapp por el paquete que contiene SendWhatsappSingleProduct:

gradle run -Pmain=com.vonage.quickstart.messages.whatsapp.SendWhatsappSingleProduct

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

Install-Package Vonage

Escriba el código

Añada lo siguiente a SendWhatsAppSingleProduct.cs:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
var request = new WhatsAppCustomRequest
{
    To = MESSAGES_TO_NUMBER,
    From = WHATSAPP_SENDER_ID,
    Custom = new
    {
        type = "interactive",
        interactive = new
        {
            type = "product",
            body = new
            {
                text = "Check out this cool product"
            },
            footer = new
            {
                text = "Sale now on!"
            },
            action = new
            {
                catalog_id = WHATSAPP_CATALOG_ID,
                product_retailer_id = WHATSAPP_PRODUCT_ID
            }
        }
    }
};
var response = await vonageClient.MessagesClient.SendAsync(request);

Ver fuente completa

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

composer require vonage/client

Crea un archivo llamado send-single-product.php y añade el siguiente código:

$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
    VONAGE_APPLICATION_ID
);

$client = new \Vonage\Client($keypair);

Ver fuente completa

Escriba el código

Añada lo siguiente a send-single-product.php:

$custom = [
    "to" => TO_NUMBER,
    "from" => WHATSAPP_NUMBER,
    "channel" => "whatsapp",
    "message_type" => "custom",
    "custom" => [
        "type" => "interactive",
        "interactive" => [
            "type" => "product",
            "body" => [
                "text" => "Check out this cool product"
            ],
            "footer" => [
                "text" => "Sale now on!"
            ],
            "action" => [
                "catalog_id" => CATALOG_ID,
                "product_retailer_id" => PRODUCT_ID
            ]
        ]
    ]
];

$whatsApp = new \Vonage\Messages\Channel\WhatsApp\WhatsAppCustom(
    TO_NUMBER,
    FROM_NUMBER,
    $custom
);

$client->messages()->send($whatsApp);

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

php send-single-product.php

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

pip install vonage python-dotenv

Escriba el código

Añada lo siguiente a send-product-message-single-item.py:

from vonage import Auth, Vonage
from vonage_messages import WhatsappCustom

client = Vonage(
    Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_PRIVATE_KEY,
    )
)

message = WhatsappCustom(
    to=MESSAGES_TO_NUMBER,
    from_=WHATSAPP_SENDER_ID,
    custom={
        'type': 'interactive',
        'interactive': {
            'type': 'product',
            'body': {'text' 'Check out this cool product'},
            'footer': {'text': 'Sale now on!'},
            'action': {
                'catalog_id': WHATSAPP_CATALOG_ID,
                'product_retailer_id': WHATSAPP_PRODUCT_ID_1,
            },
        },
    },
)

response = client.messages.send(message)
print(response)

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

python messages/whatsapp/send-product-message-single-item.py

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

gem install vonage

Crea un archivo llamado send-single-product.rb y añade el siguiente código:

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: VONAGE_PRIVATE_KEY
)

Ver fuente completa

Escriba el código

Añada lo siguiente a send-single-product.rb:

message = client.messaging.whatsapp(
  type: 'custom',
  message: {
    type: "interactive",
    interactive: {
      type: "product",
      body: {
        text: "Check out this cool product"
      },
      footer: {
        text: "Sale now on!"
      },
      action: {
        catalog_id: WHATSAPP_CATALOG_ID,
        product_retailer_id: WHATSAPP_PRODUCT_ID_1
      }
    }
  }
)

client.messaging.send(
  from: WHATSAPP_SENDER_ID,
  to: MESSAGES_TO_NUMBER,
  **message
)

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

ruby send-single-product.rb

Pruébalo

Al ejecutar el código, se envía un mensaje de WhatsApp de un solo producto al número de destino.

Para más información