Nexmo
Nexmo, die Vonage-API-Plattform, ermöglicht es Ihnen, Kommunikationen im Kontext Ihrer Anwendungen hinzuzufügen, einschließlich SMS, Voice und Chat. Registrieren Sie sich hier für ein Nexmo-Konto - https://www.nexmo.com/
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Connectormetadaten | |
|---|---|
| Herausgeber | Microsoft |
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| API-Schlüssel | Schnur | Der API-Schlüssel | Richtig |
| API-Geheimer Schlüssel | securestring | Der GEHEIME API-Schlüssel | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Aktualisieren einer Anwendung |
Dieser Vorgang wird verwendet, um eine vorhandene Anwendung in Ihrem Konto zu ändern. |
| Anwendung nach ID abrufen |
Dieser Vorgang wird verwendet, um Informationen zu einer einzelnen Anwendung anhand der ID abzurufen. |
| Anwendungen auflisten |
Ruft eine Liste aller Anwendungen ab, die Ihrem Konto zugeordnet sind. |
| Eigene Nummern auflisten |
Dieser Vorgang ruft alle Nummern ab, die Ihrem Konto zugeordnet sind. |
| Eingehende Nummern auflisten |
Dieser Vorgang wird verwendet, um alle eingehenden Nummern abzurufen, die für ein bestimmtes Land avialierbar sind. |
| Löschen einer Anwendung |
Dieser Vorgang wird verwendet, um eine vorhandene Anwendung in Ihrem Konto zu löschen. |
| Neue Anwendung erstellen |
Dieser Vorgang wird verwendet, um eine neue Anwendung in Ihrem Konto zu erstellen. |
| Senden einer SMS |
Dieser Vorgang wird verwendet, um eine SMS zu senden. |
| Senden einer Sprachdatei |
Dieser Vorgang wird verwendet, um eine synthetisierte Sprache oder eine aufgezeichnete Audiodatei an eine Telefonnummer zu senden. |
Aktualisieren einer Anwendung
Dieser Vorgang wird verwendet, um eine vorhandene Anwendung in Ihrem Konto zu ändern.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anwendungs-ID
|
application_id | True | string |
Eindeutiger Bezeichner der Anwendung. |
|
Name
|
name | True | string |
Name der Anwendung. |
|
Typ
|
type | True | string |
Anwendungstyp. |
|
Antwort-URL
|
answer_url | True | string |
Wo Ihr Webhook das Nexmo Call Control Object liefert. |
|
Ereignis-URL
|
event_url | True | string |
Gestartet, Klingeln oder Abschließen |
|
Answer-Methode
|
answer_method | string |
HTTP-Methode (Default GET). |
|
|
Event-Methode
|
event_method | string |
HTTP-Methode (Default POST). |
Gibt zurück
- Body
- applicationResponse
Anwendung nach ID abrufen
Dieser Vorgang wird verwendet, um Informationen zu einer einzelnen Anwendung anhand der ID abzurufen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anwendungs-ID
|
application_id | True | string |
Eindeutiger Bezeichner der Anwendung. |
Gibt zurück
- Body
- applicationResponse
Anwendungen auflisten
Ruft eine Liste aller Anwendungen ab, die Ihrem Konto zugeordnet sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Ergebnisanzahl
|
page_size | number |
Elemente, die für jeden Anruf zurückgegeben werden (Standard 10). |
|
|
Seitenindex
|
page_index | number |
Offset von der ersten Seite (Standard 0). |
Gibt zurück
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
applications
|
_embedded.applications | array of applicationResponse |
Eigene Nummern auflisten
Dieser Vorgang ruft alle Nummern ab, die Ihrem Konto zugeordnet sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Suchmuster
|
Search Pattern | string |
Wählen Sie ein Muster aus. |
|
|
Seitenindex
|
index | number |
Index in der Antwort. |
|
|
Ergebnisanzahl
|
size | number |
Standard 10 Max 100. |
|
|
Muster
|
pattern | number |
Nummernmuster, nach dem gesucht werden soll. |
Gibt zurück
- Body
- ListNumbersResponse
Eingehende Nummern auflisten
Dieser Vorgang wird verwendet, um alle eingehenden Nummern abzurufen, die für ein bestimmtes Land avialierbar sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Country
|
country | True | string |
Code im ISO 3166-1 Alpha-2-Format. |
|
Suchmuster
|
Search Pattern | string |
Wählen Sie ein Muster aus. |
|
|
Muster
|
pattern | number |
Nummernmuster, nach dem gesucht werden soll. |
|
|
Verfügbare Features
|
features | string |
SMS oder VOICE |
|
|
Ergebnisanzahl
|
size | number |
Standardwert: 10 |
|
|
Seitenindex
|
index | number |
Index in der Antwort. |
Gibt zurück
- Body
- ListNumbersResponse
Löschen einer Anwendung
Dieser Vorgang wird verwendet, um eine vorhandene Anwendung in Ihrem Konto zu löschen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Anwendungs-ID
|
application_id | True | string |
Eindeutiger Bezeichner der Anwendung. |
Gibt zurück
- Body
- common
Neue Anwendung erstellen
Dieser Vorgang wird verwendet, um eine neue Anwendung in Ihrem Konto zu erstellen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name
|
name | True | string |
Name der Anwendung. |
|
Typ
|
type | True | string |
Anwendungstyp. |
|
Antwort-URL
|
answer_url | True | string |
Wo Ihr Webhook das Nexmo Call Control Object liefert. |
|
Ereignis-URL
|
event_url | True | string |
Gestartet, Klingeln oder Abschließen |
|
Answer-Methode
|
answer_method | string |
HTTP-Methode (Default GET). |
|
|
Event-Methode
|
event_method | string |
HTTP-Methode (Default POST). |
Gibt zurück
- Body
- applicationResponse
Senden einer SMS
Dieser Vorgang wird verwendet, um eine SMS zu senden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Absender-ID
|
from | True | string |
Eine alphanumerische Zeichenfolge. |
|
To Phone Number
|
to | True | string |
Internationales Format E.164. |
|
Text
|
text | True | string |
SMS-Textkörper. |
|
Typ
|
type | string |
Der Standardwert ist "Text". |
|
|
Lieferbestätigungen
|
status-report-req | number |
Legen Sie auf "1" fest, um die Option zu aktivieren. |
|
|
Clientreferenz
|
client-ref | string |
Für interne Berichte. |
|
|
Visitenkarte
|
vcard | string |
vCard-Format. |
|
|
Kalenderereignis
|
vcal | string |
vCal-Format. |
|
|
Lebensdauer von SMS
|
ttl | number |
In Millisekunden. |
|
|
Rückruf-URL
|
callback | url |
Übermittlungsbestätigungsendpunkt. |
|
|
Nachrichtenklasse
|
message-class | number |
Wählen Sie einen Kurs aus. |
|
|
Benutzerdatenkopf
|
udh | string |
Hex-codierte UDH. |
|
|
Protokoll der höheren Ebene
|
protocol-id | string |
Protokoll-ID. |
|
|
Textkörper (Wenn Typ binär ist.)
|
body | string |
Hex-codierte Binärdaten. |
|
|
Title
|
title | string |
Wenn der Typ "wappush" ist. |
|
|
URL
|
url | url |
Website-URL (Wenn Typ "wappush."). |
|
|
Verfügbarkeit (Wenn der Typ "wappush" ist.)
|
validity | string |
In Millisekunden. |
Gibt zurück
- Body
- smsResponse
Senden einer Sprachdatei
Dieser Vorgang wird verwendet, um eine synthetisierte Sprache oder eine aufgezeichnete Audiodatei an eine Telefonnummer zu senden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
To Phone Number
|
to | True | string |
Internationales Format E.164. |
|
Von Telefonnummer
|
from | string |
Voice-enabled Nexmo number. |
|
|
Nachricht
|
text | True | string |
Sprachtext. |
|
Language
|
lg | string |
So synthetisieren Sie die Nachricht in. |
|
|
Geschlecht
|
voice | string |
Männlich oder weiblich. |
|
|
Zahl der Wiederholungen
|
repeat | number |
Bis zu 10 Mal. |
|
|
Computererkennung zulassen
|
machine_detection | string |
True oder Hangup. |
|
|
Computertimeout
|
machine_timeout | number |
400 ms bis 10000 ms. |
|
|
Rückruf-URL
|
callback | url |
URL für Rückruf. |
|
|
Callback-Methode
|
callback_method | string |
GET oder POST. |
Gibt zurück
- Body
- ttsResponse
Definitionen
smsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Nachrichtenanzahl
|
message-count | string |
Die Anzahl der Teile, in die die Nachricht aufgeteilt wurde. |
|
Nachrichtenarray
|
messages | array of object |
Enthält jeden Nachrichtenteil. |
|
Der Status
|
messages.status | string |
Zeigt, wie die SMS-Übermittlung verarbeitet wird. |
|
Nachrichten-ID
|
messages.message-id | string |
ID der übermittelten SMS (8 bis 16 Zeichen). |
|
To Phone Number
|
messages.to | string |
Nummerieren Sie Ihre Anforderung, an die sie gesendet wurde. |
|
Clientreferenz
|
messages.client-ref | string |
Der clientbasierte Verweis, den Sie in der Anforderung festgelegt haben. |
|
Restsaldo
|
messages.remaining-balance | string |
Saldo in Ihrem Konto. Der Wert liegt in EUR. |
|
Nachrichtenpreis
|
messages.message-price | string |
Betrag, der für Ihre Anfrage in Rechnung gestellt wird. Der Wert liegt in EUR. |
|
Netzwerk
|
messages.network | string |
Mobile Ländercode Mobile Network Code (MCCMNC) für den Netzbetreiber, der registriert ist. |
|
Fehlertext
|
messages.error-text | string |
Wenn ein Fehler aufgetreten ist, wird erläutert, was passiert ist. |
ListNumbersResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anzahl
|
count | integer |
Ergebnisanzahl. |
|
Zahlenarray
|
numbers | array of object |
Liste aller Zahlen. |
|
Kosten
|
numbers.cost | string |
Zahlenkosten. |
|
Country
|
numbers.country | string |
ISO 3166-1 Alpha-2-Format. |
|
Eingehende Zahl
|
numbers.msisdn | string |
Eingehende virtuelle Nummer. |
|
Typ
|
numbers.type | string |
Typ der Zahl. |
ttsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Anruf-ID
|
call_id | string |
Eindeutige alphanumerische 32-Zeichen-ID für diesen Aufruf. |
|
To Phone Number
|
to | string |
Die Nummer des Benutzers, an den Sie die TTS- oder TTS-Eingabeaufforderung gesendet haben. |
|
Der Status
|
status | string |
Antwortcode für diese TTS- oder TTS-Eingabeaufforderung. |
|
Fehlertext
|
error_text | string |
Wenn ein Fehler aufgetreten ist, wird erläutert, was passiert ist. |
applicationResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Id
|
id | string |
Nexmo-Anwendungs-ID. |
|
Name
|
name | string |
Anwendungsname. |
|
Schlüssel
|
keys.public_key | string |
Der öffentliche Schlüssel, der zum Überprüfen des jwt in einem https://en.wikipedia.org/wiki/JSON_Web_Token. |
gemeinsam
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Antwort
|
type | string |
Lesbare Nachricht für Menschen. |
|
Fehlertext
|
error_title | string |
Der Fehlertitel, der zurückgegeben wird, wenn ein Fehler aufgetreten ist. |