Sign in

v1

latestOpenAPI 3.0.12026-07-26105162235.7 KB
Mensagens Agendadas

Obter por ID

Retorna os detalhes de uma mensagem agendada específica.

get/v1/scheduled-message/{id}

Path parameters

idstring uuid required

ID da mensagem agendada

Query parameters

includeDetailsstring[]

Detalhes adicionais a serem incluídos

Response

Success

idstring uuid

Identificador único da mensagem agendada

createdAtstring date-time

Data e hora de criação da mensagem agendada

updatedAtstring date-time

Data e hora da última atualização da mensagem agendada

activeboolean

Indica se a mensagem agendada está ativa

companyIdstring uuid

Identificador da empresa associada à mensagem agendada

sessionIdstring uuid nullable

Identificador da sessão

contactIdstring uuid

Identificador do contato que receberá a mensagem

userIdstring uuid

Identificador do usuário que criou a mensagem agendada

channelIdstring uuid

Identificador do canal onde a mensagem será enviada

departmentIdstring uuid nullable

ID da equipe

status'SCHEDULED' | 'PROCESSED' | 'SENT' | 'DELIVERED' | 'READ' | 'CANCELED' | 'FAILED'

Status atual da mensagem agendada

type'TEMPLATE' | 'CHATBOT'

Tipo da mensagem agendada

templateIdstring uuid nullable

Identificador do template utilizado

botIdstring uuid nullable

Chave do chatbot associado

schedulingstring date-time

Data e hora programada para envio da mensagem

hiddenSessionboolean

Indica se a sessão deve ficar oculta

failureReasonstring nullable

Indica o motivo de falha caso ocorra