ajax-loader
rocket

API

Contact

Destination

Expéditeur

Modèle SMS

SMS

Réponse SMS

Utilisateur

Récupérer mes listes de contacts

Ce service permet de récupérer vos listes de contacts Avosms.

POST   https://api.avosms.com/v1/contact/list


Paramètres

Tous les paramètres ci-dessous sont à envoyer en POST.

Liste des paramètres obligatoire
id Votre identifiant de compte AvoSMS (adresse e-mail)
key Clé API disponible depuis votre compte client « Accès API »

Exemple


<?php
$curl = curl_init("https://api.avosms.com/v1/contact/list"); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_COOKIESESSION, true);
$postfields = array( 'id' => "{ID}", //REQUIRED 'key' => "{KEY}", //REQUIRED );
$postfields_json = json_encode($postfields); $trame = http_build_query($postfields, '', '&'); curl_setopt($curl, CURLOPT_POST, true); curl_setopt($curl, CURLOPT_POSTFIELDS, $trame); $raw_response = curl_exec($curl); curl_close($curl);
$response = json_decode($raw_response);
$status_response = $response->status; $code = $response->code;
if($code == "OK") { $listContact = $response->list_contact;
foreach($listContact as $contactList) { $listContactId = $contactList->list_contact_id; $listContactName = $contactList->list_contact_name; $listContactCountryName = $contactList->list_contact_country_name; $listContactCountryCode = $contactList->list_contact_country_code; $nbContactList = $contactList->nb_contact_list; $listContactCreationDate = $contactList->list_contact_creation_date; } }
?>


Codes / Réponses

Lors d'une requête vers nos services, une réponse vous est retournée au format JSON. Vous trouverez dans le champ « code » le code de retour suite à votre demande. En cas de succès, le code retour contient « OK »


En cas de succès :
code (OK) Votre demande a correctement été traitée.
list_contact Tableau contenant les listes de contacts disponible.

Variables du tableau des listes de contacts disponible (list_contact)
list_contact_id ID de liste de contact
list_contact_name ID de liste de contact
list_contact_country_name Nom du pays de la liste de contact
list_contact_country_code Code ISO2 du pays de la liste de contact
nb_contact_list Nombre de contacts présent dans la liste de contacts
list_contact_creation_date Date de création de la liste de contact (format : AAAA-MM-DD HH:MM:SS)


En cas d'erreur provenant du formatage / de votre saisie :
ERR_100 Identifiants API non reconnus.
ERR_101 Aucune liste de contacts trouvée.


En cas d'erreur de traitement par nos services :
ERR_9XX Erreur de traitement, contactez nos services.
Une erreur de traitement interne vous est informée par un code d'erreur « ERR_9XX » soit XX = chiffres non fixes, en fonction du type d'erreur.


Une question ? Besoin d'aide ?