Chamada com Áudio

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>"
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({number: '<string>', mediaUrl: '<string>', mediaBase64: '<string>'})
};

fetch('https://api.example.com/api/call/audio/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.example.com/api/call/audio/:instance"

payload = {
    "number": "<string>",
    "mediaUrl": "<string>",
    "mediaBase64": "<string>"
}
headers = {
    "token": "<token>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Auth: TokenAccount ou TokenInstance • Rate-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"
  }'

await fetch(`https://ryzeapi.cloud/api/call/audio/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:   "5511999999999",
    mediaUrl: "https://exemplo.com/mensagem.mp3"
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/call/audio/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":   "5511999999999",
        "mediaUrl": "https://exemplo.com/mensagem.mp3"
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number":   "5511999999999",
        "mediaUrl": "https://exemplo.com/mensagem.mp3"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/call/audio/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

Á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...="
  }'

await fetch(`https://ryzeapi.cloud/api/call/audio/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number:      "5511999999999",
    mediaBase64: "SUQzBAAAAAAA...="
  })
});

import os, base64, requests

with open("mensagem.mp3", "rb") as f:
    audio_b64 = base64.b64encode(f.read()).decode()

requests.post(
    f"https://ryzeapi.cloud/api/call/audio/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number":      "5511999999999",
        "mediaBase64": audio_b64
    }
)

package main

import (
    "net/http"
    "os"
    "strings"
)

func main() {
    body := strings.NewReader(`{
        "number":      "5511999999999",
        "mediaBase64": "SUQzBAAAAAAA...="
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/call/audio/"+os.Getenv("Instance_Name"), body)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    req.Header.Set("Content-Type", "application/json")
    http.DefaultClient.Do(req)
}

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

string

obrigatório

Nome da instância (ex.: $Instance_Name).

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json

Request body

string

obrigatório

Destino: telefone (5511999999999) ou JID (@s.whatsapp.net).

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.

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

HTTP	Mensagem
400	`Instance name is required`
400	`Invalid request body: <detalhe>`
400	`Number is required`
400	`Provide exactly one of mediaUrl or mediaBase64`
404	`instance not found`
500	`<motivo da falha>`

Envelope de erro:

{
  "success": false,
  "error": { "message": "Provide exactly one of mediaUrl or mediaBase64" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Chamada com Áudio

Descrição

Exemplos

Áudio por URL

Áudio em base64

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros

​Descrição

​Exemplos

​Áudio por URL

​Áudio em base64

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Notas

​Erros

Descrição

Exemplos

Áudio por URL

Áudio em base64

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros