Skip to main content
GET
/
integrations
/
external
/
chats
/
{id}
/
scheduled-messages
Listar mensagens agendadas
curl --request GET \
  --url https://api.wegly.com.br/integrations/external/chats/{id}/scheduled-messages \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "records": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_scheduled": true,
      "status": "PENDING",
      "message_kind": "OPEN_MESSAGE",
      "cancel_reason": "USER_REQUEST",
      "cancel_reason_description": "<string>",
      "failure_reason": "<string>",
      "cancel_on_inbound": true,
      "scheduled_at": "2023-11-07T05:31:56Z",
      "processed_at": "2023-11-07T05:31:56Z",
      "sent_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sender_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "canceled_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payload": {
        "type": "text",
        "body": "<string>",
        "template": {
          "name": "<string>",
          "language": "<string>"
        },
        "template_fields": [
          {
            "component": "HEADER",
            "type": "TEXT",
            "index": 123,
            "button_index": 123,
            "card_index": 123,
            "value": "<string>"
          }
        ],
        "reference_wamid": "<string>"
      },
      "attachments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "file_name": "<string>",
          "mime_type": "<string>",
          "file_size": 123
        }
      ],
      "sent_message_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Utilize o token de integração no header Authorization: Bearer {token}. O domínio de origem (Origin/Referer) deve respeitar allowed_domain, quando configurado na chave.

Path Parameters

​
id
string<uuid>
required

UUID do chat.

Query Parameters

​
search
string

Busca textual por título ou código (quando numérico).

​
skip
integer
default:0

Quantidade de registros a pular (offset). Padrão 0.

Required range: x >= 0
​
take
integer
default:10

Quantidade de registros a retornar. Padrão 10.

Required range: x >= 1
​
status
enum<string>

Status da mensagem agendada.

Available options:
PENDING,
PROCESSING,
SENT,
CANCELED,
FAILED

Response

Lista de mensagens agendadas.

​
total
integer
​
records
object[]