v1
latestOpenAPI 3.1.02026-07-26160119.8 KBPublic API
Lista as mensagens SMS recebidas por um número virtual, ordenadas por data de recebimento decrescente (receivedAt), com paginação. Útil para reprocessar notificações de webhook perdidas.
get/api/v2/virtual-phone-accounts/{id}/sms-messages
Path parameters
idstring required
Query parameters
pageinteger required
Número da página, iniciando em 1.
Example:1
pageSizeinteger required
Tamanho da página. Máximo de 200.
Example:50
receivedAtFromstring date-time
Filtra mensagens recebidas a partir desta data (inclusivo), em formato ISO8601.
Example:2025-09-01T00:00:00Z
receivedAtTostring date-time
Filtra mensagens recebidas até esta data (exclusivo), em formato ISO8601.
Example:2025-10-01T00:00:00Z
servicestring[]
Filtra mensagens cujo serviço detectado esteja na lista informada. Passe múltiplos valores repetindo o parâmetro (?service=whatsapp&service=google). Use none para incluir mensagens sem nenhum serviço detectado.
Response
Example response
{
"smsMessages": [
{
"id": "0140a8c6-3815-45b7-9e60-8e137cad845c",
"receivedAt": "2025-09-03T00:00:00Z",
"originPhoneNumber": "23456",
"destinationPhoneNumber": "+5511987654321",
"message": "Seu codigo de verificação e 123456",
"detections": {
"whatsapp": {
"verificationCode": "123456"
},
"google": {
"verificationCode": "123456"
},
"telegram": {
"verificationCode": "123456"
},
"tiktok": {
"verificationCode": "123456"
},
"shopee": {
"verificationCode": "123456"
},
"amazon": {
"verificationCode": "123456"
},
"facebook": {
"verificationCode": "123456"
},
"nubank": {
"verificationCode": "123456"
},
"microsoft": {
"verificationCode": "123456"
},
"instagram": {
"verificationCode": "123456"
},
"hotmart": {
"verificationCode": "123456"
},
"discord": {
"verificationCode": "123456"
},
"godaddy": {
"verificationCode": "123456"
},
"twilio": {
"verificationCode": "123456"
},
"youtube": {
"verificationCode": "123456"
},
"claude": {
"verificationCode": "123456"
},
"samsung": {
"verificationCode": "123456"
},
"c6": {
"verificationCode": "123456"
},
"ifood": {
"verificationCode": "123456"
},
"paypal": {
"verificationCode": "123456"
},
"autodesk": {
"verificationCode": "123456"
},
"globo": {
"verificationCode": "123456"
},
"apple": {
"verificationCode": "123456"
},
"asaas": {
"verificationCode": "123456"
},
"mercado-livre": {
"verificationCode": "123456"
},
"wechat": {
"verificationCode": "123456"
},
"alipay": {
"verificationCode": "123456"
},
"airbnb": {
"verificationCode": "123456"
},
"snapchat": {
"verificationCode": "123456"
},
"hostgator": {
"verificationCode": "123456"
},
"messages": {
"verificationCode": "123456"
},
"sendpulse": {
"verificationCode": "123456"
},
"kwai": {
"verificationCode": "123456"
},
"salvy": {
"verificationCode": "123456"
},
"santander": {
"verificationCode": "123456"
},
"itau": {
"verificationCode": "123456"
},
"temu": {
"verificationCode": "123456"
},
"mercado-pago": {
"verificationCode": "123456"
},
"indeed": {
"verificationCode": "123456"
},
"zoom": {
"verificationCode": "123456"
},
"x": {
"verificationCode": "123456"
},
"hostinger": {
"verificationCode": "123456"
}
}
}
],
"pagination": {
"page": 1,
"pageSize": 50,
"totalCount": 123,
"totalPages": 3
}
}