Nexmo
Med Nexmo, Vonage API Platform, kan du lägga till kommunikation inom ramen för dina program, inklusive SMS, Röst och Chatt. Registrera dig för ett Nexmo-konto här - https://www.nexmo.com/
Den här anslutningsappen är tillgänglig i följande produkter och regioner:
| Tjänster | Class | Regioner |
|---|---|---|
| Copilot Studio | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Logiska appar | Norm | Alla Logic Apps-regioner utom följande: – Azure Government-regioner – Regioner i Azure Kina - US Department of Defense (DoD) |
| Power Apps | Premie | Alla Power Apps-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premie | Alla Power Automate-regioner utom följande: - Amerikanska myndigheter (GCC) - Amerikanska myndigheter (GCC High) – China Cloud drivs av 21Vianet - US Department of Defense (DoD) |
| Metadata för anslutningsprogram | |
|---|---|
| Utgivare | Microsoft |
Skapa en anslutning
Anslutningsappen stöder följande autentiseringstyper:
| Standardinställning | Parametrar för att skapa anslutning. | Alla regioner | Går inte att dela |
Standard
Tillämpligt: Alla regioner
Parametrar för att skapa anslutning.
Det här är inte delningsbar anslutning. Om power-appen delas med en annan användare uppmanas en annan användare att skapa en ny anslutning explicit.
| Namn | Typ | Description | Krävs |
|---|---|---|---|
| API-nyckel | snöre | API-nyckeln | Sann |
| API-hemlighet | securestring | API-hemligheten | Sann |
Begränsningsgränser
| Name | Anrop | Förnyelseperiod |
|---|---|---|
| API-anrop per anslutning | 100 | 60 sekunder |
Åtgärder
| Hämta program efter ID |
Den här åtgärden används för att hämta information om ett enda program, givet dess ID. |
| Lista program |
Hämtar en lista över alla program som är associerade med ditt konto. |
| Lista ägda nummer |
Den här åtgärden hämtar alla nummer som är associerade med ditt konto. |
| Skapa nytt program |
Den här åtgärden används för att skapa ett nytt program i ditt konto. |
| Skicka en talfil |
Den här åtgärden används för att skicka ett syntetiserat tal eller en inspelad ljudfil till ett telefonnummer. |
| Skicka ett SMS |
Den här åtgärden används för att skicka ett SMS. |
| Ta bort ett program |
Den här åtgärden används för att ta bort ett befintligt program i ditt konto. |
| Uppdatera ett program |
Den här åtgärden används för att ändra ett befintligt program i ditt konto. |
| Visa en lista över inkommande nummer |
Den här åtgärden används för att hämta alla inkommande tal som är tillgängliga för ett visst land. |
Hämta program efter ID
Den här åtgärden används för att hämta information om ett enda program, givet dess ID.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Program-ID
|
application_id | True | string |
Unikt ID för programmet. |
Returer
- Body
- applicationResponse
Lista program
Hämtar en lista över alla program som är associerade med ditt konto.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Antal resultat
|
page_size | number |
Objekt som returneras vid varje anrop (standard 10). |
|
|
Sidindex
|
page_index | number |
Förskjutning från första sidan (standard 0). |
Returer
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
applications
|
_embedded.applications | array of applicationResponse |
Lista ägda nummer
Den här åtgärden hämtar alla nummer som är associerade med ditt konto.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Sökmönster
|
Search Pattern | string |
Välj ett mönster. |
|
|
Sidindex
|
index | number |
Index i svaret. |
|
|
Antal resultat
|
size | number |
Standard 10 Max 100. |
|
|
Mönster
|
pattern | number |
Nummermönster att söka efter. |
Returer
- Body
- ListNumbersResponse
Skapa nytt program
Den här åtgärden används för att skapa ett nytt program i ditt konto.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Namn
|
name | True | string |
Namnet på programmet. |
|
Typ
|
type | True | string |
Typ av program. |
|
Svars-URL
|
answer_url | True | string |
Där din webhook levererar Nexmo-anropskontrollobjektet. |
|
Händelse-URL
|
event_url | True | string |
Startat, ringt eller slutfört |
|
Svarsmetod
|
answer_method | string |
HTTP-metod (standard-GET). |
|
|
Händelsemetod
|
event_method | string |
HTTP-metod (standard-POST). |
Returer
- Body
- applicationResponse
Skicka en talfil
Den här åtgärden används för att skicka ett syntetiserat tal eller en inspelad ljudfil till ett telefonnummer.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Till telefonnummer
|
to | True | string |
Internationellt format E.164. |
|
Från telefonnummer
|
from | string |
Röstaktiverat Nexmo-nummer. |
|
|
Message
|
text | True | string |
Taltext. |
|
Language
|
lg | string |
Så här syntetiserar du meddelandet i. |
|
|
Kön
|
voice | string |
Man eller kvinna. |
|
|
Antal upprepningar
|
repeat | number |
Upp till 10 gånger. |
|
|
Tillåt datoridentifiering
|
machine_detection | string |
Sant eller hangup. |
|
|
Timeout för dator
|
machine_timeout | number |
400 till 1 000 ms. |
|
|
Återanrops-URL
|
callback | url |
Url för återanrop. |
|
|
Motringningsmetod
|
callback_method | string |
GET eller POST. |
Returer
- Body
- ttsResponse
Skicka ett SMS
Den här åtgärden används för att skicka ett SMS.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Avsändar-ID
|
from | True | string |
En alfanumerisk sträng. |
|
Till telefonnummer
|
to | True | string |
Internationellt format E.164. |
|
Text
|
text | True | string |
SMS-brödtext. |
|
Typ
|
type | string |
Standardvärdet är text. |
|
|
Leveranskvitton
|
status-report-req | number |
Ange till 1 för att aktivera. |
|
|
Klientreferens
|
client-ref | string |
För intern rapportering. |
|
|
Visitkort
|
vcard | string |
vCard-format. |
|
|
Kalenderhändelse
|
vcal | string |
vCal-format. |
|
|
SMS:s livslängd
|
ttl | number |
I millisekunder. |
|
|
Återanrops-URL
|
callback | url |
Slutpunkt för leveranskvitto. |
|
|
Meddelandeklass
|
message-class | number |
Välj en klass. |
|
|
Sidhuvud för användardata
|
udh | string |
Hexkodad UDH. |
|
|
Protokoll på högre nivå
|
protocol-id | string |
Protokoll-ID. |
|
|
Brödtext (om typen är binär.)
|
body | string |
Hexkodade binära data. |
|
|
Titel
|
title | string |
Om typen är wappush. |
|
|
URL
|
url | url |
Webbplats-URL (Om typen är wappush.). |
|
|
Tillgänglighet (om typen är wappush.)
|
validity | string |
I millisekunder. |
Returer
- Body
- smsResponse
Ta bort ett program
Den här åtgärden används för att ta bort ett befintligt program i ditt konto.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Program-ID
|
application_id | True | string |
Unikt ID för programmet. |
Returer
- Body
- common
Uppdatera ett program
Den här åtgärden används för att ändra ett befintligt program i ditt konto.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Program-ID
|
application_id | True | string |
Unikt ID för programmet. |
|
Namn
|
name | True | string |
Namnet på programmet. |
|
Typ
|
type | True | string |
Typ av program. |
|
Svars-URL
|
answer_url | True | string |
Där din webhook levererar Nexmo-anropskontrollobjektet. |
|
Händelse-URL
|
event_url | True | string |
Startat, ringt eller slutfört |
|
Svarsmetod
|
answer_method | string |
HTTP-metod (standard-GET). |
|
|
Händelsemetod
|
event_method | string |
HTTP-metod (standard-POST). |
Returer
- Body
- applicationResponse
Visa en lista över inkommande nummer
Den här åtgärden används för att hämta alla inkommande tal som är tillgängliga för ett visst land.
Parametrar
| Name | Nyckel | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
Country
|
country | True | string |
Kod i ISO 3166-1 alfa-2-format. |
|
Sökmönster
|
Search Pattern | string |
Välj ett mönster. |
|
|
Mönster
|
pattern | number |
Nummermönster att söka efter. |
|
|
Tillgängliga funktioner
|
features | string |
SMS eller RÖST |
|
|
Antal resultat
|
size | number |
Standard 10. |
|
|
Sidindex
|
index | number |
Index i svaret. |
Returer
- Body
- ListNumbersResponse
Definitioner
smsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Antal meddelanden
|
message-count | string |
Antal delar som meddelandet delades upp i. |
|
Meddelandematris
|
messages | array of object |
Innehåller varje meddelandedel. |
|
Läge
|
messages.status | string |
Visar hur SMS-sändningen bearbetas. |
|
Meddelande-ID
|
messages.message-id | string |
Id för sms:et som skickades (8 till 16 tecken). |
|
Till telefonnummer
|
messages.to | string |
Nummer som din begäran skickades till. |
|
Klientreferens
|
messages.client-ref | string |
Den klient-referens som du angav i begäran. |
|
Återstående saldo
|
messages.remaining-balance | string |
Saldo i ditt konto. Värdet är i EUR. |
|
Meddelandepris
|
messages.message-price | string |
Belopp som debiteras för din begäran. Värdet är i EUR. |
|
Nätverk
|
messages.network | string |
Mobile Country Code Mobile Network Code (MCCMNC) för den operatör som ska registreras med. |
|
Fel Text
|
messages.error-text | string |
Om ett fel uppstod förklarar detta vad som hände. |
ListNumbersResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Räkna
|
count | integer |
Resultatantal. |
|
Talmatris
|
numbers | array of object |
Lista över alla tal. |
|
Kostnad
|
numbers.cost | string |
Nummerkostnad. |
|
Country
|
numbers.country | string |
ISO 3166-1 alfa-2-format. |
|
Inkommande nummer
|
numbers.msisdn | string |
Inkommande virtuellt nummer. |
|
Typ
|
numbers.type | string |
Typ av tal. |
ttsResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Samtals-ID
|
call_id | string |
Unikt alfanumeriskt 32-teckens-ID för det här anropet. |
|
Till telefonnummer
|
to | string |
Antal användare som du skickade TTS- eller TTS-prompten till. |
|
Läge
|
status | string |
Svarskod för den här TTS- eller TTS-prompten. |
|
Fel Text
|
error_text | string |
Om ett fel uppstod förklarar detta vad som hände. |
applicationResponse
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Id
|
id | string |
Nexmo-program-ID. |
|
Namn
|
name | string |
Programnamn. |
|
Keys
|
keys.public_key | string |
Den offentliga nyckel som används för att verifiera jwt i en https://en.wikipedia.org/wiki/JSON_Web_Token. |
gemensam
| Name | Sökväg | Typ | Description |
|---|---|---|---|
|
Svar
|
type | string |
Mänskligt läsbart meddelande. |
|
Fel Text
|
error_title | string |
Felrubriken returnerades om det misslyckades. |