Vonage (wersja zapoznawcza)
Platforma interfejsu API Vonage umożliwia dodawanie komunikacji w kontekście aplikacji, w tym wiadomości SMS, głosu i czatu. Zarejestruj się w celu uzyskania konta Nexmo tutaj — https://www.vonage.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) |
| Kontakt | |
|---|---|
| Name | Obsługa vonage |
| adres URL | https://www.vonage.co.uk/support |
| support@vonage.com |
| Metadane łącznika | |
|---|---|
| Publisher | Vonage |
| Witryna internetowa | https://vonage.com |
| Zasady zachowania poufności informacji | https://www.vonage.com/legal/privacy-policy |
| Kategorie | Communication |
Platforma interfejsu API Vonage umożliwia dodawanie komunikacji w kontekście aplikacji, w tym wiadomości SMS, głosu i czatu.
Wymagania wstępne
Aby kontynuować, musisz wykonać następujące czynności:
- Konto Vonage, zarejestruj się pod adresem https://dashboard.nexmo.com/sign-up
Jak uzyskać poświadczenia
Aby uzyskać poświadczenia, możesz zarejestrować się w celu uzyskania bezpłatnego konta Vonage pod adresem https://dashboard.nexmo.com/sign-up
Znane problemy i ograniczenia
Ten łącznik obecnie nie uwidacznia wszystkich produktów i interfejsów API firmy Vonage
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Sprawdzanie weryfikacji |
Potwierdza, że numer PIN otrzymany od użytkownika jest zgodny z żądaniem Weryfikuj |
| Udostępnia standardowe informacje o numerze szczegółowych informacji o liczbie |
Udostępnia standardowe informacje o numerze szczegółowych informacji o liczbie |
| Wysyłanie komunikatu do danego kanału |
Wysyłanie wiadomości |
| Zawiera podstawowe informacje o numerze szczegółowych informacji o liczbie |
Zawiera podstawowe informacje o numerze szczegółowych informacji o liczbie |
| Żądanie weryfikacji |
Użyj polecenia Verify request , aby wygenerować i wysłać numer PIN do użytkownika |
Sprawdzanie weryfikacji
Potwierdza, że numer PIN otrzymany od użytkownika jest zgodny z żądaniem Weryfikuj
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Format odpowiedzi
|
format | True | string |
Format odpowiedzi |
|
Klucz interfejsu API
|
api_key | True | string |
Klucz interfejsu API |
|
Wpis tajny interfejsu API
|
api_secret | True | string |
Wpis tajny interfejsu API |
|
Jest to request_id otrzymana w odpowiedzi na żądanie Weryfikuj
|
request_id | True | string |
Jest to request_id otrzymana w odpowiedzi na żądanie Weryfikuj |
|
Kod weryfikacyjny wprowadzony przez użytkownika
|
code | True | string |
Kod weryfikacyjny wprowadzony przez użytkownika |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
identyfikator_żądania
|
request_id | string | |
|
event_id
|
event_id | string | |
|
stan
|
status | string | |
|
cena
|
price | string | |
|
waluta
|
currency | string | |
|
estimated_price_messages_sent
|
estimated_price_messages_sent | string |
Udostępnia standardowe informacje o numerze szczegółowych informacji o liczbie
Udostępnia standardowe informacje o numerze szczegółowych informacji o liczbie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Format odpowiedzi
|
format | True | string |
Format odpowiedzi |
|
Klucz interfejsu API
|
api_key | True | string |
Klucz interfejsu API |
|
Wpis tajny interfejsu API
|
api_secret | True | string |
Wpis tajny interfejsu API |
|
Numer telefonu, który potrzebujesz wglądu w format krajowy lub międzynarodowy
|
number | True | string |
Numer telefonu, który potrzebujesz wglądu w format krajowy lub międzynarodowy |
|
Dwuznaczny kod kraju w formacie ISO 3166-1 alfa-2, np. GB lub USA
|
country | True | string |
Dwuznaczny kod kraju w formacie ISO 3166-1 alfa-2, np. GB lub USA |
|
Ustaw wartość true, aby otrzymać nazwę właściciela numeru telefonu w odpowiedzi
|
cnam | string |
Ustaw wartość true, aby otrzymać nazwę właściciela numeru telefonu w odpowiedzi |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | integer | |
|
status_message
|
status_message | string | |
|
identyfikator_żądania
|
request_id | string | |
|
international_format_number
|
international_format_number | string | |
|
national_format_number
|
national_format_number | string | |
|
country_code
|
country_code | string | |
|
country_code_iso3
|
country_code_iso3 | string | |
|
country_name
|
country_name | string | |
|
country_prefix
|
country_prefix | string | |
|
request_price
|
request_price | string | |
|
refund_price
|
refund_price | string | |
|
remaining_balance
|
remaining_balance | string | |
|
network_code
|
current_carrier.network_code | string | |
|
nazwa
|
current_carrier.name | string | |
|
country
|
current_carrier.country | string | |
|
network_type
|
current_carrier.network_type | string | |
|
network_code
|
original_carrier.network_code | string | |
|
nazwa
|
original_carrier.name | string | |
|
country
|
original_carrier.country | string | |
|
network_type
|
original_carrier.network_type | string | |
|
Przeniesiony
|
ported | string | |
|
caller_type
|
caller_identity.caller_type | string | |
|
caller_name
|
caller_identity.caller_name | string | |
|
first_name
|
caller_identity.first_name | string | |
|
last_name
|
caller_identity.last_name | string | |
|
caller_name
|
caller_name | string | |
|
last_name
|
last_name | string | |
|
first_name
|
first_name | string | |
|
caller_type
|
caller_type | string |
Wysyłanie komunikatu do danego kanału
Wysyłanie wiadomości
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ zawartości dla żądania
|
Content-Type | True | string |
Typ zawartości |
|
Zaakceptowany typ daty
|
Accept | True | string |
Akceptuj |
|
Typ wiadomości do wysłania. Musisz podać tekst w tym polu
|
message_type | string |
Typ wiadomości do wysłania. Musisz podać tekst w tym polu |
|
|
Tekst wiadomości do wysłania; ograniczone do 1000 znaków
|
text | string |
Tekst wiadomości do wysłania; ograniczone do 1000 znaków |
|
|
Numer telefonu adresata wiadomości w formacie E.164
|
to | string |
Numer telefonu adresata wiadomości w formacie E.164 |
|
|
Numer telefonu adresata wiadomości w formacie E.164
|
from | string |
Numer telefonu adresata wiadomości w formacie E.164 |
|
|
Kanał do wysłania. Musisz podać wiadomość SMS w tym polu
|
channel | string |
Kanał do wysłania. Musisz podać wiadomość SMS w tym polu |
|
|
Odwołanie klienta do maksymalnie 40 znaków
|
client_ref | string |
Odwołanie klienta do maksymalnie 40 znaków |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
message_uuid
|
message_uuid | string |
message_uuid |
Zawiera podstawowe informacje o numerze szczegółowych informacji o liczbie
Zawiera podstawowe informacje o numerze szczegółowych informacji o liczbie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Format odpowiedzi
|
format | True | string |
Format odpowiedzi |
|
Klucz interfejsu API
|
api_key | True | string |
Klucz interfejsu API |
|
Wpis tajny interfejsu API
|
api_secret | True | string |
Wpis tajny interfejsu API |
|
Numer telefonu, który potrzebujesz wglądu w format krajowy lub międzynarodowy
|
number | True | string |
Numer telefonu, który potrzebujesz wglądu w format krajowy lub międzynarodowy |
|
Dwuznaczny kod kraju w formacie ISO 3166-1 alfa-2, np. GB lub USA
|
country | True | string |
Dwuznaczny kod kraju w formacie ISO 3166-1 alfa-2, np. GB lub USA |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | integer | |
|
status_message
|
status_message | string | |
|
identyfikator_żądania
|
request_id | string | |
|
international_format_number
|
international_format_number | string | |
|
national_format_number
|
national_format_number | string | |
|
country_code
|
country_code | string | |
|
country_code_iso3
|
country_code_iso3 | string | |
|
country_name
|
country_name | string | |
|
country_prefix
|
country_prefix | string |
Żądanie weryfikacji
Użyj polecenia Verify request , aby wygenerować i wysłać numer PIN do użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Format odpowiedzi
|
format | True | string |
Format odpowiedzi |
|
Klucz interfejsu API można znaleźć na pulpicie nawigacyjnym konta https://dashboard.nexmo.com
|
api_key | True | string |
Klucz interfejsu API można znaleźć na pulpicie nawigacyjnym konta https://dashboard.nexmo.com |
|
Wpis tajny interfejsu API można znaleźć na pulpicie nawigacyjnym https://dashboard.nexmo.com
|
api_secret | True | string |
Wpis tajny interfejsu API można znaleźć na pulpicie nawigacyjnym https://dashboard.nexmo.com |
|
Numer telefonu komórkowego lub telefonu stacjonarnego do zweryfikowania. Liczba musi być w formacie E.164
|
number | True | string |
Numer telefonu komórkowego lub telefonu stacjonarnego do zweryfikowania. Liczba musi być w formacie E.164 |
|
Określ dwuznaczny kod kraju, zweryfikuj, a następnie sformatuje liczbę
|
country | string |
Określ dwuznaczny kod kraju, zweryfikuj, a następnie sformatuje liczbę |
|
|
18-znakowy ciąg alfanumeryczny służący do personalizowania treści żądania SMS
|
brand | True | string |
18-znakowy ciąg alfanumeryczny służący do personalizowania treści żądania SMS |
|
11-znakowy ciąg alfanumeryczny reprezentujący tożsamość nadawcy
|
sender_id | string |
11-znakowy ciąg alfanumeryczny reprezentujący tożsamość nadawcy |
|
|
Długość kodu weryfikacyjnego
|
code_length | integer |
Długość kodu weryfikacyjnego |
|
|
Kontrolowanie języka używanego na potrzeby żądania Weryfikuj
|
lg | string |
Kontrolowanie języka używanego na potrzeby żądania Weryfikuj |
|
|
Jak długo wygenerowany kod weryfikacyjny jest prawidłowy w sekundach
|
pin_expiry | integer |
Jak długo wygenerowany kod weryfikacyjny jest prawidłowy w sekundach |
|
|
Czas oczekiwania w sekundach między próbami dostarczenia kodu weryfikacyjnego
|
next_event_wait | integer |
Czas oczekiwania w sekundach między próbami dostarczenia kodu weryfikacyjnego |
|
|
Wstępnie zdefiniowana sekwencja akcji SMS i TTS w celu przekazania numeru PIN użytkownikowi
|
workflow_id | integer |
Wstępnie zdefiniowana sekwencja akcji SMS i TTS w celu przekazania numeru PIN użytkownikowi |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
stan
|
status | string | |
|
identyfikator_żądania
|
request_id | string |