List of subaccounts
- Home
- List of subaccounts
SMS Partner account
Recovery of by accounts
To retrieve the information from sub accounts, there are two methods:
- For the platform:
By visiting your dashboard dashboard or you will have access to all sub accounts associated with your account.- For the API:
By performing a query on the url below.
URLs
GET https://api.smspartner.fr/v1/subaccount/list
Settings
Each API request supports the following parameters :
| apiKey | ApiKey from your account. You get it in your SMS Partner account |
|---|---|
| page | The page number of the page, there are 20 results per page. If omitted, page 1 will be returned. |
| Optional settings | |
| _format | Response format. You can choose between JSON ou XML. By default, the response format is JSON. |
Request
Sample query :
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
<?php // Prepare data for GET request $data = 'apiKey=YOUR_API_KEY'; $curl = curl_init(); curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/subaccount/list?'.$data); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_TIMEOUT, 10); $result = curl_exec($curl); curl_close($curl); // Process your response here echo $result; ?> |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
Imports System.IO Imports System.Net Module Module1 Sub Main() Dim base_url As String = "http://api.smspartner.fr/v1/" Dim apiKey As String = "VOTRE_APIKEY" #check credits Dim url As String url = base_url & "subaccount/list" & "?apiKey=" & apiKey Dim credits As String credits = apiRequest("GET", url, Nothing) End Sub Function apiRequest(method As String, url As String, parameters As String) As String Dim request As HttpWebRequest request = WebRequest.Create(url) request.Method = method request.Timeout = 10000 # timeout in ms request.ContentType = "application/json; charset=utf-8" request.ContentLength = 0 #set POST data If Not String.IsNullOrEmpty(parameters) Then request.ContentLength = parameters.Length Using reqStream As StreamWriter = New StreamWriter(request.GetRequestStream()) reqStream.Write(parameters) End Using End If #get response Dim returnValue As String = Nothing Using response As HttpWebResponse = request.GetResponse() If response.StatusCode = HttpStatusCode.OK Then Using resStream = response.GetResponseStream() If resStream IsNot Nothing Then Using reader As New StreamReader(resStream) returnValue = reader.ReadToEnd() End Using End If End Using End If End Using apiRequest = returnValue End Function End Module |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
# std import logging import json from collections import OrderedDict # 3p import requests API_KEY = "MY API KEY" URL = "https://api.smspartner.fr/v1" class SMSPartner(): def get_list_subaccount(self): url = URL + "/subaccount/list?apiKey=" + API_KEY r = requests.get(url) r_json = r.json() if r_json.get("success") == True: print(r_json) status = True else: print(r_json) status = False return status |
|
1 |
curl -H "Content-Type: application/json" -X GET https://api.smspartner.fr/v1/subaccount/list?apiKey=xxx&page=1 |
Replies
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
{ "success": true, "code": 200, "total": 29, "nb_per_page": 20, "page": 1, "data": [ { "id": 1, "email": "email1", "type": "simple", "token": "token1", //Est utilisé comme identifiant du sous-compte pour ajouter des crédits "apiKey": "ApiKey sous compte", "createdAt": "2016-03-04 11:23:14", "credits": { "balance": "0.800", "currency": "EUR" } }, { "id": 2, "email": "email2", "type": "simple", "token": "token2", "apiKey": "ApiKey2 du sous compte", "createdAt": "2016-03-04 11:23:14", "credits": { "balance": "10.245", "currency": "EUR" } } ] } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
<?xml version="1.0" encoding="UTF-8"?> <entry>true</entry> <entry>200</entry> <entry>20</entry> <entry>1</entry> <entry>2</entry> <entry> <entry> <entry>1</entry> <entry> <![CDATA[email1]]> </entry> <entry> <![CDATA[2016-03-04 11:23:14]]> </entry> <entry> <entry>670</entry> <entry> <![CDATA[4]]> </entry> <entry>666</entry> </entry> </entry> <entry> <entry>2</entry> <entry> <![CDATA[email2]]> </entry> <entry xsi:nil="true"/> <entry> <![CDATA[2016-03-05 09:14:47]]> </entry> <entry> <entry>110</entry> <entry>0</entry> <entry>110</entry> </entry> </entry> </entry> </result> |
Errors
Error message Example :
|
1 2 3 4 5 |
{ "success": false, "code": 10, "message": "Clé API incorrecte" } |
|
1 2 3 4 5 6 7 8 |
<?xml version="1.0" encoding="UTF-8"?> <result> <entry>false</entry> <entry>10</entry> <entry> <![CDATA[Clé API incorrecte]]> </entry> </result> |
Control code
| Reply | ||
|---|---|---|
| 1 | The API Key is required | |
| 10 | Invalid API key | |
| 200 | Everything went well ! | |