Déposer un message vocal
- Home
- Déposer un message vocal
Déposer un message vocal
Le dépôt d’un message vocal (VMS) est disponible sur l’API. Le dépôt fonctionne sur les fixes mais aussi sur les mobiles, il est important de noter que le fonctionnement est différent.
Pour rappel : sur un numéro mobile le message est directement déposé sur le répondeur alors que sur un numéro fixe, le téléphone sonne et le message est déposé uniquement si le destinataire ne répond pas.
Pour déposer un message vocal sur les répondeurs mobile Rate Limit: 2000 requêtes par heure
Limite: 5 requêtes par minute
URL
POST https://api.voicepartner.fr/v1/campaign/send
Paramètres
Chaque demande d’API prend en charge les paramètres suivants :
apiKey | Clé API de votre compte. Vous l’obtenez dans votre compte Voice Partner. |
---|---|
tokenAudio | Identifiant du fichier audio |
emailForNotification | La notification de fin de campagne sera envoyé vers cette adresse email |
phoneNumbers | Numéros de téléphone mobile des destinataires. Pour l’envoi de plusieurs SMS les numéros doivent être séparés par des virgules. Ils peuvent être :
|
Paramètres optionnels | |
sender | Numéro de téléphone portable qui peut être rappelé. Ce numéro doit être validé au préalable sur la plateforme my.voicepartner.fr. |
scheduledDate | Date d’envoi du message, au format YYYY-mm-dd H:m:00 (ex: 2021-02-02 14:15:00) . A définir uniquement si vous souhaitez que les dépôts soient envoyés en différé. |
notifyUrl | Url de retour du statut de la campagne envoyé en GET |
Requête
1 |
http://api.voicepartner.fr/v1/campaign/send |
Réponses
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
{ "success": true, "campaignId": "campaignId", "cost": 0.15, "currency": "EUR", "nbSms": 1, "audioFile": { "filename": "filename.wav", "size": "135.8Ko" }, "detail": { "33": { "nbSms": 1, "cost_unity": 0.15, "cost": 0.15 } } } |
Exemples
1 2 3 4 5 6 7 8 9 10 |
curl -X POST \ http://api.voicepartner.fr/v1/campaign/send \ -H 'Content-Type: application/json' \ -H 'Postman-Token: 40756d00-a7f3-4162-8513-bd6a13328cc3' \ -H 'cache-control: no-cache' \ -d '{ "apiKey":"YOUR-API-KEY", "phoneNumbers":"06XXXXXXXX", "tokenAudio":"TOKEN-AUDIO" }' |
© 2014 - 2023 NDA MEDIA. Tous droits réservés. Mentions légales