Nexmo
Nexmo, platforma interfejsu API Vonage, umożliwia dodawanie komunikacji w kontekście aplikacji, w tym wiadomości SMS, voice i chat. Zarejestruj się w celu uzyskania konta Nexmo tutaj — https://www.nexmo.com/
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Metadane łącznika | |
|---|---|
| Publisher | Microsoft |
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: Wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja Power App zostanie udostępniona innemu użytkownikowi, inny użytkownik zostanie poproszony o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Klucz interfejsu API | ciąg | Klucz interfejsu API | Prawda |
| Wpis tajny interfejsu API | securestring | Wpis tajny interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie aplikacji |
Ta operacja służy do modyfikowania istniejącej aplikacji na twoim koncie. |
| Pobieranie aplikacji według identyfikatora |
Ta operacja służy do pobierania informacji o pojedynczej aplikacji, biorąc pod uwagę jego identyfikator. |
| Tworzenie nowej aplikacji |
Ta operacja służy do tworzenia nowej aplikacji na twoim koncie. |
| Usuwanie aplikacji |
Ta operacja służy do usuwania istniejącej aplikacji na twoim koncie. |
| Wysyłanie pliku mowy |
Ta operacja służy do wysyłania syntetyzowanej mowy lub nagranego pliku dźwiękowego do numeru telefonu. |
| Wysyłanie wiadomości SMS |
Ta operacja służy do wysyłania wiadomości SMS. |
| Wyświetlanie listy aplikacji |
Pobiera listę wszystkich aplikacji skojarzonych z twoim kontem. |
| Wyświetlanie listy numerów należących do |
Ta operacja pobiera wszystkie liczby skojarzone z kontem. |
| Wyświetlanie listy numerów przychodzących |
Ta operacja służy do pobierania wszystkich numerów przychodzących, które są lotne dla danego kraju. |
Aktualizowanie aplikacji
Ta operacja służy do modyfikowania istniejącej aplikacji na twoim koncie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator aplikacji
|
application_id | True | string |
Unikatowy identyfikator aplikacji. |
|
Name
|
name | True | string |
Nazwa aplikacji. |
|
Typ
|
type | True | string |
Typ aplikacji. |
|
Adres URL odpowiedzi
|
answer_url | True | string |
Gdzie element webhook dostarcza obiekt sterowania wywołania Nexmo. |
|
Adres URL zdarzeń
|
event_url | True | string |
Rozpoczęte, dzwoniące lub ukończone |
|
Answer, metoda
|
answer_method | string |
Metoda HTTP (Domyślna metoda GET). |
|
|
Event, metoda
|
event_method | string |
Metoda HTTP (Default POST). |
Zwraca
- Body
- applicationResponse
Pobieranie aplikacji według identyfikatora
Ta operacja służy do pobierania informacji o pojedynczej aplikacji, biorąc pod uwagę jego identyfikator.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator aplikacji
|
application_id | True | string |
Unikatowy identyfikator aplikacji. |
Zwraca
- Body
- applicationResponse
Tworzenie nowej aplikacji
Ta operacja służy do tworzenia nowej aplikacji na twoim koncie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Name
|
name | True | string |
Nazwa aplikacji. |
|
Typ
|
type | True | string |
Typ aplikacji. |
|
Adres URL odpowiedzi
|
answer_url | True | string |
Gdzie element webhook dostarcza obiekt sterowania wywołania Nexmo. |
|
Adres URL zdarzeń
|
event_url | True | string |
Rozpoczęte, dzwoniące lub ukończone |
|
Answer, metoda
|
answer_method | string |
Metoda HTTP (Domyślna metoda GET). |
|
|
Event, metoda
|
event_method | string |
Metoda HTTP (Default POST). |
Zwraca
- Body
- applicationResponse
Usuwanie aplikacji
Ta operacja służy do usuwania istniejącej aplikacji na twoim koncie.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator aplikacji
|
application_id | True | string |
Unikatowy identyfikator aplikacji. |
Zwraca
- Body
- common
Wysyłanie pliku mowy
Ta operacja służy do wysyłania syntetyzowanej mowy lub nagranego pliku dźwiękowego do numeru telefonu.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Do numeru telefonu
|
to | True | string |
Format międzynarodowy E.164. |
|
Z numeru telefonu
|
from | string |
Numer Nexmo z obsługą głosu. |
|
|
Message
|
text | True | string |
Tekst mowy. |
|
Język
|
lg | string |
Aby zsyntetyzować komunikat w. |
|
|
Gender
|
voice | string |
Mężczyzna lub kobieta. |
|
|
Liczba powtórzeń
|
repeat | number |
Do 10 razy. |
|
|
Zezwalaj na wykrywanie maszyn
|
machine_detection | string |
True lub hangup. |
|
|
Limit czasu maszyny
|
machine_timeout | number |
400 ms do 10000 ms. |
|
|
Adres URL wywołania zwrotnego
|
callback | url |
Adres URL wywołania zwrotnego. |
|
|
Callback, metoda
|
callback_method | string |
GET lub POST. |
Zwraca
- Body
- ttsResponse
Wysyłanie wiadomości SMS
Ta operacja służy do wysyłania wiadomości SMS.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator nadawcy
|
from | True | string |
Ciąg alfanumeryczny. |
|
Do numeru telefonu
|
to | True | string |
Format międzynarodowy E.164. |
|
Tekst
|
text | True | string |
Treść wiadomości SMS. |
|
Typ
|
type | string |
Domyślnie tekst. |
|
|
Potwierdzenia dostawy
|
status-report-req | number |
Ustaw wartość 1, aby włączyć. |
|
|
Dokumentacja klienta
|
client-ref | string |
W przypadku raportowania wewnętrznego. |
|
|
Wizytówka
|
vcard | string |
Format vCard. |
|
|
Zdarzenie kalendarza
|
vcal | string |
Format vCal. |
|
|
Żywotność wiadomości SMS
|
ttl | number |
W milisekundach. |
|
|
Adres URL wywołania zwrotnego
|
callback | url |
Punkt końcowy potwierdzenia dostarczenia. |
|
|
Message, klasa
|
message-class | number |
Wybierz klasę. |
|
|
Nagłówek danych użytkownika
|
udh | string |
Kodowany szesnastkowy udH. |
|
|
Protokół wyższego poziomu
|
protocol-id | string |
Identyfikator protokołu. |
|
|
Treść (jeśli typ jest binarny).
|
body | string |
Zakodowane dane binarne szesnastkowe. |
|
|
Title
|
title | string |
Jeśli typ to wappush. |
|
|
URL
|
url | url |
Adres URL witryny internetowej (jeśli typ to wappush.). |
|
|
Dostępność (jeśli typ to wappush).
|
validity | string |
W milisekundach. |
Zwraca
- Body
- smsResponse
Wyświetlanie listy aplikacji
Pobiera listę wszystkich aplikacji skojarzonych z twoim kontem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Liczba wyników
|
page_size | number |
Elementy zwracane przy każdym wywołaniu (domyślnie 10). |
|
|
Indeks strony
|
page_index | number |
Przesunięcie z pierwszej strony (wartość domyślna 0). |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
applications
|
_embedded.applications | array of applicationResponse |
Wyświetlanie listy numerów należących do
Ta operacja pobiera wszystkie liczby skojarzone z kontem.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Wzorzec wyszukiwania
|
Search Pattern | string |
Wybierz wzorzec. |
|
|
Indeks strony
|
index | number |
Indeksuj w odpowiedzi. |
|
|
Liczba wyników
|
size | number |
Wartość domyślna 10 Maksymalna 100. |
|
|
Wzór
|
pattern | number |
Wzorzec liczb do wyszukania. |
Zwraca
- Body
- ListNumbersResponse
Wyświetlanie listy numerów przychodzących
Ta operacja służy do pobierania wszystkich numerów przychodzących, które są lotne dla danego kraju.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Country
|
country | True | string |
Kod w formacie ISO 3166-1 alfa-2. |
|
Wzorzec wyszukiwania
|
Search Pattern | string |
Wybierz wzorzec. |
|
|
Wzór
|
pattern | number |
Wzorzec liczb do wyszukania. |
|
|
Dostępne funkcje
|
features | string |
SMS lub VOICE |
|
|
Liczba wyników
|
size | number |
Wartość domyślna 10. |
|
|
Indeks strony
|
index | number |
Indeksuj w odpowiedzi. |
Zwraca
- Body
- ListNumbersResponse
Definicje
smsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba komunikatów
|
message-count | string |
Liczba części, na które wiadomość została podzielona. |
|
Tablica komunikatów
|
messages | array of object |
Zawiera każdą część komunikatu. |
|
Status
|
messages.status | string |
Pokazuje sposób przetwarzania wysyłania wiadomości SMS. |
|
Identyfikator wiadomości
|
messages.message-id | string |
Identyfikator przesłanej wiadomości SMS (od 8 do 16 znaków). |
|
Do numeru telefonu
|
messages.to | string |
Numer, do którego wysłano żądanie. |
|
Dokumentacja klienta
|
messages.client-ref | string |
Element client-ref ustawiony w żądaniu. |
|
Pozostała równowaga
|
messages.remaining-balance | string |
Saldo na koncie. Wartość jest wyrażona w EUR. |
|
Cena wiadomości
|
messages.message-price | string |
Kwota naliczona za żądanie. Wartość jest wyrażona w EUR. |
|
Sieć
|
messages.network | string |
Mobile Country Code Mobile Network Code (MCCMNC) dla przewoźnika, który ma być zarejestrowany. |
|
Tekst błędu
|
messages.error-text | string |
Jeśli wystąpił błąd, wyjaśnia to, co się stało. |
ListNumbersResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Liczba
|
count | integer |
Liczba wyników. |
|
Tablica liczb
|
numbers | array of object |
Lista wszystkich liczb. |
|
Koszt
|
numbers.cost | string |
Koszt liczbowy. |
|
Country
|
numbers.country | string |
Format ISO 3166-1 alfa-2. |
|
Numer przychodzący
|
numbers.msisdn | string |
Przychodzący numer wirtualny. |
|
Typ
|
numbers.type | string |
Typ liczby. |
ttsResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Identyfikator połączenia
|
call_id | string |
Unikatowy alfanumeryczny 32-znakowy identyfikator tego wywołania. |
|
Do numeru telefonu
|
to | string |
Liczba użytkowników, do których wysłano monit TTS lub TTS. |
|
Status
|
status | string |
Kod odpowiedzi dla tego monitu TTS lub TTS. |
|
Tekst błędu
|
error_text | string |
Jeśli wystąpił błąd, wyjaśnia to, co się stało. |
applicationResponse
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Id
|
id | string |
Identyfikator aplikacji Nexmo. |
|
Name
|
name | string |
Nazwa aplikacji. |
|
Keys
|
keys.public_key | string |
Klucz publiczny używany do sprawdzania poprawności pliku jwt w obiekcie https://en.wikipedia.org/wiki/JSON_Web_Token. |
wspólny
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Odpowiedź
|
type | string |
Czytelny dla człowieka komunikat. |
|
Tekst błędu
|
error_title | string |
Tytuł błędu zwrócony w przypadku niepowodzenia. |