v1Ressourcen/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/inboxQuery-Parameter
kindstring (comment | message | mention)optional
Only this kind of item.
platformstringoptional
A network key, for example instagram.
statusstring (open | resolved)optional
Only open or only resolved items.
clientIdstringoptional
Only this client's items.
keywordstringoptional
Text or @handle to search for.
pageintegeroptional
The page number, from 0.
Antwort
dataobjectoptional
itemsarray of objectoptional
The items.
totalintegeroptional
How many items match the filters.
pageintegeroptional
This page's number.
pageSizeintegeroptional
How many items a page holds.
Fehler
400Der Anfrage fehlt ein erforderlicher Parameter, oder sie ist anderweitig fehlerhaft.
401API-Schlüssel fehlt, ist ungültig, abgelaufen oder widerrufen.
403Dem Schlüssel fehlt die erforderliche Berechtigung, oder er ist für diesen Kunden/Standort nicht autorisiert.
404Die Ressource wurde nicht gefunden oder gehört nicht zu Ihrer Agentur.
429Zu viele Anfragen. Versuchen Sie es nach der im Retry-After-Header angegebenen Anzahl Sekunden erneut.
get/api/v1/inbox
Ihr API-Schlüssel
kind
platform
status
clientId
keyword
page
{}