Stato del noleggio
- Home
- Stato del noleggio
Recuperare lo stato di un noleggio di contatto
Questa interrogazione permette di recuperare Permette di recuperare lo stato di un noleggio di contatti.
URL
GET https://api.smspartner.fr/v1/location/status
Impostazioni
Ogni richiesta dall’API supporta i seguenti parametri :
apiKey | API key per il tuo account. Lo ottieni nel tuo account Partner SMS |
---|---|
token | Identificatore di noleggio. |
Richiesta
Interrogazione campione :
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&token=xxx'; $curl = curl_init(); curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/location/status?'.$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 55 |
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" Dim token As String = XXX #check credits Dim url As String url = base_url & "location/status" & "?apiKey=" & apiKey & "&token=" & token 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_delivery(self,token): url = URL + "/location/status?apiKey=" + API_KEY + "&token=" + token 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/location/status?apiKey=xxx&token=xxx |
Risposte
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 |
{ "success": true, "token": "identifiant de la location", "status": "File downloaded by user from api", "location": { "sexe": "femme", "minAge": 31, "maxAge": 49, "zipcode": "60200", "interest": "12", "category": 103, "details_localisation": [ { "Type": "cp", "Location": "60200", "VolumeDesired": "10", "Volume": "266" } ], "cost": { "quantity": 10, "total": "0.900", "cost_unity": "0.090" } }, "file": { "phoneNumbers": "10" } } |
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 |
<?xml version='1.0' encoding='UTF-8'?> <result> <entry>true</entry> <entry> <![CDATA[b22b841a21624f4f452ba7fa8c822c0ed7cecfdb]]> </entry> <entry> <![CDATA[File downloaded by user from api]]> </entry> <entry> <entry> <![CDATA[femme]]> </entry> <entry>31</entry> <entry>49</entry> <entry> <![CDATA[60200]]> </entry> <entry> <![CDATA[12]]> </entry> <entry>103</entry> <entry> <entry> <entry> <![CDATA[cp]]> </entry> <entry> <![CDATA[60200]]> </entry> <entry> <![CDATA[10]]> </entry> <entry> <![CDATA[266]]> </entry> </entry> </entry> <entry> <entry>10</entry> <entry> <![CDATA[0.900]]> </entry> <entry> <![CDATA[0.090]]> </entry> </entry> </entry> <entry> <entry> <![CDATA[10]]> </entry> </entry> </result> |
Errori
Esempio di messaggio di errore :
1 2 3 4 5 |
{ "success": false, "code": 10, "message": "Clé API incorrecte" } |
1 2 3 4 5 6 |
<?xml version='1.0' encoding='UTF-8'?> <result> <entry>false</entry> <entry>10</entry> <entry>Clé API incorrecte</entry> </result> |
Indicatore di stato del noleggio
0 | La richiesta di noleggio è stata fatta | |
---|---|---|
1 | Il file è in fase di creazione | |
2 | La creazione del file è completa. È possibile scaricarlo | |
3 | Richiesta di noleggio non riuscita | |
5 | Il file è già stato scaricato |
Codice di controllo
Rispondi a | ||
---|---|---|
1 | La chiave API è richiesta | |
10 | Chiave API errata | |
31 | il token di noleggio è richiesto | |
32 | Noleggio non trovato | |
200 | È andato tutto bene! |