Conversion API

La Conversion API vous permet d'indiquer à Vonage la fiabilité de votre 2FA les communications. L'envoi des données de conversion à Vonage permet une livraison plus rapide et plus fiable de vos messages.

Note: Si vous utilisez le Verify API pour 2FA, vous n'avez pas besoin de nous envoyer des données de conversion. L'API Verify s'en charge automatiquement.

Vonage utilise ces données de conversion, ainsi que récépissés de livraison (DLR) pour faciliter l'Adaptive Routing™. L'algorithme Adaptive Routing détermine automatiquement les meilleurs itinéraires des transporteurs par lesquels acheminer les SMS et les appels vocaux à un moment donné. Dans la plupart des cas, un DLR est la confirmation que votre message a été délivré au destinataire. Cependant, les DLR des opérateurs ne sont pas tous fiables et certains ne les fournissent pas du tout. Par conséquent, les données de conversion sont notre meilleur indicateur de la qualité des itinéraires.

Note: Les données de conversion que vous nous envoyez sont confidentielles : Vonage ne les partagera jamais avec des tiers.

Avant d'envoyer les données de conversion

L'accès à la Conversion API n'est pas activé par défaut lorsque vous créez votre Account Vonage. Pour utiliser la Conversion API, vous devez d'abord demander l'accès en envoyant un courriel à soutien.

Lorsque vous nous envoyez des données de conversion, vous devez faire la distinction entre vos 2FA des messages et autres communications. Par exemple, alertes basées sur des événements ou des messages marketing. Pour ce faire, utilisez un Clé API pour authentifier les demandes adressées à l'API Conversion pour 2FA, et une clé API différente pour tout le reste.

Rapport sur les données de conversion

Le diagramme suivant illustre le flux de travail de la Conversion API :

Pour envoyer les données de conversion à Vonage :

Lancez un flux de travail 2FA en envoyer une demande 2FA
Vonage envoie un message texte ou vocal à votre utilisateur.
Votre utilisateur répond à votre message ou à votre demande de vérification.

Envoyer immédiatement une Conversion API demande avec des informations sur le message identifié par message-id:

//You use the information you received in response from a request to SMS API or Call API.

var https = require('https');

var data = JSON.stringify({
 api_key: 'API_KEY',
 api_secret: 'API_SECRET',
 message-id: message-id,
 timestamp: yyyy-MM-dd HH:mm:ss,
 delivered: true_or_false
});

var options = {
 host: 'api.nexmo.com',
 path: '/conversions/sms',
 port: 443,
 method: 'POST'
};

var req = https.request(options);

req.write(data);
req.end();

var responseData = '';
req.on('response', function(res){
 res.on('data', function(chunk){
   responseData += chunk;
 });

});

val client = Vonage {
    apiKey(VONAGE_API_KEY)
    apiSecret(VONAGE_API_SECRET)
}

client.conversion.convertSms(
    messageId = MESSAGE_UUID,
    delivered = true,
    timestamp = Instant.now()
)

VonageClient client = VonageClient.builder()
    .apiKey(VONAGE_API_KEY)
    .apiSecret(VONAGE_API_SECRET)
    .build();

client.getConversionClient().submitConversion(
    ConversionRequest.Type.SMS, // Conversion product type
    MESSAGE_ID,                 // ID of the message that was sent
    true,                       // Whether the message was sent successfully
    Date.from(Instant.now())    // Timestamp to associate with the conversion
);

<?php
//You use the information you received in response from a request to SMS API or Call API.
  $url = 'https://api.nexmo.com/conversions/sms?' . http_build_query([
          'api_key' => 'API_KEY',
          'api_secret' => 'API_SECRET',
          'message-id'=> message-id,
          'timestamp'=> yyyy-MM-dd HH:mm:ss,
          'delivered'=> true_or_false
      ]);

  $ch = curl_init($url);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HEADER, 1);
  $response = curl_exec($ch);
  $header_size = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
  $header = substr($response, 0, $header_size);
  if (strpos($header, '201')){
    echo ("Success");
  }
}

from vonage import Auth, Vonage

client = Vonage(Auth(api_key=VONAGE_API_KEY, api_secret=VONAGE_API_SECRET))

client.sms.submit_sms_conversion(
    message_id='MESSAGE_ID',
    delivered=True,
    timestamp='2020-01-01T12:00:00Z',
)

Important: Vous devez toujours envoyer ces demandes dès que possible après que l'utilisateur a répondu à votre invitation 2FA et ne pas attendre de les soumettre par lots. Le routage adaptatif s'appuie sur des données de conversion opportunes pour prendre les meilleures décisions en matière de routage.