/messages/{id} (GET)

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

Endpoint: social-sb.com/api/v2/messages/{id}

Verb: GET

Paramètres obligatoires :

id : identifiant SPREAD du message

Paramètres complémentaires :

withEmailsSubjects ⇒ permet d’indiquer si vous voulez récupérer les sujets des emails (seulement valable pour les canaux de type “email”). 1 si vous voulez l’information, 0 sinon. Si non précisé, la valeur vaudra 0. Les sujets des emails seront retournés dans un tableau.

Réponse :

"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,
    "subjects": null
}

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);

/messages (GET)

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

Endpoint: social-sb.com/api/v2/messages

Verb: GET

Paramètres obligatoires :

Aucun

Paramètres complémentaires :

Aucun

Réponse :

"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"

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'envoi est supérieure à la date passée en paramètre seront retournés

startDeliveringBefore ⇒ seuls les messages dont la date d'envoi est inférieure à la date passée en paramètre seront retournés

endDeliveringAfter ⇒ seuls les messages dont la date de fin d'envoi est supérieure à la date passée en paramètre seront retournés

endDeliveringBefore ⇒ seuls les messages dont la date de fin d'envoi est inférieur à la date passée en paramètre seront retournés

type ⇒ seuls les messages dont le type est égal à celui passé en paramètre seront retournés. Le type a deux valeurs possibles :

scenario

oneshot La valeur oneshot représente les emails venant des Messages. La valeur scenario représente les emails 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

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

done

withEmailsSubjects ⇒ permet d’indiquer si vous voulez récupérer les sujets des emails (seulement valable pour les canaux de type “email”). 1 si vous voulez l’information, 0 sinon. Si non précisé, la valeur vaudra 0. Les sujets des emails seront retournés dans un tableau.

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)

🆘

Si vous avez d’autres questions sur ce sujet, vous pouvez contacter le support. 💬