/customers-messages (GET)

Permet de récupérer tous les customers ayant eu une interaction avec un message précis, identifié par son messageId

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

Verb: GET

Paramètres obligatoires (à passer en paramètre GET) :

messageId : Identifiant SPREAD du message

Paramètres complémentaires :

Aucun

Réponse :

"message": {
 "messageId": "1234",
 "customers": [
     {
     "customerId": "123456",
     "channelId": "9876",
     "delivered": true,
     "deliveryDetails": "Delivered",
     "status": "clicked",
     "date": "2019-06-04 12:42:50"
     },
     {
     "customerId": "123457",
     "channelId": "9876",
     "delivered": false,
     "deliveryDetails": "Delivered",
     "status": "read",
     "date": "2019-06-04 12:42:38"
     }
 ]
 },
 "count": 2,
 "nextPageUrl": "http://social-sb.com/api/v2/customers-messages?messageId=1219&amp;startAt=2"

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/customers-messages?messageId=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);

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 ⇒ seules les interactions créées après la date passée en paramètre seront remontées

createBefore ⇒ seules les interactions créées avant la date passée en paramètre seront remontées

messageId ⇒ seuls les channels provenant du message dont l'id est égale à celui passé en paramètre seront remontés

channelType ⇒ seuls les channels dont le type est égale à celui passé en paramètre seront remontés

messageState ⇒ seuls les messages dont le statut est égal à celui passé en paramètre seront remontés. Les valeurs possibles du statut sont les suivantes :

deleted

archived

draft

programmed

active

waiting

done

marketingPressureLevel ⇒ seuls les messages dont le niveau de pression marketing est égale à celui passé en paramètre seront remontés

actionState ⇒ seules les interactions du même type que celui passé en paramètre seront remontées. Une interaction peut avoir 2 valeurs :

read

clicked

messageType ⇒ seuls les messages dont le type est égale à celui passé en paramètre seront remontés. Le type d'un message peut avoir 2 valeurs :

scenario

oneshot

delivered ⇒ seuls les channel dont la livraison est égale à celle passée en paramètre seront remontés. La livraison peut avoir 2 valeurs :

true

false

Les paramètres sur la pagination :

startAt ⇒ permet de commencer la liste des consentements à partir de l'occurence passée en paramètre

maxResult ⇒ permet de limiter le nombre de consentements remontés par pages (max 5000)

/customers-messages/{customerId} (GET)

Permet de récupérer tous les messages (via les canaux Email, Pop-up et SMS) envoyés à un profil, identifié par son customerId.

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