Pré-visualizar Link de Chamada

POST

api

call

link

:instance

preview

Pré-visualizar Link de Chamada

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 ou TokenInstance • Rate-limit: Global (100/min) • Idempotente: sim

Descrição

Consulta os metadados de um link de chamada sem entrar na chamada. Útil para mostrar, antes de participar, quem criou o link e se é necessária aprovação para entrar. Aceita tanto o token isolado quanto a URL completa do link no campo link.

Exemplos

Pré-visualizar por URL completa

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

Pré-visualizar apenas pelo token

O campo link também aceita o token isolado, sem o restante da 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)
}

Resposta de sucesso

200 OK

{
  "success":            true,
  "token":              "AbCdEfGhIjKlMnOp",
  "video":              false,
  "approvalRequired":   false,
  "isAdmin":            false,
  "creator":            "5511999999999@s.whatsapp.net",
  "creatorPhoneNumber": "5511999999999"
}

approvalRequired indica se o link tem sala de espera (participantes precisam ser aprovados antes de entrar). isAdmin indica se esta conta é administradora do link. creator e creatorPhoneNumber identificam quem criou o link. Esta consulta não entra na chamada nem altera o link.

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

Token do link ou a URL completa do link de chamada (ex.: https://call.whatsapp.com/audio/<token>).

boolean

Dica opcional indicando se o link é de vídeo. Normalmente não é necessário, pois o tipo já vem na resposta.

Erros

HTTP	Mensagem
400	`Instance name is required`
400	`Invalid request body: <detalhe>`
400	`Link is required`
404	`instance not found`
500	`<motivo da falha>`

Envelope de erro:

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

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Pré-visualizar Link de Chamada

Descrição

Exemplos

Pré-visualizar por URL completa

Pré-visualizar apenas pelo token

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Erros

​Descrição

​Exemplos

​Pré-visualizar por URL completa

​Pré-visualizar apenas pelo token

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Erros

Descrição

Exemplos

Pré-visualizar por URL completa

Pré-visualizar apenas pelo token

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Erros