ajax-loader
rocket

API

Contact

Destination

Expéditeur

Modèle SMS

SMS

Réponse SMS

Utilisateur

Récupérer une liste de contacts

Ce service permet de récupérer les informations d'une liste de contacts Avosms.

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


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 »
listContactId ID de la liste de contacts à récupérer

Exemple


<?php
$curl = curl_init("https://api.avosms.com/v1/contact/list/information"); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_COOKIESESSION, true);
$postfields = array( 'id' => "{ID}", //REQUIRED 'key' => "{KEY}", //REQUIRED 'listContactId' => "{LIST CONTACT ID}", //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") { $listContactName = $response->list_contact_name; $listContactCountryName = $response->list_contact_country_name; $listContactCountryCode = $response->list_contact_country_code; $nbContactList = $response->nb_contact_list; $listContactCreationDate = $response->list_contact_creation_date;
$contactList = $response->list_contact;
foreach($contactList as $contact_list) { $contactCivility = $contact_list->contact_civility; $contactName = $contact_list->contact_name; $contactFirstName = $contact_list->contact_first_name; $contactTelephoneNumber = $contact_list->contact_telephone_number; $contactEmail = $contact_list->contact_email; $contactBirthday = $contact_list->contact_birthday; $contactOther = $contact_list->contact_other; } }
?>


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_name Nom de la liste de contacts.
list_contact_country_name Nom du pays de la liste de contacts.
list_contact_country_code Code ISO2 du pays de la liste de contacts.
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).
list_contact Tableau contenant les contacts présent dans la liste.

Variables du tableau contenant les contacts présent dans la liste (list_contact)
contact_civility Civilité du contact.
contact_name Nom du contact.
contact_first_name Prénom du contact.
contact_telephone_number Numéro de téléphone du contact.
contact_email Email du contact.
contact_birthday Anniverssaire du contact.
contact_other Autre information sur le contact.


En cas d'erreur provenant du formatage / de votre saisie :
ERR_100 Identifiants API non reconnus.
ERR_101 Aucune liste de contacts existante pour l'ID renseigné.


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 ?