get
https://{subdomain}.kommo.com/api/v4/talks
Este método retorna uma coleção de conversas existentes na conta.
Limitations
O método está disponível para todos os usuários da conta. Os dados retornados dependem dos direitos do usuário para o contato associado com a conversa.
Data type header when the request is successful
Content-Type: application/hal+json
Data type header in case of an error
Content-Type: application/problem+json
Parâmetros de resposta
| Parâmetro | Tipo de dado | Descrição |
|---|---|---|
| talk_id | int | ID da conversa |
| created_at | int | Data de criação da conversa no formato Unix Timestamp |
| updated_at | int | Data da última atualização da conversa em Unix Timestamp |
| rate | int | Avaliação da conversa passada através do robô de NPS |
| contact_id | int | ID do contato associado à conversa |
| chat_id | string | ID do chat associado à conversa |
| entity_id | int | null | ID da entidade relacionada à conversa |
| entity_type | string | null | Tipo de entidade relacionada. Valores possíveis: lead |
| status | string | Status da conversa. Valores possíveis: in_work – conversa está ativa, closed – conversa está fechada, nps_scheduled – pesquisa de NPS está agendada, nps_in_progress – pesquisa de NPS foi enviada e está pendente de resposta, with_error – conversa ativa, mas um erro ocorreu durante o fluxo do robô de NPS. |
| is_in_work | bool | Indica se a conversa está aberta |
| is_read | bool | Indica se a conversa foi lida |
| origin | string | Tipo de fonte por onde a conversa foi criada (por exemplo, telegram) |
| source_id | int | null | Fonte da conversa ID |
| account_id | int | ID da conta |
| _embedded | object | Dados de entidade incorporados |
| _embedded[contacts] | array | Dados do contato associado com a conversa (no máximo 1 Contato) |
| _embedded[contacts][0] | object | Objeto do Contato |
| _embedded[contacts][0][id] | int | ID do contato |
| _embedded[leads] | array | Dados do Lead associado com a conversa (no máximo 1 lead) |
| _embedded[leads][0] | object | Objeto do Lead |
| _embedded[leads][0][id] | int | ID do Lead |