Sdílet prostřednictvím

Nexmo

Nexmo, platforma rozhraní API Vonage, umožňuje přidat komunikaci v kontextu vašich aplikací, včetně SMS, hlasu a chatu. Tady si zaregistrujte účet Nexmo – https://www.nexmo.com/

Tento konektor je dostupný v následujících produktech a oblastech:

Service Class Regions
Copilot Studio Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Logic Apps Standard Všechny oblasti Logic Apps s výjimkou následujících:
     – Oblasti Azure Government
     – Oblasti Azure China
     - Ministerstvo obrany USA (DoD)
Power Apps Premium Všechny oblasti Power Apps s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Power Automate Premium Všechny oblasti Power Automate s výjimkou následujících:
     – státní správa USA (GCC)
     – státní správa USA (GCC High)
     - China Cloud provozovaný společností 21Vianet
     - Ministerstvo obrany USA (DoD)
Metadata konektoru
Vydavatel Microsoft

Vytvoření připojení

Konektor podporuje následující typy ověřování:
výchozí Parametry pro vytvoření připojení Všechny oblasti Nesdílitelné

Výchozí

Použitelné: Všechny oblasti

Parametry pro vytvoření připojení

Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.

Název Typ Description Povinné
Klíč rozhraní API řetězec Klíč rozhraní API Pravdivé
Tajný klíč rozhraní API securestring Tajný kód rozhraní API Pravdivé

Limity omezování

Name Volání Období obnovení
Volání rozhraní API na připojení 100 60 sekund

Akce

Aktualizace aplikace

Tato operace slouží k úpravě existující aplikace ve vašem účtu.
Odeslání souboru řeči

Tato operace se používá k odesílání syntetizované řeči nebo nahraného zvukového souboru na telefonní číslo.
Odeslání zprávy SMS

Tato operace se používá k odeslání zprávy SMS.
Odstranění aplikace

Tato operace slouží k odstranění existující aplikace ve vašem účtu.
Seznam vlastněných čísel

Tato operace načte všechna čísla přidružená k vašemu účtu.
Vytvoření nové aplikace

Tato operace slouží k vytvoření nové aplikace ve vašem účtu.
Výpis aplikací

Načte seznam všech aplikací přidružených k vašemu účtu.
Výpis příchozích čísel

Tato operace se používá k načtení všech příchozích čísel, která jsou pro danou zemi avialble.
Získání aplikace podle ID

Tato operace se používá k načtení informací o jedné aplikaci vzhledem k jeho ID.

Aktualizace aplikace

ID operace:
UpdateApplication

Tato operace slouží k úpravě existující aplikace ve vašem účtu.

Parametry

Name Klíč Vyžadováno Typ Description
ID aplikace
 application_id True string

Jedinečný identifikátor aplikace
Název
 name True string

Název aplikace.
Typ
 type True string

Typ aplikace.
Adresa URL odpovědi
 answer_url True string

Kde váš webhook doručí objekt Nexmo Call Control Object.
Adresa URL událostí
 event_url True string

Začátek, vyzvánění nebo dokončení
Answer – metoda
 answer_method string

Metoda HTTP (Default GET).
Event – metoda
 event_method string

Metoda HTTP (Default POST).

Návraty

Body
applicationResponse

Odeslání souboru řeči

ID operace:
SendTts

Tato operace se používá k odesílání syntetizované řeči nebo nahraného zvukového souboru na telefonní číslo.

Parametry

Name Klíč Vyžadováno Typ Description
Na telefonní číslo
 to True string

Mezinárodní formát E.164.
Z telefonního čísla
 from string

Číslo Nexmo s podporou hlasu.
Message
 text True string

Text řeči
Jazyk
 lg string

Syntetizování zprávy.
Pohlaví
 voice string

Muž nebo žena.
Počet opakování
 repeat number

Až 10krát.
Povolit detekci počítačů
 machine_detection string

Pravda nebo zavěsit.
Časový limit počítače
 machine_timeout number

400 ms až 1 0000 ms.
Adresa URL zpětného volání
 callback url

Adresa URL zpětného volání
Callback – metoda
 callback_method string

GET nebo POST.

Návraty

Body
ttsResponse

Odeslání zprávy SMS

ID operace:
SendSms

Tato operace se používá k odeslání zprávy SMS.

Parametry

Name Klíč Vyžadováno Typ Description
ID odesílatele
 from True string

Alfanumerický řetězec.
Na telefonní číslo
 to True string

Mezinárodní formát E.164.
Text
 text True string

Tělo SMS.
Typ
 type string

Výchozí hodnota je text.
Potvrzení o doručení
 status-report-req number

Nastavte na hodnotu 1, abyste ji povolili.
Referenční dokumentace klienta
 client-ref string

Pro interní vytváření sestav.
Vizitka
 vcard string

formát vCard.
Událost kalendáře
 vcal string

formát vCal.
Životnost SMS
 ttl number

V milisekundách.
Adresa URL zpětného volání
 callback url

Koncový bod potvrzení o doručení
Message – třída
 message-class number

Vyberte třídu.
Záhlaví uživatelských dat
 udh string

Šestnáctkové kódování UDH.
Protokol vyšší úrovně
 protocol-id string

ID protokolu.
Text (Pokud je typ binární.)
 body string

Šestnáctková binární data.
Title
 title string

Pokud je typ wappush.
URL
 url url

Adresa URL webu (pokud je typ wappush.).
Dostupnost (pokud je typ wappush.)
 validity string

V milisekundách.

Návraty

Body
smsResponse

Odstranění aplikace

ID operace:
DeleteApplication

Tato operace slouží k odstranění existující aplikace ve vašem účtu.

Parametry

Name Klíč Vyžadováno Typ Description
ID aplikace
 application_id True string

Jedinečný identifikátor aplikace

Návraty

Body
common

Seznam vlastněných čísel

ID operace:
ListOwnedNumbers

Tato operace načte všechna čísla přidružená k vašemu účtu.

Parametry

Name Klíč Vyžadováno Typ Description
Vzor hledání
 Search Pattern string

Vyberte vzor.
Index stránky
 index number

Index v odpovědi.
Počet výsledků
 size number

Výchozí hodnota 10 Max 100.
Vzor
 pattern number

Číselný vzor, který chcete vyhledat.

Návraty

Body
ListNumbersResponse

Vytvoření nové aplikace

ID operace:
CreateApplication

Tato operace slouží k vytvoření nové aplikace ve vašem účtu.

Parametry

Name Klíč Vyžadováno Typ Description
Název
 name True string

Název aplikace.
Typ
 type True string

Typ aplikace.
Adresa URL odpovědi
 answer_url True string

Kde váš webhook doručí objekt Nexmo Call Control Object.
Adresa URL událostí
 event_url True string

Začátek, vyzvánění nebo dokončení
Answer – metoda
 answer_method string

Metoda HTTP (Default GET).
Event – metoda
 event_method string

Metoda HTTP (Default POST).

Návraty

Body
applicationResponse

Výpis aplikací

ID operace:
ListApplications

Načte seznam všech aplikací přidružených k vašemu účtu.

Parametry

Name Klíč Vyžadováno Typ Description
Počet výsledků
 page_size number

Položky vrácené při každém volání (výchozí 10)
Index stránky
 page_index number

Posun od první stránky (výchozí 0)

Návraty

Name Cesta Typ Description
applications
 _embedded.applications array of applicationResponse

Výpis příchozích čísel

ID operace:
ListInboundNumbers

Tato operace se používá k načtení všech příchozích čísel, která jsou pro danou zemi avialble.

Parametry

Name Klíč Vyžadováno Typ Description
Country
 country True string

Kód ve formátu ISO 3166-1 alfa-2
Vzor hledání
 Search Pattern string

Vyberte vzor.
Vzor
 pattern number

Číselný vzor, který chcete vyhledat.
Dostupné funkce
 features string

SMS nebo VOICE
Počet výsledků
 size number

Výchozí hodnota 10.
Index stránky
 index number

Index v odpovědi.

Návraty

Body
ListNumbersResponse

Získání aplikace podle ID

ID operace:
GetApplication

Tato operace se používá k načtení informací o jedné aplikaci vzhledem k jeho ID.

Parametry

Name Klíč Vyžadováno Typ Description
ID aplikace
 application_id True string

Jedinečný identifikátor aplikace

Návraty

Body
applicationResponse

Definice

smsResponse

Name Cesta Typ Description
Počet zpráv
 message-count string

Počet částí, na které byla zpráva rozdělena.
Pole zpráv
 messages array of object

Obsahuje každou část zprávy.
Stav
 messages.status string

Ukazuje, jak probíhá zpracování odesílání SMS.
ID zprávy
 messages.message-id string

ID odeslané zprávy SMS (8 až 16 znaků).
Na telefonní číslo
 messages.to string

Číslo žádosti bylo odesláno.
Referenční dokumentace klienta
 messages.client-ref string

Odkaz klienta, který jste nastavili v požadavku.
Zbývající zůstatek
 messages.remaining-balance string

Zůstatek na vašem účtu. Hodnota je v EUR.
Cena zprávy
 messages.message-price string

Částka účtovaná za vaši žádost. Hodnota je v EUR.
Síť
 messages.network string

Mobilní kód mobilní sítě (MCCMNC) mobilního kódu země pro dopravce, který má být registrován.
Text chyby
 messages.error-text string

Pokud došlo k chybě, vysvětluje se, co se stalo.

ListNumbersResponse

Name Cesta Typ Description
Počet
 count integer

Počet výsledků.
Matice čísel
 numbers array of object

Seznam všech čísel
Náklady
 numbers.cost string

Číselné náklady.
Country
 numbers.country string

Formát ISO 3166-1 alfa-2.
Příchozí číslo
 numbers.msisdn string

Příchozí virtuální číslo
Typ
 numbers.type string

Typ čísla.

ttsResponse

Name Cesta Typ Description
ID hovoru
 call_id string

Jedinečné alfanumerické 32 znakové ID pro toto volání.
Na telefonní číslo
 to string

Počet uživatelů, na které jste odeslali výzvu K TTS nebo TTS.
Stav
 status string

Kód odpovědi pro tento dotaz TTS nebo TTS.
Text chyby
 error_text string

Pokud došlo k chybě, vysvětluje se, co se stalo.

applicationResponse

Name Cesta Typ Description
identifikační číslo
 id string

ID aplikace Nexmo.
Název
 name string

Název aplikace
Keys
 keys.public_key string

Veřejný klíč použitý k ověření jwt v objektu .https://en.wikipedia.org/wiki/JSON_Web_Token

společný

Name Cesta Typ Description
Odezva
 type string

Zpráva čitelná pro člověka
Text chyby
 error_title string

Název chyby vrácený v případě selhání