Create Call Link

POST

api

call

link

:instance

Create Call Link

curl --request POST \
  --url https://api.example.com/api/call/link/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '{
  "video": true
}'

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

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

payload = { "video": True }
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

Creates a reusable shareable call link, audio or video, that can be shared with anyone. Whoever opens the link can join the call, without needing to receive a call first. Use the video field to choose between an audio link (default) or a video link. The response returns the link’s token and the full url, ready to share.

Examples

Audio link (default)

curl -X POST "https://ryzeapi.cloud/api/call/link/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{}'

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

import os, requests

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

package main

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

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

Video link

video: true generates a video call link instead of audio.

curl -X POST "https://ryzeapi.cloud/api/call/link/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "video": true
  }'

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

import os, requests

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

package main

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

func main() {
    body := strings.NewReader(`{
        "video": true
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/call/link/"+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,
  "token":   "AbCdEfGhIjKlMnOp",
  "url":     "https://call.whatsapp.com/audio/AbCdEfGhIjKlMnOp",
  "video":   false
}

For video: true, the URL path segment changes to /video/ (e.g., https://call.whatsapp.com/video/<token>). The link is reusable, it can be opened by multiple people, at different times, until it is revoked.

Path parameters

string

required

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

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json

Request body

boolean

default:"false"

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

Errors

HTTP	Message
400	`Instance name is required`
400	`Invalid request body: <detail>`
404	`instance not found`
500	`<failure reason>`

Error envelope:

{
  "success": false,
  "error": { "message": "instance not found" }
}

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Create Call Link

Description

Examples

Audio link (default)

Video link

Success response

Path parameters

Headers

Request body

Errors

​Description

​Examples

​Audio link (default)

​Video link

​Success response

​Path parameters

​Headers

​Request body

​Errors

Description

Examples

Audio link (default)

Video link

Success response

Path parameters

Headers

Request body

Errors