v1

latestOpenAPI 3.0.12026-07-26105162235.7 KB

Conversas

Enviar mensagem síncrona

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.<br />O envio da mensagem será síncrono, então ele pode demorar um tempo até que o servidor do canal de atencimento responda com um status válido para a mensagem.<br />O tempo máximo que este metodo esperará uma resposta é de 25 segundos, após este tempo ele entregará a última situação da mensagem;

post/v1/session/{id}/message/sync

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

updatedAtstring date-time

timestampstring date-time nullable

senderIdstring nullable

sessionIdstring uuid

templateIdstring uuid nullable

userIdstring uuid nullable

direction'FROM_HUB' | 'TO_HUB'

textstring nullable

fileIdstring uuid nullable

refIdstring uuid nullable

readContactAtstring date-time nullable

failedReasonstring nullable

filesIdsstring[] nullable