Enviar mensagem - Documentação

curl --request POST \ --url https://api.jurichat.com/conversation/send-message \ --header 'Content-Type: multipart/form-data' \ --header 'x-jurichat-api-key: <api-key>' \ --form 'conversationId=<unknown>' \ --form 'message=<unknown>' \ --form 'type=<unknown>' \ --form 'file=<unknown>' \ --form 'caption=<unknown>' \ --form 'fileName=<unknown>' \ --form 'showResponsibleName=<unknown>' \ --form 'replyMessageId=<unknown>' \ --form 'contactName=<unknown>' \ --form 'contactPhoneNumber=<unknown>' \ --form 'templateName=<unknown>' \ --form 'variables=<unknown>' \ --form 'headerVariables=<unknown>' \ --form 'headerVariableNames=<unknown>' \ --form 'headerMedia=<unknown>' \ --form 'bodyVariableNames=<unknown>' \ --form 'buttonVariables=<unknown>'

Authorizations

x-jurichat-api-key

string

header

required

Chave de API do escritório (criada no painel). Envie o valor no header x-jurichat-api-key.

Body

multipart/form-data

conversationId

any

ID da conversa. Enviado como campo de formulário (multipart/form-data).

message

any

Texto da mensagem ou conteúdo conforme o tipo.

type

any

Tipo da mensagem: text, audio, image, video, document, contact ou template.

file

any

Arquivo de mídia. Obrigatório para tipos de mídia.

caption

any

Legenda da mídia. Opcional.

fileName

any

Nome do arquivo para documentos. Opcional.

showResponsibleName

any

Quando verdadeiro, exibe o nome do atendente na mensagem enviada.

replyMessageId

any

ID da mensagem à qual esta é uma resposta. Opcional.

contactName

any

Nome do contato. Obrigatório quando type for contact.

contactPhoneNumber

any

Telefone do contato. Obrigatório quando type for contact.

templateName

any

Nome do template WhatsApp. Obrigatório quando type for template.

variables

any

Variáveis do template em JSON array ou lista separada por vírgula. Opcional.

headerVariables

any

Variáveis do cabeçalho do template em JSON array ou lista separada por vírgula. Opcional.

headerVariableNames

any

Nomes das variáveis do cabeçalho em JSON array. Opcional.

headerMedia

any

Mídia do cabeçalho do template em JSON. Ex: {"format":"IMAGE","link":"https://..."}. Opcional.

bodyVariableNames

any

Nomes das variáveis do corpo em JSON array. Opcional.

buttonVariables

any

Variáveis de botões dinâmicos do template em JSON array. Ex: [{"index":0,"parameters":["valor"]}]. Opcional.

Response

Default Response

success

boolean

required

Indica se o envio foi aceito para processamento.