Chamada Fake

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

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

fetch('https://api.example.com/api/call/fake/: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/fake/:instance"

payload = {
    "number": "<string>",
    "duration": 123
}
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 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"
  }'

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

import os, requests

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

package main

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

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

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

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

import os, requests

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

package main

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

func main() {
    body := strings.NewReader(`{
        "number":   "5511999999999",
        "duration": 15
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/call/fake/"+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":  "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

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).

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

HTTP	Mensagem
400	`Instance name is required`
400	`Invalid request body: <detalhe>`
400	`Number is required`
400	`Duration must be between 1 and 60 seconds`
404	`instance not found`
500	`<motivo da falha>`

Envelope de erro:

{
  "success": false,
  "error": { "message": "Duration must be between 1 and 60 seconds" }
}

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Descrição

Exemplos

Chamada fake simples

Tocar por uma duração específica

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Erros

​Descrição

​Exemplos

​Chamada fake simples

​Tocar por uma duração específica

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Erros

Descrição

Exemplos

Chamada fake simples

Tocar por uma duração específica

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Erros