v1

latestOpenAPI 3.0.32026-07-24113102327.9 KB
messages

Retorna uma lista de mensagens.

Utilize este método para listar as mensagens enviadas através da sua conta na plataforma Vindi. Leia a documentação sobre paginação e filtros de busca.

Atributos para busca

<code>id</code>, <code>notification_type</code>, <code>notification_id</code>, <code>seen_at</code>, <code>customer_id</code>, <code>charge_id</code> e <code>created_at</code>.

get/v1/messages

Query parameters

pageinteger

Page of results to fetch.

per_pageinteger

Number of results to return per page.

querystring

Filtro para busca

sort_by'id' | 'notification_type' | 'notification_id' | 'seen_at' | 'customer_id' | 'charge_id' | 'created_at'

Atributo opcional para ordenação

sort_order'asc' | 'desc'

Sentido opcional para ordenação

Response

Consulta realizada com sucesso.

idinteger required

ID da mensagem

notification_type'email' | 'sms' required

Tipo da notificação da mensagem

seen_atstring

Última visualização da mensagem

created_atstring required

Data e hora do envio da mensagem