ajax-loader
rocket

API

Contact

Destination

Sender

SMS Model

SMS

SMS responses

User

Create a list of contacts

This service allows you to create a list of Avosms contacts.

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


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
listContactName Name of the list of contacts to retrieve
listContactCountryCode ISO2 country code of the contact list

Example


<?php
$curl = curl_init("https://api.avosms.com/v1/contact/list/create"); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_COOKIESESSION, true);
$postfields = array( 'id' => "{ID}", //REQUIRED 'key' => "{KEY}", //REQUIRED 'listContactName' => "{LIST CONTACT NAME}", //REQUIRED 'listContactCountryCode' => "{LIST CONTACT COUNTRY CODE}", //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") { $listContactId = $response->list_contact_id; }
?>


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_id ID of the contact list.


In case of an error in the formatting / your input :
ERR_100 Unrecognized APIs.
ERR_101 The name of the contact list is empty.
ERR_102 The ISO2 country code of the contact list is empty.
ERR_103 No existing country for the given ISO2 code.
ERR_104 The name of the contact list is not available.


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?