Vincular grupos

POST

api

community

link

:instance

Vincular grupos

curl --request POST \
  --url https://api.example.com/api/community/link/:instance \
  --header 'Content-Type: <content-type>' \
  --header 'token: <token>' \
  --data '
{
  "communityJid": "<string>",
  "groupJid": [
    "<string>"
  ]
}
'

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({communityJid: '<string>', groupJid: ['<string>']})
};

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

payload = {
    "communityJid": "<string>",
    "groupJid": ["<string>"]
}
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

Vincula uno o más grupos existentes a una comunidad. Cada vinculación tiene un delay interno de 1s para evitar throttling del servidor de WhatsApp. Los fallos individuales no abortan la operación, van al array failed.

Ejemplos

Vincular 2 grupos

Adjunta en bloque 2 grupos existentes a la comunidad 120363406289005073@g.us en una sola llamada. El servicio aplica un delay interno de 1s entre vinculaciones para evitar throttling.

curl -X POST "https://ryzeapi.cloud/api/community/link/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "communityJid": "120363406289005073@g.us",
    "groupJid": [
      "120363406289005074@g.us",
      "120363406289005075@g.us"
    ]
  }'

await fetch(`https://ryzeapi.cloud/api/community/link/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    communityJid: "120363406289005073@g.us",
    groupJid: [
      "120363406289005074@g.us",
      "120363406289005075@g.us"
    ]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/community/link/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "communityJid": "120363406289005073@g.us",
        "groupJid": [
            "120363406289005074@g.us",
            "120363406289005075@g.us"
        ]
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "communityJid": "120363406289005073@g.us",
        "groupJid": [
            "120363406289005074@g.us",
            "120363406289005075@g.us"
        ]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/community/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)
}

Vincular 1 grupo

Vincula un solo grupo a la comunidad. El array groupJid acepta 1 o más elementos, útil cuando quieres agregar subgrupos uno por uno.

curl -X POST "https://ryzeapi.cloud/api/community/link/$Instance_Name" \
  -H "token: $Token_Instance" \
  -H "Content-Type: application/json" \
  -d '{
    "communityJid": "120363406289005073@g.us",
    "groupJid": ["120363406289005074@g.us"]
  }'

await fetch(`https://ryzeapi.cloud/api/community/link/${process.env.Instance_Name}`, {
  method: "POST",
  headers: {
    "token":        process.env.Token_Instance,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    communityJid: "120363406289005073@g.us",
    groupJid: ["120363406289005074@g.us"]
  })
});

import os, requests

requests.post(
    f"https://ryzeapi.cloud/api/community/link/{os.environ['Instance_Name']}",
    headers={
        "token":        os.environ["Token_Instance"],
        "Content-Type": "application/json"
    },
    json={
        "communityJid": "120363406289005073@g.us",
        "groupJid":     ["120363406289005074@g.us"]
    }
)

package main

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

func main() {
    body := strings.NewReader(`{
        "communityJid": "120363406289005073@g.us",
        "groupJid": ["120363406289005074@g.us"]
    }`)
    req, _ := http.NewRequest("POST", "https://ryzeapi.cloud/api/community/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

Devuelve el conteo en message (formato "Linked N of M groups to community"), el array linked con los JIDs vinculados con éxito, y failed con los que no se procesaron (JID inválido, grupo ya vinculado a otra comunidad o bot sin permiso). success es true cuando se vinculó al menos un grupo.

200 OK

{
  "success": true,
  "message": "Linked 2 of 2 groups to community",
  "linked": [
    "120363406289005074@g.us",
    "120363406289005075@g.us"
  ],
  "failed": []
}

Tanto el éxito parcial como el fallo total devuelven HTTP 200. Verifica siempre success + failed[] del lado del cliente para detectar errores por grupo.

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

string

requerido

application/json

Cuerpo de la solicitud

string

requerido

JID @g.us de la comunidad.

string[]

requerido

Array de JIDs @g.us de los grupos a vincular. Al menos 1 elemento.

Notas

Un grupo ya vinculado a otra comunidad termina en failed[], desvincúlalo primero mediante /unlink.
Límite de 50 subgrupos por comunidad. Los excedentes fallan silenciosamente.
El Grupo de Anuncios ya pertenece a la comunidad desde la creación y no puede vincularse.
El bot debe ser administrador tanto de la comunidad como del grupo que se vincula.

Errores

HTTP	Mensaje
400	`community jid is required`
400	`group jid is required`
400	`Instance is not connected to WhatsApp`
500	`error parse community jid: <reason>`

Envoltorio:

{
  "success": false,
  "error": { "message": "community jid is required" }
}

Desvincular grupos

Elimina grupos de la comunidad.

Listar subgrupos

Confirma los subgrupos vinculados.

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Vincular grupos

Descripción

Ejemplos

Vincular 2 grupos

Vincular 1 grupo

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores

Siguiente

Desvincular grupos

Listar subgrupos

​Descripción

​Ejemplos

​Vincular 2 grupos

​Vincular 1 grupo

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Cuerpo de la solicitud

​Notas

​Errores

​Siguiente

Desvincular grupos

Listar subgrupos

Descripción

Ejemplos

Vincular 2 grupos

Vincular 1 grupo

Respuesta exitosa

Parámetros de ruta

Cabeceras

Cuerpo de la solicitud

Notas

Errores

Siguiente