Iniciar Ticket

URL Base

A URL base padrão é https://api.pg.iappbr.com.br/api/v1/, seguida pelo endpoint específico do caminho.

Endpoint

POST /ticket/{channel_id}

Obtendo os IDs Necessários

Obter o ID do Canal (channel_id)

1. Acesse a seção "Meus Números" na plataforma.

2. Selecione o canal específico para o qual deseja enviar a mensagem.

3. Na barra de endereço do navegador, copie o ID do canal após /channels/{channel_id}.

Obter o ID do Template (template_id)

1. Certifique-se de que você tenha um template criado. Aprenda a criar um template aqui.

2. Na página do canal selecionado, vá para a seção "templates".

3. Ao lado do nome do template desejado, clique no botão de cópia para copiar o ID do template.

Obter o ID do Departamento e Agente/Atendente (department_id e attendant_id)

Aprenda a obter os IDs aqui.

Enviando uma Mensagem

Requisição na API

curl --request POST \
  --url 'https://api.pg.iappbr.com.br/api/v1/ticket/{channel_id}' \
  --header 'Authorization: Bearer SEU_TOKEN_AQUI' \
  --header 'Content-Type: application/json' \
  --data '{
    "attendant_id": "{attendant_id}",
    "department_id": "{department_id}",
    "message": {
      "type": "DOCUMENT",
      "link": "https://exemplo.com/documento.pdf"
    },
    "params": [
      "Parametro1",
      "Parametro2"
    ],
    "phone_number": "5511999999999",
    "template_id": "{template_id}"
}'

Estrutura da Mensagem

Campos Obrigatórios:

• attendant_id: ID do atendente.

• department_id: ID do departamento.

• phone_number: Número de telefone do destinatário em formato E.164.

• template_id: ID do template aprovado.

• params: Array de strings com os parâmetros a serem substituídos no template, na sequência que aparecem. Necessário somente se o template tiver variáveis. {N}, Quick_Reply, URL {N}, Copy_Code.

Campos Opcionais:

• message: Objeto contendo detalhes adicionais da mensagem. Necessário somente se o template for do tipo mídia (imagem, documento).

  • type: Tipo de mídia. Valores possíveis são: IMAGE, DOCUMENT.

  • link: Link para o arquivo de mídia.

Resultado do Envio

Após o envio, o resultado final que temos na API é este:

{
  "status": "success",
  "data": {
    "chat_id": "string",
    "ticket_id": "string",
    "contact_id": "string"
  }
}

Na Aplicação o chat deve ter sido criado, no status de ATIVO.

• https://app.iappbr.com/chats/{chat_id} -> Leva para o chat na aplicação.

Exemplo

Neste exemplo temos um Template com 5 variáveis que teremos que passar por parâmetro:

Observando o template, temos os seguintes parâmetros que foram inseridos na criação:

• Body / Corpo -> 3 Parâmetros

  • Victor

  • 25/10/2023

  • Cupom#123

• Botão - Copiar Código -> 1 Parâmetro

  • example

• Botão - Abrir Link + {{1}} -> 1 Parâmetro

  • Cupom#123

Sabendo destes parâmetros, podemos enviar os params na seguinte forma:

"params": ["João", "01/01/2024", "0002", "0002", "0002"]