Crear Enlace de Llamada

POST

api

call

link

:instance

Crear Enlace de Llamada

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

Descripción

Crea un enlace de llamada reutilizable, de audio o video, que se puede compartir con cualquier persona. Quien abra el enlace puede unirse a la llamada, sin necesidad de recibir una llamada primero. Usa el campo video para elegir entre un enlace de audio (por defecto) o de video. La respuesta incluye el token del enlace y la url completa, lista para compartir.

Ejemplos

Enlace de audio (por defecto)

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

Enlace de video

video: true genera un enlace de llamada de video en lugar de 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)
}

Respuesta exitosa

200 OK

{
  "success": true,
  "token":   "AbCdEfGhIjKlMnOp",
  "url":     "https://call.whatsapp.com/audio/AbCdEfGhIjKlMnOp",
  "video":   false
}

Para video: true, el segmento de la URL cambia a /video/ (ej.: https://call.whatsapp.com/video/<token>). El enlace es reutilizable, puede abrirlo varias personas, en momentos distintos, hasta que sea revocado.

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

boolean

predeterminado:"false"

Cuando es true, genera un enlace de llamada de video en lugar de audio.

Errores

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

Envoltorio de error:

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

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Crear Enlace de Llamada

Descripción

Ejemplos

Enlace de audio (por defecto)

Enlace de video

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Errores

​Descripción

​Ejemplos

​Enlace de audio (por defecto)

​Enlace de video

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Errores

Descripción

Ejemplos

Enlace de audio (por defecto)

Enlace de video

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Errores