> ## Documentation Index > Fetch the complete documentation index at: https://docs.connectadesk.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar templates do canal > Lista os templates do canal. Aqui você encontra o **nome** a usar em `template.name` e quantas variáveis cada template exige. A lista sai do Connecta DESK, e não de uma consulta ao provedor: por isso ela responde rápido e aceita os filtros de situação e de fila. O catálogo é alimentado pela sincronização com a Meta/Gupshup, então um template aprovado agora no provedor aparece aqui depois da próxima sincronização. Canal sem nenhum template sincronizado devolve lista vazia e agenda a sincronização em segundo plano — a chamada seguinte já encontra o catálogo. Um canal que não usa template aprovado também devolve lista vazia, sem erro. ## OpenAPI ````yaml /api-reference/openapi.yaml get /channels/{id}/templates openapi: 3.0.3 info: title: Connecta DESK API pública version: 1.0.0 description: > API pública do Connecta DESK, disponível em `/api/v1`. O acesso é feito com um token gerado no módulo de tokens. Cada token tem permissões por **módulo × método**, e toda leitura de lista é paginada. ## Autenticação ``` Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6 ``` O token pertence a uma **empresa**, e não a um usuário. A empresa usada é sempre a do token, então enviar `companyId` no corpo não tem efeito. Token ausente, inválido, revogado ou expirado recebe a mesma resposta `401`. ## Ordem de verificação 1. **token** → `401` 2. **empresa ativa** → `403` 3. **API habilitada no plano** → `403 ERR_API_NOT_ENABLED` (não se aplica a on-premise) 4. **rate limit da empresa** → `429` 5. **permissão do token** → `403 ERR_API_FORBIDDEN_SCOPE` ## Ids de usuário Todo id de usuário na API é o id do usuário **nesta empresa**, o mesmo que `GET /users` devolve. Vale para o que a API responde (`user.id`, `assignedTo.id`, `userCreated.id`) e para o que ela aceita (`userId`, `userIds`, `assignedToUserId` e o `{id}` das rotas de usuário). A mesma pessoa pode trabalhar em várias empresas, com nome e perfil diferentes em cada uma, e tem um id diferente em cada empresa. Um id que não pertence a esta empresa responde `404`, com a mesma mensagem de um id inexistente. ## Paginação Todo `GET` de lista é paginado. O `meta` traz apenas `page`, `perPage` e `hasMore`, sem o total de registros. Para percorrer tudo, avance `page` enquanto `hasMore` for `true`. ## Idempotência Opcional em `POST`/`PUT`, pelo header `Idempotency-Key`. Se você repetir a chamada com a mesma chave e o mesmo corpo, recebe a resposta já gravada (com `Idempotent-Replay: true`). Com a mesma chave e um corpo diferente, a resposta é `409`. servers: - url: https://api.connectadesk.com/api/v1 description: Produção security: - apiToken: [] tags: - name: contacts description: Cadastro de contatos, campos extras e origem de marketing. - name: tickets x-displayName: Conversas description: Abertura, transferência, encerramento e qualificação de conversas. - name: messages description: Envio assíncrono e leitura de mensagens. - name: tags description: Tags e vínculo com atendimentos. - name: queues description: Filas de atendimento e seus atendentes. - name: wrapups description: Tipos de qualificação. - name: users description: Atendentes e administradores. - name: schedules description: Mensagens programadas. - name: quick-messages description: Respostas rápidas. - name: campaigns description: Disparos em massa. - name: crm description: Painéis, etapas, cards e indicadores. - name: channels description: Canais (somente leitura). - name: reports description: Relatórios e dashboards. - name: products description: Catálogo de produtos, categorias e desempenho nas vendas. - name: custom-fields description: >- Campos personalizados de contato e de card, e variáveis globais da empresa. - name: profiles description: Perfis de permissões da empresa (somente leitura). - name: webchat description: >- Webchat nativo pelo seu sistema: abrir sessão de um visitante, enviar e ler mensagens. O token precisa do escopo `webchat` (GET e POST). paths: /channels/{id}/templates: parameters: - $ref: '#/components/parameters/idParam' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/perPage' - name: status in: query description: > Situação do template. Aceita mais de uma, separadas por vírgula. Sem o filtro, vêm todas — inclusive rascunho e reprovado. | Valor | Quando aparece | |---|---| | `APPROVED` | Aprovado pelo provedor, pronto para disparo | | `PENDING` | Enviado e aguardando análise | | `REJECTED` | Reprovado | | `PAUSED` | Pausado pelo provedor, por qualidade | | `DISABLED` | Desativado pela Meta por qualidade, de forma definitiva | | `ARCHIVED` | Arquivado | | `DRAFT` | Rascunho, ainda não enviado para análise | schema: type: string example: APPROVED - name: queueId in: query description: > Traz só os modelos que esta fila pode usar: os que valem para todas as filas mais os vinculados a ela. A fila precisa ser da sua empresa. schema: type: integer example: 13 get: tags: - channels summary: Listar templates do canal description: > Lista os templates do canal. Aqui você encontra o **nome** a usar em `template.name` e quantas variáveis cada template exige. A lista sai do Connecta DESK, e não de uma consulta ao provedor: por isso ela responde rápido e aceita os filtros de situação e de fila. O catálogo é alimentado pela sincronização com a Meta/Gupshup, então um template aprovado agora no provedor aparece aqui depois da próxima sincronização. Canal sem nenhum template sincronizado devolve lista vazia e agenda a sincronização em segundo plano — a chamada seguinte já encontra o catálogo. Um canal que não usa template aprovado também devolve lista vazia, sem erro. responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/ChannelTemplate' meta: $ref: '#/components/schemas/PageMeta' '404': $ref: '#/components/responses/NotFound' components: parameters: idParam: name: id in: path required: true schema: type: integer example: 1042 page: name: page in: query description: Número da página, começando em 1. Um valor inválido é tratado como 1. schema: type: integer minimum: 1 default: 1 example: 1 perPage: name: perPage in: query description: >- Quantidade de itens por página. O máximo depende do ambiente (padrão 100). schema: type: integer minimum: 1 maximum: 100 default: 20 example: 50 schemas: ChannelTemplate: type: object description: >- Template aprovado do canal, com as informações que você precisa para saber o que enviar. properties: name: type: string example: confirmacao_pedido description: Nome exibido. language: type: string example: pt_BR status: type: string example: APPROVED category: type: string nullable: true example: UTILITY bodyText: type: string description: Texto do corpo, com os marcadores `{{n}}`. example: Olá {{1}}, seu pedido {{2}} foi confirmado. bodyVariables: type: integer description: Quantidade de itens que `template.parameters.body` precisa ter. example: 2 headerType: type: string nullable: true enum: - TEXT - IMAGE - VIDEO - DOCUMENT - LOCATION description: | Tipo do cabeçalho do template, conforme aprovado na Meta: | valor | significado | | --- | --- | | `TEXT` | Texto. | | `IMAGE` | Imagem. | | `VIDEO` | Vídeo. | | `DOCUMENT` | Documento (PDF e afins). | | `LOCATION` | Localização. | headerText: type: string nullable: true headerVariables: type: integer description: >- Quantidade de itens que `template.parameters.header` precisa ter. É sempre 0 quando o cabeçalho é mídia. example: 0 headerRequiresMedia: type: boolean description: >- `true` quando o cabeçalho é imagem, vídeo ou documento. Nesse caso, o arquivo é enviado pelo upload de mídia do agendamento, e não por `parameters.header`. footerText: type: string nullable: true buttons: type: array items: type: object PageMeta: type: object required: - page - perPage - hasMore properties: page: type: integer example: 1 perPage: type: integer example: 20 hasMore: type: boolean description: Indica se há mais registros além desta página. example: true example: page: 1 perPage: 20 hasMore: true Error: type: object required: - error properties: error: type: object required: - code - message properties: code: type: string description: Código fixo do erro, para você tratar cada caso no seu sistema. example: ERR_API_FORBIDDEN_SCOPE message: type: string details: {} responses: NotFound: description: >- O recurso não existe ou pertence a outra empresa. Por segurança, a resposta é a mesma nos dois casos. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ERR_API_NOT_FOUND message: Registro não encontrado. securitySchemes: apiToken: type: http scheme: bearer description: Token da API no formato `sk_live_…`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.