Skip to main content
GET
/
api
/
v1
/
template
Obter Template Por Unidade
curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/template
{
  "message": "<string>",
  "templates": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "iconId": "<string>",
      "templateIcon": {
        "id": "<string>",
        "institutionId": "<string>",
        "type": "<string>",
        "fileName": "<string>",
        "internalStorageUrl": "<string>",
        "url": "<string>",
        "maskName": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "extension": "<string>",
        "size": 123,
        "numberWords": 123
      },
      "institutionId": "<string>",
      "institution": {},
      "unityId": "<string>",
      "unity": {},
      "category": "<string>",
      "prompt": "<string>",
      "hasInstagram": true,
      "hasMessenger": true,
      "hasMulti": true,
      "hasTools": true,
      "hasVoice": true,
      "hasWhatsapp": true,
      "hasPlugin": true,
      "active": true,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "voiceTemplate": [
        {}
      ],
      "voicesTemplateCount": 123,
      "pluginTemplate": [
        {
          "id": "<string>",
          "active": true,
          "templateId": "<string>",
          "pluginData": {
            "id": "<string>",
            "name": "<string>"
          },
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "pluginsTemplateCount": 123,
      "canCreatePlugins": true
    }
  ],
  "categories": [
    {}
  ],
  "totalCount": 123
}
unityId
string
ID da unidade

Descrição da Resposta

message
string
required
Mensagem de retorno da API indicando o status da operação (ex: “Template returned successfully”).
templates
[]
required
Lista de templates disponíveis.
id
uuid
required
Identificador único do template.
name
string
required
Nome do template.
description
string
required
Descrição breve do template.
iconId
uuid
required
Identificador do ícone associado ao template.
templateIcon
object
required
Detalhes do ícone associado ao template.
id
uuid
required
Identificador único do ícone.
institutionId
uuid
required
Identificador da instituição associada ao ícone.
type
string
required
Tipo do ícone (ex: accountIcon).
fileName
string
required
Nome do arquivo do ícone.
internalStorageUrl
string
required
URL de armazenamento interno do ícone.
url
string
required
URL pública do ícone.
maskName
string
Nome da máscara aplicada ao ícone.
createdAt
string
required
Data e hora de criação do ícone.
updatedAt
string
required
Data e hora da última atualização do ícone.
extension
string
required
Extensão do arquivo (ex: svg+xml).
size
number
required
Tamanho do arquivo em bytes.
numberWords
number
Número de palavras associadas ao ícone (caso aplicável).
institutionId
uuid
Identificador da instituição associada ao template.
institution
object
Objeto com informações da instituição, se disponível.
unityId
uuid
Identificador da unidade associada ao template.
unity
object
Objeto com informações da unidade, se disponível.
category
string
required
Categoria do template (ex: marketing, support, sales).
prompt
string
required
Prompt base utilizado pelo template.
hasInstagram
boolean
required
Indica se o template possui integração com Instagram.
hasMessenger
boolean
required
Indica se o template possui integração com Messenger.
hasMulti
boolean
required
Indica se o template oferece suporte a múltiplos canais simultâneos.
hasTools
boolean
required
Indica se o template possui ferramentas adicionais.
hasVoice
boolean
required
Indica se o template possui suporte a voz.
hasWhatsapp
boolean
required
Indica se o template possui integração com WhatsApp.
hasPlugin
boolean
required
Indica se o template possui plugins configurados.
active
boolean
required
Indica se o template está ativo.
createdAt
string
required
Data e hora de criação do template.
updatedAt
string
required
Data e hora da última atualização do template.
voiceTemplate
array
required
Lista de templates de voz associados.
voicesTemplateCount
number
required
Quantidade de templates de voz associados.
pluginTemplate
array
required
Lista de plugins associados ao template.
id
uuid
required
Identificador único do plugin associado.
active
boolean
required
Indica se o plugin está ativo.
templateId
uuid
required
Identificador do template ao qual o plugin pertence.
pluginData
object
required
Dados do plugin associado.
id
uuid
required
Identificador único do plugin.
name
string
required
Nome do plugin.
createdAt
string
required
Data e hora de criação do plugin.
updatedAt
string
required
Data e hora da última atualização do plugin.
pluginsTemplateCount
number
required
Quantidade de plugins associados ao template.
canCreatePlugins
boolean
required
Indica se é possível criar novos plugins para o template.
categories
array
required
Lista de categorias disponíveis para templates (ex: support, marketing, sales).
totalCount
number
required
Quantidade total de templates retornados.