Saltar al contenido principal
POST
/
api
/
call
/
fake
/
:instance
Llamada Falsa
curl --request POST \
  --url https://api.example.com/api/call/fake/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "duration": 123
}
'
Auth: TokenAccount o TokenInstanceRate-limit: Global (100/min) • Idempotente: no

Descripción

Inicia una llamada de voz que hace sonar el teléfono del destinatario unos segundos y cuelga sola, sin audio ni conexión de medios. Útil para llamar la atención, validar un número o flujos de “sonar y colgar”. El campo duration controla cuántos segundos suena la llamada antes del corte automático: por defecto 8 segundos, rango permitido 1 a 60.

Ejemplos

Llamada falsa simple

Usa la duración por defecto (8 segundos).
curl -X POST "https://ryzeapi.cloud/api/call/fake/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999"
  }'

Sonar por una duración específica

duration: 15 hace que la llamada suene 15 segundos antes de colgar.
curl -X POST "https://ryzeapi.cloud/api/call/fake/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number":   "5511999999999",
    "duration": 15
  }'

Respuesta exitosa

200 OK
{
  "success":  true,
  "message":  "Call placed successfully",
  "callId":   "3EB08FCF27E532F1D3D3",
  "number":   "5511999999999",
  "duration": 8
}
La llamada es cortada automáticamente por el servidor tras duration segundos. No hay flujo de audio en esta llamada.

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).
duration
int
predeterminado:"8"
Segundos que suena la llamada antes de colgar automáticamente. Rango permitido: 1 a 60. Omitido o 0 usa el valor por defecto 8.

Errores

HTTPMensaje
400Instance name is required
400Invalid request body: <detail>
400Number is required
400Duration must be between 1 and 60 seconds
404instance not found
500<motivo del fallo>
Envoltorio de error:
{
  "success": false,
  "error": { "message": "Duration must be between 1 and 60 seconds" }
}