Previsualizar Enlace de Llamada

POST

api

call

link

:instance

preview

Previsualizar Enlace de Llamada

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

Descripción

Consulta los metadatos de un enlace de llamada sin unirse a la llamada. Útil para mostrar, antes de participar, quién creó el enlace y si se requiere aprobación para entrar. Acepta tanto el token solo como la URL completa del enlace en el campo link.

Ejemplos

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

Previsualizar solo con el token

El campo link también acepta el token solo, sin el resto de la 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)
}

Respuesta exitosa

200 OK

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

approvalRequired indica si el enlace tiene sala de espera (los participantes deben ser aprobados antes de entrar). isAdmin indica si esta cuenta es administradora del enlace. creator y creatorPhoneNumber identifican quién creó el enlace. Esta consulta no une a la llamada ni modifica el enlace.

Parámetros de ruta

string

requerido

Nombre de la instancia (p. ej., $Instance_Name).

Cabeceras

string

requerido

TokenAccount o TokenInstance.

string

requerido

application/json

Cuerpo de la solicitud

string

requerido

El token del enlace o la URL completa del enlace de llamada (ej.: https://call.whatsapp.com/audio/<token>).

boolean

Indicación opcional de si el enlace es de video. Normalmente no es necesaria, ya que el tipo se devuelve en la respuesta.

Errores

HTTP	Mensaje
400	`Instance name is required`
400	`Invalid request body: <detail>`
400	`Link is required`
404	`instance not found`
500	`<motivo del fallo>`

Envoltorio de error:

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Previsualizar Enlace de Llamada

Descripción

Ejemplos

Previsualizar por URL completa

Previsualizar solo con el token

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Errores

​Descripción

​Ejemplos

​Previsualizar por URL completa

​Previsualizar solo con el token

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Errores

Descripción

Ejemplos

Previsualizar por URL completa

Previsualizar solo con el token

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Errores