Llamada con Audio

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

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 o TokenInstance • Rate-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"
  }'

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://ejemplo.com/mensaje.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://ejemplo.com/mensaje.mp3"
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "number":   "5511999999999",
        "mediaUrl": "https://ejemplo.com/mensaje.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)
}

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

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("mensaje.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)
}

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

string

requerido

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

Cabeceras

string

requerido

TokenAccount o TokenInstance.

string

requerido

application/json

Cuerpo de la solicitud

string

requerido

Destino: teléfono (5511999999999) o JID (@s.whatsapp.net).

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.

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

HTTP	Mensaje
400	`Instance name is required`
400	`Invalid request body: <detail>`
400	`Number is required`
400	`Provide exactly one of mediaUrl or mediaBase64`
404	`instance not found`
500	`<motivo del fallo>`

Envoltorio de error:

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Llamada con Audio

Descripción

Ejemplos

Audio desde una URL

Audio en base64

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores

​Descripción

​Ejemplos

​Audio desde una URL

​Audio en base64

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Notas

​Errores

Descripción

Ejemplos

Audio desde una URL

Audio en base64

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores