Envio de documento

URL Base

A URL base padrão para enviar mensagens de texto é https://go.api.iappbr.com/api/v1, seguida pelo endpoint específico do caminho.

Endpoint

POST /message/{channel_id}/document

Descrição Este endpoint é utilizado para enviar uma mensagem de texto por um canal específico. A mensagem será enviada para o número de telefone informado e é obrigatório ser informado o atendente.

Headers

• Authorization: Bearer Token de autenticação da empresa.

Parâmetros de URL

• channel_id: O ID do canal para onde a mensagem será enviada.

Parâmetros do Corpo (Request Body)

{
  "attendant_id": "string",
  "department_id": "string",
  "phone_number": "string",
  "document_link": "string",
  "document_name": "string",
  "force_change_to_active": "boolean"
}

Parâmetro	Tipo	Descrição
attendant_id	string	ID do atendente responsável por enviar a mensagem.
department_id	string	(Opcional) ID do departamento. Necessário se for forçar a ativação.
phone_number	string	Número de telefone para o qual a mensagem será enviada. Deve estar no formato E.164.
image_link	string	Link recebido do upload da imagem a ser enviada. (Deve ser de nosso CDN)
image_name	string	Nome do Documento a ser exibido. Ex: documento.pdf
force_change_to_active	boolean	Define se o chat será forçado a mudar para o status "ativo". Útil se o chat estiver no chatbot ou aguardando.

---

Resposta (Response Body)

Se a mensagem for enviada com sucesso, o sistema retornará um objeto com informações sobre o evento de envio e detalhes do chat:

{
  "status": "success",
  "data": {
    "event_id": "string",
    "meta_id": "string",
    "ticket_id": "string",
    "chat_id": "string"
  }
}

Parâmetro	Tipo	Descrição
event_id	string	ID do evento gerado pelo envio da mensagem. Utilizado para recuperação de evento
meta_id	string	ID da mensagem atrelado à META.
ticket_id	string	ID do ticket ao qual a mensagem está vinculada.
chat_id	string	ID do chat no qual a mensagem foi enviada.

---

Erros Possíveis

Erros Possíveis ao Enviar Mensagem com Documento

Status	Erro	Descrição
400	Parâmetros inválidos	Ocorre quando os parâmetros da requisição estão ausentes ou em formato incorreto. Os parâmetros obrigatórios são phone_number, document_link e document_name.
400	Atendente não encontrado	Ocorre quando o attendant_id fornecido não corresponde a um atendente válido da empresa.
400	Departamento não encontrado	Ocorre quando o department_id fornecido não corresponde a um departamento válido da empresa.
400	Erro ao buscar contato	Ocorre quando o sistema não consegue encontrar ou criar um contato com o número de telefone informado.
400	Erro ao buscar chat	Ocorre quando o sistema não consegue encontrar ou criar um chat para o contato.
500	Erro ao obter ticket	Ocorre quando o sistema não consegue recuperar ou criar um ticket para o chat.
500	Erro ao buscar documento	Ocorre quando o documento não pode ser baixado do link fornecido.
400	Documento não encontrado	Ocorre quando o servidor retorna um status diferente de 200 OK ao tentar acessar o link do documento.
500	Erro ao processar documento	Ocorre quando há problemas ao ler os dados do documento baixado.
400	Erro ao processar o número de telefone	Ocorre quando o formato do número de telefone resulta em um JID (identificador do WhatsApp) inválido.
500	Erro interno do Servidor	Erro interno do Servidor

Exemplo de Erro:

{
  "status": "error",
  "message": "Erro ao buscar documento"
}

---

Observações

• Certifique-se de que o número de telefone esteja no formato correto ([phone]) ao enviar a mensagem.

• Caso o chat esteja criado ou aguardando, use a opção force_change_to_active para forçar a ativação do chat.

• Erros específicos do chat, como "Departamento não encontrado", devem ser tratados adequadamente para evitar falhas na comunicação.