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âmetro

Tipo de dado

Descrição

id

int

ID do modelo

account_id

int

ID da conta à qual o modelo pertence

name

string

Nome do modelo

content

string

Corpo do modelo (a mensagem que é enviada ao usuário)

is_editable

bool

Define se os usuários podem editar o modelo por meio da interface da Kommo.

type

string

Tipo do modelo

buttons

array

Array de objetos de botão

buttons[]

obj

Um objeto de botão

buttons[][type]

string

Tipo de botão. As opções disponíveis são inline (botão de texto simples) e url (botão de link)

buttons[][text]

string

Texto no botão

buttons[][url]

string

URL do botão do tipo url

attachment

object|null

Objeto do arquivo adicionado ao modelo

attachment[id]

string

UUID do arquivo anexado ao modelo

attachment[name]

string

Nome do arquivo (será enviado para um mensageiro)

attachment[type]

string

Tipo de arquivo (imagem, arquivo, documento, vídeo)

attachment[is_external]

bool

Indicador de que o arquivo é de um serviço de arquivos. Para todos os modelos adicionados a partir da primavera de 2022, retorna true.

created_at

int

Indica quando o modelo foi adicionado no formato Unix Timestamp

updated_at

int

Indica quando o modelo foi atualizado pela última vez no formato Unix Timestamp

external_id

string

ID externo do modelo. ID do modelo no seu sistema.

review_status

string|null

Status do modelo do WhatsApp:
approved/review/paused/rejected. Requer o Parâmetro GET with.

is_on_review

null|bool

Indica se o modelo está sendo revisado? Requer o Parâmetro GET with.

waba_footer

string

Rodapé do modelo do WhatsApp

waba_category

string

Categoria do modelo do WhatsApp. As seguintes categorias estão disponíveis: UTILITY/AUTHENTICATION/MARKETING

waba_language

string

Idioma do modelo do WhatsApp

waba_examples

obj

Exemplos de substituição de elementos de marcação do modelo do WhatsApp. Exemplo: "waba_examples":{"{{lead.name}}":"qwerty"}

waba_header

string

Cabeçalho do modelo do WhatsApp com limite de até 60 caracteres.

waba_header_type

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).

_embedded

obj

Um objeto contendo informações relacionadas à solicitação

_embedded.reviews

array

Array de status do modelo do WhatsApp. Requer Parâmetro GET with.

_embedded.reviews[][id]

int

ID do status do modelo do WhatsApp. Requer Parâmetro GET with.

_embedded.reviews[][source_id]

int

ID da fonte do status do modelo do WhatsApp. Requer Parâmetro GET with.

_embedded.reviews[][reject_reason]

string

A razão pela qual o modelo do WhatsApp foi rejeitado. Requer Parâmetro GET with.

_embedded.reviews[][status]

string

Status 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!