Guide technique pour la suppression de l'API des US Short Codes

La messagerie d'application à personne (A2P) connaît des changements dans le secteur. Vonage supprime l'API US Short Codes API en raison du nouveau code de conduite de T-Mobile et d'AT&T, qui impose à l'utilisateur le partage de l'origine du trafic A2P. Cette suppression va de pair avec la nouvelle norme A2P 10DLC qui offre une plus grande flexibilité pour les codes longs et limite l'utilisation des codes courts par les entreprises.

En conséquence, les opérateurs américains ne prendront plus en charge le trafic des codes courts partagés (SSC). Veuillez noter que cela n'a pas d'incidence sur les codes courts dédiés.

Ce que cela signifie pour les clients qui utilisent l'API des US Short Codes

Les clients qui utilisent l'API US Short Codes de Vonage devront migrer vers l'une des autres API disponibles. Si vous utilisez l'API US Short Codes pour les communications par SMS, vous devrez modifier votre code et vos configurations pour utiliser l'API SMS API. En outre, si vous l'utilisez pour l'authentification à deux facteurs, vous devrez modifier votre code pour utiliser l'API SMS API ou l Verify API.

Si vous ne souhaitez pas utiliser les SDK pris en charge par Vonage, les API elles-mêmes sont facilement disponibles. Pour plus d'informations sur ces API, veuillez consulter la Référence de l'API SMS et la référence de l'API Verify API (en anglais).

Comment migrer vers l'API SMS et ses implications

Vonage dispose de bibliothèques pour prendre en charge différentes langues, que vous pouvez trouver sur la page Tableau de bord du développeur - Aperçu des SMS. Cependant, pour cette page, nous montrerons quelques exemples en utilisant Node.js.

Envoyer un SMS avec Node.js

Le SDK peut être installé à l'aide de la commande suivante :

L'extrait de code ci-dessous est un exemple d'envoi d'un SMS à un numéro de téléphone prédéterminé :

const Vonage = require('@vonage/server-sdk')
const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET
})
const from = VONAGE_BRAND_NAME
const to = TO_NUMBER
const text = 'A text message sent using the Vonage SMS API'
vonage.message.sendSms(from, to, text, (err, responseData) => {
    if (err) {
        console.log(err);
    } else {
        if(responseData.messages[0]['status'] === "0") {
            console.log("Message sent successfully.");
        } else {
            console.log(`Message failed with error: ${responseData.messages[0]['error-text']}`);
        }
    }
})

Recevoir des SMS avec Node.js

La réception d'un SMS nécessite que votre projet dispose d'un webhook accessible au public. Pour le développement, nous recommandons d'utiliser ngrok, dont nous avons un tutoriel sur la façon de l'utiliser avec nos services ici.

Tout d'abord, le projet nécessite deux bibliothèques tierces, express et body-parser, que vous pouvez installer en exécutant ce qui suit :

L'extrait de code ci-dessous montre un exemple de la manière de gérer la réception d'un SMS entrant avec le webhook : /webhooks/inbound-sms

const app = require('express')()
const bodyParser = require('body-parser')
app.use(bodyParser.json())
app.use(bodyParser.urlencoded({ extended: true }))
app
  .route('/webhooks/inbound-sms')
  .get(handleInboundSms)
  .post(handleInboundSms)
function handleInboundSms(request, response) {
  const params = Object.assign(request.query, request.body)
  console.log(params)
  response.status(204).send()
}
app.listen(process.env.PORT || 3000)

L'API SMS ne permet pas aux utilisateurs d'accepter ou de refuser les communications. Cette modification signifie que les développeurs devront gérer cette fonctionnalité de leur côté en apportant des ajustements à l'exemple ci-dessus et en mettant en place une méthode de stockage des préférences de contact des utilisateurs, par exemple dans une base de données.

Comment puis-je obtenir un nouveau numéro ?

Avec la suppression des US Short Codes partagés, les clients devront acheter un nouveau numéro pour envoyer et recevoir des SMS. Vous pouvez acheter des numéros dans le Tableau de bord du développeur. Veillez à choisir un numéro permettant d'envoyer des SMS.

Vous pouvez trouver les options de migration avec les conseils de nos experts.

Comment puis-je enregistrer des modèles à utiliser dans mes SMS ?

L'API US Short Codes comportait une fonctionnalité dans le tableau de bord permettant d'enregistrer des modèles pour l'utilisation de différents types d'alertes, comme les alertes, le marketing ou l'authentification à deux facteurs. Cette fonctionnalité n'est plus disponible et vous devrez créer ces modèles dans le cadre de votre projet.

Autres informations

Pour plus d'informations sur l'utilisation de l'API SMS, vous pouvez trouver toutes les informations nécessaires dans le tableau de bord du développeur.

Si vous souhaitez obtenir des informations sur la tarification de l'API SMS, veuillez consulter la page page de tarification.

Comment migrer vers Verify API et implications

Verify dispose de bibliothèques pour prendre en charge différents langages, que vous pouvez consulter sur l'aperçu Verify des Developer Docs. Cependant, pour cette page, nous montrerons quelques exemples en utilisant Node.js.

Faire une demande de vérification

Tout d'abord, le projet nécessite le SDK Vonage Node @vonage/server-sdkque vous pouvez installer en exécutant ce qui suit :

L'extrait de code ci-dessous montre un exemple de demande de vérification d'un utilisateur, en veillant à remplacer ce qui suit :

• votre clé API Vonage

• votre secret API Vonage

• le Numbers des bénéficiaires

• et votre nom de marque / votre numéro

const Vonage = require('@vonage/server-sdk');
const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET
});
vonage.verify.request({
  number: RECIPIENT_NUMBER,
  brand: BRAND_NAME
}, (err, result) => {
  if (err) {
    console.error(err);
  } else {
    const verifyRequestId = result.request_id;
    console.log('request_id', verifyRequestId);
  }
});

Vérifier le code de vérification

Le code ci-dessous nécessite également l'instanciation de Vonage dans l'exemple trouvé à l'étape précédente. Mais pour vérifier le code de vérification saisi par l'utilisateur, l'extrait de code ci-dessous montre cette fonctionnalité.

Veillez à mettre à jour les REQUEST_ID et CODE avec des valeurs valides.

vonage.verify.check({
  request_id: REQUEST_ID,
  code: CODE
}, (err, result) => {
  if (err) {
    console.error(err);
  } else {
    console.log(result);
  }
});

Veuillez noter que l'API Verify permet de gérer une liste d'exclusion par défaut. Cela signifie qu'il existe une fonction intégrée permettant de répondre automatiquement aux utilisateurs finaux qui répondent par STOP et de marquer ces utilisateurs finaux pour qu'ils ne reçoivent pas d'autres messages.

Si vous étiez un client de Vonage utilisant votre modèle 2FA à l'aide de l'API USSC, vous pourriez être en mesure de personnaliser un modèle à l'aide de l'API Verify. Veuillez consulter notre documentation Verify pour comprendre les exigences du modèle.

Comment puis-je enregistrer des modèles à utiliser dans mes messages SMS ?

L'API US Short Codes comportait une fonctionnalité dans le tableau de bord permettant d'enregistrer des modèles pour l'utilisation de différents types d'alertes, comme les alertes, le marketing ou l'authentification à deux facteurs. Cette fonctionnalité n'est plus disponible et vous devrez créer ces modèles dans le cadre de votre projet.

Autres informations

Pour plus d'informations sur l'utilisation de l'API Verify, vous pouvez trouver toutes les informations nécessaires dans le tableau de bord du développeur.

Si vous souhaitez obtenir des informations sur les tarifs de l'API Verify, veuillez consulter la page Page de tarification.