Schedule Call

POST

api

call

schedule

:instance

Schedule Call

curl --request POST \
  --url https://api.example.com/api/call/schedule/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "number": "<string>",
  "name": "<string>",
  "startTime": 123,
  "description": "<string>",
  "endTime": 123,
  "video": true,
  "reminderOffsetSec": 123
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    number: '<string>',
    name: '<string>',
    startTime: 123,
    description: '<string>',
    endTime: 123,
    video: true,
    reminderOffsetSec: 123
  })
};

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

payload = {
    "number": "<string>",
    "name": "<string>",
    "startTime": 123,
    "description": "<string>",
    "endTime": 123,
    "video": True,
    "reminderOffsetSec": 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

Schedules a WhatsApp call for a future time. Creates a call link and sends, in the chat of the given number, a scheduled-call event card carrying that link, the title (name), and the start time (startTime). The recipient sees the event card and can open the link to join once it starts. Use the video field to choose between an audio link (default) or a video link.

startTime (and endTime, when provided) use a Unix timestamp in seconds, not milliseconds, and startTime must be in the future.

Examples

Simple scheduling

curl -X POST "https://ryzeapi.cloud/api/call/schedule/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "name": "Team meeting",
    "startTime": 1751500000
  }'

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

import os, requests

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

package main

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

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

With description, end time, and reminder

description adds an agenda to the event, endTime sets the end time, and reminderOffsetSec sets how many seconds before the start a reminder is shown to the recipient.

curl -X POST "https://ryzeapi.cloud/api/call/schedule/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "name": "Team meeting",
    "description": "Weekly team sync",
    "startTime": 1751500000,
    "endTime": 1751503600,
    "video": true,
    "reminderOffsetSec": 900
  }'

await fetch(`https://ryzeapi.cloud/api/call/schedule/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    number: "5511999999999",
    name: "Team meeting",
    description: "Weekly team sync",
    startTime: 1751500000,
    endTime: 1751503600,
    video: true,
    reminderOffsetSec: 900
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/call/schedule/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "number": "5511999999999",
        "name": "Team meeting",
        "description": "Weekly team sync",
        "startTime": 1751500000,
        "endTime": 1751503600,
        "video": True,
        "reminderOffsetSec": 900
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "number": "5511999999999",
        "name": "Team meeting",
        "description": "Weekly team sync",
        "startTime": 1751500000,
        "endTime": 1751503600,
        "video": true,
        "reminderOffsetSec": 900
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/call/schedule/"+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,
  "messageId": "3EB08FCF27E532F1D3D3",
  "token":     "AbCdEfGhIjKlMnOp",
  "url":       "https://call.whatsapp.com/audio/AbCdEfGhIjKlMnOp",
  "startTime": 1751500000
}

messageId identifies the event message sent to the recipient. token and url belong to the call link that was already created, useful if it needs to be shared manually. startTime confirms the recorded start time.

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 number (5511999999999) or JID (5511999999999@s.whatsapp.net).

string

required

Event title, shown on the scheduled-call card.

integer

required

Call start date and time, as a Unix timestamp (seconds). Must be in the future.

string

Event description or agenda.

integer

default:"0"

End date and time, as a Unix timestamp (seconds). Omitted or 0 means no end time is set. When provided, it must be greater than startTime.

boolean

default:"false"

When true, generates a video call link instead of audio.

integer

How many seconds before the start a reminder should be shown to the recipient.

Errors

HTTP	Message
400	`Instance name is required`
400	`Invalid request body: <detail>`
400	`Number is required`
400	`startTime must be in the future (Unix seconds)`
400	`endTime must be after startTime`
404	`instance not found`
500	`<failure reason>`

Error envelope:

{
  "success": false,
  "error": { "message": "startTime must be in the future (Unix seconds)" }
}

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

Simple scheduling

With description, end time, and reminder

Success response

Path parameters

Headers

Request body

Errors

​Description

​Examples

​Simple scheduling

​With description, end time, and reminder

​Success response

​Path parameters

​Headers

​Request body

​Errors

Description

Examples

Simple scheduling

With description, end time, and reminder

Success response

Path parameters

Headers

Request body

Errors