Pular para o conteúdo principal
POST
/
api
/
call
/
audio
/
:instance
Chamada com Áudio
curl --request POST \
  --url https://api.example.com/api/call/audio/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "mediaUrl": "<string>",
  "mediaBase64": "<string>"
}
'
Auth: TokenAccount ou TokenInstanceRate-limit: Global (100/min) • Idempotente: não

Descrição

Inicia uma chamada de voz e, quando o destinatário atende, reproduz um arquivo de áudio. O áudio é convertido automaticamente (via ffmpeg) para o formato exigido pela chamada de voz do WhatsApp. Informe a mídia em exatamente um campo: mediaUrl (aceita URL pública ou base64/data URI) ou mediaBase64 (somente base64). Enviar os dois, ou nenhum, é erro.

Exemplos

Áudio por URL

curl -X POST "https://ryzeapi.cloud/api/call/audio/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":   "5511999999999",
    "mediaUrl": "https://exemplo.com/mensagem.mp3"
  }'

Áudio em base64

Use mediaBase64 quando você já tem os bytes do arquivo (sem URL pública).
curl -X POST "https://ryzeapi.cloud/api/call/audio/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":      "5511999999999",
    "mediaBase64": "SUQzBAAAAAAA...="
  }'

Resposta de sucesso

200 OK
{
  "success": true,
  "message": "Audio call placed",
  "callId":  "3EB08FCF27E532F1D3D3",
  "number":  "5511999999999"
}
O áudio só é reproduzido se o destinatário atender a chamada. A conversão para o formato de voz do WhatsApp é feita automaticamente no servidor.

Parâmetros de rota

instance
string
obrigatório
Nome da instância (ex.: $Instance_Name).

Headers

token
string
obrigatório
TokenAccount ou TokenInstance.
Content-Type
string
obrigatório
application/json

Request body

number
string
obrigatório
Destino: telefone (5511999999999) ou JID (@s.whatsapp.net).
mediaUrl
string
Fonte do áudio: aceita uma URL pública (http(s)://…) ou o conteúdo do arquivo em base64 — base64 puro ou data URI (data:audio/mpeg;base64,…). O servidor detecta automaticamente qual dos dois você enviou. Informe isto ou mediaBase64, nunca os dois.
mediaBase64
string
Conteúdo do arquivo de áudio em base64. Informe isto ou mediaUrl, nunca os dois.

Notas

  • Informe exatamente uma fonte de mídia: mediaUrl ou mediaBase64. Enviar ambas (ou nenhuma) retorna 400.
  • O servidor usa ffmpeg para converter o áudio para o codec exigido pela chamada de voz do WhatsApp; formatos comuns (mp3, ogg, wav, m4a) são aceitos.

Erros

HTTPMensagem
400Instance name is required
400Invalid request body: <detalhe>
400Number is required
400Provide exactly one of mediaUrl or mediaBase64
404instance not found
500<motivo da falha>
Envelope de erro:
{
  "success": false,
  "error": { "message": "Provide exactly one of mediaUrl or mediaBase64" }
}