v1Recursos/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/api/v1/inbox
inbox:read
Parâmetros de consulta
kindstring (comment | message | mention)opcional
Only this kind of item.
platformstringopcional
A network key, for example instagram.
statusstring (open | resolved)opcional
Only open or only resolved items.
clientIdstringopcional
Only this client's items.
keywordstringopcional
Text or @handle to search for.
pageintegeropcional
The page number, from 0.
Resposta
dataobjectopcional
itemsarray of objectopcional
The items.
totalintegeropcional
How many items match the filters.
pageintegeropcional
This page's number.
pageSizeintegeropcional
How many items a page holds.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/inbox
Sua chave de API
kind
platform
status
clientId
keyword
page
{}

Novo na API da Synup?