API - Message

Owned by Former user (Deleted)
Last updated: 28 Jun 2019
2 min read

 Pour être informés de toutes les mises à jour concernant l’API v2 de SPREAD, inscrivez-vous ici : https://social-sb.com/z/newsletter-api-v1-v2

Méthodes disponibles


GET Message

Cette méthode permet de récupérer les informations d'un message.

GET ⇒ social-sb.com/api/v2/messages/{id}

Paramètres obligatoires :

  • "id" : identifiant SPREAD du message

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok ⇒

"message": 
{
 	"id": "1234",
 	"title": "Un titre",
 	"type": "scenario",
 	"marketingPressureLevel": "normal",
 	"state": "draft",
 	"createdAt": "2017-10-17 08:25:37",
 	"updatedAt": "2017-10-17 08:25:37",
 	"startDeliveringAt": null,
 	"endDeliveringAt": null
}

Sinon, affichage d'un message d'erreur.

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/messages/1234");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:clef_privee");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);


GET Messages

Cette méthode permet de récupérer tous les messages d'un site_id.

GET ⇒ social-sb.com/api/v2/messages

Paramètres obligatoires :

Aucun

Paramètres complémentaires :

Aucun

Réponse :

Si GET ok ⇒

"messages": 
[
	 {
	 	"id": "1234",
	 	"title": "Un titre",
	 	"type": "scenario",
	 	"marketingPressureLevel": "normal",
	 	"state": "draft",
	 	"createdAt": "2017-10-17 08:25:37",
	 	"updatedAt": "2017-10-17 08:25:37",
	 	"startDeliveringAt": null,
	 	"endDeliveringAt": null
	 },
	 {
	 	"id": "1235",
	 	"title": "Autre titre",
	 	"type": "oneshot",
	 	"marketingPressureLevel": "unlimited",
	 	"state": "draft",
	 	"createdAt": "2017-10-17 08:26:41",
	 	"updatedAt": "2017-11-09 09:23:55",
	 	"startDeliveringAt": null,
	 	"endDeliveringAt": null
	 }
 ],
 "count": 2,
 "nextPageUrl": "http://social-sb.com/api/v2/messages?startAt=2"

Sinon, affichage d'un message d'erreur.

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/messages");
// Auth avec la clé publique et la clé privée (voir dans Paramétrage > Tracker)
curl_setopt($curl, CURLOPT_USERPWD, "clef_public:clef_privee");
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);

Faire une recherche précise :

Il est possible d'affiner la liste retournée en passant des paramètres GET.

Les paramètres d'affinage possibles :

  • "createdAfter" ⇒ seuls les messages créés après la date passée en paramètre seront remontés
  • "createBefore" ⇒ seuls les messages créés avant la date passée en paramètre seront remontés
  • "modifiedAfter" ⇒ seuls les messages modifiés après la date passée en paramètre seront remontés
  • "modifiedBefore" ⇒ seuls les messages modifiés avant la date passée en paramètre seront retournés
  • "startDeliveringAfter" ⇒ seuls les messages dont la date d'envoie est supérieure à la date passée en paramètre seront retournés
  • "startDeliveringBefore" ⇒ seuls les messages dont la date d'envoie est inférieure à la date passée en paramètre seront retournés
  • "endDeliveringAfter" ⇒ seuls les messages dont la date de fin d'envoie est supérieure à la date passée en paramètre seront retournés
  • "endDeliveringBefore" ⇒ seuls les messages dont la date de fin d'envoie est inférieur à la date passée en paramètre seront retournés
  • "type" ⇒ seuls les messages dont le type est égale à celui passé en paramètres seront retournés. Le type a deux valeurs possibles : "scenario" ou "oneshot". La valeur "oneshot" représente tous les messages venant de l'Unified Messaging. La valeur "scenario représente tous les messages venant des Scénarios.
  • "marketingPressureLevel" ⇒ seuls les messages dont le taux de pression marketing est égale à celui passé en paramètre seront retournés. La pression marketing à trois valeurs possibles : "unlimited", "normal" et "low".
  • "state" ⇒ seuls les messages dont le statut est égale à celui passé en paramètre seront retournés. Les statuts possibles sont : "deleted", "archived", "draft", "programmed", "active", "waiting" et "done".

Les paramètres sur la pagination :

  • "startAt" ⇒ permet de commencer la liste des messages à partir de l'occurence passée en paramètre
  • "maxResult" ⇒ permet de limiter le nombre de messages remontés par pages (max 5000)