https://d226lax1qjow5r.cloudfront.net/blog/blogposts/the-vonage-messages-api-is-now-in-our-server-sdks/sdk_updates.png

La API Messages API de Vonage ahora está en nuestros SDK para servidores

Publicado el July 5, 2022

Tiempo de lectura: 3 minutos

Actualización: Messages API de Vonage ahora admite RCS (servicios de comunicación enriquecidos) ¡en todos nuestros SDK de servidor! RCS permite una mensajería enriquecida e interactiva con funciones como respuestas sugeridas, tarjetas enriquecidas, recibos de lectura y contenido de marca. Obtén más información sobre los mensajes RCS en nuestra documentación y en nuestro último anuncio, "RCS Business Messaging ahora es GA en el Messages API de Vonage".

API de Messages API ofrece a los desarrolladores la capacidad de integrar la funcionalidad de mensajería en sus aplicaciones a través de múltiples canales como SMS, MMS, WhatsApp, Facebook Messengery Viber.

Hasta ahora, sin embargo, si querías usar la Messages API, necesitabas acceder al endpoint directamente. Eso significaba lidiar con todos los diversos problemas de bajo nivel, como la gestión del ciclo Solicitud/Respuesta, la creación de cabeceras, la autenticación y la serialización de datos.

Estoy súper emocionado de anunciar que nuestros SDK de servidor son ahora compatibles con Messages API. Así que, si eres un desarrollador que trabaja con Ruby, Node, PHP, Python, Javao .NETpuede dejar que nuestros SDK se ocupen de los detalles de bajo nivel y centrarse en la creación de su aplicación.

Echemos un vistazo a algunas de las cosas que puede hacer utilizando la Messages API a través de nuestros SDK.

SMS

Una de las cosas que puedes hacer con la Messages API es enviar mensajes SMS. Es posible que ya haya enviado mensajes SMS utilizando nuestros SDK de servidor a través de nuestra SMS API. Ahora tiene la opción de utilizar la SMS API o la Messages API para enviar mensajes SMS.

Existen algunas diferencias entre las dos API. Un par de ejemplos serían las opciones de autenticación y la configuración de los webhooks. También hay diferencias en cuanto a cómo se implementan estas API en nuestros SDK de servidor.

A continuación se muestran ejemplos de envío de un SMS a través de la API de Messages mediante la aplicación SDK de Ruby y SDK de Node.

SDK de Ruby

# instantiating a client object
client = Vonage::Client.new(
  application_id: '76543a12-1b87-4c32-a1b2-1d9876543210',
  private_key: File.read('private.key')
)

# creating an SMS message object
message = Vonage::Messaging::Message.sms(
  message: "A SMS message sent using the Vonage Messages API"
)

# sending the SMS
response = client.messaging.send(
  from: '447700900000',
  to: '447700900001',
  **message
)

SDK de nodos

// initializing dependencies
const Vonage = require('@vonage/server-sdk')
const SMS = require('@vonage/server-sdk/lib/Messages/SMS');
const fs = require('fs');

// reads the private key file
let privateKey = fs.readFileSync('private.key', 'utf8');

// instantiating a client object
const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
  applicationId: '76543a12-1b87-4c32-a1b2-1d9876543210',
  privateKey: privateKey
})

// sending the SMS
vonage.messages.send(
  new SMS("This is an SMS text message sent using the Messages API", '447700900001', '447700900000'),
  (err, data) => {
    if (err) {
      console.error(err);
    } else {
      console.log(data.message_uuid);
    }
  }
);

MMS

Otro canal de Messages API ahora disponible en los SDK es MMS (Multimedia Message Service). Este canal permite enviar mensajes con contenido multimedia, como imágenes, audio, vídeo y vCards (.vcf archivos).

A continuación se muestra un ejemplo de envío de un mensaje de imagen MMS utilizando el SDK .NET.

var credentials = Credentials.FromApiKeyAndSecret(
  "76543a12-1b87-4c32-a1b2-1d9876543210",
  "abc123"
);

var vonageClient = new VonageClient(credentials);

var request = new Vonage.Messages.Mms.MmsImageRequest
{
    To = "447700900000",
    From = "447700900001",
    Image = new Attachment
    {
        Url = "https://example.com/image.jpg"
    }
};

var response = await vonageClient.MessagesClient.SendAsync(request);

WhatsApp

WhatsApp es un canal de mensajería que se ha hecho muy popular en los últimos años. WhatsApp en un contexto empresarial es ideal para la mensajería transaccional, además de ser muy adecuado para casos de uso de comercio conversacional. Con Messages API de Vonage, puedes enviar y recibir mensajes de WhatsApp utilizando una WhatsApp Business Account. Con Mensajes ahora en los SDK, es aún más fácil incorporar flujos de mensajería de WhatsApp en tus aplicaciones.

Messages API admite numerosos tipos de mensajes de WhatsApp, como texto, imagen, audio y Video, entre otros, ¡y pronto se añadirá compatibilidad con más tipos de mensajes! Más información sobre la mensajería de WhatsApp y la creación de una WhatsApp Business Account.

A continuación se muestra un ejemplo de envío de un mensaje de Video de WhatsApp utilizando el SDK DE PHP.

// creating a Keypair object using private key and app id
$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents('private.key'),
    '76543a12-1b87-4c32-a1b2-1d9876543210'
);

// instantiating a Client object using the Keypair
$client = new \Vonage\Client($keypair);


// instantiating a VideoObject message attachment
$videoObject = new \Vonage\Messages\MessageObjects\VideoObject(
    'https://example.com/video.mp4',
    'This is an video file'
);

// instantiating a WhatsAppVideo message which contains the VideoObject attachment
$whatsApp = new \Vonage\Messages\MessageType\WhatsApp\WhatsAppVideo(
    '447700900001',
    '447700900000',
    $videoObject
);

// sending the WhatsAppVideo message
$client->send($whatsApp);

Facebook Messenger

Al igual que WhatsApp, Messages API te permite utilizar Facebook Messenger en un contexto empresarial para permitir conversaciones entre usuarios de Facebook y páginas de Facebook. De nuevo, existen múltiples tipos de mensajes dentro de este canal, como texto, imagen, audio, vídeo y archivo.

Puede obtener más información sobre Messenger en nuestra documentación y consultar un ejemplo de uso del Java SDK para enviar un mensaje de audio de Messenger.

var client = VonageClient.builder()
    .applicationId("76102c93-1d87-4a13-a1d5-1c9863095337")
    .privateKeyPath("/path/to/private.key")
    .build();

var message = MessengerAudioRequest.builder()
    .from("9876543210").to("0123456789")
    .url("https://example.com/audio.mp3")
    .build();

var response = client.getMessagesClient().sendMessage(message);

Viber

Otro canal de mensajería disponible en la Messages API es Viber. Viber puede utilizarse para enviar mensajes de texto o imágenes. Más información sobre Viber en nuestra documentación.

A continuación se muestra un ejemplo de cómo enviar un mensaje de texto de Viber utilizando el SDK de Python.

# initializing dependencies
import vonage

# instantiating a Client object with app id and private key
client = vonage.Client(
    application_id='76543a12-1b87-4c32-a1b2-1d9876543210',
    private_key='private.key',
)

# sending a message using the Messages object's send_message method
client.messages.send_message(
    {
        'channel': 'viber_service',
        'message_type': 'text',
        'to': '447700900000',
        'from': '9876543210',
        'text': 'This is a Viber message from the Vonage Messages API'
    }
)

¿Quieres empezar a utilizar la Messages API hoy mismo? Entonces crea una Vonage Developer Accountinstala el SDK del servidor para tu lenguaje de programación preferido y prueba algunos de los ejemplos de código específicos en nuestros documentos.

Compartir:

https://a.storyblok.com/f/270183/373x376/e8d3211236/karl-lingiah.png
Karl LingiahDefensor del desarrollador Ruby

Karl es un defensor de los desarrolladores para Vonage, centrado en el mantenimiento de nuestros SDK de servidor Ruby y la mejora de la experiencia de los desarrolladores para nuestra comunidad. Le encanta aprender, hacer cosas, compartir conocimientos y, en general, todo lo relacionado con la tecnología web.