Enviar Audio

Metodo

POST https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/audio

Conceituacao

Envia uma mensagem de audio para um numero de telefone atraves de um canal conectado. O audio pode ser enviado como mensagem de voz (bolha de audio, similar ao gravado no WhatsApp) ou como arquivo de audio (com player de midia), controlado pelo campo ptt.

Diferenca entre os modos

Campo ptt	Comportamento
true	Mensagem de voz - Exibida como bolha de audio (push-to-talk), identica a uma mensagem gravada pelo microfone do WhatsApp.
false	Arquivo de audio - Exibido com player de midia completo, mostrando nome do arquivo e duracao.

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 pelo qual a mensagem sera enviada.

Body

Atributo	Tipo	Obrigatorio	Descricao
to	string	Sim	Numero do destinatario no formato DDI+DDD+NUM.
audioUrl	string	Sim	URL publica do arquivo de audio.
fileName	string	Nao	Nome do arquivo de audio.
mimeType	string	Nao	Tipo MIME do audio (ex: audio/ogg).
fileSize	number	Nao	Tamanho do arquivo em bytes.
ptt	boolean	Nao	Se true, envia como mensagem de voz (bolha). Se false, envia como arquivo de audio. Padrao: false.

Request

Mensagem de voz

cURL

curl -X POST "https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/audio" \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999998888",
    "audioUrl": "https://exemplo.com/audio-atendimento.ogg",
    "ptt": true
  }'

Node.js

const axios = require('axios');

const response = await axios.post(
  'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/audio',
  {
    to: "5511999998888",
    audioUrl: "https://exemplo.com/audio-atendimento.ogg",
    ptt: true
  },
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.post(
    'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/audio',
    json={
        'to': '5511999998888',
        'audioUrl': 'https://exemplo.com/audio-atendimento.ogg',
        'ptt': True
    },
    headers={
        'Authorization': 'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
)

print(response.json())

Arquivo de audio

cURL

curl -X POST "https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/audio" \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999998888",
    "audioUrl": "https://exemplo.com/podcast-episodio-01.mp3",
    "ptt": false
  }'

Node.js

const axios = require('axios');

const response = await axios.post(
  'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/audio',
  {
    to: "5511999998888",
    audioUrl: "https://exemplo.com/podcast-episodio-01.mp3",
    ptt: false
  },
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.post(
    'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/audio',
    json={
        'to': '5511999998888',
        'audioUrl': 'https://exemplo.com/podcast-episodio-01.mp3',
        'ptt': False
    },
    headers={
        'Authorization': 'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
)

print(response.json())

Response

202 - Aceito

{
  "success": true,
  "message": "Mensagem enfileirada para envio"
}

400 - Dados invalidos

{
  "message": "Dados de entrada invalidos.",
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "field": "audioUrl",
      "message": "A URL do audio e obrigatoria."
    }
  ]
}

401 - Nao autorizado

{
  "message": "Token de autenticacao invalido ou ausente.",
  "code": "UNAUTHORIZED"
}

429 - Rate limit excedido

{
  "message": "Limite de requisicoes excedido. Tente novamente em alguns segundos.",
  "code": "RATE_LIMIT_EXCEEDED"
}

Dica

Para mensagens de voz, utilize o formato OGG com codec Opus para melhor compatibilidade. Para arquivos de audio, MP3 e o formato mais amplamente suportado.