Segmentação e de cálculo

Esta consulta calcula a segmentação e o custo de direcionamento.

URLs

POST https://api.smspartner.fr/v1/location/optin

Configurações

Cada solicitação de API suporta os seguintes parâmetros :

apiKey	Chave de API da sua conta. Você obtê-lo em sua conta SMS Partner.
op	Operação a executar : Cálculo: calcula o custo e o número de contatos afetados pela segmentação Preço: calcule o custo da segmentação Aluguel: alugue uma base de contatos
configurações	sexo: O gênero dos contatos direcionados deve ser : – `m` (unis) – ou `h` (homem) – ou `f` (mulher) idade mínima: A idade mínima do alvo deve ser maior de 18 anos. idade máxima: A idade máxima do alvo deve ser inferior a 99. interesse: O foco principal do alvo. subInterest (opcional): Sub Categoria de foco. categoria (opcional): categoria sócio-profissional : – `102`: CSP+ – `103`: CSP- departamento (opcional): Lista de departamentos segmentados. por exemplo, 02,60, etc … Código postal (opcional): Lista de códigos postais alvejados. por exemplo 02.200,60200, etc …
volumes	Esta configuração está disponível somente se op = aluga ou preço. Permite que você escolha um volume desejado por código postal ou departamento
_formato	Formato de resposta. Você pode escolher entre `JSON` ou `XML`. Por padrão, o formato de resposta é `JSON`.

Petição

Consulta de exemplo :

<?php
        // Prepare data for POST request
        $fields = array(
            'apiKey'=> 'YOUR API KEY',
            'op':'calcul',
            'parameters':{
            'sexe'=> 'm',
            'minAge'=> '25',
            'maxAge' => '35',
            'zipcode'=> '60200',
            'interest'=> 14, /*Habitation*/
            'subInterest'=> 35 /*Cuisine*/
            },
            'volumes':{
            '60200':20
            }
        );
 
        $curl = curl_init();
        curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/location/optin');
        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;
?>

<?php

// Prepare data for POST request

$fields = array(

'apiKey'=> 'YOUR API KEY',

'op':'calcul',

'parameters':{

'sexe'=> 'm',

'minAge'=> '25',

'maxAge' => '35',

'zipcode'=> '60200',

'interest'=> 14, /*Habitation*/

'subInterest'=> 35 /*Cuisine*/

'volumes':{

'60200':20

}

);

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL,'https://api.smspartner.fr/v1/location/optin');

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;

Imports System.IO
Imports System.Net
 
Module Module1
 
  Sub Main()
 
    Dim base_url As String = "http://api.smspartner.fr/v1/"
    Dim apiKey As String = "YOUR API KEY"
 
    #send sms
    url = base_url & "location/optin"
    #note : utiliser une librairie JSON en production, par exemple :
    #https//www.nuget.org/packages/Newtonsoft.Json/
    Dim parameters As String = String.Format(
        "{{""apiKey"":""{0}"",""op"":""{1}"",""parameters"":""{2}"",""volumes"":""{3}""}}",
        apiKey,
        "price",
        "{ "sexe"=> "m","minAge"=> "25","maxAge" => "35","zipcode"=> "60200","interest"=> 14,"subInterest"=> 35}",
        "{"60200":20}"
        )
        ""
    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

Imports System.IO

Imports System.Net

Module Module1

Sub Main()

Dim base_url As String = "http://api.smspartner.fr/v1/"

Dim apiKey As String = "YOUR API KEY"

#send sms

url = base_url & "location/optin"

#note : utiliser une librairie JSON en production, par exemple :

#https//www.nuget.org/packages/Newtonsoft.Json/

Dim parameters As String = String.Format(

"{{""apiKey"":""{0}"",""op"":""{1}"",""parameters"":""{2}"",""volumes"":""{3}""}}",

apiKey,

"price",

"{ "sexe"=> "m","minAge"=> "25","maxAge" => "35","zipcode"=> "60200","interest"=> 14,"subInterest"=> 35}",

"{"60200":20}"

)

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

# std
import http.client
 
conn = http.client.HTTPConnection("api,smspartner,fr")
 
payload = "{"apiKey":"YOUR API KEY","op":"price","parameters":{"sexe":"f","minAge":25,"maxAge":35,"zipcode":"06200","interest":12,"subInterest":29,"category":103},"volumes":{"60200":20}}"
 
headers = {
    "Content-Type": "application/json"
    }
 
conn.request("POST", "v1,location,optin", payload, headers)
 
res = conn.getresponse()
data = res.read()
 
print(data.decode("utf-8"))

# std

import http.client

conn = http.client.HTTPConnection("api,smspartner,fr")

payload = "{"apiKey":"YOUR API KEY","op":"price","parameters":{"sexe":"f","minAge":25,"maxAge":35,"zipcode":"06200","interest":12,"subInterest":29,"category":103},"volumes":{"60200":20}}"

headers = {

"Content-Type": "application/json"

}

conn.request("POST", "v1,location,optin", payload, headers)

res = conn.getresponse()

data = res.read()

print(data.decode("utf-8"))

curl -X POST https://api.smspartner.fr/v1/location/optin -H "Content-Type: application/json" -d '{"apiKey":"YOUR API KEY","op":"price","parameters":{"sexe":"f","minAge":25,"maxAge":35,"zipcode":"06200","interest":"12","subInterest":"29","category":103}}

1	curl -X POST https://api.smspartner.fr/v1/location/optin -H "Content-Type: application/json" -d '{"apiKey":"YOUR API KEY","op":"price","parameters":{"sexe":"f","minAge":25,"maxAge":35,"zipcode":"06200","interest":"12","subInterest":"29","category":103}}

{
    "success": true,
    "op": "price",
    "datas": [
        {
            "Type": "CP",
            "Localite": "06200",
            "Volume": 20
        },
        {
            "Type": "total",
            "Localite": "total",
            "Volume": 20
        }
    ],
    "cost": {
        "quantity": 20,
        "total": 2.52,
        "cost_unity": 0.09
    }
}

{

"success": true,

"op": "price",

"datas": [

{

"Type": "CP",

"Localite": "06200",

"Volume": 20

{

"Type": "total",

"Localite": "total",

"Volume": 20

}

"cost": {

"quantity": 20,

"total": 2.52,

"cost_unity": 0.09

}

<?xml version="1.0" encoding="UTF-8"?>
<result>
    <entry>true</entry>
    <entry>
        <![CDATA[price]]>
    </entry>
    <entry>
        <entry>
            <entry>
                <![CDATA[CP]]>
            </entry>
            <entry>
                <![CDATA[06200]]>
            </entry>
            <entry>28</entry>
        </entry>
        <entry>
            <entry>
                <![CDATA[total]]>
            </entry>
            <entry>
                <![CDATA[total]]>
            </entry>
            <entry>28</entry>
        </entry>
    </entry>
    <entry>
        <entry>28</entry>
        <entry>2.52</entry>
        <entry>0.09</entry>
    </entry>
</result>

<?xml version="1.0" encoding="UTF-8"?>

<entry>

<![CDATA[price]]>

</entry>

<entry>

<![CDATA[CP]]>

</entry>

<entry>

<![CDATA[06200]]>

</entry>

</entry>

<entry>

<![CDATA[total]]>

</entry>

<entry>

<![CDATA[total]]>

</entry>

</entry>

<entry>

</entry>

</result>

Erros

Exemplo mensagem de erro :

JSON
XML

{
    "success": false,
    "code": 10,
    "message": "Clé API incorrecte"
}

{

"success": false,

"code": 10,

"message": "Clé API incorrecte"

}

<?xml version='1.0' encoding='UTF-8'?>
<result>
    <entry>false</entry>
    <entry>10</entry>
    <entry>Clé API incorrecte</entry>
</result>

<?xml version='1.0' encoding='UTF-8'?>

<entry>false</entry>

<entry>Clé API incorrecte</entry>

</result>

Código de controle

	resposta
1	A chave API é necessária
10	Chave de API inválida
200	Tudo correu bem!

Ciblage & calcule

Segmentação e de cálculo

URLs

POST https://api.smspartner.fr/v1/location/optin

Configurações

Petição

Respostas

Erros

Código de controle