Etapa 2: Conectar canal do chat

Descrição

🚧

Esteja ciente de que você não poderá executar esta etapa descrita acima diretamente na seção de Referência da API devido a limitações da ferramenta: não é possível calcular os cabeçalhos necessários e enviar uma solicitação simultaneamente.

Para vincular um canal de chat a uma conta, você deve enviar uma solicitação POST com o channel_id e o ID da conta no corpo da solicitação.

Como resposta, você obterá um scope_id exclusivo para este canal, que será usado posteriormente para o envio de mensagens. Assim que o canal de chat for vinculado à conta Kommo, você poderá gerenciar mensagens e receber webhooks sobre mensagens enviadas.


🚧

A conexão deve ser estabelecida após cada instalação da integração na conta, pois o canal é automaticamente desativado quando a integração é desativada.

O corpo da solicitação será incluído duas vezes: uma como seu próprio corpo e outra como o MD5 do corpo, que será incluído na assinatura.

📘

Você deve escrever o corpo na sua solicitação da mesma forma que fez ao calcular os cabeçalhos.

Cabeçalhos e tipo de autorização

O processo de autorização para a API de Chat difere de outros métodos da API do Kommo. Ao contrário de outros métodos, a API de Chat não requer um Token de Acesso para autorização; em vez disso, você precisa incluir cabeçalhos específicos em todas as solicitações.

Requisitos gerais para solicitações da API de Chat

  • Todas as solicitações para a API de Chat devem ser enviadas para o domínio amojo.kommo.com e incluir os seguintes cabeçalhos: Date, Content-Type, Content-MD5, X-Signature.
  • Os parâmetros devem ser incluídos no corpo da solicitação em formato JSON.
  • A API de Chat possui tipagem rigorosa, portanto, certifique-se de que o tipo de argumento esperado corresponda à descrição do parâmetro.

🚧

É importante não usar uma secret key no frontend do widget. Quaisquer solicitações usando a chave secreta devem ser feitas apenas a partir da parte backend do seu aplicativo.

Cabeçalho do tipo de dados quando a solicitação é bem-sucedida/em caso de erro.
Content-Type: application/json

Parâmetros de resposta

ParâmetroTipo de dadoDescrição
account_idstringID do participante do chat no lado da Kommo (amojo_id)
scope_idstringUUID, scope_id da conta para o seu canal
titlestringNome do bot
hook_api_versionstringA versão da API do Chat
Language