Get a List of SMSes

This request will return a subset of all your SMSes. Use the page and count parameters to get the whole list.

The Method
Parameters
Responses
Code Samples
Tutorial

The Method

API		Method
REST	GET	http://[Your URL]/api/2.0/sms
XML-RPC	Call	sms.ListSms

Your URL is the address of your Everlytic install.

Your method must be structured as follows:

ListSms(int $page, int $count, string $order, string $direction, \struct | array $filters) : array

Parameters

You can customise the list that this request returns using the following, optional, parameters:

Property	Type	Description	Required
$page	integer	The page number of the list.	no
$count	integer	The number of results to return per page.	no
$order	integer	The name of the field to order the listing by.	no
$direction	integer	The direction of the ordering: 'asc' or 'desc'.	no
$filters	integer	The fields to filter on.	no

Responses

Type	Description
array	An array of SMSes.

Code Samples

PHP (using REST API)

$url = '(Your URL)/api/2.0/sms';
$method = 'GET';
$cSession = curl_init();
$headers = array();
$auth = base64_encode($username . ':' . $apikey);
$headers[] = 'Authorization: Basic ' . $auth;
curl_setopt($cSession, CURLOPT_URL, $url);
curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);
curl_setopt($cSession, CURLOPT_HEADER, false);
curl_setopt($cSession, CURLOPT_CUSTOMREQUEST, strtoupper($method));
curl_setopt($cSession, CURLOPT_HTTPHEADER, $headers);
$result = curl_exec($cSession);
curl_close($cSession);

$url = '(Your URL)/api/2.0/sms';

$method = 'GET';

$cSession = curl_init();

$headers = array();

$auth = base64_encode($username . ':' . $apikey);

$headers[] = 'Authorization: Basic ' . $auth;

curl_setopt($cSession, CURLOPT_URL, $url);

curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);

curl_setopt($cSession, CURLOPT_HEADER, false);

curl_setopt($cSession, CURLOPT_CUSTOMREQUEST, strtoupper($method));

curl_setopt($cSession, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($cSession);

curl_close($cSession);

Tutorial

The rest of this document describes the example above, step-by-step.

In our Getting Started section we covered the four important components of an API request; URL, method, headers, and body.

Let's analyse the code sample above to determine where each line fits into this outline.

1. Load the Everlytic API

The following line of code tells the server which API URL to access for the request:

$url = '(Your URL)/api/2.0/sms';

2. Method

In this line of code, you tell the API which REST function to use:

$method = ‘GET’;

3. cURL

cURL is a tool for sending and receiving files from a web server. This line of code initialises the cURL session.

$cSession = curl_init();

4. Initiate the headers

This section of the code opens the headers section and passes the authentication (including your API key).

$headers = array();

$auth = base64_encode($username . ':' . $apikey);

$headers[] = 'Authorization: Basic ' . $auth;

5. Set various cURL options for the session

The first line uses the $url to get your specified url
The second line returns the string (text) of the return value.
The third line tells the server not to include the header in the ouput.
The fourth line calls the $method specified above, which is to ‘GET’ (read) the data from the server.

curl_setopt($cSession, CURLOPT_URL, $url);

curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);

curl_setopt($cSession, CURLOPT_HEADER, false);

curl_setopt($cSession, CURLOPT_CUSTOMREQUEST, strtoupper($method));

6. Headers

Call the headers using the $headers method.

curl_setopt($cSession, CURLOPT_HTTPHEADER, $headers);

7. Output the API response to test authentication

$result = curl_exec($cSession);

8. Close the cURL session

curl_close($cSession);