Enviar un mensaje con Failover

Si se rechaza un mensaje enviado mediante la Messages API de Vonage, se pueden definir mensajes de conmutación por error para que se envíen en su lugar. La conmutación por error se puede realizar desde cualquier canal o tipo de mensaje a cualquier otro canal o tipo de mensaje; sin embargo, el siguiente ejemplo muestra la conmutación por error de RCS a SMS.

Ejemplo

A continuación encontrará la descripción de todas las variables utilizadas en cada fragmento de código:

ClaveDescripción
VONAGE_APPLICATION_ID

The Vonage Application ID.

VONAGE_PRIVATE_KEY_PATH

Private key path.

TO_NUMBER

The number you are sending the to in E.164 format. For example 447700900000.

RCS_SENDER_ID

The sender ID for the RCS message.

JWT

Used to authenticate your request. See Authentication for more information, including how to generate a JWT.

SMS_SENDER_ID

The alphanumeric string that represents the name or number of the organization sending the message.

MESSAGES_API_URL

There are two versions of the API, each with their own endpoints. For production the previous Messages API endpoint was https://api.nexmo.com/v0.1/messages, the new one is https://api.nexmo.com/v1/messages. For sandbox testing the Messages API endpoint is https://messages-sandbox.nexmo.com/v0.1/messages or https://messages-sandbox.nexmo.com/v1/messages, depending on which version you have set in the sandbox dashboard.

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-message-with-failover.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": "'${RCS_SENDER_ID}'",
    "channel": "rcs",
    "message_type": "text",
    "text": "This is an RCS text message sent via the Vonage Messages API",
    "failover": [
      {
        "to": "'${MESSAGES_TO_NUMBER}'",
        "from": "'${SMS_SENDER_ID}'",
        "channel": "sms",
        "message_type": "text",
        "text": "This is an SMS sent using the Vonage Messages API."
      }
    ]
  }'

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

bash send-message-with-failover.sh

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 SendMessageWithFailover y añade el siguiente código al método main:

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

Ver fuente completa

Escriba el código

Añada lo siguiente al método main del archivo SendMessageWithFailover:

val messageId = client.messages.send(
    rcsText {
        to(MESSAGES_TO_NUMBER)
        from(RCS_SENDER_ID)
        text("This is an RCS text message sent using the Messages API")
        failover(
            smsText {
                to(MESSAGES_TO_NUMBER)
                from(SMS_SENDER_ID)
                text("This is an SMS sent using the Vonage Messages API.")
            }
        )
    }
)

Ver fuente completa

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 por el paquete que contiene SendMessageWithFailover:

gradle run -Pmain=com.vonage.quickstart.kt.messages.SendMessageWithFailover

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 SendMessageWithFailover 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();

Ver fuente completa

Escriba el código

Añada lo siguiente al método main del archivo SendMessageWithFailover:

var response = client.getMessagesClient().sendMessage(
		RcsTextRequest.builder()
			.from(RCS_SENDER_ID).to(MESSAGES_TO_NUMBER)
			.text("This is an RCS message sent via the Vonage Messages API")
			.failover(SmsTextRequest.builder()
					.from(SMS_SENDER_ID).to(MESSAGES_TO_NUMBER)
					.text("This is an SMS sent using the Vonage Messages API.")
					.build()
			)
			.build()
);
System.out.println(response);

Ver fuente completa

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 por el paquete que contiene SendMessageWithFailover:

gradle run -Pmain=com.vonage.quickstart.messages.SendMessageWithFailover

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

Install-Package Vonage

Escriba el código

Añada lo siguiente a SendMessageWithFailover.cs:

var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);
var vonageClient = new VonageClient(credentials);
var request = new RcsTextRequest
{
    To = MESSAGES_TO_NUMBER,
    From = RCS_SENDER_ID,
    Text = "This is an RCS text message sent via the Vonage Messages API",
    Failover = new List<IMessage>
    {
        new SmsRequest
        {
            To = MESSAGES_TO_NUMBER,
            From = SMS_SENDER_ID,
            Text = "This is an SMS text message sent via the Vonage Messages API"
        }
    }
};
var response = await vonageClient.MessagesClient.SendAsync(request);

Ver fuente completa

Requisitos previos

Si no tiene una solicitud, puede crear uno. Asegúrese también de configure sus webhooks.

gem install vonage

Crea un archivo llamado send-message-with-failover.rb y añade el siguiente código:

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: VONAGE_PRIVATE_KEY
)

Ver fuente completa

Escriba el código

Añada lo siguiente a send-message-with-failover.rb:

rcs_message = client.messaging.rcs(
  to: MESSAGES_TO_NUMBER,
  from: RCS_SENDER_ID,
  type: 'text',
  message: 'This is an RCS text message sent via the Vonage Messages API'
)

sms_message = client.messaging.sms(
    to: MESSAGES_TO_NUMBER,
    from: SMS_SENDER_ID,
    message: 'This is a failover SMS message in case the RCS message is rejected.'
  )

client.messaging.send(
  **rcs_message,
  failover: [sms_message]
)

Ver fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

ruby send-message-with-failover.rb

Pruébalo

Al ejecutar el código se envía un mensaje RCS al número de destino; si ese mensaje es rechazado, se enviará en su lugar un mensaje SMS.