Pular para o conteúdo

GET /v1/scheduled-messages/{id}

GET
/v1/scheduled-messages/{id}
curl --request GET \
--url https://seu-endereco-da-api/v1/scheduled-messages/example \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler conversas (conversations:read).

id
required
string
Media typeapplication/json
object
id
required
string
conversationId
required
string
contactId
required
string
contactName
required
string
nullable
contactPhone
required
string
nullable
contactProfilePicUrl
required

Presigned url for the contact’s whatsapp profile photo

string
nullable
channelId
required
string
channel
required

Null quando o canal foi apagado de vez

object
name
required

O nome que o cliente deu ao canal na plataforma

string
provider
required
string
status
required
string
coexistence
required
boolean
phoneNumber
required

O numero ou @ da conta no provedor

string
nullable
accountName
required

O nome da conta no provedor: o verificado da Meta, ou o do aparelho no canal lite

string
nullable
removed
required

O canal foi apagado; a conversa continua descrevendo por onde ela aconteceu

boolean
items
required
Array<object>
object
id
required
string
position
required
number
kind
required
string
type
required
string
text
required
string
nullable
mediaKey
required
string
nullable
mediaMime
required
string
nullable
fileName
required
string
nullable
mediaUrl
required
string
nullable
timezone
required
string
scheduleKind
required
string
runAt
required
string format: date-time
nullable
localTime
required
string
nullable
weekdays
required
Array<number>
dayOfMonth
required
number
nullable
holidayPolicy
required

Ignore, skip ou postpone: o que fazer quando a ocorrência cai num feriado

string
holidayConfigId
required

Horário comercial cujos calendários definem o feriado; nulo usa todos os calendários do tenant

string
nullable
fallbackTemplateId
required
string
nullable
fallbackHeaderMediaKey
required
string
nullable
fallbackHeaderMediaMime
required
string
nullable
sendAfter
required
string format: date-time
nullable
status
required
string
lastFiredAt
required
string format: date-time
nullable
lastError
required
string
nullable
occurrenceCount
required
number
recurrenceLabel
required
string
createdByUserId
required
string
nullable
authorName
required
string
nullable
authorAvatarUrl
required

Public url for the author’s photo

string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
canManage
required

The caller holds conversations:write and may act on the schedule’s conversation (edit, pause, delete)

boolean

Example generated

{
"id": "example",
"conversationId": "example",
"contactId": "example",
"contactName": "example",
"contactPhone": "example",
"contactProfilePicUrl": "example",
"channelId": "example",
"channel": {
"name": "example",
"provider": "example",
"status": "example",
"coexistence": true,
"phoneNumber": "example",
"accountName": "example",
"removed": true
},
"items": [
{
"id": "example",
"position": 1,
"kind": "example",
"type": "example",
"text": "example",
"mediaKey": "example",
"mediaMime": "example",
"fileName": "example",
"mediaUrl": "example"
}
],
"timezone": "example",
"scheduleKind": "example",
"runAt": "2026-04-15T12:00:00Z",
"localTime": "example",
"weekdays": [
1
],
"dayOfMonth": 1,
"holidayPolicy": "example",
"holidayConfigId": "example",
"fallbackTemplateId": "example",
"fallbackHeaderMediaKey": "example",
"fallbackHeaderMediaMime": "example",
"sendAfter": "2026-04-15T12:00:00Z",
"status": "example",
"lastFiredAt": "2026-04-15T12:00:00Z",
"lastError": "example",
"occurrenceCount": 1,
"recurrenceLabel": "example",
"createdByUserId": "example",
"authorName": "example",
"authorAvatarUrl": "example",
"createdAt": "2026-04-15T12:00:00Z",
"updatedAt": "2026-04-15T12:00:00Z",
"canManage": true
}