v1Recursos/Reviews/getListar aprovações de respostas

Listar aprovações de respostas

Lista as solicitações de aprovação de respostas. Uma aprovação de resposta é um rascunho de resposta a uma avaliação que sua agência envia a um ou mais usuários do portal do cliente para aprovação antes de ir ao ar. Quando um usuário do cliente aprova, a Synup publica exatamente o texto aprovado, incluindo a edição dele; ele também pode agendar para mais tarde ou pedir alterações. A resposta traz a solicitação mais recente de cada avaliação, da mais nova para a mais antiga, entre no máximo 200 solicitações, além da contagem de solicitações aguardando o cliente e das devolvidas com pedido de alterações. Um token restrito a clientes vê apenas os próprios clientes.

get/api/v1/reviews/reply-approvals
reviews:read
Parâmetros de consulta
clientIdstringopcional
Retornar apenas solicitações deste cliente.
statusstring (pending | changes_requested | approved | scheduled | posted | failed | withdrawn | cancelled)opcional
Retornar apenas solicitações com este status.
reviewIdsstringopcional
IDs de avaliações separados por vírgula, até 200. Retornar apenas solicitações destas avaliações.
Resposta
dataobjectopcional
countsobjectopcional
Totais dos clientes do token, ou de clientId quando você o envia. status e reviewIds não os restringem.
awaitingintegeropcional
Solicitações aguardando o cliente (pending).
changesRequestedintegeropcional
Solicitações que o cliente devolveu pedindo alterações (changes_requested).
requestsarray of objectopcional
A solicitação mais recente de cada avaliação correspondente, da mais nova para a mais antiga.
reviewIdstringopcional
A avaliação a que esta solicitação se refere.
idstringopcional
O ID da solicitação. Use-o para ler o histórico, enviar um lembrete ou retirar a solicitação.
statusstring (pending | changes_requested | approved | scheduled | posted | failed | withdrawn | cancelled)opcional
Em que pé está a solicitação: pending (aguardando o cliente), changes_requested (o cliente pediu alterações; continua aberta, então ele ainda pode aprovar ou você pode enviar uma resposta revisada), approved (aprovada e sendo publicada), scheduled (aprovada para publicar em scheduledFor), posted (a resposta está no ar), failed (a publicação falhou, veja error), withdrawn (sua agência a retirou) ou cancelled (a avaliação foi respondida de outra forma ou removida).
versionHashstringopcional
Uma impressão digital do texto. Ela muda sempre que o texto muda, e a decisão do cliente só vale para a versão que ele viu.
textstringopcional
A resposta da solicitação. Se um cliente a editou e decidiu, é a versão dele.
notestringopcional
Sua mensagem para os usuários do cliente, ou null.
requestedAtstringopcional
Quando a solicitação foi criada.
scheduledForstringopcional
Quando uma resposta agendada será publicada, ou null.
errorstringopcional
Por que a publicação falhou, ou null.
assigneesarray of objectopcional
Os usuários do portal do cliente a quem a solicitação foi enviada.
idstringopcional
O ID do usuário do cliente.
namestringopcional
O nome dele, ou o e-mail quando não há nome cadastrado.
emailstringopcional
O endereço de e-mail dele.
decidedBystringopcional
O nome do usuário do cliente que decidiu, ou null.
seenobjectopcional
Se alguém abriu a solicitação, e onde.
emailbooleanopcional
true assim que alguém a abriu pelo e-mail.
portalbooleanopcional
true assim que alguém a viu no portal.
lastCommentobjectopcional
O comentário mais recente de um usuário do cliente, ou null.
bodystringopcional
O texto do comentário.
bystringopcional
O nome do usuário do cliente que o escreveu.
atstringopcional
Quando foi escrito.
emailSkippedstringopcional
Por que o último e-mail de notificação não foi enviado, como um código curto (por exemplo switched_off quando a pessoa desativou esses e-mails, ou portal_domain_required quando a agência não tem domínio de portal). null quando o e-mail foi enviado ou ainda não foi tentado. Em qualquer caso, a solicitação continua aguardando no portal.
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.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/reviews/reply-approvals
Sua chave de API
clientId
status
reviewIds
{}

Guias que usam este recurso