👥 Mensagens Em Grupo

SendGroupMessageAPI

Endpoint com mais de um formato de payload na coleção oficial: **SendGroupMessageAPIFile**, **SendGroupMessageAPIText**. 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 em Grupo"}],"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}/group":{"post":{"tags":["👥 Mensagens em Grupo"],"summary":"SendGroupMessageAPI","operationId":"SendGroupMessageAPIFile","parameters":[{"$ref":"#/components/parameters/ApiId"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"media":{"type":"string","format":"binary","description":"Arquivo(s) a ser enviado (imagem, documento, etc)"},"body":{"type":"string","description":"Texto da mensagem que acompanhará o arquivo"},"number":{"type":"string","description":"ID do grupo do WhatsApp"},"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"}},"required":["media"]}},"application/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"Texto da mensagem que será enviada"},"number":{"type":"string","description":"ID do grupo do WhatsApp"},"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."}},"description":"Endpoint com mais de um formato de payload na coleção oficial: **SendGroupMessageAPIFile**, **SendGroupMessageAPIText**. Veja os exemplos do corpo para escolher a variante."}}}}

POST /v2/api/external/{apiId}/groupMediaUrl

SendMessageAPIFileURLGroup

{"openapi":"3.0.3","info":{"title":"Connect.ai — API Externa","version":"v4.x.x.x"},"tags":[{"name":"👥 Mensagens em Grupo"}],"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}/groupMediaUrl":{"post":{"tags":["👥 Mensagens em Grupo"],"summary":"SendMessageAPIFileURLGroup","operationId":"SendMessageAPIFileURLGroup","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":"ID do grupo do WhatsApp"},"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."}}}}}}

Este artigo foi útil?