Nexmo
Nexmo, la piattaforma API Vonage, consente di aggiungere comunicazioni all'interno del contesto delle applicazioni, tra cui SMS, Voce e Chat. Iscriversi per ottenere un account Nexmo qui - https://www.nexmo.com/
Questo connettore è disponibile nei prodotti e nelle aree seguenti:
| Servizio | Class | Regions |
|---|---|---|
| Copilot Studio | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| App per la logica | Normale | Tutte le aree di App per la logica , ad eccezione delle seguenti: - Aree di Azure per enti pubblici - Aree di Azure Cina - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Apps | Di alta qualità | Tutte le aree di Power Apps , ad eccezione dei seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Power Automate | Di alta qualità | Tutte le aree di Power Automate , ad eccezione delle seguenti: - Governo degli Stati Uniti (GCC) - Us Government (GCC High) - China Cloud gestito da 21Vianet - Dipartimento della Difesa degli Stati Uniti (DoD) |
| Metadati del connettore | |
|---|---|
| Editore | Microsoft |
Creazione di una connessione
Il connettore supporta i tipi di autenticazione seguenti:
| Predefinita | Parametri per la creazione della connessione. | Tutte le aree geografiche | Non condivisibile |
Predefinito
Applicabile: tutte le aree
Parametri per la creazione della connessione.
Questa non è una connessione condivisibile. Se l'app power viene condivisa con un altro utente, verrà richiesto a un altro utente di creare una nuova connessione in modo esplicito.
| Nome | TIPO | Description | Obbligatorio |
|---|---|---|---|
| Chiave API | corda | Chiave API | Vero |
| Segreto API | securestring | Segreto API | Vero |
Limiti per la limitazione delle richieste
| Nome | Chiamate | Periodo di rinnovo |
|---|---|---|
| Chiamate API per connessione | 100 | 60 secondi |
Azioni
| Aggiornare un'applicazione |
Questa operazione viene usata per modificare un'applicazione esistente nell'account. |
| Creare una nuova applicazione |
Questa operazione viene usata per creare una nuova applicazione nell'account. |
| Elencare i numeri di proprietà |
Questa operazione recupera tutti i numeri associati all'account. |
| Elencare i numeri in ingresso |
Questa operazione viene usata per recuperare tutti i numeri in ingresso disponibili per un determinato paese. |
| Elencare le applicazioni |
Recupera un elenco di tutte le applicazioni associate all'account. |
| Eliminare un'applicazione |
Questa operazione viene usata per eliminare un'applicazione esistente nell'account. |
| Inviare un file vocale |
Questa operazione viene utilizzata per inviare un file audio sintetizzato o registrato a un numero di telefono. |
| Inviare un SMS |
Questa operazione viene usata per inviare un SMS. |
| Ottenere l'applicazione in base all'ID |
Questa operazione viene usata per recuperare informazioni su una singola applicazione, in base al relativo ID. |
Aggiornare un'applicazione
Questa operazione viene usata per modificare un'applicazione esistente nell'account.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID applicazione
|
application_id | True | string |
Identificatore univoco dell'applicazione. |
|
Nome
|
name | True | string |
Nome dell'applicazione. |
|
TIPO
|
type | True | string |
Tipo di applicazione. |
|
URL risposta
|
answer_url | True | string |
Dove il webhook recapita l'oggetto Controllo chiamata Nexmo. |
|
URL eventi
|
event_url | True | string |
Avviato, squillamento o completamento |
|
Answer, metodo
|
answer_method | string |
Metodo HTTP (GET predefinito). |
|
|
Event, metodo
|
event_method | string |
Metodo HTTP (POST predefinito). |
Restituisce
- Corpo
- applicationResponse
Creare una nuova applicazione
Questa operazione viene usata per creare una nuova applicazione nell'account.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Nome
|
name | True | string |
Nome dell'applicazione. |
|
TIPO
|
type | True | string |
Tipo di applicazione. |
|
URL risposta
|
answer_url | True | string |
Dove il webhook recapita l'oggetto Controllo chiamata Nexmo. |
|
URL eventi
|
event_url | True | string |
Avviato, squillamento o completamento |
|
Answer, metodo
|
answer_method | string |
Metodo HTTP (GET predefinito). |
|
|
Event, metodo
|
event_method | string |
Metodo HTTP (POST predefinito). |
Restituisce
- Corpo
- applicationResponse
Elencare i numeri di proprietà
Questa operazione recupera tutti i numeri associati all'account.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Criterio di ricerca
|
Search Pattern | string |
Selezionare un modello. |
|
|
Indice pagina
|
index | number |
Indice nella risposta. |
|
|
Conteggio risultati
|
size | number |
Valore predefinito 10 Max 100. |
|
|
Modello
|
pattern | number |
Modello numerico da cercare. |
Restituisce
- Corpo
- ListNumbersResponse
Elencare i numeri in ingresso
Questa operazione viene usata per recuperare tutti i numeri in ingresso disponibili per un determinato paese.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Paese
|
country | True | string |
Codice nel formato ISO 3166-1 alfa-2. |
|
Criterio di ricerca
|
Search Pattern | string |
Selezionare un modello. |
|
|
Modello
|
pattern | number |
Modello numerico da cercare. |
|
|
Funzionalità disponibili
|
features | string |
SMS o VOICE |
|
|
Conteggio risultati
|
size | number |
Impostazione predefinita 10. |
|
|
Indice pagina
|
index | number |
Indice nella risposta. |
Restituisce
- Corpo
- ListNumbersResponse
Elencare le applicazioni
Recupera un elenco di tutte le applicazioni associate all'account.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
Conteggio risultati
|
page_size | number |
Elementi restituiti per ogni chiamata (valore predefinito 10). |
|
|
Indice pagina
|
page_index | number |
Offset dalla prima pagina (valore predefinito 0). |
Restituisce
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
applicazioni
|
_embedded.applications | array of applicationResponse |
Eliminare un'applicazione
Questa operazione viene usata per eliminare un'applicazione esistente nell'account.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID applicazione
|
application_id | True | string |
Identificatore univoco dell'applicazione. |
Restituisce
- Corpo
- common
Inviare un file vocale
Questa operazione viene utilizzata per inviare un file audio sintetizzato o registrato a un numero di telefono.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
A numero di telefono
|
to | True | string |
Formato internazionale E.164. |
|
Da Numero di telefono
|
from | string |
Numero Nexmo abilitato per la voce. |
|
|
Message
|
text | True | string |
Testo vocale. |
|
Language
|
lg | string |
Per sintetizzare il messaggio in . |
|
|
Sesso
|
voice | string |
Maschio o femmina. |
|
|
Ripeti conteggio
|
repeat | number |
Fino a 10 volte. |
|
|
Consenti rilevamento computer
|
machine_detection | string |
True o hangup. |
|
|
Timeout computer
|
machine_timeout | number |
Da 400 ms a 10000 ms. |
|
|
Callback URL (URL callback)
|
callback | url |
URL per il callback. |
|
|
Callback, metodo
|
callback_method | string |
GET o POST. |
Restituisce
- Corpo
- ttsResponse
Inviare un SMS
Questa operazione viene usata per inviare un SMS.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID mittente
|
from | True | string |
Stringa alfanumerica. |
|
A numero di telefono
|
to | True | string |
Formato internazionale E.164. |
|
Testo
|
text | True | string |
Corpo SMS. |
|
TIPO
|
type | string |
Il valore predefinito è testo. |
|
|
Ricevute di consegna
|
status-report-req | number |
Impostare su 1 per abilitare. |
|
|
Informazioni di riferimento sul client
|
client-ref | string |
Per la creazione di report interni. |
|
|
Tessera business
|
vcard | string |
Formato vCard. |
|
|
Calendar, evento
|
vcal | string |
Formato vCal. |
|
|
Durata dell'SMS
|
ttl | number |
In millisecondi. |
|
|
Callback URL (URL callback)
|
callback | url |
Endpoint della ricevuta di recapito. |
|
|
Classe Message
|
message-class | number |
Selezionare una classe. |
|
|
Intestazione dati utente
|
udh | string |
Hex encoded UDH. |
|
|
Protocollo di livello superiore
|
protocol-id | string |
ID protocollo. |
|
|
Corpo (se il tipo è binario).
|
body | string |
Dati binari con codifica esadecimale. |
|
|
Titolo
|
title | string |
Se il tipo è wappush. |
|
|
URL
|
url | url |
URL sito Web (se type è wappush.). |
|
|
Disponibilità (se il tipo è wappush.
|
validity | string |
In millisecondi. |
Restituisce
- Corpo
- smsResponse
Ottenere l'applicazione in base all'ID
Questa operazione viene usata per recuperare informazioni su una singola applicazione, in base al relativo ID.
Parametri
| Nome | Chiave | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
ID applicazione
|
application_id | True | string |
Identificatore univoco dell'applicazione. |
Restituisce
- Corpo
- applicationResponse
Definizioni
smsResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Conteggio messaggi
|
message-count | string |
Numero di parti in cui il messaggio è stato suddiviso. |
|
Matrice di messaggi
|
messages | array of object |
Contiene ogni parte del messaggio. |
|
stato
|
messages.status | string |
Viene illustrato come l'invio SMS viene elaborato. |
|
ID messaggio
|
messages.message-id | string |
ID dell'SMS inviato (da 8 a 16 caratteri). |
|
A numero di telefono
|
messages.to | string |
Numero a cui è stata inviata la richiesta. |
|
Informazioni di riferimento sul client
|
messages.client-ref | string |
Riferimento client impostato nella richiesta. |
|
Saldo
|
messages.remaining-balance | string |
Saldo nel tuo account. Il valore è in EUR. |
|
Prezzo messaggio
|
messages.message-price | string |
Importo addebitato per la richiesta. Il valore è in EUR. |
|
Rete
|
messages.network | string |
Mobile Country Code Mobile Network Code (MCCMNC) per il gestore telefonico con cui è registrato. |
|
Testo di errore
|
messages.error-text | string |
Se si è verificato un errore, questo spiega cosa è successo. |
ListNumbersResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Conteggio
|
count | integer |
Conteggio dei risultati. |
|
Matrice numeri
|
numbers | array of object |
Elenco di tutti i numeri. |
|
Costo
|
numbers.cost | string |
Costo numerico. |
|
Paese
|
numbers.country | string |
Formato ISO 3166-1 alfa-2. |
|
Numero in ingresso
|
numbers.msisdn | string |
Numero virtuale in ingresso. |
|
TIPO
|
numbers.type | string |
Tipo di numero. |
ttsResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
ID chiamata
|
call_id | string |
ID carattere alfanumerico univoco di 32 caratteri per questa chiamata. |
|
A numero di telefono
|
to | string |
Numero dell'utente a cui è stato inviato il messaggio TTS o TTS. |
|
stato
|
status | string |
Codice di risposta per questo prompt TTS o TTS. |
|
Testo di errore
|
error_text | string |
Se si è verificato un errore, questo spiega cosa è successo. |
applicationResponse
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
id
|
id | string |
ID applicazione Nexmo. |
|
Nome
|
name | string |
Nome applicazione. |
|
Keys
|
keys.public_key | string |
Chiave pubblica usata per convalidare il token jwt in un oggetto https://en.wikipedia.org/wiki/JSON_Web_Token. |
comune
| Nome | Percorso | Tipo | Descrizione |
|---|---|---|---|
|
Risposta
|
type | string |
Messaggio leggibile. |
|
Testo di errore
|
error_title | string |
Titolo dell'errore restituito se non è riuscito. |