Transferir informações de digitação

O método fornece a transferência de informações de que o cliente está digitando algo no mensageiro. A informação será exibida na interface da Kommo.

🚧

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.

Você precisa enviar a solicitação duas vezes:

  • na primeira vez, você verá que o cliente está no perfil


  • na segunda vez, você verá que o cliente está digitando


Cabeçalhos e tipo de autorização

ParâmetroTipo de dadoDescrição
DatestringData e hora em que a solicitação foi gerada. A assinatura será válida por 15 minutos a partir dessa data. A data deve estar no formato “Thu, 01 Jan 2023 12:00:00 +0000” (RFC2822).
Content-typestringTipo de dados da solicitação. Atualmente, apenas application/json é suportado.
Content-MD5stringPara o corpo da solicitação, é necessário calcular o hash MD5 e indicá-lo no cabeçalho em letras minúsculas. Ao mesmo tempo, é importante lembrar que o corpo da solicitação é calculado como um fluxo de bytes, sem considerar o final da marcação JSON, e se houver “\n” ou espaços no final, eles também serão levados em conta.
X-SignaturestringAssinatura da solicitação como uma string. Ela é formada a partir do nome do método (GET/POST) em maiúsculas, com os valores dos cabeçalhos concatenados por “\n”. Os valores dos cabeçalhos são organizados em uma ordem específica. Se não houver cabeçalho, uma string vazia é especificada em seu lugar. Em seguida, adicione o caminho solicitado da URL sem o protocolo e o domínio (sem parâmetros GET) à string. A string resultante é calculada usando HMAC-SHA1 e, como segredo, utilizamos a chave secreta do canal obtida durante o registro. O hash resultante, em letras minúsculas, é indicado no cabeçalho X-Signature.

Cabeçalho de tipo de dado quando a solicitação é bem-sucedida ou em caso de erro
Content-Type: application/hal+json

Resposta

O método não retorna um corpo em caso de solicitação bem-sucedida, mas aparece na interface do Kommo que o cliente está digitando.

Path Params
string
required

Você pode obter o ID do escopo na Etapa 2.

Body Params
string

ID do chat no lado da integração

sender
object

ID do usuário no lado da integração

Headers
string

Tipo de dados da solicitação. Atualmente, apenas application/json é suportado.

string

Data e hora em que a solicitação foi gerada. A assinatura será válida por 15 minutos a partir dessa data. A data deve estar no formato “Qui, 01 Jan 2023 12:00:00 +0000” (RFC2822).

string

Para o corpo da solicitação, é necessário calcular o hash MD5 e indicá-lo no cabeçalho em letras minúsculas. É importante lembrar que o corpo da solicitação é calculado como um fluxo de bytes, sem considerar o final da marcação JSON, e se houver “\n” ou espaços no final, eles também serão levados em conta. Para solicitações GET, o MD5 também deve ser calculado. Mesmo que nada seja passado no corpo da solicitação, o MD5 será obtido de uma string vazia.

string

Assinatura da solicitação como uma string. Ela é formada a partir do nome do método (GET/POST) em letras maiúsculas, com os valores dos cabeçalhos concatenados por “\n”. Os valores dos cabeçalhos vêm em uma ordem específica. Se não houver cabeçalho, é especificada uma string vazia. Em seguida, adicione o caminho solicitado da URL sem o protocolo e domínio (sem parâmetros GET) à string. A string resultante é calculada usando HMAC-SHA1 e, como segredo, usamos a chave do canal obtida durante o registro. O hash resultante em letras minúsculas é indicado no cabeçalho X-Signature.

Responses

Language
Choose an example:
application/json