GET /v2/api/external/{apiId}/getMessageByMessageId
GetMessageByMessageId
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📨 Mensagens"}],"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}/getMessageByMessageId":{"get":{"tags":["📨 Mensagens"],"summary":"GetMessageByMessageId","operationId":"GetMessageByMessageId","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"messageId","in":"query","required":false,"description":"ID da mensagem retornado pela Meta (ex: wamid.xxxxx)","schema":{"type":"string"}}],"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."}}}}}}
SendMessageAPI
Endpoint com mais de um formato de payload na coleção oficial: **SendMessageAPIFile**, **SendMessageAPIText**. Veja os exemplos do corpo para escolher a variante.
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📨 Mensagens"}],"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}":{"post":{"tags":["📨 Mensagens"],"summary":"SendMessageAPI","operationId":"SendMessageAPIFile","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"media":{"type":"string","format":"binary","description":"Arquivo a ser enviado (imagem, documento, etc)"},"body":{"type":"string","description":"Texto da mensagem que acompanhará o arquivo"},"number":{"type":"string","description":"Número do WhatsApp do destinatário (formato: 5511999999999)"},"externalKey":{"type":"string","description":"Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)"},"isClosed":{"type":"string","description":"Define se o ticket será fechado após o envio"},"validateNumber":{"type":"string","description":"Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR (recomendado p/ WABA)."}},"required":["media"]}},"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"Texto da mensagem que será enviada"},"number":{"type":"string","description":"Número do WhatsApp do destinatário (formato: 5511999999999)"},"externalKey":{"type":"string","description":"Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)"},"isClosed":{"type":"boolean","description":"Define se o ticket será fechado após o envio"},"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."}},"description":"Endpoint com mais de um formato de payload na coleção oficial: **SendMessageAPIFile**, **SendMessageAPIText**. Veja os exemplos do corpo para escolher a variante."}}}}
POST /v2/api/external/{apiId}/url
SendMessageAPIFileURL
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📨 Mensagens"}],"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}/url":{"post":{"tags":["📨 Mensagens"],"summary":"SendMessageAPIFileURL","operationId":"SendMessageAPIFileURL","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mediaUrl":{"type":"string","description":"URL do arquivo que será enviado (imagem, documento, etc)"},"body":{"type":"string","description":"Texto da mensagem que acompanhará o arquivo"},"number":{"type":"string","description":"Número do WhatsApp do destinatário (formato: 5511999999999)"},"externalKey":{"type":"string","description":"Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)"},"isClosed":{"type":"boolean","description":"Define se o ticket será fechado após o envio"},"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."}}}}}}
POST /v2/api/external/{apiId}/base64
SendMessageAPITextBase64
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📨 Mensagens"}],"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}/base64":{"post":{"tags":["📨 Mensagens"],"summary":"SendMessageAPITextBase64","operationId":"SendMessageAPITextBase64","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"Texto da mensagem que acompanhará o arquivo"},"number":{"type":"string","description":"Número do WhatsApp do destinatário (formato: 5511999999999)"},"base64Data":{"type":"string","description":"Arquivo codificado em base64"},"mimeType":{"type":"string","description":"Tipo MIME do arquivo (ex: image/png, application/pdf)"},"fileName":{"type":"string","description":"Nome do arquivo que será exibido"},"isClosed":{"type":"boolean","description":"Define se o ticket será fechado após o envio"},"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."}}}}}}
POST /v2/api/external/{apiId}/voice
SendMessageAPIVoice
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📨 Mensagens"}],"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}/voice":{"post":{"tags":["📨 Mensagens"],"summary":"SendMessageAPIVoice","operationId":"SendMessageAPIVoice","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"audio":{"type":"string","description":"URL do arquivo de áudio que será enviado"},"number":{"type":"string","description":"Número do WhatsApp do destinatário (formato: 5511999999999)"},"externalKey":{"type":"string","description":"Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)"},"isClosed":{"type":"boolean","description":"Define se o ticket será fechado após o envio"}}}}}},"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."}}}}}}
GET /v2/api/external/{apiId}/params/
SendMessageParams
{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"📨 Mensagens"}],"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}/params/":{"get":{"tags":["📨 Mensagens"],"summary":"SendMessageParams","operationId":"SendMessageParams","parameters":[{"$ref":"#/components/parameters/ApiId"},{"name":"body","in":"query","required":false,"description":"Texto da mensagem que será enviada","schema":{"type":"string"}},{"name":"number","in":"query","required":false,"description":"Número do WhatsApp do destinatário (formato: 5511999999999)","schema":{"type":"integer"}},{"name":"externalKey","in":"query","required":false,"description":"Chave única do sistema para identificação (valor gerado do seu lado para controle do envio e não pode se repetir)","schema":{"type":"string"}},{"name":"bearertoken","in":"query","required":false,"description":"Token de autenticação","schema":{"type":"string"}},{"name":"isClosed","in":"query","required":false,"description":"Define se o ticket será fechado após o envio","schema":{"type":"string"}},{"name":"validateNumber","in":"query","required":false,"description":"Validar numero (opcional, padrao true). Se false, usa o numero exatamente como enviado, sem normalizacao do 9o digito BR (recomendado p/ WABA).","schema":{"type":"string"}}],"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."}}}}}}