Envio de documento

URL Base

A URL base padrão para enviar mensagens de texto é https://api.pg.iappbr.com.br/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

Status	Erro	Descrição
400	Chat não encontrado!	O chat vinculado ao número de telefone não foi encontrado no sistema.
400	O Chat está fechado	O chat foi encerrado e não é possível enviar mensagens até que um novo ticket seja iniciado.
400	Departamento não encontrado!	O atendente não pertence ao departamento vinculado ao chat, ou o departamento informado está errado.
400	O Chat está aguardando	O chat está aguardando resposta e não pode ser reativado sem a opção force_change_to_active.
400	O Chat está no chatbot	O chat está no chatbot e precisa de ativação forçada para continuar.
400	O Chat está expirado	O chat foi expirado e precisa ser reaberto.
400	Não existe Ticket Ativo para esse número.	Não há um ticket ativo vinculado ao número de telefone fornecido.
400	Por favor aguarde a resposta para poder enviar mensagens livres.	Não é possível enviar mensagens antes de receber uma resposta.
400	O Chat está aguardando, mas pertence a outro atendente.	O chat está aguardando e está vinculado a um atendente diferente do fornecido.
400	O Chat está aguardando, mas pertence a outro departamento. (Forneça o departamento)	O chat está vinculado a um departamento diferente, e o departamento deve ser fornecido.
400	Canal não encontrado (Setup incompleto).	O canal especificado não foi encontrado, ou a configuração está incompleta.
400	Canal não encontrado.	O canal especificado na URL não foi encontrado ou não pertence à empresa autenticada.
500	InternalServerErrorException	Erro interno no servidor ao tentar enviar a mensagem ou ao se comunicar com a API do WhatsApp.

Exemplo de Erro:

{
  "status": "error",
  "message": "Chat não encontrado!"
}

---

Observações

• Certifique-se de que o número de telefone esteja no formato correto (E.164) 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 "Chat fechado" ou "Departamento não encontrado", devem ser tratados adequadamente para evitar falhas na comunicação.

• No Caso de Chat Fechado inicie o ticket seguindo a documentação aqui