Connect.aiCentral de Ajuda

📋 Templates WABA

SendTemplateWaba

A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { "success": true, "data": { "message": "Message sent successfully", "ticketId": 123 } }

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📋 Templates WABA"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/template":{"post":{"tags":["📋 Templates WABA"],"summary":"SendTemplateWaba","operationId":"SendTemplateWaba","description":"A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { \"success\": true, \"data\": { \"message\": \"Message sent successfully\", \"ticketId\": 123 } }","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"Número do WhatsApp do destinatário (formato: 5511999999999)"},"isClosed":{"type":"boolean","description":"Define se o ticket será fechado após o envio"},"templateData":{"type":"object","description":"Dados do template do WhatsApp Business API","properties":{"messaging_product":{"type":"string","description":"Produto de mensageria (sempre whatsapp)"},"to":{"type":"string","description":"Número do destinatário (mesmo do campo number)"},"type":{"type":"string","description":"Tipo da mensagem (sempre template)"},"template":{"type":"object","description":"Configurações do template","properties":{"name":{"type":"string","description":"Nome do template aprovado"},"language":{"type":"object","description":"Configurações de idioma","properties":{"code":{"type":"string","description":"Código do idioma (ex: en_US, pt_BR)"}}}}}}},"validateNumber":{"type":"boolean","description":"Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

SendTemplateWabaBody

A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { "success": true, "data": { "message": "Message sent successfully", "ticketId": 123 } }

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📋 Templates WABA"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/templateBody":{"post":{"tags":["📋 Templates WABA"],"summary":"SendTemplateWabaBody","operationId":"SendTemplateWabaBody","description":"A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { \"success\": true, \"data\": { \"message\": \"Message sent successfully\", \"ticketId\": 123 } }","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"Número do WhatsApp do destinatário (formato: 5511999999999)"},"isClosed":{"type":"boolean","description":"Define se o ticket será fechado após o envio"},"templateData":{"type":"object","description":"Dados do template do WhatsApp Business API","properties":{"messaging_product":{"type":"string","description":"Produto de mensageria (sempre whatsapp)"},"to":{"type":"string","description":"Número do destinatário (mesmo do campo number)"},"type":{"type":"string","description":"Tipo da mensagem (sempre template)"},"template":{"type":"object","description":"Configurações do template","properties":{"name":{"type":"string","description":"Nome do template aprovado"},"language":{"type":"object","description":"Configurações de idioma","properties":{"code":{"type":"string","description":"Código do idioma (ex: en_US, pt_BR)"}}}}}}},"validateNumber":{"type":"boolean","description":"Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

SendTemplateWabaMarketing

A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { "success": true, "data": { "message": "Message sent successfully", "ticketId": 123 } }

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📋 Templates WABA"}],"servers":[{"url":"https://{baseUrl}","description":"Instalação Connect.ai do cliente","variables":{"baseUrl":{"default":"api.seudominio.com.br","description":"Domínio do backend Connect.ai, sem protocolo e sem barra final."}}}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Token da API do conta (na coleção Postman: `BearerToken`)."}},"parameters":{"ApiId":{"name":"apiId","in":"path","required":true,"description":"ID da API externa cadastrada no Connect.ai.","schema":{"type":"string"}}}},"paths":{"/v2/api/external/{apiId}/templateMarketingBody":{"post":{"tags":["📋 Templates WABA"],"summary":"SendTemplateWabaMarketing","operationId":"SendTemplateWabaMarketing","description":"A resposta retorna o ticketId do atendimento criado ou reutilizado. Exemplo: { \"success\": true, \"data\": { \"message\": \"Message sent successfully\", \"ticketId\": 123 } }","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"Número do WhatsApp do destinatário (formato: 5511999999999)"},"isClosed":{"type":"boolean","description":"Define se o ticket será fechado após o envio"},"templateData":{"type":"object","description":"Dados do template do WhatsApp Business API","properties":{"messaging_product":{"type":"string","description":"Produto de mensageria (sempre whatsapp)"},"to":{"type":"string","description":"Número do destinatário (mesmo do campo number)"},"type":{"type":"string","description":"Tipo da mensagem (sempre template)"},"template":{"type":"object","description":"Configurações do template","properties":{"name":{"type":"string","description":"Nome do template aprovado"},"language":{"type":"object","description":"Configurações de idioma","properties":{"code":{"type":"string","description":"Código do idioma (ex: en_US, pt_BR)"}}}}}}},"validateNumber":{"type":"boolean","description":"Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR — recomendado p/ WABA evitar ticket duplicado"}}}}}},"responses":{"200":{"description":"Requisição processada com sucesso.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Parâmetros inválidos ou faltando."},"401":{"description":"Token ausente, inválido ou sem permissão."}}}}}}

Este artigo foi útil?

Anterior💼 OportunidadesPróximo 🎫 Tickets