O método permite obter uma lista de modelos na sua conta.
Limitações
O método está disponível com direitos de administrador.
O método retorna apenas os modelos que foram criados pela integração atual.
Cabeçalho de tipo de dados em caso de sucesso
Content-Type: application/hal+json
Cabeçalho de tipo de dados em caso de erro
Content-Type: application/problem+json
Parâmetros de resposta
Parâmetro | Tipo de dado | Descrição |
---|---|---|
| int | ID do modelo |
| int | ID da conta à qual o modelo pertence |
| string | Nome do modelo |
| string | Corpo do modelo (a mensagem que é enviada ao usuário) |
| bool | Define se os usuários podem editar o modelo por meio da interface da Kommo. |
| string | Tipo do modelo |
| array | Array de objetos de botão |
| obj | Um objeto de botão |
| string | Tipo de botão. As opções disponíveis são |
| string | Texto no botão |
| string | URL do botão do tipo |
| object|null | Objeto do arquivo adicionado ao modelo |
| string | UUID do arquivo anexado ao modelo |
| string | Nome do arquivo (será enviado para um mensageiro) |
| string | Tipo de arquivo (imagem, arquivo, documento, vídeo) |
| bool | Indicador de que o arquivo é de um serviço de arquivos. Para todos os modelos adicionados a partir da primavera de 2022, retorna |
| int | Indica quando o modelo foi adicionado no formato Unix Timestamp |
| int | Indica quando o modelo foi atualizado pela última vez no formato Unix Timestamp |
| string | ID externo do modelo. ID do modelo no seu sistema. |
| string|null | Status do modelo do WhatsApp: |
| null|bool | Indica se o modelo está sendo revisado? Requer o Parâmetro GET with. |
| string | Rodapé do modelo do WhatsApp |
| string | Categoria do modelo do WhatsApp. As seguintes categorias estão disponíveis: |
| string | Idioma do modelo do WhatsApp |
| obj | Exemplos de substituição de elementos de marcação do modelo do WhatsApp. Exemplo: |
| string | Cabeçalho do modelo do WhatsApp com limite de até 60 caracteres. |
| string | Tipo de cabeçalho do modelo do WhatsApp. As opções disponíveis são: texto (modelo do WhatsApp com um cabeçalho), mídia (modelo do WhatsApp com um cabeçalho de mídia, deve haver um arquivo anexado). |
| obj | Um objeto contendo informações relacionadas à solicitação |
| array | Array de status do modelo do WhatsApp. Requer Parâmetro GET with. |
| int | ID do status do modelo do WhatsApp. Requer Parâmetro GET with. |
| int | ID da fonte do status do modelo do WhatsApp. Requer Parâmetro GET with. |
| string | A razão pela qual o modelo do WhatsApp foi rejeitado. Requer Parâmetro GET with. |
| string | Status do modelo do WhatsApp. Requer Parâmetro GET with. |