Enviar una plantilla de autenticación de WhatsApp
En este fragmento de código aprenderá a enviar una plantilla de autenticación de WhatsApp utilizando la Messages API.
WhatsApp ha actualizado recientemente las normas de uso de las plantillas de autenticación, que ahora deben incluir un COPY_CODE o ONE_TAP botón. Dado que contiene un botón, una plantilla de autenticación se considera una plantilla interactiva. Al enviar plantillas interactivas a través de la API de Messages API de Vonage, deben enviarse con un botón message_type de custom en lugar de template.
La plantilla To se envía mediante el objeto personalizado Messages. El objeto personalizado toma una sección parcial de la solicitud original de la API de WhatsApp y la envía directamente a WhatsApp.
Las plantillas de mensajes multimedia de WhatsApp constan de una estructura de cuerpo, pie de página y botones.
Nota: En caso de que esté intentando enviar una plantilla Auth con el botón One-Tap y si no realiza un apretón de manos antes de enviar el mensaje, o el mensaje no supera una comprobación de elegibilidad, el mensaje entregado mostrará un botón de copia de código en lugar de un botón de una pulsación.
Ejemplo
A continuación encontrará la descripción de todas las variables utilizadas en cada fragmento de código:
| Clave | Descripción |
|---|---|
VONAGE_APPLICATION_ID | The Vonage Application ID. |
VONAGE_APPLICATION_PRIVATE_KEY_PATH | Private key path. |
WHATSAPP_NUMBER | The WhatsApp number that has been allocated to you by Vonage. For sandbox testing the number is 14157386102. |
VONAGE_NUMBER | Refer to |
TO_NUMBER | Replace with the number you are sending to. E.g. |
WHATSAPP_AUTH_TEMPLATE_NAME | The name of the Authentication template created in your WhatsApp Business Account. |
OTP | A One-Time Password |
NOTA: No utilice un + o 00 cuando introduzca un número de teléfono, empiece por el prefijo del 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-authentication-template.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": "template",
"template": {
"name": "'${WHATSAPP_TEMPLATE_NAME}'",
"language": {
"policy": "deterministic",
"code": "en"
},
"components": [
{
"type": "body",
"parameters": [
{
"type": "text",
"text": "'${WHATSAPP_OTP}'"
}
]
},
{
"type": "button",
"sub_type": "url",
"index": "0",
"parameters": [
{
"type": "text",
"text": "'${WHATSAPP_OTP}'"
}
]
}
]
}
}Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
npm install @vonage/server-sdk @vonage/messagesCrea un archivo llamado send-authentication-template.js y añade el siguiente código:
const { Vonage } = require('@vonage/server-sdk');
const { Channels } = require('@vonage/messages');
/**
* It is best to send messages using JWT instead of basic auth. If you leave out
* apiKey and apiSecret, the messages SDK will send requests using JWT tokens
*
* @link https://developer.vonage.com/en/messages/technical-details#authentication
*/
const vonage = new Vonage(
{
applicationId: VONAGE_APPLICATION_ID,
privateKey: VONAGE_PRIVATE_KEY,
},
{
...(MESSAGES_API_URL ? {apiHost: MESSAGES_API_URL} : {}),
},
);Escriba el código
Añada lo siguiente a send-authentication-template.js:
vonage.messages.send({
to: MESSAGES_TO_NUMBER,
from: WHATSAPP_SENDER_ID,
channel: Channels.WHATSAPP,
messageType: 'custom',
custom: {
type: 'template',
template: {
name: WHATSAPP_TEMPLATE_NAME,
language: {
policy: 'deterministic',
code: 'en',
},
components: [
{
type: 'body',
parameters: [
{
type: 'text',
text: WHATSAPP_OTP,
},
],
},
{
type: 'button',
sub_type: 'url',
index: '0',
parameters: [
{
type: 'text',
text: WHATSAPP_OTP,
},
],
},
],
},
},
})
.then(({ messageUUID }) => console.log(messageUUID))
.catch((error) => console.error(error));Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
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 SendWhatsappAuthenticationTemplate y añade el siguiente código al método main:
val client = Vonage {
applicationId(VONAGE_APPLICATION_ID)
privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}Escriba el código
Añada lo siguiente al método main del archivo SendWhatsappAuthenticationTemplate:
val messageId = client.messages.send(
whatsappCustom {
to(MESSAGES_TO_NUMBER)
from(WHATSAPP_SENDER_ID)
custom(mapOf(
"type" to MessageType.TEMPLATE,
"template" to mapOf(
"name" to WHATSAPP_AUTH_TEMPLATE_NAME,
"language" to mapOf(
"policy" to Policy.DETERMINISTIC,
"code" to Locale.ENGLISH
),
"components" to listOf(
mapOf(
"type" to "body",
"parameters" to listOf(
mapOf(
"type" to MessageType.TEXT,
"text" to WHATSAPP_OTP
)
)
),
mapOf(
"type" to MessageType.BUTTON,
"sub_type" to "url",
"index" to 0,
"parameters" to listOf(
mapOf(
"type" to MessageType.TEXT,
"text" to WHATSAPP_OTP
)
)
)
)
)
))
}
)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 SendWhatsappAuthenticationTemplate:
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 SendWhatsappAuthenticationTemplate 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();Escriba el código
Añada lo siguiente al método main del archivo SendWhatsappAuthenticationTemplate:
var response = client.getMessagesClient().sendMessage(
WhatsappCustomRequest.builder()
.from(WHATSAPP_SENDER_ID).to(MESSAGES_TO_NUMBER)
.custom(Map.of(
"type", MessageType.TEMPLATE,
"template", Map.of(
"name", WHATSAPP_AUTH_TEMPLATE_NAME,
"language", Map.of(
"policy", Policy.DETERMINISTIC,
"code", Locale.ENGLISH
),
"components", List.of(
Map.of(
"type", "body",
"parameters", List.of(
Map.of(
"type", MessageType.TEXT,
"text", WHATSAPP_OTP
)
)
),
Map.of(
"type", MessageType.BUTTON,
"sub_type", "url",
"index", 0,
"parameters", List.of(
Map.of(
"type", MessageType.TEXT,
"text", WHATSAPP_OTP
)
)
)
)
)
)).build()
);
System.out.println("Message sent successfully. ID: "+response.getMessageUuid());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 SendWhatsappAuthenticationTemplate:
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
Install-Package VonageEscriba el código
Añada lo siguiente a SendWhatsAppAuthenticationTemplate.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 = "template",
template = new
{
name = WHATSAPP_TEMPLATE_NAME,
language = new
{
code = "en",
policy = "deterministic"
},
components = new object[]
{
new
{
type = "body",
parameters = new[]
{
new
{
type = "text",
text = WHATSAPP_OTP
}
}
},
new
{
type = "button",
sub_type = "url",
index = "0",
parameters = new[]
{
new
{
type = "text",
text = WHATSAPP_OTP
}
}
}
}
}
}
};
var response = await vonageClient.MessagesClient.SendAsync(request);Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
composer require vonage/clientCrea un archivo llamado send-authentication-template.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);Escriba el código
Añada lo siguiente a send-authentication-template.php:
$custom = [
"to" => TO_NUMBER,
"from" => WHATSAPP_NUMBER,
"channel" => "whatsapp",
"message_type" => "custom",
"custom" => [
"type" => "template",
"template" => [
"name" => WHATSAPP_AUTH_TEMPLATE_NAME,
"language" => [
"policy" => "deterministic",
"code" => "en"
],
"components" => [
[
"type" => "body",
"parameters" => [
[
"type" => "text",
"text" => '$OTP'
]
]
],
[
"type" => "button",
"sub_type" => "url",
"index" => "0",
"parameters" => [
[
"type" => "text",
"text" => '$OTP'
]
]
]
]
]
]
];
$whatsApp = new \Vonage\Messages\Channel\WhatsApp\WhatsAppCustom(
TO_NUMBER,
FROM_NUMBER,
$custom
);
$client->messages()->send($whatsApp);Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
pip install vonage python-dotenvEscriba el código
Añada lo siguiente a send-authentication-template.py:
print(response)Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
Requisitos previos
Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.
gem install vonageCrea un archivo llamado send-authentication-template.rb y añade el siguiente código:
Ejecute su código
Guarde este archivo en su máquina y ejecútelo:
Pruébalo
Al ejecutar el código, se envía una plantilla de autenticación de WhatsApp al número de destino.