Preview Call Link

POST

api

call

link

:instance

preview

Preview Call Link

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

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

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

payload = {
    "link": "<string>",
    "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: yes

Description

Looks up the metadata of a call link without joining the call. Useful to show, before joining, who created the link and whether approval is required to join. Accepts either the bare token or the full link URL in the link field.

Examples

Preview by full URL

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

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

import os, requests

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

package main

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

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

Preview by token only

The link field also accepts the bare token, without the rest of the URL.

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

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

import os, requests

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

package main

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

func main() {
    body := strings.NewReader(`{
        "link": "AbCdEfGhIjKlMnOp"
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/call/link/"+os.Getenv("Instance_Name")+"/preview", 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",
  "video":              false,
  "approvalRequired":   false,
  "isAdmin":            false,
  "creator":            "5511999999999@s.whatsapp.net",
  "creatorPhoneNumber": "5511999999999"
}

approvalRequired indicates whether the link has a waiting room (participants must be approved before joining). isAdmin indicates whether this account is an admin of the link. creator and creatorPhoneNumber identify who created the link. This lookup does not join the call or change the link.

Path parameters

string

required

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

Headers

string

required

TokenAccount or TokenInstance.

string

required

application/json

Request body

string

required

The link’s token or the full call link URL (e.g., https://call.whatsapp.com/audio/<token>).

boolean

Optional hint indicating whether the link is a video link. Usually not needed, since the type is already returned in the response.

Errors

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

Error envelope:

{
  "success": false,
  "error": { "message": "Link is required" }
}

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Preview Call Link

Description

Examples

Preview by full URL

Preview by token only

Success response

Path parameters

Headers

Request body

Errors

​Description

​Examples

​Preview by full URL

​Preview by token only

​Success response

​Path parameters

​Headers

​Request body

​Errors

Description

Examples

Preview by full URL

Preview by token only

Success response

Path parameters

Headers

Request body

Errors