Textlocal Logo

API Documentation

Get Users (Advanced)

A Reseller only service Requires Advanced Reseller API This command can be used to get all the users with their account details, credit thresholds, API keys and other information created under a dual brand or white label provider account.

Resource URL

https://api.txtlocal.com/get_users/

Sample Request

Select Language
PHP 
  1. <?php
  2.  
  3. $data = [
  4.     'apiKey' => 'Your API Key',
  5.  
  6. ];
  7.  
  8. // Send the POST request with cURL
  9. $ch = curl_init('https://api.txtlocal.com/get_users/');
  10. curl_setopt($ch, CURLOPT_POST, true);
  11. curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
  12. curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  13. $response = curl_exec($ch);
  14. curl_close($ch);
  15.  
  16. // Process your response here
  17. echo $response;
  1. <?php
  2.  
  3. 	// Account details
  4. 	$apiKey = urlencode('Your API key');
  5.  
  6. 	// Prepare data for GET request
  7. 	$data = '&apikey=' . $apiKey;
  8.  
  9. 	// Send the GET request with cURL
  10. 	$ch = curl_init('https://api.txtlocal.com/get_users/?' . $data);
  11. 	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  12. 	$response = curl_exec($ch);
  13. 	curl_close($ch);
  14.  
  15. 	// Process your response here
  16. 	echo $response;

Parameters

There are no additional parameters for this command
Login Parameters (Additional Information)
apiKey You can create these in your Messenger Control Panel (click here) for each application, and limit the usage of them by host IP Address.

Sample Response

  1. {
  2.   "users": [
  3.     {
  4.       "id": "277112",
  5.       "loginID": "example.user1@example.com",
  6.       "Credits": 10,
  7.       "api_hash": "1848ca2c189562792b87939a9df6eba07e2e6a5f",
  8.       "default_sender_name": "Jims Autos",
  9.       "last_sent": "0000-00-00",
  10.       "signup_date": "2015-09-18 11:40",
  11.       "timezone": "Europe/London",
  12.       "activated": true,
  13.       "name": "Example User 1",
  14.       "address": "Company, Unit 35, Business Park, Long Road",
  15.       "postcode": "WR14 3SZ",
  16.       "town": "Malvern",
  17.       "county": "Worcestershire",
  18.       "country": "United Kingdom",
  19.       "telephone": "447123456789",
  20.       "credit_alerts": {
  21.         "email": "",
  22.         "thresholds": [
  23.           50,
  24.           20,
  25.           10,
  26.           5
  27.         ]
  28.       },
  29.       "api_keys": []
  30.     },
  31.     {
  32.       "id": "277235",
  33.       "loginID": "example.user0@example.com",
  34.       "Credits": 25,
  35.       "api_hash": "254ba9cf3039c216fc1c3e00fe6499cbac06eb34",
  36.       "default_sender_name": "Luigis",
  37.       "last_sent": "0000-00-00",
  38.       "signup_date": "2015-09-18 14:49",
  39.       "timezone": "Europe/London",
  40.       "activated": true,
  41.       "name": "Example User 0",
  42.       "address": "Company, Unit 35, Business Park, Long Road",
  43.       "postcode": "WR14 3SZ",
  44.       "town": "Malvern",
  45.       "county": "Worcestershire",
  46.       "country": "United Kingdom",
  47.       "telephone": "447987654321",
  48.       "credit_alerts": {
  49.         "email": "example.user0@example.com",
  50.         "thresholds": [
  51.           50,
  52.           20,
  53.           10,
  54.           5
  55.         ]
  56.       },
  57.       "api_keys": [
  58.         {
  59.           "api_key": "GSi8ihLplrc-L1FJ4KVQW9UTPIX0E7NC8YZA5RGMOS",
  60.           "notes": "Example API Key",
  61.           "ip_addresses": [
  62.             "123.123.123.123"
  63.           ]
  64.         }
  65.       ]
  66.     }
  67.   ],
  68.   "status": "success"
  69. }
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <response>
  3.     <users>
  4.         <user>
  5.             <id>277112</id>
  6.             <loginID>example.user1@example.com</loginID>
  7.             <Credits>10</Credits>
  8.             <api_hash>1848ca2c189562792b87939a9df6eba07e2e6a5f</api_hash>
  9.             <default_sender_name>Jims Autos</default_sender_name>
  10.             <last_sent>0000-00-00</last_sent>
  11.             <signup_date>2015-09-18 11:40</signup_date>
  12.             <timezone>Europe/London</timezone>
  13.             <activated>1</activated>
  14.             <name>Example User 1</name>
  15.             <address>Company, Unit 35, Business Park, Long Road</address>
  16.             <postcode>WR14 3SZ</postcode>
  17.             <town>Malvern</town>
  18.             <county>Worcestershire</county>
  19.             <country>United Kingdom</country>
  20.             <telephone>447123456789</telephone>
  21.             <credit_alerts>
  22.                 <email></email>
  23.                 <thresholds>
  24.                     <threshold>50</threshold>
  25.                     <threshold>20</threshold>
  26.                     <threshold>10</threshold>
  27.                     <threshold>5</threshold>
  28.                 </thresholds>
  29.             </credit_alerts>
  30.             <api_keys></api_keys>
  31.         </user>
  32.         <user>
  33.             <id>277235</id>
  34.             <loginID>example.user0@example.com</loginID>
  35.             <Credits>25</Credits>
  36.             <api_hash>254ba9cf3039c216fc1c3e00fe6499cbac06eb34</api_hash>
  37.             <default_sender_name>Luigis</default_sender_name>
  38.             <last_sent>0000-00-00</last_sent>
  39.             <signup_date>2015-09-18 14:49</signup_date>
  40.             <timezone>Europe/London</timezone>
  41.             <activated>1</activated>
  42.             <name>Example User 0</name>
  43.             <address>Company, Unit 35, Business Park, Long Road</address>
  44.             <postcode>WR14 3SZ</postcode>
  45.             <town>Malvern</town>
  46.             <county>Worcestershire</county>
  47.             <country>United Kingdom</country>
  48.             <telephone>447987654321</telephone>
  49.             <credit_alerts>
  50.                 <email>example.user0@example.com</email>
  51.                 <thresholds>
  52.                     <threshold>50</threshold>
  53.                     <threshold>20</threshold>
  54.                     <threshold>10</threshold>
  55.                     <threshold>5</threshold>
  56.                 </thresholds>
  57.             </credit_alerts>
  58.             <api_keys>
  59.                 <api_key>
  60.                     <api_key>GSi8ihLplrc-L1FJ4KVQW9UTPIX0E7NC8YZA5RGMOS</api_key>
  61.                     <notes>Example API Key</notes>
  62.                     <ip_addresses>
  63.                         <ip_addresse>123.123.123.123</ip_addresse>
  64.                     </ip_addresses>
  65.                 </api_key>
  66.             </api_keys>
  67.         </user>
  68.     </users>
  69.     <status>success</status>
  70. </response>

Errors

Error Codes
71 No users found.
72 No reseller account found.