https://a.storyblok.com/f/270183/72873/c4ff8d47b4/sdk_updates.png

A Messages API do Vonage já está disponível em nossos SDKs de servidor

Publicado em July 5, 2022

Tempo de leitura: 3 minutos

Atualização: A Messages API do Vonage agora oferece suporte a RCS (Rich Communication Services) em todos os nossos SDKs de servidor! O RCS permite mensagens ricas e interativas com recursos como respostas sugeridas, cartões avançados, confirmações de leitura e conteúdo com a marca do remetente. Saiba mais sobre as mensagens RCS em nossa documentação e em nosso anúncio mais recente, “Mensagens RCS para empresas agora estão disponíveis para uso geral na Messages API da Vonage”

A API de mensagens da Vonage Messages API oferece aos desenvolvedores a capacidade de integrar funcionalidades de mensagens em suas Applications em diversos canais, como SMS, MMS, WhatsApp, Facebook Messengere Viber.

Até agora, porém, se você quisesse usar a Messages API, precisava acessar o endpoint diretamente. Isso significava lidar com todas as diversas questões de baixo nível, como gerenciar o ciclo de solicitação/resposta, criar cabeçalhos, lidar com a autenticação e serializar dados.

Estou super animado em anunciar que nossos SDKs de servidor agora oferecem suporte à Messages API. Então, se você é um desenvolvedor que trabalha com Ruby, Node, PHP, Python, Javaou .NET, você pode deixar que nossos SDKs cuidem dos detalhes de baixo nível para você e, assim, se concentrar no desenvolvimento do seu aplicativo!

Vamos dar uma olhada em algumas das coisas que você pode fazer usando a Messages API por meio de nossos SDKs.

SMS

Uma das coisas que você pode fazer com a Messages API é enviar mensagens SMS. Talvez você já tenha enviado mensagens SMS usando nossos SDKs de servidor por meio da nossa SMS API. Agora você tem a opção de usar tanto a SMS API quanto a Messages API para enviar mensagens SMS.

Existem algumas diferenças entre as duas APIs. Alguns exemplos seriam as opções de autenticação e a configuração dos webhooks. Também há diferenças em relação à forma como essas diferentes APIs são implementadas em nossos SDKs de servidor.

Aqui estão alguns exemplos de como enviar um SMS por meio da Messages API usando o SDK do Ruby e SDK do Node.

SDK do 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 do Node

// 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

Outro canal da Messages API agora disponível nos SDKs é o MMS (Serviço de Mensagens Multimídia). Esse canal permite enviar mensagens que incluem conteúdo multimídia, como imagens, áudio, vídeo e vCards (.vcf arquivos).

Aqui está um exemplo de envio de uma mensagem MMS com imagem usando o SDK do .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

O WhatsApp é um canal de mensagens cuja popularidade cresceu exponencialmente nos últimos anos. No contexto empresarial, o WhatsApp é excelente para mensagens transacionais, além de ser muito adequado para casos de uso de comércio conversacional. Com a Messages API, você pode enviar e receber mensagens do WhatsApp usando uma conta do WhatsApp Business. Com o Messages agora integrado aos SDKs, ficou ainda mais fácil incorporar fluxos de mensagens do WhatsApp aos seus aplicativos.

A Messages API oferece suporte a diversos tipos de mensagens do WhatsApp, incluindo texto, imagem, áudio e vídeo, entre outros, e em breve serão adicionados mais tipos de mensagens! Saiba mais sobre as mensagens do WhatsApp e como configurar um Account do WhatsApp Business.

A seguir, apresentamos um exemplo de envio de uma mensagem de Video pelo WhatsApp usando o SDK do 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

Da mesma forma que o WhatsApp, a Messages API permite usar o Facebook Messenger em um contexto empresarial para possibilitar conversas entre usuários do Facebook e Páginas do Facebook. Novamente, há vários tipos de mensagens nesse canal, como texto, imagem, áudio, vídeo e arquivo.

Você pode saber mais sobre o Messenger em nossa documentação e conferir abaixo um exemplo de uso do SDK do Java para enviar uma mensagem de áudio pelo 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

Outro canal de mensagens disponível na Messages API é o Viber. O Viber pode ser usado para enviar mensagens de texto ou imagens. Saiba mais sobre o Viber em nossa documentação.

Veja a seguir um exemplo de como enviar uma mensagem de texto pelo Viber usando o SDK do 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'
    }
)

Quer começar a usar a Messages API hoje mesmo? Então crie uma account de desenvolvedor da Vonage, instale o SDK de servidor para sua linguagem de programação preferida e experimente alguns dos exemplos de código em nossa documentação!

Compartilhar:

https://a.storyblok.com/f/270183/373x376/e8d3211236/karl-lingiah.png
Karl LingiahDefensor da Comunidade de Desenvolvedores Ruby

Karl é um Developer Advocate da Vonage, com foco na manutenção de nossos SDKs de servidor em Ruby e na melhoria da experiência dos desenvolvedores da nossa comunidade. Ele adora aprender, criar coisas, compartilhar conhecimento e tudo o que esteja relacionado à tecnologia da web em geral.