Envoyer un SMS vocal

Envoyer un SMS vocal sur mobile Rate Limit: 2000 requêtes par heure

URL

POST https://api.voicepartner.fr/v1/tts/send

Paramètres

apiKey	Clé API de votre compte. Vous l’obtenez dans votre compte Voice Partner.
text	Texte du message vocal. Une pause entre les mots est possible.
tokenAudio	Identifiant du fichier audio, le paramètre “text” ne sera pas pris en compte.
lang	Langue dans laquelle le message est envoyé
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 : au format national (06xxxxxxxx) ou international (+336xxxxxxxx), pour des numéros français.
Paramètres optionnels
speechRate	La vitesse de reproduction de la parole dans le message. Efficace uniquement lorsque vous utilisez du texte. La plage prise en charge va de 0.5 (parole ralentie) à 2 (accélération de la parole). Les valeurs inférieures à 0.5 seront remplacées par 0.5 et les valeurs supérieures à 2 seront remplacées par 2. La vitesse par défaut est 1.
notifyUrl	Url de retour du statut du SMS vocal envoyé en POST au format JSON
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 SMS soient envoyés en différé.

Pause entre les mots

Il est possible d’ajouter des pauses entre les mots et d’allonger la durée du message vocal en utilisant la virgule «,».
Par exemple, si vous souhaitez avoir une pause de 3 secondes après chaque mot, le paramètre text devrait alors ressembler à ceci: «un ,,,,,, deux ,,,,,, trois ,,,,,,». Chaque virgule crée une pause de 0,5 seconde.

Requête

http://api.voicepartner.fr/v1/tts/send

1	http://api.voicepartner.fr/v1/tts/send

Réponses

JSON

{
    "success": true,
    "campaignId": "Ff1tbu0lax",
    "cost": xxx,
    "currency": "EUR",
    "nbSms": 1,
    "lang": "en",
    "duration": 6.3,
    "detail": {
        "33": {
            "nbSms": 1,
            "cost_unity": xxx,
            "cost": xxx,
            "country_code": "fr",
            "duration": 6.3
        }
    }
}

{

"success": true,

"campaignId": "Ff1tbu0lax",

"cost": xxx,

"currency": "EUR",

"nbSms": 1,

"lang": "en",

"duration": 6.3,

"detail": {

"33": {

"nbSms": 1,

"cost_unity": xxx,

"cost": xxx,

"country_code": "fr",

"duration": 6.3

}

Exemples

CURL

curl -X POST \
  http://api.voicepartner.fr/v1/tts/send \
  -H 'Content-Type: application/json' \
  -H 'cache-control: no-cache' \
  -d '{
"apiKey":"YOUR-API-KEY",
"phoneNumbers":"06XXXXXXXX",
"speed":"1",
"text":"Mon premier test",
"notifyUrl":"http://..."
}'

curl -X POST \

http://api.voicepartner.fr/v1/tts/send \

-H 'Content-Type: application/json' \

-H 'cache-control: no-cache' \

-d '{

"apiKey":"YOUR-API-KEY",

"phoneNumbers":"06XXXXXXXX",

"speed":"1",

"text":"Mon premier test",

"notifyUrl":"http://..."