Envoi de VMS par API

Envoyer un message vocal en dépôt direct sur répondeur mobile de manière automatisée par API.

Connectez-vous à nos serveurs d'envoi de SMS, VOCAL et HLR en utilisant notre API HTTP

Pour pouvoir utiliser l'API veuillez ouvrir un compte, vous connecter puis l'activer en vous rendant sur "VOCAL" > "Mon Api".

API HTTP POST : Envoi de données XML

Important : L'encodage supporté est : ISO-8859-15 (Europe de l'Ouest)

1. Envoi de VMS

URL de notre serveur VOCAL : https://vocal.capitolemobile.com/api/sendvms/xml

La chaîne de caractère constituant le VMS doit commencer par : XML= puis contenir la structure de données suivante :


<VMS>



<authentification>

<username></username>

<password></password>

</authentification>



<message>

<sender></sender>

<type></type>

<voice_msg></voice_msg>

<tts></tts>

<id></id>

</message>



<recipients>

<gsm></gsm>

<gsm></gsm>

<gsm></gsm>

</recipients>



</VMS>

Authentification

username : Votre identifiant de connexion (login)
password : Votre mot de passe API (disponible via "VMS" > "Mon API" > "Paramètres API")

Message

sender : Numéro appelant (numéro de fixe français métropolitain ex : 0123456789). IMPORTANT : le n° appelant doit être un n° valide.
type : (Optionnel) "AD" (Diffusion au décroché, vers n° fixes et mobiles) ou "DD" (Dépôt direct sur répondeur mobile, vers n° mobiles uniquement) par défaut
voice_msg : (Optionnel) Nom du message vocal enregistré sur la plateforme VMS (en ligne). IMPORTANT : la durée du message vocal doit être comprise entre 15 et 59 secondes.
tts : (Optionnel) Text-to-Speach, message textuel à transformer en message vocal. IMPORTANT : la durée du message vocal doit être comprise entre 15 et 59 secondes.
id : (Optionnel) ID de campagne personnalisé (10 caractères max.) récupérable dans vos rapports de délivrabilité (accusés de réception / n° invalide), voir ci-dessous. IMPORTANT : le caractère "-" ne doit impérativement pas être présent dans l'ID de campagne.

Recipients

gsm : Numéro de téléphone fixe (AD et DD) et mobile (DD seulement) français métropolitain

Exemple d'intégration PHP

Important : L'encodage supporté est : ISO-8859-15 (Europe de l'Ouest)


<?php

// CapitoleMobile POST URL

$postUrl = "https://vocal.capitolemobile.com/api/sendvms/xml";

//Structure de Données XML

$xmlString = '<VMS>


<authentification>

<username>xxxxxxxxxxx</username>

<password>xxxxxxxxxxx</password>

</authentification>


<message>

<type>DD</type>

<voice_msg>Mon message vocal</voice_msg>

<sender>0123456789</sender>

<sender>123456</id>

</message>


<recipients>

<gsm>0611223344</gsm>

<gsm>33622334455</gsm>

</recipients>


</VMS>';

// insertion du nom de la variable POST "XML" avant les données au format XML

$fields = "XML=" . urlencode(utf8_encode($xmlString));

// dans cet exemple, la requête POST est realisée grâce à la librairie Curl

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $postUrl);

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS, $fields);

// Réponse de la requête POST

$response = curl_exec($ch);

curl_close($ch);

// Ecriture de la réponse

echo $response;

?>

Réponse à la requête HTTP POST

Lorsqu'un envoi est réalisé avec succès, en réponse à votre appel HTTP vous recevez un code : SENDING_OK

Dans le cas contraire vous recevez l'un des codes "erreur" suivant :

AUTH_FAILED : Erreur d'authentification (identifiant / mot de passe) ou l'option "API" désactivée
NO_RECIPIENT : Manque destinataire
NOT_ENOUGH_CREDITS : Solde insuffisant pour procéder à l'envoi
INVALID_SENDER : N° appelant manquant est vide ou invalide
INVALID_VOICE_MSG : Le message vocal est vide ou n'existe pas
VOICE_MSG_NOT_RECORDED : Le message vocal n'a pas été enregistré correctement (ex : si le message vocal déposé est trop court ou trop long pour être diffusé)
NO_RECIPIENT : Le numéro du destinataire est vide
INVALID_RECIPIENT : Le numéro du destinataire est invalide
_IS_BLACKLISTED : Le numéro du destinataire est dans la liste "noire" du compte ("STOP")

En plus du code réponse, vous recevez l'état du solde de votre compte (ex : SENDING_OK;9542)