Saltar al contenido principal
POST
/
api
/
call
/
audio
/
:instance
Llamada con Audio
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 o TokenInstanceRate-limit: Global (100/min) • Idempotente: no

Descripción

Inicia una llamada de voz y, cuando el destinatario atiende, reproduce un archivo de audio. El audio se convierte automáticamente (vía ffmpeg) al formato requerido por las llamadas de voz de WhatsApp. Indica el medio en exactamente un campo: mediaUrl (acepta URL pública o base64/data URI) o mediaBase64 (solo base64). Enviar ambas, o ninguna, es un error.

Ejemplos

Audio desde una 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://ejemplo.com/mensaje.mp3"
  }'

Audio en base64

Usa mediaBase64 cuando ya tienes los bytes del archivo (sin 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...="
  }'

Respuesta exitosa

200 OK
{
  "success": true,
  "message": "Audio call placed",
  "callId":  "3EB08FCF27E532F1D3D3",
  "number":  "5511999999999"
}
El audio solo se reproduce si el destinatario atiende la llamada. La conversión al formato de voz de WhatsApp se hace automáticamente en el servidor.

Parámetros de ruta

instance
string
requerido
Nombre de la instancia (p. ej., $Instance_Name).

Cabeceras

token
string
requerido
TokenAccount o TokenInstance.
Content-Type
string
requerido
application/json

Cuerpo de la solicitud

number
string
requerido
Destino: teléfono (5511999999999) o JID (@s.whatsapp.net).
mediaUrl
string
Fuente del audio: acepta una URL pública (http(s)://…) o el contenido del archivo en base64 — base64 puro o un data URI (data:audio/mpeg;base64,…). El servidor detecta automáticamente cuál de los dos enviaste. Indica esto o mediaBase64, nunca ambos.
mediaBase64
string
Contenido del archivo de audio en base64. Indica esto o mediaUrl, nunca ambos.

Notas

  • Indica exactamente una fuente de medios: mediaUrl o mediaBase64. Enviar ambas (o ninguna) devuelve 400.
  • El servidor usa ffmpeg para convertir el audio al códec requerido por las llamadas de voz de WhatsApp; se aceptan formatos comunes (mp3, ogg, wav, m4a).

Errores

HTTPMensaje
400Instance name is required
400Invalid request body: <detail>
400Number is required
400Provide exactly one of mediaUrl or mediaBase64
404instance not found
500<motivo del fallo>
Envoltorio de error:
{
  "success": false,
  "error": { "message": "Provide exactly one of mediaUrl or mediaBase64" }
}