v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Obter uma lista de modelos

O método permite obter uma lista de modelos na sua conta.

get/api/v4/chats/templates

Query parameters

pageinteger

Página da lista de modelos

limitinteger

Número de entidades retornadas por solicitação (Máx. 50)

filter[external_id]string[]

Filtrar por ID externo. Um array de vários IDs.

withstring

Este método suporta apenas o parâmetro de revisões

Response

200

_pageinteger

Example response

{
  "_page": 1,
  "_links": {
    "self": {
      "href": "https://example.kommo.com/api/v4/chats/templates?page=1&limit=50"
    },
    "next": {
      "href": "https://example.kommo.com/api/v4/chats/templates?page=2&limit=50"
    }
  },
  "_embedded": {
    "chat_templates": [
      {
        "id": 734129,
        "account_id": 29439107,
        "name": "Modelo teste",
        "content": "Novo conteúdo. Nome do contato - {{contact.name}}",
        "created_at": 1640200627,
        "updated_at": 1640360627,
        "buttons": [
          {
            "text": "Botão 1",
            "type": "inline"
          }
        ],
        "external_id": "meu_id_externo",
        "type": "waba",
        "waba_footer": "meu rodapé",
        "waba_category": "UTILITY",
        "waba_language": "en",
        "waba_examples": {
          "{{contact.name}}": "Meu contato"
        },
        "waba_header": "Exemplo de cabeçalho",
        "waba_header_type": "text",
        "review_status": "review",
        "is_on_review": true,
        "_embedded": {
          "reviews": [
            {
              "id": 36337,
              "source_id": 13232340,
              "status": "review"
            }
          ]
        },
        "_links": {
          "self": {
            "href": "https://example.kommo.com/api/v4/chats/templates/7349"
          }
        }
      }
    ]
  }
}