Messages API Sandbox

Die Messages API Sandbox ist eine schnelle Möglichkeit, den Versand von Nachrichten über bestimmte Messaging-Kanäle mit der Vonage Messages API zu testen. Es müssen keine externen Accounts bei Providern eingerichtet werden (z. B. WhatsApp Business Account). Das bedeutet, dass Sie diese Kanäle der Messages API sofort mit Ihrem Vonage Account ausprobieren können.

• WhatsApp
• Viber
• Facebook Messenger
• Instagram

Um die Sandbox zu nutzen, um das Senden von Nachrichten für einen bestimmten Kanal auszuprobieren, muss Ihre Nummer oder ID, die mit diesem Kanal verbunden ist, zunächst zu einer Liste der für den Kanal zulässigen Nummern/IDs hinzugefügt werden. Sie müssen eine Nachricht an die Sandbox senden, wie es in der Dashboard damit Ihre Nummer oder ID in die Liste der zulässigen Nummern aufgenommen werden kann.

Bitte beachten Sie dies:

• Numbers und IDs, die auf der Erlaubnisliste stehen, sind mit bestimmten Vonage API-Schlüsseln verbunden. Wenn Sie dieselbe Nummer/ID mit einem anderen Vonage API-Schlüssel zulassen (z. B. über ein separates Vonage Dashboard-Konto), wird diese Nummer/ID aus der Sandbox-Zulassungsliste für den API-Schlüssel entfernt, für den sie zuvor hinzugefügt wurde.
• Die Sandbox verwendet einen anderen API-Endpunkt als die produktive Messages API. Stellen Sie sicher, dass Sie den Sandbox-Endpunkt verwenden, wenn Sie die Messages API über die Sandbox ausprobieren.
• Die Sandbox ist für erprobend die Messages API, zum Beispiel während einer ersten Erkundung der API. Es ist nicht dafür gedacht, als Teil einer QA- oder Staging-Umgebung verwendet zu werden, um Ihre Integration zu testen, bevor Sie sie in Betrieb nehmen. Wenn Sie sich bereits entschieden haben, die Messages API in Ihre Anwendung zu integrieren, empfehlen wir Ihnen, Ihr eigenes Konto einzurichten, indem Sie den Anweisungen auf dem Dashboard für den jeweiligen Kanal folgen.

Messages API Sandbox-Preise

Die Nutzung der Messages API Sandbox ist kostenlos. Es gilt eine monatliche faire Nutzungsgrenze von 100 Nachrichten/Monat. Wenn diese Grenze überschritten wird, geben Ihre Nachrichtenanfragen eine 429 HTTP-Fehler.

Satzgrenze

Die Messages API Sandbox hat ein Ratenlimit von einer Nachricht pro Sekunde.

Einrichten der Sandbox

Führen Sie die folgenden Schritte aus, um einen Kanal in der Sandbox einzurichten (beachten Sie, dass jeder Kanal separat eingerichtet werden muss).

1. Gehen Sie zum Messages API Sandbox auf dem Dashboard.
2. Wenn Sie über mehrere API-Schlüssel in der Datei API-Schlüssel Wählen Sie in der Dropdown-Liste den API-Schlüssel aus, der mit der einzurichtenden Sandbox verknüpft werden soll.
3. Klicken Sie auf die Zum Sandkasten hinzufügen Link zu dem Kanal, den Sie einrichten möchten, und folgen Sie den Anweisungen im Dashboard für diesen Kanal.

Webhooks konfigurieren

1. Geben Sie den Namen Ihrer Anwendung ein Eingehend Webhook-URL. Der eingehende Webhook ist die URL, an die eingehende Nachrichten weitergeleitet werden.
2. Geben Sie den Namen Ihrer Anwendung ein Status Webhook-URL. Der Status-Webhook ist die URL, über die Sie Aktualisierungen des Nachrichtenstatus erhalten.
3. Klicken Sie auf die Webhooks speichern Taste.

Webhook-Wiederholungen

Eingehende und Status-Webhooks werden in der Messages API Sandbox pro Benachrichtigung wiederholt. Jede Antwort auf einen Webhook, die nicht 200 ist, veranlasst Vonage, den Versuch in regelmäßigen Abständen mit zunehmender Länge zu wiederholen: 5, 10, 20, 40, 80, 160, 320, 640 und dann alle 900 Sekunden für 24 Stunden.

Senden Sie eine Testnachricht über die Messages API Sandbox

Sobald Ihre Nummer oder Empfänger-ID auf der Zulassungsliste steht, müssen Sie den Endpunkt der Messages API Sandbox verwenden, um Ihre Testnachrichten zu senden. Der from Wert in der Anfrage sollte die ID oder Nummer sein, die mit dem spezifischen externen Vonage Sandbox Account verbunden ist. Für Ihre Testzwecke kann der Wert in der from Feld ist bereits in den Codeausschnitten in der Dashboard. Es ist wichtig zu beachten, dass Sie den Wert in der Tabelle ersetzen müssen. to mit Ihrer Nummer oder Empfänger-ID, die für das jeweilige externe Vonage Sandbox-Konto zugelassen ist.

Das folgende Beispiel zeigt die Verwendung der Sandbox zum Senden einer WhatsApp-Textnachricht, aber der gleiche allgemeine Ansatz kann auch für andere Kanäle verwendet werden. Beachten Sie die Verwendung des Sandbox-Endpunkts anstelle des Standard-Nachrichten-Endpunkts (wenn Sie eines der Server-SDKs verwenden, muss der Standard-Endpunkt überschrieben werden).

Nachstehend finden Sie die Beschreibung aller in den einzelnen Codeausschnitten verwendeten Variablen:

curl -X POST $MESSAGES_SANDBOX_URL \
  -H "Authorization: Bearer "$JWT\
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "to": "'${MESSAGES_TO_NUMBER}'",
    "from": "'${WHATSAPP_SENDER_ID}'",
    "channel": "whatsapp",
    "message_type": "text",
    "text": "This is a WhatsApp text message sent using the Vonage Messages API."
  }'

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

const vonage = new Vonage(
  {
    applicationId: VONAGE_APPLICATION_ID,
    privateKey: VONAGE_PRIVATE_KEY,
  },
  {
    apiHost: MESSAGES_SANDBOX_URL,
  },
);

vonage.messages.send({
  to: MESSAGES_TO_NUMBER,
  from: WHATSAPP_SENDER_ID,
  channel: Channels.WHATSAPP,
  messageType: 'text',
  text: 'This is a WhatsApp text message sent using the Vonage Messages API.',
})
  .then((resp) => console.log(resp.messageUUID))
  .catch((error) => console.error(error));

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

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

println(client.messages.send(
    whatsappText {
        to(MESSAGES_SANDBOX_ALLOW_LISTED_TO_NUMBER)
        from(MESSAGES_SANDBOX_WHATSAPP_NUMBER)
        text("Hello from $WHATSAPP_SENDER_ID!")
    },
    sandbox = true
))

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

implementation 'com.vonage:server-sdk:9.3.1'

System.out.println(VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build()
		.getMessagesClient()
		.useSandboxEndpoint()
		.sendMessage(WhatsappTextRequest.builder()
			.from(MESSAGES_SANDBOX_WHATSAPP_NUMBER)
			.to(MESSAGES_SANDBOX_ALLOW_LISTED_TO_NUMBER)
			.text("Hello from Vonage, "+System.getenv("NAME"))
			.build()
		).getMessageUuid()
);

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Install-Package Vonage

// Set "Url.Api" to "https://messages-sandbox.nexmo.com" in appsettings.json
var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);

var vonageClient = new VonageClient(credentials);

var request = new WhatsAppTextRequest
{
    To = messagesSandboxAllowListedToNumber,
    From = messagesSandboxWhatsAppNumber,
    Text = "A WhatsApp text message sent using the Vonage Messages API via the Messages Sandbox"
};

var response = await vonageClient.MessagesClient.SendAsync(request);

composer require vonage/client

pip install vonage python-dotenv

client = Vonage(
    auth=Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_PRIVATE_KEY,
    ),
    http_client_options=HttpClientOptions(api_host=MESSAGES_SANDBOX_HOST),
)

message = WhatsappText(
    to=MESSAGES_TO_NUMBER,
    from_=WHATSAPP_SENDER_ID,
    text="This is a WhatsApp text message sent using the Vonage Messages API via the Messages Sandbox",
)

response = client.messages.send(message)

gem install vonage

Probieren Sie es aus

Wenn Sie den Code ausführen, wird eine WhatsApp-Nachricht an die Zielnummer gesendet.

Nächste Schritte

Nachdem Sie diese Channels mit der Messages API Sandbox ausprobiert haben, folgen nun einige Schritte, die Sie befolgen können, um mit der Messages API selbst zu arbeiten:

Richten Sie Ihre sozialen Kanäle ein

Die genaue Vorgehensweise hängt von dem jeweiligen Kanal ab. Sie können mit dem Externe Accounts Seite des Vonage Dashboards, oder lesen Sie zunächst die kanalspezifische Dokumentation Erste Schritte:

• Erste Schritte mit WhatsApp
• Erste Schritte mit Facebook Messenger
• Erste Schritte mit Viber Business Messages

Erfahren Sie mehr über die sozialen Kanäle

Lesen Sie unsere kanalspezifische Dokumentation, um mehr über jeden sozialen Kanal und seine Funktionsweise zu erfahren:

• Verstehen von WhatsApp-Nachrichten
• Verstehen von Facebook-Nachrichten
• Verstehen von Viber Messaging