Messages: Listar
GET
https://{organization}.myguper.com/api/sender/messages
View paginada de message_process_queue (modo admin excluído) com
um resumo de dispatcher por linha. Alimenta a tela de log de
mensagens no admin.
Para descobrir qual mensagem iniciou uma conversa a partir de um
telefone, filtre por cellphone (exato) e peça o corpo com
include=rendered_body — uma chamada devolve as mensagens recentes
para aquele número já com o texto renderizado, sem round-trip de
detalhe e sem precisar resolver o cliente antes.
Try-it values populated from environment ACME (Demo)
Autenticação
Token
Send your user token in the x-guper-authorization header.
Cabeçalhos
| Name | Type | Description |
|---|---|---|
| x-guper-authorization * | string | User token issued by Guper. |
| Content-Type * | string | Always `application/json` for endpoints that accept a JSON body. |
Parâmetros de query
| Name | Type | Description |
|---|---|---|
| q[column][operator] | string | Filter using the `q[column][operator]=value` grammar. See [List query parameters](/docs/{lang}/guides/list-query-parameters) for the full operator table. |
| o[column] | string | Sort by column. Direction: `ASC`, `DESC`, `1` or `0`. |
| e | integer |
Items per page. Max `1000`. `0` for unlimited.
padrão:
20 |
| p | integer |
Page number (≥ 1).
padrão:
1 |
| mode | string | Filter by queue mode. |
| slug | string | Filter by message slug. |
| sequence | integer | Filter by sequence id. |
| template | integer | Filter by template id: messages that have at least one dispatcher sent with this template. Also accepted by `/messages/count`. |
| status | string | Filter by processing status. |
| startDate | string | `Y-m-d` (inclusive, 00:00:00). |
| endDate | string | `Y-m-d` (inclusive, 23:59:59). |
| person_id | integer | Filter by register person id (exact). |
| cellphone | string | Filter by recipient cellphone (exact match on the snapshot stored at send time). Skips resolving phone->person in register. |
| search | string | Substring match on person name/email/cellphone. |
| include | string | Comma list; adds rendered fields to each dispatcher in the list (opt-in, off by default). Allowed: `rendered_body`, `rendered_subject`, `rendered_text`, `rendered_meta`. |
| entries | integer |
padrão:
20 |
| page | integer |
padrão:
1 |
Respostas
Relacionados
Copied to clipboard