section-9134a21

API-VOICE

section-1
1 Portée

VOICE est un proxy/API pour envoyer des appels vocaux , en utilisant une interface API.
VOICE propose deux interfaces :
- via Web: l'utilisateur se connecte via un navigateur
- via API: l'application du client échange des informations automatiquement avec la plateforme de LAfricaMobile
Ce document décrit la seconde manière et explique comment utiliser cette API.

section-2
2 Paramètres du compte
2.1 Pré-­­requis

Pour utiliser cette API, vous avez besoin d'un compte valide. Lors de la création de votre compte, LAfricaMobile doit vous donner:
- un login (nommé aussi accountid)
- un mot de passe
Cette paire identifiant / mot de passe est utilisée comme paramètre d’identification dans l'API.

2.2 Variables utilisées dans la documentation

Dans ce document, nous utilisons des valeurs ci-dessous. Les vraies valeurs vous seront données par notre équipe technique ou par votre propre configuration (pour les paramètres dépendant de votre côté, ret_url par exemple). Certaines d’entre elles peuvent ne pas être utilisées en fonction de vos besoins.
Valeursd’essai du document:
- login=fred
- password=xpasswordx
- VOICE Server url :  https://voice.lafricamobile.com/api
Vous devez remplacer ces valeurs par vos propres paramètres pendant vos tests.

section-3
3 Upload Message vocal
3.1 Comment envoyer via php

Pour lancer une campagne vous devez commencer d’abord à uploder le message vocal à envoyer.
Les paramètres sont :

Nom Mandatory Valeur test Comment
login Y fred Value given by LAM
password Y xpasswordx Value given by LAM
filename Y messagevocal.wav Message vocal à envoyer

Voici un exemple avec le script PHP

REPONSE OK

Content-Type: application/json

{
"clientFileName": "49ef5933b03f0fc1806b0084c63d30dd.wav",
"serverFileName": "jwli3kha.hqe",
"url":"http://africamobile.tel4b.com/CallManager/v1/FileDownload/temp/jwli3kha.hqe/49ef5933b03
f0fc1806b0084c63d30dd.wav",
"extension": ".wav",
"mimeType": "audio/wav"
}

ERREUR
{
"error": {}
}

section-4
4 Envoyer Message vocal
4.1 Comment envoyer via php

Les paramètres sont :

Nom Mandatory Valeur test Comment
login Y fred Value given by LAM
password Y xpasswordx Value given by LAM
filename Y 49ef5933b03f0fc1806b0084c63d30dd.wav nom message vocal après upload
serverfilename Y jwli3kha.hqe nom message vocal serveur après upload
campagnename N CAMPP nom campagne
contacts Y [ 221773758085, 221774400788, 221774450792 ] Contacts à envoyer le message

Voici un exemple avec le script PHP

REPONSE OK

Content-Type: application/json

{"id":101,"calls":[{"id":234,"contactId":73,"contactName":"Contact_[10/04/2016:48:15]","contactFirstname":"Contact_[10/04/2016:48:15]","start":null,"called":"00221773758085","callStateId":1,"callResultId":1},{"id":236,"contactId":74,"contactName":"Contact_[10/04/2016:48:15]","contactFirstname":"Contact_[10/04/2016:48:15]","start":null,"called":"00221774400788","callStateId":1,"callResultId":1},{"id":235,"contactId":75,"contactName":"Contact_[10/04/2016:48:16]","contactFirstname":"Contact_[10/04/2016:48:16]","start":null,"called":"00221774450792","callStateId":1,"callResultId":1}],"login":null,"count":0,

"processingCallCount":0,"callSuccessount":0,"callFailedCount":0,"callIgnoredCount":0,

"campaignName":"CAMPP_[10/04/2016:48:18]","start":"2020-04-10T18:48:19","historyStateId":2,"messageFileName":"35"}

ERREUR
{
"error": {}
}

section-5
5 Historique des appels

Retourne la liste des historiques

<?php
$curl = curl_init();
curl_setopt_array($curl,
array(CURLOPT_URL=>"https://voice.lafricamobile.com/api/Histories?login=fr
ed&password=xpasswordx",
CURLOPT_CUSTOMREQUEST => "GET",
));
$response = curl_exec($curl);
?>
curl_close($curl);
echo $response;

REPONSE OK

Content-Type:application/json

[
{
"id": 0 ,
"calls": [
{
"id": 0 ,
"contactId": 0 ,
"contactName": "string",
"contactFirstname": "string",
"start": "2020-04-30T09:55:43.285Z",
"called": "string",
"callStateId": "Waiting",
"callResultId": "Waiting"
}
],
"login": "string",
"count": 0 ,
"processingCallCount": 0 ,
"callSuccessCount": 0 ,
"callFailedCount": 0 ,
"callIgnoredCount": 0 ,
"campaignName": "string",
"start": "2020-04-30T09:55:43.285Z",
"historyStateId": "Scheduled",
"messageFileName": "string"
}
]

section-6
6 Les étapes à suivre

Télécharger le logiciel AUDACITY si possible sur l'adresse
https://www.audacityteam.org/download/
1- Enregistrer un fichier audio(maxi 1 min) sur Audacity et l'exporter en format WAV
2- Remplir le fichier de contacts en laissant la colonne ContactFunctionId à 1 pour tous les contacts
3- Incrémenter à chaque fois la colonne ExternalId pour chaque nouveau numéro
4- Se connecter à l'interface
5- Sur liste de diffusion, importer une liste de diffusion (fichier Excel)
6- Sur message, ajouter un nouveau message (importer le fichier audio enregistré)
7- Sur l'onglet campagne : nouvelle campagne, nom, type de campagne (test), sélectionner le message audio, choisir la liste de diffusion

LAfricaMobile est la 1ère plateforme de communication multi-opérateurs et multicanale en Afrique. Nous proposons aux entreprises et organisations présentes sur le continent africain des solutions Business et Management leur permettant de créer et maintenir le lien avec leurs clients ou utilisateurs.
  • LAfricaMobile
    Siège social: Immeuble CFI ,
    11 Rue VINCENS X, Avenue Faidherbe, Dakar

  • (+221) 33 842 58 55

  • contact@lafricamobile.com