ajax-loader
rocket

API

Contact

Destination

Sender

SMS Model

SMS

SMS responses

User

Retrieve my contact lists

This service allows you to retrieve your Avosms contact lists.

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


Parameters

All the parameters below are to be sent in POST.

List of mandatory parameters
id Your AvoSMS account ID (email address)
key API key available from your "API Access" customer account

Example


<?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 / Answers

When you make a request to our services, a response is returned to you in JSON format. You will find in the "code" field the return code following your request. In case of success, the return code contains " OK ".


If successful:
code (OK) Your request has been processed correctly.
list_contact Table containing lists of available contacts.

Variables of the table of available contact lists (list_contact)
list_contact_id Contact list ID
list_contact_name Contact list ID
list_contact_country_name Name of the country in the contact list
list_contact_country_code ISO2 country code of the contact list
nb_contact_list Number of contacts in the contact list
list_contact_creation_date Date of creation of the contact list (format: YYYY-MM-DD HH:MM:SS)


In case of an error in the formatting / your input :
ERR_100 Unrecognized APIs.
ERR_101 No contact list found.


In the event of an error in processing by our services :
ERR_9XX Processing error, contact our services.
An internal processing error is reported to you by an error code "ERR_9XX", i.e. XX = non-fixed digits, depending on the type of error.


Have a question? Do you need help?