/channels-messages/{id} (GET)

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

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

Verb: GET

Paramètres obligatoires:

id : identifiant SPREAD du channel

Paramètres complémentaires:

Aucun

Réponse:

"channel":
{
     "id": "1234",
     "name": "SMS de relance",
     "messageId": "4321",
     "type": "sms",
     "state": "on",
     "createdAt": "2018-06-26 13:31:34",
     "deliveryDelay": "0",
     "deliveryTime": "14:00",
     "deliveryCondition": "no delay",
     "errorCount": "0",
     "toDeliverCount": "0",
     "deliveredCount": "0",
     "readCount": "0",
     "clickedCount": "0"
}

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/channels-messages/1234");
curl_setopt($curl, CURLOPT_USERPWD, "cle_publique:cle_privee"); // À remplacer par les clés d'API publique et privée dans votre back office, menu "Paramétrage > Tracker" en bas de page
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$curl_return = curl_exec($curl);
var_dump($curl_return);
curl_close($curl);

/channels-messages (GET)

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

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

Verb: GET

Paramètres obligatoires:

Aucun

Paramètres complémentaires:

Aucun

Réponse:

"channels":
[
 {
     "id": "1256",
     "name": "Popup d'invitation",
     "messageId": "1171",
     "type": "widget",
     "state": "on",
     "createdAt": "2017-08-28 12:52:40",
     "deliveryDelay": "0",
     "deliveryTime": "08:00",
     "deliveryCondition": "if precedent is not read after X days",
     "errorCount": "0",
     "toDeliverCount": "0",
     "deliveredCount": "0",
     "readCount": "0",
     "clickedCount": "0"
 },
 {
     "id": "1257",
     "name": "Email principal",
     "messageId": "1171",
     "type": "email",
     "state": "on",
     "createdAt": "2017-08-28 12:52:40",
     "deliveryDelay": "2",
     "deliveryTime": "10:00",
     "deliveryCondition": "forced delay of X days",
     "errorCount": "0",
     "toDeliverCount": "0",
     "deliveredCount": "0",
     "readCount": "0",
     "clickedCount": "0"
 }
]
"count": 2,
"nextPageUrl": "http://social-sb.com/api/v2/channels-messages?startAt=2"

Exemple d'appel PHP :

$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "https://social-sb.com/api/v2/channels-messages");
curl_setopt($curl, CURLOPT_USERPWD, "cle_publique:cle_privee"); // À remplacer par les clés d'API publique et privée dans votre back office, menu "Paramétrage > Tracker" en bas de page
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 channels créés après la date passée en paramètre seront remontés

createBefore ⇒ seuls les channels créés avant la date passée en paramètre seront remontés

modifiedAfter ⇒ seuls les channels modifiés après la date passée en paramètre seront remontés

modifiedBefore ⇒ seuls les channels modifiés avant la date passée en paramètre seront retournés

messageId ⇒ seuls les channels appartenant au message dont l'identifiant est égale à celui passé en paramètre seront remontés

type ⇒ seuls les channels du même type que celui passé en paramètre seront remontés. Le type peut avoir 3 valeurs : widget, sms ou email

deliveryCondition ⇒ seuls les channels ayant les mêmes conditions d'envoi seront remontés. Les conditions d'envoi peuvent avoir 4 valeurs :

no_delay s'il n'y a aucune condition de délai,

precedent_not_read si le précédent channel n'a pas été lu au bout de X jours,

forced_delay délai systématique de X jours

precedent_read si le channel précédent a été lu au bout de X jours

errorMoreThan, toDeliverMoreThan, deliveredMoreThan, readMoreThan et clickedMoreThan ⇒ seuls les channels dont les compteurs (respectivement) errorCount, toDeliverCount, deliveredCount, readCount et clickedCount sont supérieurs aux valeurs passées en paramètres seront remontés

errorMoreLess, toDeliverMoreLess, deliveredMoreLess, readMoreLess et clickedMoreLess ⇒ seuls les channels dont les compteurs (respectivement) errorCount, toDeliverCount, deliveredCount, readCount et clickedCount sont inférieurs aux valeurs passées en paramètres seront remontés

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)

🆘

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

Channel message

/channels-messages/{id} (GET)

/channels-messages (GET)