Apagar Mensagem
Metodo
POST https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/delete
Conceituacao
Apaga uma mensagem para todos os participantes da conversa. A mensagem sera removida do WhatsApp do destinatario e substituida pela indicacao "Esta mensagem foi apagada".
Restricoes
- Apenas mensagens enviadas (
direction: "OUTBOUND") podem ser apagadas. - Janela de exclusao: A exclusao segue as regras do WhatsApp (variavel conforme versao, atualmente ate 2 dias).
- A mensagem permanece no banco de dados da Ogmma para fins de auditoria, mas com indicacao de que foi apagada.
Atributos
Header
| Atributo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| Authorization | string | Sim | Bearer {API_KEY} - Chave de autenticacao da API |
| Content-Type | string | Sim | application/json |
Path Parameters
| Atributo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| channelId | string | Sim | ID do canal. |
Body
| Atributo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
| messageId | string | Sim | ID da mensagem a ser apagada. |
Request
- cURL
- Node.js
- Python
curl -X POST "https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/delete" \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"messageId": "6650a1b2c3d4e5f6a7b8c9f0"
}'
const axios = require('axios');
const response = await axios.post(
'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/delete',
{
messageId: "6650a1b2c3d4e5f6a7b8c9f0"
},
{
headers: {
'Authorization': 'Bearer {API_KEY}',
'Content-Type': 'application/json'
}
}
);
console.log(response.data);
import requests
response = requests.post(
'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/delete',
json={
'messageId': '6650a1b2c3d4e5f6a7b8c9f0'
},
headers={
'Authorization': 'Bearer {API_KEY}',
'Content-Type': 'application/json'
}
)
print(response.json())
Response
200 - Exclusao processada
{
"success": true,
"message": "Exclusao processada"
}
400 - Mensagem nao pode ser apagada
{
"message": "A mensagem nao pode ser apagada. Verifique se e uma mensagem enviada e dentro da janela de exclusao.",
"code": "MESSAGE_NOT_DELETABLE"
}
401 - Nao autorizado
{
"message": "Token de autenticacao invalido ou ausente.",
"code": "UNAUTHORIZED"
}
404 - Mensagem nao encontrada
{
"message": "Mensagem nao encontrada.",
"code": "MESSAGE_NOT_FOUND"
}
429 - Rate limit excedido
{
"message": "Limite de requisicoes excedido. Tente novamente em alguns segundos.",
"code": "RATE_LIMIT_EXCEEDED"
}
Importante
A operacao de exclusao e processada de forma assincrona. O status QUEUED indica que a solicitacao foi recebida e sera processada. A confirmacao da exclusao no WhatsApp do destinatario depende da conectividade do canal.