Get a list of all clients.



Parameter

Description

Required

pagePage number, for paginationNO
maxMaximum results returned per pageNO


Example


curl http://api.transmitsms.com/get-clients.json \
  -u 2e24c1cbdd987221e165d543f34b84bf:secret


JSON Response

{
  clients_total: 24,
  clients: [
    {
      id: 56423,
      name: "Terry's Repairs",
      contact: "Terry Richards",
      email: "terry@example.com",
      msisdn: "61491570156",
      currency: "AUD",
      timezone: "Australia/Sydney",
      created: "2013-02-14 13:45:22",
      client_pays: false,
      sms_margin: 3.1,
      apikey: "2e24xxxxxxxxxxxxxxxx4b84bf",
      apisecret: "YyYD2lad*88",
      recharge_amount: 20,
      total_lists: 34,
      total_sms: 575665,
      total_contacts: 542,
      total_spend: 450.464,
      total_revenue: 234.12,
      credits_based: false,
      balance: 43.56
    }],
    page: {
      count: 1,
      number: 1
    }  
}

XML Response

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <clients_total>24</clients_total>
  <clients>
    <id>56423</id>
    <name>Terry&amp;#39;s Repairs</name>
    <contact>Terry Richards</contact>
    <email>terry@example.com</email>
    <msisdn>61491570156</msisdn>
    <currency>AUD</currency>
    <timezone>Australia/Sydney</timezone>
    <created>2013-02-14 13:45:22</created>
    <client_pays>false</client_pays>
    <sms_margin>3.1</sms_margin>
    <apikey>2e24xxxxxxxxxxxxxxxx4b84bf</apikey>
    <apisecret>YyYD2lad*88</apisecret>
    <recharge_amount>20</recharge_amount>
    <total_lists>34</total_lists>
    <total_sms>575665</total_sms>
    <total_contacts>542</total_contacts>
    <total_spend>450.464</total_spend>
    <total_revenue>234.12</total_revenue>
    <credits_based>false</credits_based>
    <balance>43.56</balance>
  </clients>
  <page>
    <count>1</count>
    <number>1</number>
  </page>
</response>


PHP Examples


<?php
  include '../../APIClient2.php';

  $api = new transmitsmsAPI('API_KEY', 'API_SECRET');
  $offset = 0;
  $limit = 10;

  $result = $api->getClients($offset,$limit);

  if ($result->error->code == 'SUCCESS') {
    echo "You have {$result->clients_total} clients, showing page
      {$result->page->number} of {$result->page->count} <hr>";

    foreach ($result->clientsas$client) {
      echo "Client {$client->name} with email {$client->email}
        has balance of {$client->balance}<br>";
    }

  } else {
    echo "Error: {$result->error->description}";
  }