Nexmo
Nexmo, la plateforme d’API Vonage, vous permet d’ajouter des communications dans le contexte de vos applications, notamment sms, voix et conversation. Inscrivez-vous à un compte Nexmo ici - https://www.nexmo.com/
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Applications logiques | Norme | Toutes les régions Logic Apps , à l’exception des suivantes : - Régions Azure Government - Régions Azure Chine - Us Department of Defense (DoD) |
| Power Apps | Premium | Toutes les régions Power Apps , à l’exception des suivantes : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Toutes les régions Power Automate , à l’exception des éléments suivants : - Us Government (GCC) - Us Government (GCC High) - China Cloud géré par 21Vianet - Us Department of Defense (DoD) |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Microsoft |
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Par défaut | Paramètres de création de connexion. | Toutes les régions | Non partageable |
Faire défaut
Applicable : Toutes les régions
Paramètres de création de connexion.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Clé d’API | ficelle | Clé API | Vrai |
| Secret d’API | securestring | Secret de l’API | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 100 | 60 secondes |
Actions
| Créer une application |
Cette opération est utilisée pour créer une application dans votre compte. |
| Envoyer un fichier speech |
Cette opération permet d’envoyer un fichier audio synthétisé ou enregistré à un numéro de téléphone. |
| Envoyer un SMS |
Cette opération est utilisée pour envoyer un SMS. |
| Mettre à jour une application |
Cette opération est utilisée pour modifier une application existante dans votre compte. |
| Obtenir l’application par ID |
Cette opération est utilisée pour récupérer des informations sur une seule application, en fonction de son ID. |
| Répertorier les applications |
Récupère une liste de toutes les applications associées à votre compte. |
| Répertorier les numéros appartenant à la liste |
Cette opération récupère tous les nombres associés à votre compte. |
| Répertorier les numéros entrants |
Cette opération est utilisée pour récupérer tous les nombres entrants qui sont aviables pour un pays donné. |
| Supprimer une application |
Cette opération est utilisée pour supprimer une application existante dans votre compte. |
Créer une application
Cette opération est utilisée pour créer une application dans votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom
|
name | True | string |
Nom de l’application. |
|
Type
|
type | True | string |
Type d’application. |
|
URL de réponse
|
answer_url | True | string |
Où votre webhook fournit l’objet de contrôle d’appel Nexmo. |
|
URL des événements
|
event_url | True | string |
Démarré, sonnant ou terminé |
|
Answer, méthode
|
answer_method | string |
Méthode HTTP (GET par défaut). |
|
|
Event, méthode
|
event_method | string |
Méthode HTTP (DEFAULT POST). |
Retours
- Corps
- applicationResponse
Envoyer un fichier speech
Cette opération permet d’envoyer un fichier audio synthétisé ou enregistré à un numéro de téléphone.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Pour numéro de téléphone
|
to | True | string |
International format E.164. |
|
À partir du numéro de téléphone
|
from | string |
Numéro Nexmo compatible avec la voix. |
|
|
Message
|
text | True | string |
Texte vocal. |
|
Language
|
lg | string |
Pour synthétiser le message dans. |
|
|
Gender
|
voice | string |
Mâle ou femelle. |
|
|
Nombre de répétitions
|
repeat | number |
Jusqu’à 10 fois. |
|
|
Autoriser la détection des ordinateurs
|
machine_detection | string |
True ou raccrocher. |
|
|
Délai d’expiration de l’ordinateur
|
machine_timeout | number |
400 ms à 1 000 ms. |
|
|
Callback URL (URL de rappel)
|
callback | url |
URL du rappel. |
|
|
Callback, méthode
|
callback_method | string |
GET ou POST. |
Retours
- Corps
- ttsResponse
Envoyer un SMS
Cette opération est utilisée pour envoyer un SMS.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de l’expéditeur
|
from | True | string |
Chaîne alphanumérique. |
|
Pour numéro de téléphone
|
to | True | string |
International format E.164. |
|
Texto
|
text | True | string |
Corps SMS. |
|
Type
|
type | string |
Valeur par défaut du texte. |
|
|
Reçus de livraison
|
status-report-req | number |
Définissez la valeur 1 pour l’activer. |
|
|
Informations de référence sur le client
|
client-ref | string |
Pour les rapports internes. |
|
|
Carte de visite
|
vcard | string |
Format vCard. |
|
|
Événement de calendrier
|
vcal | string |
Format vCal. |
|
|
Durée de vie du SMS
|
ttl | number |
En millisecondes. |
|
|
Callback URL (URL de rappel)
|
callback | url |
Point de terminaison de reçu de remise. |
|
|
Classe message
|
message-class | number |
Choisissez une classe. |
|
|
En-tête de données utilisateur
|
udh | string |
Hex encodé UDH. |
|
|
Protocole de niveau supérieur
|
protocol-id | string |
ID de protocole. |
|
|
Corps (si le type est binaire.)
|
body | string |
Données binaires codées en hexadécimal. |
|
|
Titre
|
title | string |
Si le type est wappush. |
|
|
URL
|
url | url |
URL du site web (si le type est wappush.). |
|
|
Disponibilité (si le type est wappush.)
|
validity | string |
En millisecondes. |
Retours
- Corps
- smsResponse
Mettre à jour une application
Cette opération est utilisée pour modifier une application existante dans votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’application
|
application_id | True | string |
Identificateur unique de l’application. |
|
Nom
|
name | True | string |
Nom de l’application. |
|
Type
|
type | True | string |
Type d’application. |
|
URL de réponse
|
answer_url | True | string |
Où votre webhook fournit l’objet de contrôle d’appel Nexmo. |
|
URL des événements
|
event_url | True | string |
Démarré, sonnant ou terminé |
|
Answer, méthode
|
answer_method | string |
Méthode HTTP (GET par défaut). |
|
|
Event, méthode
|
event_method | string |
Méthode HTTP (DEFAULT POST). |
Retours
- Corps
- applicationResponse
Obtenir l’application par ID
Cette opération est utilisée pour récupérer des informations sur une seule application, en fonction de son ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’application
|
application_id | True | string |
Identificateur unique de l’application. |
Retours
- Corps
- applicationResponse
Répertorier les applications
Récupère une liste de toutes les applications associées à votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre de résultats
|
page_size | number |
Éléments retournés sur chaque appel (par défaut 10). |
|
|
Page Index
|
page_index | number |
Décalage de la première page (par défaut 0). |
Retours
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Applications
|
_embedded.applications | array of applicationResponse |
Répertorier les numéros appartenant à la liste
Cette opération récupère tous les nombres associés à votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Modèle de recherche
|
Search Pattern | string |
Choisissez un modèle. |
|
|
Page Index
|
index | number |
Index dans la réponse. |
|
|
Nombre de résultats
|
size | number |
Valeur par défaut 10 Max 100. |
|
|
Motif
|
pattern | number |
Modèle de nombre à rechercher. |
Retours
- Corps
- ListNumbersResponse
Répertorier les numéros entrants
Cette opération est utilisée pour récupérer tous les nombres entrants qui sont aviables pour un pays donné.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Pays
|
country | True | string |
Code au format ISO 3166-1 alpha-2. |
|
Modèle de recherche
|
Search Pattern | string |
Choisissez un modèle. |
|
|
Motif
|
pattern | number |
Modèle de nombre à rechercher. |
|
|
Fonctionnalités disponibles
|
features | string |
SMS ou VOIX |
|
|
Nombre de résultats
|
size | number |
Valeur par défaut : 10. |
|
|
Page Index
|
index | number |
Index dans la réponse. |
Retours
- Corps
- ListNumbersResponse
Supprimer une application
Cette opération est utilisée pour supprimer une application existante dans votre compte.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID d’application
|
application_id | True | string |
Identificateur unique de l’application. |
Retours
- Corps
- common
Définitions
smsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre de messages
|
message-count | string |
Nombre de parties du message divisées en. |
|
Tableau de messages
|
messages | array of object |
Contient chaque partie de message. |
|
Statut
|
messages.status | string |
Montre comment l’envoi SMS est traité. |
|
Message Id
|
messages.message-id | string |
ID du SMS envoyé (8 à 16 caractères). |
|
Pour numéro de téléphone
|
messages.to | string |
Numéro de votre demande à laquelle vous avez été envoyée. |
|
Informations de référence sur le client
|
messages.client-ref | string |
Client-ref que vous définissez dans la requête. |
|
Solde
|
messages.remaining-balance | string |
Solde dans votre compte. La valeur est en EUR. |
|
Prix du message
|
messages.message-price | string |
Montant facturé pour votre demande. La valeur est en EUR. |
|
Réseau
|
messages.network | string |
Mobile Country Code Mobile Network Code (MCCMNC) pour l’opérateur auprès de lequel il est inscrit. |
|
Texte d’erreur
|
messages.error-text | string |
Si une erreur s’est produite, cela explique ce qui s’est passé. |
ListNumbersResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Nombre
|
count | integer |
Nombre de résultats. |
|
Tableau de nombres
|
numbers | array of object |
Liste de tous les nombres. |
|
Coûts
|
numbers.cost | string |
Coût du nombre. |
|
Pays
|
numbers.country | string |
Format ISO 3166-1 alpha-2. |
|
Numéro entrant
|
numbers.msisdn | string |
Numéro virtuel entrant. |
|
Type
|
numbers.type | string |
Type de nombre. |
ttsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
ID d’appel
|
call_id | string |
ID de caractère alphanumérique unique 32 pour cet appel. |
|
Pour numéro de téléphone
|
to | string |
Numéro de l’utilisateur auquel vous avez envoyé l’invite TTS ou TTS. |
|
Statut
|
status | string |
Code de réponse pour cette invite TTS ou TTS. |
|
Texte d’erreur
|
error_text | string |
Si une erreur s’est produite, cela explique ce qui s’est passé. |
applicationResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Id
|
id | string |
ID d’application Nexmo. |
|
Nom
|
name | string |
Nom de l’application. |
|
Keys
|
keys.public_key | string |
Clé publique utilisée pour valider le jwt dans un https://en.wikipedia.org/wiki/JSON_Web_Token. |
commun
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Réponse
|
type | string |
Message lisible par l’homme. |
|
Texte d’erreur
|
error_title | string |
Titre de l’erreur retournée en cas d’échec. |