Criar Link de Chamada

POST

api

call

link

:instance

Criar Link de Chamada

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

Descrição

Cria um link de chamada reutilizável, de áudio ou vídeo, que pode ser compartilhado com qualquer pessoa. Quem abrir o link consegue entrar na chamada, sem precisar receber uma ligação primeiro. Use o campo video para escolher entre um link de áudio (padrão) ou de vídeo. A resposta traz o token do link e a url completa, pronta para compartilhar.

Exemplos

Link de áudio (padrão)

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

Link de vídeo

video: true gera um link de chamada de vídeo em vez de áudio.

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

Resposta de sucesso

200 OK

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

Para video: true, o segmento da URL muda para /video/ (ex.: https://call.whatsapp.com/video/<token>). O link é reutilizável: pode ser aberto por várias pessoas, em momentos diferentes, até ser revogado.

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

boolean

padrão:"false"

Quando true, gera um link de chamada de vídeo em vez de áudio.

Erros

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

Envelope de erro:

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

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Criar Link de Chamada

Descrição

Exemplos

Link de áudio (padrão)

Link de vídeo

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Erros

​Descrição

​Exemplos

​Link de áudio (padrão)

​Link de vídeo

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Erros

Descrição

Exemplos

Link de áudio (padrão)

Link de vídeo

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Erros