Obter um modelo por ID

O método permite obter dados sobre um modelo.

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âmetroTipo de dadoDescrição
idintID do modelo
account_idintID da conta à qual o modelo pertence
namestringNome do modelo
contentstringCorpo do modelo (a mensagem que é enviada ao usuário)
is_editableboolDefine se os usuários podem editar o modelo por meio da interface da Kommo.
typestringTipo do modelo
buttonsarrayArray de objetos de botão
buttons[]objUm objeto de botão
buttons[][type]stringTipo de botão. As opções disponíveis são inline (botão de texto simples) e url (botão de link)
buttons[][text]stringTexto no botão
buttons[][url]stringURL do botão do tipo url
attachmentobject|nullObjeto do arquivo adicionado ao modelo
attachment[id]stringUUID do arquivo anexado ao modelo
attachment[name]stringNome do arquivo (será enviado para um mensageiro)
attachment[type]stringTipo de arquivo (imagem, arquivo, documento, vídeo)
attachment[is_external]boolIndicador de que o arquivo é de um serviço de arquivos. Para todos os modelos adicionados a partir da primavera de 2022, retorna true.
created_atintIndica quando o modelo foi adicionado no formato Unix Timestamp
updated_atintIndica quando o modelo foi atualizado pela última vez no formato Unix Timestamp
external_idstringID externo do modelo. ID do modelo no seu sistema.
review_statusstring|nullStatus do modelo do WhatsApp:
approved/review/paused/rejected. Requer o Parâmetro GET with.
is_on_reviewnull|boolIndica se o modelo está sendo revisado? Requer o Parâmetro GET with.
waba_footerstringRodapé do modelo do WhatsApp
waba_categorystringCategoria do modelo do WhatsApp. As seguintes categorias estão disponíveis: UTILITY/AUTHENTICATION/MARKETING
waba_languagestringIdioma do modelo do WhatsApp
waba_examplesobjExemplos de substituição de elementos de marcação do modelo do WhatsApp. Exemplo: "waba_examples":{"{{lead.name}}":"qwerty"}
waba_headerstringCabeçalho do modelo do WhatsApp com limite de até 60 caracteres.
waba_header_typestringTipo 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).
_embeddedobjUm objeto contendo informações relacionadas à solicitação
_embedded.reviewsarrayArray de status do modelo do WhatsApp. Requer Parâmetro GET with.
_embedded.reviews[][id]intID do status do modelo do WhatsApp. Requer Parâmetro GET with.
_embedded.reviews[][source_id]intID da fonte do status do modelo do WhatsApp. Requer Parâmetro GET with.
_embedded.reviews[][reject_reason]stringA razão pela qual o modelo do WhatsApp foi rejeitado. Requer Parâmetro GET with.
_embedded.reviews[][status]stringStatus do modelo do WhatsApp. Requer Parâmetro GET with.
Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!