Fake Call

POST

api

call

fake

:instance

Fake Call

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 or TokenInstance • Rate-limit: Global (100/min) • Idempotent: no

Description

Starts a voice call that rings the recipient’s phone for a few seconds and hangs up on its own, no audio, no media connection. Useful to grab attention, validate a number, or for “ring-and-drop” flows. The duration field controls how many seconds the call rings before the automatic hang-up: default 8 seconds, allowed range 1 to 60.

Examples

Simple fake call

Uses the default duration (8 seconds).

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

Ring for a specific duration

duration: 15 makes the call ring for 15 seconds before hanging up.

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

Success response

200 OK

{
  "success":  true,
  "message":  "Call placed successfully",
  "callId":   "3EB08FCF27E532F1D3D3",
  "number":   "5511999999999",
  "duration": 8
}

The call is ended automatically by the server after duration seconds. There is no audio stream on this call.

Path parameters

string

required

Instance name (e.g., $Instance_Name).

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json

Request body

string

required

Destination: phone (5511999999999) or JID (@s.whatsapp.net).

int

default:"8"

Seconds the call rings before hanging up automatically. Allowed range: 1 to 60. Omitted or 0 uses the default 8.

Errors

HTTP	Message
400	`Instance name is required`
400	`Invalid request body: <detail>`
400	`Number is required`
400	`Duration must be between 1 and 60 seconds`
404	`instance not found`
500	`<failure reason>`

Error envelope:

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

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

Simple fake call

Ring for a specific duration

Success response

Path parameters

Headers

Request body

Errors

​Description

​Examples

​Simple fake call

​Ring for a specific duration

​Success response

​Path parameters

​Headers

​Request body

​Errors

Description

Examples

Simple fake call

Ring for a specific duration

Success response

Path parameters

Headers

Request body

Errors