KOkommo

Obter conversas

Este método retorna uma coleção de conversas existentes na conta.

get/api/v4/talks

Request

  • Base URL
    https://subdomain.kommo.com
  • URL
    https://subdomain.kommo.com/api/v4/talks
  • Auth
    OAuth 2

Query parameters

pageinteger

Página de resposta

limitinteger

Número de entidades retornadas por requisição (limite – 250)

filter[talk_id][]integer[]

Filtrar conversa pelo seu ID. Aceita tanto um único ID quanto um array de IDs

filter[contact_id][]integer[]

Filtrar pelo ID do contato. Aceita tanto um único ID quanto um array de IDs

filter[entity_id][]integer[]

Filtrar pelo ID de entidade (lead). Aceita tanto um único ID quanto um array de IDs. Deve ser usado com o filter[entity_type]

filter[entity_type]string

po de entidade para filtrar pelo entity_id. Valores possíveis: lead

filter[only_in_work]string

O parâmetro é opcional e não requer um valor. Se presente, apenas conversas abertas serão retornadas

Response

Requisição bem-sucedida

_total_itemsinteger

Example response

{
  "_total_items": 1,
  "_embedded": {
    "talks": [
      {
        "talk_id": 249,
        "created_at": 1773754561,
        "updated_at": 1773762171,
        "contact_id": 24602666,
        "chat_id": "307d7d92-6d7c-4f14-aa4f-795b403e9fc5",
        "entity_id": 20139824,
        "entity_type": "lead",
        "status": "in_work",
        "is_in_work": true,
        "origin": "kommo_origin",
        "source_id": 43444,
        "account_id": 2921238,
        "_links": {
          "self": {
            "href": "https://subdomain.kommo.com/api/v4/talks/249?page=1&limit=1"
          }
        },
        "_embedded": {
          "contacts": [
            {
              "id": 24602666,
              "_links": {
                "self": {
                  "href": "https://subdomain.kommo.com/api/v4/contacts/24602666?page=1&limit=1"
                }
              }
            }
          ],
          "leads": [
            {
              "id": 20139824,
              "_links": {
                "self": {
                  "href": "https://subdomain.kommo.com/api/v4/leads/20139824?page=1&limit=1"
                }
              }
            }
          ]
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.