Pular para o conteúdo principal
POST
/
api
/
call
/
fake
/
:instance
Chamada Fake
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 ou TokenInstanceRate-limit: Global (100/min) • Idempotente: não

Descrição

Inicia uma chamada de voz que toca por alguns segundos no aparelho do destinatário e desliga sozinha, sem áudio e sem conexão de mídia. Útil para chamar atenção, validar número ou fluxos de “toque e desligue”. O campo duration controla por quantos segundos a chamada fica tocando antes do encerramento automático: padrão 8 segundos, faixa permitida 1 a 60.

Exemplos

Chamada fake simples

Usa a duração padrão (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"
  }'

Tocar por uma duração específica

duration: 15 faz a chamada tocar por 15 segundos antes de desligar.
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
  }'

Resposta de sucesso

200 OK
{
  "success":  true,
  "message":  "Call placed successfully",
  "callId":   "3EB08FCF27E532F1D3D3",
  "number":   "5511999999999",
  "duration": 8
}
A chamada é encerrada automaticamente pelo servidor após duration segundos. Não há fluxo de áudio nesta chamada.

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).
duration
int
padrão:"8"
Segundos que a chamada fica tocando antes de desligar automaticamente. Faixa permitida: 1 a 60. Omitido ou 0 usa o padrão 8.

Erros

HTTPMensagem
400Instance name is required
400Invalid request body: <detalhe>
400Number is required
400Duration must be between 1 and 60 seconds
404instance not found
500<motivo da falha>
Envelope de erro:
{
  "success": false,
  "error": { "message": "Duration must be between 1 and 60 seconds" }
}