Ajouter / retirer des crédits
- Home
- Ajouter / retirer des crédits
Adding credit
From your account, you can add credits to your sub accounts. The funds will be debited from your main account.
URLs
POST https://api.smspartner.fr/v1/subaccount/credit/add
Settings
Each API request supports the following parameters :
| apiKey | ApiKey from your account. You get it in your SMS Partner account |
|---|---|
| credit | Number of Credit in Euro add subaccount. |
| tokenSubaccount | Under Account Name. |
| 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 18 19 20 21 22 |
<?php // Prepare data for POST request $fields = array( 'apiKey'=> 'YOUR API KEY', 'credit'=> '100', 'tokenSubaccount'=>'identifiant du sous-compte' ); $curl = curl_init(); curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/subaccount/credit/add'); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_TIMEOUT, 10); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_POSTFIELDS,json_encode($fields)); $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 55 56 57 58 59 |
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" #send sms url = base_url & "subaccount/credit/sms" #note : utiliser une librairie JSON en production, par exemple : #https//www.nuget.org/packages/Newtonsoft.Json/ Dim parameters As String = String.Format( "{{""apiKey"":""{0}"",""credit"":""{1}"",""tokenSubaccount"":""{2}""}}", apiKey, 50, "identifiant du sous-compte") Console.Write(parameters) apiRequest("POST", url, parameters) 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 24 25 26 27 28 29 30 31 32 |
# 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 add_credit(self,creditToAdd,tokenSubaccount): data = OrderedDict([ ("apiKey", API_KEY), ("credit",creditToAdd), ("tokenSubaccount",tokenSubaccount) ]) url = URL + "/subaccount/credit/add" r = requests.post(url, data=json.dumps(data), verify=False) 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 POST -d '{"apiKey":"xxxxx","credit":"10","tokenSubaccount":"identifiant du sous-compte"}' https://api.smspartner.fr/v1/subaccount/credit/add |
Replies
|
1 2 3 4 5 6 7 |
{ "success": true, "code": 200, "credit": 2869.2, "subaccountCredit": 61.8, "currency": "EUR" } |
|
1 2 3 4 5 6 7 8 9 10 |
<?xml version="1.0" encoding="UTF-8"?> <result> <entry>true</entry> <entry>200</entry> <entry>2859.2</entry> <entry>71.8</entry> <entry> <![CDATA[EUR]]> </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 | |
| 2 | Credit is required | |
| 3 | The identifier of the sub-account is required | |
| 4 | You do not have the permission | |
| 5 | Credit to attribute must be greater than 0 | |
| 6 | The balance must be greater than 0 | |
| 7 | The sub-account does not exist | |
| 8 | Insufficient credit | |
| 10 | Invalid API key | |
| 200 | Everything went well ! | |
Remove credit
From your account, you can delete your credit accounts under. The credits will be added to your main account.
URLs
POST https://api.smspartner.fr/v1/subaccount/credit/remove
Settings
Each API request supports the following parameters :
| apiKey | ApiKey from your account. You get it in your SMS Partner account |
|---|---|
| credit | Number of Credit in Euro add subaccount. |
| tokenSubaccount | Under Account Name. |
| 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 18 19 20 21 22 |
<?php // Prepare data for POST request $fields = array( 'apiKey'=> 'YOUR API KEY', 'credit'=> '100', 'tokenSubaccount'=>'identifiant du sous-compte' ); $curl = curl_init(); curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/subaccount/credit/add'); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_TIMEOUT, 10); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_POSTFIELDS,json_encode($fields)); $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 55 56 57 58 59 |
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" #send sms url = base_url & "subaccount/credit/sms" #note : utiliser une librairie JSON en production, par exemple : #https//www.nuget.org/packages/Newtonsoft.Json/ Dim parameters As String = String.Format( "{{""apiKey"":""{0}"",""credit"":""{1}"",""tokenSubaccount"":""{2}""}}", apiKey, 50, "identifiant du sous-compte") Console.Write(parameters) apiRequest("POST", url, parameters) 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 24 25 26 27 28 29 30 31 32 |
# 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 add_credit(self,creditToAdd,tokenSubaccount): data = OrderedDict([ ("apiKey", API_KEY), ("credit",creditToAdd), ("tokenSubaccount",tokenSubaccount) ]) url = URL + "/subaccount/credit/add" r = requests.post(url, data=json.dumps(data), verify=False) 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 POST -d '{"apiKey":"xxxxx","credit":"10","tokenSubaccount":"identifiant du sous-compte"}' https://api.smspartner.fr/v1/subaccount/credit/add |
Replies
|
1 2 3 4 5 6 7 |
{ "success": true, "code": 200, "credit": 2869.2, "subaccountCredit": 61.8, "currency": "EUR" } |
|
1 2 3 4 5 6 7 8 9 10 |
<?xml version="1.0" encoding="UTF-8"?> <result> <entry>true</entry> <entry>200</entry> <entry>2859.2</entry> <entry>71.8</entry> <entry> <![CDATA[EUR]]> </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 | |
| 2 | Credit is required | |
| 3 | The identifier of the sub-account is required | |
| 4 | You do not have the permission | |
| 5 | Credit to attribute must be greater than 0 | |
| 6 | The balance must be greater than 0 | |
| 7 | The sub-account does not exist | |
| 8 | Insufficient credit | |
| 10 | Invalid API key | |
| 200 | Everything went well ! | |