PicChat

Templates

Consultar modelo

GEThttps://api.picchat.com.br/v1/templates/{id}

Devolve um modelo de mensagem pelo ID com todos os componentes e o canal. Modelo excluído responde 404.

Autenticação: Bearer tokenPermissão: Templates › ver

Parâmetros de caminho

  • idstring (uuid)obrigatório

    UUID do modelo.

Respostas

200OK

  • idstring (uuid)obrigatório

    ID do modelo.

  • namestringobrigatório

    Nome exibido.

  • internal_namestringobrigatório

    Nome interno (o registrado na Meta).

  • typestringobrigatório

    Tipo/canal do modelo.

    whatsapp_litewhatsappsmsemailwebhookrcs

  • statusstringobrigatório

    Status de aprovação.

    APPROVEDIN_APPEALPENDINGREJECTEDPENDING_DELETIONDELETEDDISABLEDPAUSEDLIMIT_EXCEEDEDARCHIVED

  • categorystring | nullobrigatório

    Categoria na Meta.

    ACCOUNT_UPDATEPAYMENT_UPDATEPERSONAL_FINANCE_UPDATESHIPPING_UPDATERESERVATION_UPDATEISSUE_RESOLUTIONAPPOINTMENT_UPDATETRANSPORTATION_UPDATETICKET_UPDATEALERT_UPDATEAUTO_REPLYTRANSACTIONALOTPUTILITYMARKETINGAUTHENTICATIONSERVICEnull

  • languagestring | nullobrigatório

    Idioma (ex.: pt_BR).

  • quality_scorestring | nullobrigatório

    Qualidade do modelo na Meta.

    GREENYELLOWREDUNKNOWNnull

  • bodystring | nullobrigatório

    Texto do corpo, com variáveis {{n}}.

  • HEADERanyobrigatório

    Componente de cabeçalho no formato da Meta (JSON livre, pode ser null).

  • BODYanyobrigatório

    Componente de corpo no formato da Meta (JSON livre, pode ser null).

  • FOOTERanyobrigatório

    Componente de rodapé no formato da Meta (JSON livre, pode ser null).

  • BUTTONSanyobrigatório

    Botões no formato da Meta (JSON livre, pode ser null).

  • CAROUSELanyobrigatório

    Cartões de carrossel no formato da Meta (JSON livre, pode ser null).

  • LIMITED_TIME_OFFERanyobrigatório

    Oferta por tempo limitado no formato da Meta (JSON livre, pode ser null).

  • ex_idstring | nullobrigatório

    ID do modelo na Meta.

  • reasonstring | nullobrigatório

    Motivo da rejeição, quando houver.

  • created_atstring (date-time)obrigatório

    Criação.

  • updated_atstring (date-time)obrigatório

    Última atualização.

  • channelsobject | nullobrigatório

    Canal do modelo.

  • channels.idstring (uuid)obrigatório

    ID do canal.

  • channels.namestringobrigatório

    Nome do canal.

  • channels.typestringobrigatório

    Tipo do canal.

    whatsappwhatsapp_litesmsemailwebhookchatinstagramrcs

403Acesso negado: usuário do token sem a permissão da rota (`permission_denied`) ou token não ligado a um usuário ativo (`token_without_user`) — para token de integração da conta isso só é aplicado quando `access.enforced` é true (veja GET /v1/me); token pessoal e JWT de sessão são sempre verificados; `account_id` na query diferente da conta do token; conta do tipo INFRA.

404Registro não existe, é de outra conta, foi excluído ou está fora do escopo de canais do usuário.

498Token ausente, inválido, de outra finalidade (ex.: token do canal chat) ou revogado. Note o status não padrão 498.