Listar mensagens | Muchaw DEV

Retorna uma lista paginada de mensagens. Filtre por número, direção, status, remetente ou destinatário.

AuthorizationBearer

API Key in the format mk_live_<43-chars>. Obtain from the Dashboard or POST /auth/api-keys.

number_idstringOptional

Filtrar por ID do número do WhatsApp

directionenumOptional

Filter by message direction

Allowed values:

statusstringOptional

Filter by delivery status (e.g., sent, delivered, read, failed)

toContactstringOptional

Filter by recipient contact (phone or BSUID)

fromContactstringOptional

Filter by sender contact (phone or BSUID)

limitintegerOptional1-100Defaults to 20

Maximum number of records to return (1-100, default 20)

offsetintegerOptional0-9007199254740991Defaults to 0

Number of records to skip for pagination (default 0)

Default Response

datalist of objects

Array of message records

paginationobject

Pagination metadata

401

Unauthorized Error

1	{
2	"data": [
3	{
4	"id": "msg_8f3a2b7c9d4e",
5	"numberId": "num_1234567890abcdef",
6	"waMessageId": "wam_9876543210fedcba",
7	"direction": "INBOUND",
8	"fromContact": "5511998765432",
9	"toContact": "bsuid_abc123xyz789",
10	"type": "text",
11	"body": "Olá, gostaria de saber mais sobre seus serviços.",
12	"status": "delivered",
13	"statusTimestamp": "2024-06-10T15:22:30Z",
14	"createdAt": "2024-06-10T15:20:00Z"
15	}
16	],
17	"pagination": {
18	"total": 1,
19	"limit": 1,
20	"offset": 0
21	}
22	}

$	curl https://dev.muchau.com.br/api/messages/ \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"