Technischer Leitfaden für die Abschaffung der US-Kurznummern-API

In der Branche gibt es Veränderungen im Bereich des Application to Person (A2P) Messaging. Vonage veraltet die US Shared Short Code API aufgrund des neuen Verhaltenskodexes von T-Mobile und AT&T ab, der die Nutzung von A2P-Verkehr durch gemeinsame Absender untersucht. Diese Abschaffung erfolgt in Verbindung mit dem neuen A2P 10DLC Standard, der mehr Flexibilität für lange Codes bietet und die Verwendung von Kurzcodes durch Unternehmen einschränkt.

Infolgedessen werden US-Carrier keinen gemeinsamen Shortcode-Traffic (SSC) mehr unterstützen. Bitte beachten Sie, dass dies keine Auswirkungen auf dedizierte Shortcodes hat.

Was dies für Kunden bedeutet, die die US Shared Short Code API verwenden

Kunden, die die US Shared Short Code API von Vonage nutzen, müssen auf eine der anderen verfügbaren APIs umsteigen. Wenn Sie die US Shared Short Code API für die Kommunikation per SMS verwenden, müssen Sie Ihren Code und Ihre Konfigurationen anpassen, um die SMS API. Wenn Sie sie für die Zwei-Faktor-Authentifizierung verwenden, müssen Sie Ihren Code anpassen, um entweder die SMS API oder die Verify API.

Wenn Sie die von Vonage unterstützten SDKs nicht verwenden möchten, sind die APIs selbst ohne weiteres verfügbar. Weitere Informationen zu diesen APIs finden Sie in der SMS API-Referenz und die Verify API-Referenz.

Umstellung auf SMS API und Auswirkungen

Vonage verfügt über Bibliotheken zur Unterstützung verschiedener Sprachen, die Sie in der Entwickler Dashboard SMS Übersicht. Auf dieser Seite werden wir jedoch einige Beispiele mit Node.js zeigen.

Eine SMS mit Node.js versenden

Das SDK kann mit dem folgenden Befehl installiert werden:

Der folgende Codeausschnitt ist ein Beispiel dafür, wie eine SMS an eine bestimmte Telefonnummer gesendet werden kann:

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']}`);
        }
    }
})

SMS-Empfang mit Node.js

Der Empfang einer SMS erfordert, dass Ihr Projekt über einen öffentlich zugänglichen Webhook verfügt. Für Entwicklungszwecke empfehlen wir die Verwendung von ngrok. Wir haben ein Tutorial, wie man dies mit unseren Diensten verwendet hier.

Zunächst benötigt das Projekt zwei Bibliotheken von Drittanbietern, express und body-parser, die Sie mit folgendem Befehl installieren können:

Das folgende Code-Snippet zeigt ein Beispiel für den Empfang einer eingehenden SMS mit dem 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)

Die SMS API verfügt nicht über die Funktionalität, die es den Nutzern ermöglicht, sich für oder gegen die Kommunikation zu entscheiden. Diese Änderung bedeutet, dass die Entwickler diese Funktion auf ihrer Seite handhaben müssen, indem sie das obige Beispiel anpassen und eine Methode zum Speichern der Kontaktpräferenzen der Benutzer einrichten, z. B. in einer Datenbank.

Wie kann ich eine neue Nummer bekommen?

Mit der Abschaffung der US Shared Short Codes müssen die Kunden eine neue Nummer kaufen, um SMS-Nachrichten zu senden und zu empfangen. Sie können Numbers kaufen über das Entwickler-Dashboard. Achten Sie bitte darauf, dass Sie eine Number mit SMS-Funktionen wählen.

Sie finden die verfügbaren Migrationsmöglichkeiten mit den Leitlinien unserer Fachexperten.

Wie kann ich Vorlagen zur Verwendung in meinen SMS-Nachrichten registrieren?

Die US Shared Short Code API verfügt über eine Funktion im Dashboard, mit der Sie Vorlagen für die Verwendung verschiedener Benachrichtigungstypen registrieren können, z. B. für Warnungen, Marketing oder 2-Faktor-Authentifizierung. Diese Funktion ist nicht mehr verfügbar, und Sie müssen diese Vorlagen in Ihrem Projekt erstellen.

Sonstige Informationen

Weitere Informationen zur Verwendung der SMS API finden Sie auf der Seite Entwickler-Dashboard.

Wenn Sie Informationen zu den Preisen für die SMS API wünschen, lesen Sie bitte die Seite Preisgestaltung.

Umstellung auf Verify API und Auswirkungen

Vonage verfügt über Bibliotheken zur Unterstützung verschiedener Sprachen, die Sie in der Übersicht der Developer Docs Verify sehen können. Auf dieser Seite werden wir jedoch einige Beispiele mit Node.js zeigen.

Antrag auf Verifizierung stellen

Zunächst benötigt das Projekt das Vonage Node SDK @vonage/server-sdkdas Sie mit folgendem Befehl installieren können:

Der nachstehende Codeausschnitt zeigt ein Beispiel dafür, wie die Überprüfung eines Benutzers angefordert werden kann, wobei Folgendes zu ersetzen ist:

• Ihr Vonage API-Schlüssel

• Ihr Vonage API-Geheimnis

• die Empfängernummer

• und Ihr Markenname / Ihre Nummer

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);
  }
});

Überprüfen Sie den Verifizierungscode

Der nachstehende Code erfordert auch die Vonage-Instanziierung im Beispiel aus dem vorherigen Schritt. Um jedoch den vom Benutzer eingegebenen Verifizierungscode zu überprüfen, zeigt das folgende Codeschnipsel diese Funktionalität.

Achten Sie darauf, dass Sie die REQUEST_ID und CODE mit gültigen Werten.

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

Bitte beachten Sie, dass die Verify API standardmäßig die Möglichkeit bietet, eine Verbotsliste zu verwalten. Dies bedeutet, dass es eine eingebaute Funktion gibt, um Endnutzern, die mit STOP antworten, automatisch zu antworten und diese Endnutzer zu kennzeichnen, damit sie keine weiteren Nachrichten erhalten.

Wenn Sie ein Vonage-Kunde waren und Ihre 2FA-Vorlage über die USSC-API verwendet haben, können Sie möglicherweise eine Vorlage über die Verify-API anpassen. Bitte lesen Sie unsere Verify-Dokumentation um die Anforderungen an die Vorlage zu verstehen.

Wie kann ich Vorlagen zur Verwendung in meinen SMS-Nachrichten registrieren?

Die US Shared Short Code API verfügt über eine Funktion im Dashboard, mit der Sie Vorlagen für die Verwendung verschiedener Benachrichtigungstypen registrieren können, z. B. für Warnungen, Marketing oder 2-Faktor-Authentifizierung. Diese Funktion ist nicht mehr verfügbar, und Sie müssen diese Vorlagen in Ihrem Projekt erstellen.

Sonstige Informationen

Weitere Informationen zur Verwendung der Verify API finden Sie auf der Seite Entwickler-Dashboard.

Wenn Sie Informationen zu den Preisen von Verify API wünschen, lesen Sie bitte die Seite Preisgestaltung.