v1

latestOpenAPI 3.0.12026-07-26105162235.7 KB

Conversas

Enviar mensagem

Este endpoint segue as mesmas regras do canal de atendimento, por exemplo: uma conversa só pode ser iniciada no WhatsApp utilizando um modelo de mensagem.<br />Caso o contato não esteja cadastrado, ele será cadastrado automaticamente antes do envio. O envio da mensagem será assincrono, ao enviar a mensagem será salva em uma fila de disparo, e será processada posteriormente. Para verificar a situação do envio, consulte pelo endereço /chat/v1/message/{}/status

post/v1/session/{id}/message

Path parameters

idstring uuid required

Request body

textstring nullable

Texto da mensagem a ser enviada. Obrigatório caso não seja informado o parâmetro templateId ou fileUrl.

templateIdstring nullable

ID do modelo de mensagem para a mensagem a ser enviada. Obrigatório caso não seja informado o parâmetro text ou fileUrl.

parametersobject nullable

Parâmetros do modelo de mensagem. Obrigatório caso o modelo de mensagem informado no templateId possua parâmetros.

fileUrlstring nullable

URL pública de algum arquivo que deseja-se enviar na mensagem. O arquivo enviado deverá seguir as regras do canal de atendimento.

fileIdstring uuid nullable

Código do arquivo que deseja-se enviar na mensagem, o ID pode ser obtido nas rotas /core/v2/file, o arquivo deverá seguir as regras do canal de atendimento.

refIdstring uuid nullable

ID de referência para identificar a mensagem externamente como resposta a uma mensagem anterior.

Response

Success

idstring uuid

createdAtstring date-time nullable

updatedAtstring date-time

sessionIdstring uuid nullable

senderIdstring nullable

statusUrlstring nullable

failureReasonstring nullable