Detalhes técnicos da Messages API

A Messages API permite enviar e, em alguns casos, receber mensagens por SMS, MMS, RCS, Facebook Messenger, Viber, WhatsApp e e-mail. Outros canais poderão ser suportados no futuro.

O diagrama a seguir ilustra como a Messages API do Vonage permite que você envie mensagens para o caso de uso de sua escolha por meio de vários canais a partir de um único ponto de extremidade; por exemplo, você poderia enviar mensagens de notificação pelo WhatsApp e por SMS:

Recursos compatíveis

Também é oferecido suporte limitado para objetos personalizados:

Legenda:

• = Compatível.
• = Compatível com o canal, mas não com a Vonage.
• n/a = Não é compatível com o canal.

Notas:

1. Para a RCS, o custom Esse tipo está obsoleto. As mensagens “Button” e “Location” são suportadas como Fichas de sugestão em text, card, e carousel digitar mensagens

Autenticação

A Messages API oferece suporte a ou Autenticação básica ou Autenticação JWT (JSON Web Token), mas há algumas diferenças importantes entre as duas que devem ser levadas em conta:

• A autenticação básica utiliza um Chave e segredo da API, e realiza a autenticação no Account nível.
• A autenticação JWT utiliza um JSON Web Token gerados por meio de uma chave privada e um ID de aplicativo. Os JWTs oferecem recursos avançados, como ACLs, e realizam a autenticação no aplicativo nível, o que significa que você pode acessar as configurações do seu aplicativo Vonage, como, por exemplo, o aplicativo webhooks e Mídia de entrada segura.

Recomendamos que você use Autenticação JWT em produção para a maioria dos casos de uso. A autenticação básica pode ser suficiente ao testar a API, como ao usar o Messages Sandbox, ou para alguns casos de uso básicos.

Se você estiver usando nosso SDKs de servidor Para interagir com a Messages API, elas podem criar JWTs automaticamente para você.

Limites de taxa

O limite de taxa padrão para solicitações à Messages API é de 75 solicitações por segundo por chave de API. Esse limite pode ser aumentado caso a caso. Entre em contato com seu gerente de conta ou representante de vendas para discutir o aumento do seu limite de taxa.

API de Contas Externas

O API de Contas Externas é usado para gerenciar seus Accounts do Viber Business Messages, do Facebook Messenger e do WhatsApp ao utilizar esses canais com as APIs do Messages e da Dispatch API.

Introdução

Neste exemplo, você precisará substituir as seguintes variáveis por valores reais, utilizando qualquer método que lhe for mais conveniente:

O código a seguir mostra como enviar uma mensagem SMS usando a Messages API:

curl -X POST https://api.nexmo.com/v1/messages \
	-u "${VONAGE_API_KEY}:${VONAGE_API_SECRET}" \
	-H 'Content-Type: application/json' \
	-H 'Accept: application/json' \
	-d $'{
		"to": "'${MESSAGES_TO_NUMBER}'",
		"from": "'${SMS_SENDER_ID}'",
		"channel": "sms",
		"message_type": "text",
		"text": "This is an SMS sent using the Vonage Messages API."
	}'

npm install @vonage/server-sdk @vonage/messages

const { Vonage } = require('@vonage/server-sdk');
const { Channels } = require('@vonage/messages');

/**
 * By leaving out the applicationId and privateKey parameters, the Vonage
 * SDK will use basic authentication to authenticate with the Messages API.
 *
 * @link https://developer.vonage.com/en/messages/technical-details#authentication
 */
const vonage = new Vonage(
  {
    apiKey: VONAGE_API_KEY,
    apiSecret: VONAGE_API_SECRET,
  },
  {
    ...(MESSAGES_API_URL ? {apiHost: MESSAGES_API_URL} : {}),
  },
);

vonage.messages.send({
  messageType: 'sms',
  channel: Channels.SMS,
  text: 'This is an SMS text message sent using the Messages API',
  to: MESSAGES_TO_NUMBER,
  from: SMS_SENDER_ID,
})
  .then(({ messageUUID }) => console.log(messageUUID))
  .catch((error) => console.error(error));

Referência

• Referência da Messages API
• Referência da API de Contas Externas