Enviar un contacto
En este fragmento de código aprenderás a enviar un contacto a WhatsApp mediante Messages API. Esto utiliza la API 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 Mensaje de contacto documentació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. |
VONAGE_PRIVATE_KEY_PATH | Private key path. |
BASE_URL | For production use the base URL is |
MESSAGES_API_URL | There are two versions of the API, each with their own endpoints. For production the previous Messages API endpoint was |
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 |
VONAGE_NUMBER | Refer to |
TO_NUMBER | Replace with the number you are sending to. E.g. |
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-contact.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": "contacts",
"contacts": [
{
"addresses": [
{
"city": "Menlo Park",
"country": "United States",
"country_code": "us",
"state": "CA",
"street": "1 Hacker Way",
"type": "HOME",
"zip": "94025"
},
{
"city": "Menlo Park",
"country": "United States",
"country_code": "us",
"state": "CA",
"street": "200 Jefferson Dr",
"type": "WORK",
"zip": "94025"
}
],
"birthday": "2012-08-18",
"emails": [
{
"email": "test@fb.com",
"type": "WORK"
},
{
"email": "test@whatsapp.com",
"type": "WORK"
}
],
"name": {
"first_name": "John",
"formatted_name": "John Smith",
"last_name": "Smith"
},
"org": {
"company": "WhatsApp",
"department": "Design",
"title": "Manager"
},
"phones": [
{
"phone": "+1 (940) 555-1234",
"type": "HOME"
},
{
"phone": "+1 (650) 555-1234",
"type": "WORK",
"wa_id": "16505551234"
}
],
"urls": [
{
"url": "https://www.facebook.com",
"type": "WORK"
}
]
}
]
}
}'
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-contact.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-contact.js:
vonage.messages.send({
to: MESSAGES_TO_NUMBER,
from: WHATSAPP_SENDER_ID,
channel: Channels.WHATSAPP,
messageType: 'custom',
custom: {
type: 'contacts',
contacts: [
{
addresses: [
{
city: 'Menlo Park',
country: 'United States',
country_code: 'us',
state: 'CA',
street: '1 Hacker Way',
type: 'HOME',
zip: '94025',
},
{
city: 'Menlo Park',
country: 'United States',
country_code: 'us',
state: 'CA',
street: '200 Jefferson Dr',
type: 'WORK',
zip: '94025',
},
],
birthday: '2012-08-18',
emails: [
{
email: 'test@fb.com',
type: 'WORK',
},
{
email: 'test@whatsapp.com',
type: 'WORK',
},
],
name: {
first_name: 'John',
formatted_name: 'John Smith',
last_name: 'Smith',
},
org: {
company: 'WhatsApp',
department: 'Design',
title: 'Manager',
},
phones: [
{
phone: '+1 (940) 555-1234',
type: 'HOME',
},
{
phone: '+1 (650) 555-1234',
type: 'WORK',
wa_id: '16505551234',
},
],
urls: [
{
url: 'https://www.facebook.com',
type: 'WORK',
},
],
},
],
},
})
.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 SendWhatsappContact 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 SendWhatsappContact:
val messageId = client.messages.send(
whatsappCustom {
to(MESSAGES_TO_NUMBER)
from(WHATSAPP_SENDER_ID)
custom(mapOf(
"type" to "contacts",
"contacts" to listOf(
mapOf(
"addresses" to listOf(
mapOf(
"city" to "Menlo Park",
"country" to "United States",
"state" to "CA",
"country_code" to "us",
"street" to "1 Hacker Way",
"type" to "HOME",
"zip" to "94025"
),
mapOf(
"city" to "Menlo Park",
"country" to "United States",
"state" to "CA",
"country_code" to "us",
"street" to "200 Jefferson Dr",
"type" to "WORK",
"zip" to "94025"
)
),
"birthday" to "2012-08-18",
"emails" to listOf(
mapOf(
"email" to "test@fb.com",
"type" to "WORK"
),
mapOf(
"email" to "test@whatsapp.com",
"type" to "WORK"
)
),
"name" to mapOf(
"first_name" to "Jayden",
"last_name" to "Smith",
"formatted_name" to "J. Smith"
),
"org" to mapOf(
"company" to "WhatsApp",
"department" to "Design",
"title" to "Manager"
),
"phones" to listOf(
mapOf(
"phone" to "+1 (940) 555-1234",
"type" to "HOME"
),
mapOf(
"phone" to "+1 (650) 555-1234",
"type" to "WORK",
"wa_id" to "16505551234"
)
),
"urls" to listOf(
mapOf(
"url" to "https://www.facebook.com",
"type" to "WORK"
)
)
)
)
))
}
)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 SendWhatsappContact:
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 SendWhatsappContact 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 SendWhatsappContact:
var response = client.getMessagesClient().sendMessage(
WhatsappCustomRequest.builder()
.from(WHATSAPP_SENDER_ID).to(MESSAGES_TO_NUMBER)
.custom(Map.of(
"type", "contacts",
"contacts", List.of(Map.of(
"addresses", List.of(
Map.of(
"city", "Menlo Park",
"country", "United States",
"state", "CA",
"country_code", "us",
"street", "1 Hacker Way",
"type", "HOME",
"zip", "94025"
),
Map.of(
"city", "Menlo Park",
"country", "United States",
"state", "CA",
"country_code", "us",
"street", "200 Jefferson Dr",
"type", "WORK",
"zip", "94025"
)
),
"birthday", "2012-08-18",
"emails", List.of(
Map.of(
"email", "test@fb.com",
"type", "WORK"
),
Map.of(
"email", "test@whatsapp.com",
"type", "WORK"
)
),
Map.of("name", Map.of(
"first_name", "Jayden",
"last_name", "Smith",
"formatted_name", "J. Smith"
)),
Map.of("org", Map.of(
"company", "WhatsApp",
"department", "Design",
"title", "Manager"
)),
Map.of("phones", List.of(
Map.of(
"phone", "+1 (940) 555-1234",
"type", "HOME"
),
Map.of(
"phone", "+1 (650) 555-1234",
"type", "WORK",
"wa_id", "16505551234"
)
)),
Map.of("urls", List.of(
Map.of(
"url", "https://www.facebook.com",
"type", "WORK"
)
))
))
))
.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 SendWhatsappContact:
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 SendWhatsAppContact.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 = "contacts",
contacts = new []
{
new
{
name = new {
first_name = "John",
formatted_name = "John Smith",
last_name = "Smith",
},
birthday = "2012-08-18",
emails = new []
{
new
{
email = "test@fb.com",
type = "WORK",
},
new
{
email = "test@whatsapp.com",
type = "WORK",
}
},
addresses = new []
{
new
{
city = "Menlo Park",
country = "United States",
country_code = "US",
state = "CA",
street = "1 Hacker Way",
type = "WORK",
zip = "94025",
}
},
org = new
{
company = "WhatsApp",
department = "Design",
title = "Manager",
},
urls = new
{
url = "https://www.facebook.com",
type = "WORK",
}
}
}
}
};
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-contact.php y añade el siguiente código:
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-contact.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": "contacts",
"contacts": [
{
"addresses": [
{
"city": "Menlo Park",
"country": "United States",
"country_code": "us",
"state": "CA",
"street": "1 Hacker Way",
"type": "HOME",
"zip": "94025",
},
{
"city": "Menlo Park",
"country": "United States",
"country_code": "us",
"state": "CA",
"street": "200 Jefferson Dr",
"type": "WORK",
"zip": "94025",
},
],
"birthday": "2012-08-18",
"emails": [
{"email": "test@fb.com", "type": "WORK"},
{"email": "test@whatsapp.com", "type": "WORK"},
],
"name": {
"first_name": "John",
"formatted_name": "John Smith",
"last_name": "Smith",
},
"org": {
"company": "WhatsApp",
"department": "Design",
"title": "Manager",
},
"phones": [
{"phone": "+1 (940) 555-1234", "type": "HOME"},
{
"phone": "+1 (650) 555-1234",
"type": "WORK",
"wa_id": "16505551234",
},
],
"urls": [{"url": "https://www.facebook.com", "type": "WORK"}],
}
],
},
)
response = client.messages.send(message)
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-contact.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 un mensaje de contacto de WhatsApp al número de destino. En WhatsApp puedes ver los datos del contacto y añadirlo a la agenda si es necesario.