v1Ressources/Social Inbox/getList inbox items
List inbox items
Lists Social Inbox comments, direct messages and mentions, newest first, 20 per page. Filters apply before paging, so total counts only the matching items. Every item carries actions, which says what can be done to it through this API and, when something cannot, the reason.
get
inbox:read/api/v1/inboxParamètres de requête
kindstring (comment | message | mention)facultatif
Only this kind of item.
platformstringfacultatif
A network key, for example instagram.
statusstring (open | resolved)facultatif
Only open or only resolved items.
clientIdstringfacultatif
Only this client's items.
keywordstringfacultatif
Text or @handle to search for.
pageintegerfacultatif
The page number, from 0.
Réponse
dataobjectfacultatif
itemsarray of objectfacultatif
The items.
totalintegerfacultatif
How many items match the filters.
pageintegerfacultatif
This page's number.
pageSizeintegerfacultatif
How many items a page holds.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/inbox
Votre clé API
kind
platform
status
clientId
keyword
page
{}