Skip to main content
GET
/
scheduled-message
Listar mensagens agendadas
curl --request GET \
  --url http://localhost:3001/scheduled-message/ \
  --header 'X-JuriChat-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "conversationId": "<string>",
      "userId": "<string>",
      "type": "<string>",
      "scheduledAt": "2023-11-07T05:31:56Z",
      "status": "PENDING",
      "sentAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "conversation": {
        "id": "<string>",
        "person": {
          "id": "<string>",
          "name": "<string>",
          "phoneNumber": "<string>"
        },
        "group": {
          "id": "<string>",
          "name": "<string>"
        }
      },
      "content": "<unknown>",
      "metadata": "<unknown>"
    }
  ],
  "totalResults": 123,
  "totalPages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.jurichat.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

X-JuriChat-Api-Key
string
header
required

Chave de API do escritório (criada no painel). Envie o valor no header X-JuriChat-Api-Key.

Query Parameters

page
default:1

Número da página.

limit
default:20

Quantidade de itens por página.

conversationId
string

Filtra pelo ID da conversa.

Pattern: ^[cC][^\s-]{8,}$
inboxId
string

Filtra pelo ID da inbox.

Pattern: ^[cC][^\s-]{8,}$
status
enum<string>

Filtra pelo status do agendamento.

Available options:
PENDING,
SENT,
CANCELLED

Response

Default Response

data
object[]
required

Itens da página atual.

totalResults
number
required

Total de registros encontrados.

totalPages
number
required

Total de páginas para a quantidade solicitada.