Solution SMS

Bannière Découvrez Dialog, une exclusivité Primotexto qui va révolutionner votre communication par SMS !

API SMS

Intégrez Primotexto à vos applications grâce à notre puissante API SMS.

  >  
Campagnes  >  

Créer une nouvelle campagne standard

Requête à envoyer

URL Marketing

https://api.primotexto.com/v2/marketing/campaigns

URL Notification

https://api.primotexto.com/v2/notification/campaigns

HTTP METHOD

POST

HEADERS

X-Primotexto-ApiKey: YOUR_API_KEY Content-Type: application/json

DATA

{ "name": "Communication soldes 2014", "message": "Soldes 2014 ! Début des soldes ce Lundi dans l'ensemble de notre réseau !", "sendList": { "id": "533e9f59e4b05d2efeb6f1b4" } }

Retour de l'API


HEADERS

HTTP/1.1 200 OK Date: Fri, 08 Jan 2016 15:11:02 GMT Server: Apache Content-Type: application/json;charset=UTF-8 Vary: Accept-Encoding Transfer-Encoding: chunked

DATA

{ "id": "534bac13e4b0598311698694", }
Objets DATA
Description
! Paramètres REQUIS !
"name"
Le nom de la campagne: "Communication soldes 2014"
"message"
Le contenu du message: "Soldes 2014 ! Début des soldes ce Lundi dans l'ensemble de notre réseau !"
"sendList"
La liste de destinataires: "id": "533e9f59e4b05d2efeb6f1b4"
Options
"date"
"date": 1398177000000 => Tue, 22 Apr 2014 14:30:00 GMT
Programmation de la campagne pour une date définie (format: timestamp millisecondes).
"sourceAddress"
"sourceAddress": "YourCompany"
L'expediteur personnalisé du message.
Sans personnalisation, l'expediteur sera un shortcode numérique du type 36 XXX.
Si vous personnalisez l'expediteur, un "STOP au 36 XXX" sera automatiquement ajouté à votre message.

// Download library -> https://www.primotexto.com/api/librairies/latest-php.asp require_once 'primotexto-api-php/baseManager.class.php'; // Authentication authenticationManager::setApiKey('YOUR_API_KEY'); // Standard $newCampaign = new PTCampaign(); $newCampaign->type = 'marketing'; $newCampaign->name = 'PHP API - Standard'; $newCampaign->message = 'Exemple de contenu de campagne en API PHP'; $newCampaign->sendList = '551954f0e4b39e793123d95b'; $newCampaign->sourceAddress = 'PT-PHP'; $campaign = campaignsManager::campaignsCreate($newCampaign); $campaignId = json_decode($campaign)->campaignId; // Standard with Fields $newCampaign = new PTCampaign(); $newCampaign->type = 'marketing'; $newCampaign->name = 'PHP API - Standard'; $newCampaign->message = 'Exemple de contenu + Fields de campagne en API PHP. Monsieur ${nom_de_famille}, votre anniversaire est le ${anniversaire} !'; $newCampaign->sendList = '551954f0e4b39e793123d95b'; $newCampaign->sourceAddress = 'PT-PHP'; $campaign = campaignsManager::campaignsCreate($newCampaign); $campaignId = json_decode($campaign)->campaignId;
curl -X POST \ -H "X-Primotexto-ApiKey: YOUR_API_KEY" \ -H "ContenContent-Type: application/json" \ -d '{"name": "Confirmation de prélévement Septembre", \ "message": "Nous vous informons du prélévement automatique d'un montant de 19.90€ effectué ce jour sur votre compte bancaire.", \ "sendList": {"id": "533e9f59e4b05d2efeb6f1b4"}}' \ https://api.primotexto.com/v2/marketing/campaigns





Créer une nouvelle campagne avec contenu HTML hebergé @Primotexto

Requête à envoyer

URL Marketing

https://api.primotexto.com/v2/marketing/campaigns

URL Notification

https://api.primotexto.com/v2/notification/campaigns

HTTP METHOD

POST

HEADERS

X-Primotexto-ApiKey: YOUR_API_KEY Content-Type: application/json

DATA

{ "name": "Campagne 11-04-2014", "message": "Soldes 2014 ! Rendez-vous vite sur ${rich_message}", "sendList": { "id": "533e9f59e4b05d2efeb6f1b4" }, "landingPage": " \t

Contenu HTML

", "landingPageTitle": "Titre de la page cible", "landingPageType": "CUSTOM" }

Retour de l'API


HEADERS

HTTP/1.1 200 OK Date: Fri, 08 Jan 2016 15:11:02 GMT Server: Apache Content-Type: application/json;charset=UTF-8 Vary: Accept-Encoding Transfer-Encoding: chunked

DATA

{ "id": "534bac13e4b0598311698694", }
Objets DATA
Description
! Paramètres REQUIS !
"name"
Le nom de la campagne: "Campagne 11-04-2014"
"message"
Le contenu du message: "Soldes 2014 ! Rendez-vous vite sur ${rich_message}"
"sendList"
La liste de destinataires: "id": "533e9f59e4b05d2efeb6f1b4"
"landingPage"
"landingPage": "<html> <head> \t<title> </title> </head> <body> <p>Contenu HTML </p> </body> </html>"
"landingPageTitle"
"landingPageTitle": "Titre de la page cible"
"landingPageType"
"landingPageType": "CUSTOM"
Options
"date"
"date": 1398177000000 => Tue, 22 Apr 2014 14:30:00 GMT
Programmation de la campagne pour une date définie (format: timestamp millisecondes).
"sourceAddress"
"sourceAddress": "YourCompany"
L'expediteur personnalisé du message.
Sans personnalisation, l'expediteur sera un shortcode numérique du type 36 XXX.
Si vous personnalisez l'expediteur, un "STOP au 36 XXX" sera automatiquement ajouté à votre message.

"flash"
"flash": "true"
Envoyer sous forme de SMS flash.
Un SMS Flash ne s'affiche qu'une seule fois, entiérement, dans un format propre à l'appareil récepteur, et n'est pas enregistré dans la liste des SMS du destinataire.
// Download library -> https://www.primotexto.com/api/librairies/latest-php.asp require_once 'primotexto-api-php/baseManager.class.php'; // Authentication authenticationManager::setApiKey('YOUR_API_KEY'); // IntRich $newCampaign = new PTCampaign(); $newCampaign->type = 'marketing'; $newCampaign->name = 'PHP API - IntRich'; $newCampaign->message = 'Exemple de contenu + Intrich ( ${rich_message} ) de campagne en API PHP'; $newCampaign->sendList = '551954f0e4b39e793123d95b'; $newCampaign->landingPageType = 'CUSTOM'; $newCampaign->landingPage = '\n\n\tTitre de ma page ma page HTML\n\n\n

Contenu de ma page HTML

\n\n\n'; $newCampaign->landingPageTitle = 'Titre de ma page ma page HTML'; $campaign = campaignsManager::campaignsCreate($newCampaign); $campaignId = json_decode($campaign)->campaignId;
curl -X POST \ -H "X-Primotexto-ApiKey: YOUR_API_KEY" \ -H "ContenContent-Type: application/json" \ -d '{"name": "Campagne 11-04-2014", \ "message": "Nous vous confirmons l'expedition de votre nouvelle carte à votre domicile. Pour suivre son avancement, veuillez consulter ${rich_message}", \ "sendList": {"id": "533e9f59e4b05d2efeb6f1b4"}, \ "landingPage": " \t

Contenu HTML

", \ "landingPageTitle": "Titre de la page cible", \ "landingPageType": "CUSTOM" }' \ https://api.primotexto.com/v2/marketing/campaigns





Créer une nouvelle campagne avec lien URL @Votre_site

Requête à envoyer

URL Marketing

https://api.primotexto.com/v2/marketing/campaigns

URL Notification

https://api.primotexto.com/v2/notification/campaigns

HTTP METHOD

POST

HEADERS

X-Primotexto-ApiKey: YOUR_API_KEY Content-Type: application/json

DATA

{ "name": "Campagne 11-04-2014", "message": "Soldes 2014 ! Consultez en avant-première notre catalogue: ${rich_message}", "sendList": { "id": "533e9f59e4b05d2efeb6f1b4" }, "externalUrl": "http://domain.com/soldes.php", "landingPageType": "EXTERNAL" }

Retour de l'API


HEADERS

HTTP/1.1 200 OK Date: Fri, 08 Jan 2016 15:11:02 GMT Server: Apache Content-Type: application/json;charset=UTF-8 Vary: Accept-Encoding Transfer-Encoding: chunked

DATA

{ "id": "534bac13e4b0598311698694", }
Objets DATA
Description
! Paramètres REQUIS !
"name"
Le nom de la campagne: "Campagne 11-04-2014"
"message"
Le contenu du message: "Soldes 2014 ! Consultez en avant-première notre catalogue: ${rich_message}"
"sendList"
La liste de destinataires: "id": "533e9f59e4b05d2efeb6f1b4"
"externalUrl"
"externalUrl": "http://domain.com/soldes.php"
"landingPageType"
"landingPageType": "EXTERNAL"
Options
"date"
"date": 1398177000000 => Tue, 22 Apr 2014 14:30:00 GMT
Programmation de la campagne pour une date définie (format: timestamp millisecondes).
"sourceAddress"
"sourceAddress": "YourCompany"
L'expediteur personnalisé du message.
Sans personnalisation, l'expediteur sera un shortcode numérique du type 36 XXX.
Si vous personnalisez l'expediteur, un "STOP au 36 XXX" sera automatiquement ajouté à votre message.

"flash"
"flash": "true"
Envoyer sous forme de SMS flash.
Un SMS Flash ne s'affiche qu'une seule fois, entiérement, dans un format propre à l'appareil récepteur, et n'est pas enregistré dans la liste des SMS du destinataire.
// Download library -> https://www.primotexto.com/api/librairies/latest-php.asp require_once 'primotexto-api-php/baseManager.class.php'; // Authentication authenticationManager::setApiKey('YOUR_API_KEY'); // ExtRich $newCampaign = new PTCampaign(); $newCampaign->type = 'marketing'; $newCampaign->name = 'PHP API - ExtRich'; $newCampaign->message = 'Exemple de contenu + Extrich ( ${rich_message} ) de campagne en API PHP'; $newCampaign->sendList = '551954f0e4b39e793123d95b'; $newCampaign->landingPageType = 'EXTERNAL'; $newCampaign->externalUrl = 'http://www.votre-site.com/'; $campaign = campaignsManager::campaignsCreate($newCampaign); $campaignId = json_decode($campaign)->campaignId;
curl -X POST \ -H "X-Primotexto-ApiKey: YOUR_API_KEY" \ -H "ContenContent-Type: application/json" \ -d '{"name": "Campagne 11-04-2014", \ "message": "Nous vous confirmons l'expedition de votre nouvelle carte à votre domicile. Pour suivre son avancement, veuillez consulter ${rich_message}", \ "sendList": {"id": "533e9f59e4b05d2efeb6f1b4"}, \ "externalUrl": "http://domain.com/avancement.php", \ "landingPageType": "EXTERNAL" }' \ https://api.primotexto.com/v2/marketing/campaigns