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

Descrição

Vincula um ou mais grupos existentes a uma comunidade. Cada vinculação tem delay interno de 1s para evitar throttling do servidor WhatsApp. Falhas individuais não abortam a operação, vão para o array failed.

Exemplos

Vincular 2 grupos

Anexa em lote 2 grupos existentes à comunidade 120363406289005073@g.us numa única chamada. O serviço aplica delay interno de 1s entre as vinculações 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 um único grupo à comunidade. O array groupJid aceita 1 ou mais itens, útil quando você quer adicionar subgrupos um a um.

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

Resposta de sucesso

Devolve a contagem em message (formato "Linked N of M groups to community"), o array linked com os JIDs vinculados com sucesso e failed com os que não foram processados (JID inválido, grupo já vinculado a outra comunidade ou bot sem permissão). success é true quando ao menos um grupo foi vinculado.

200 OK

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

Sucesso parcial e falha total retornam HTTP 200. Sempre cheque success + failed[] no cliente para detectar erros por grupo.

Parâmetros de rota

string

obrigatório

Nome da instância.

Headers

string

obrigatório

TokenAccount ou TokenInstance.

string

obrigatório

application/json

Request body

string

obrigatório

JID @g.us da comunidade.

string[]

obrigatório

Array de JIDs @g.us dos grupos a vincular. Pelo menos 1 item.

Notas

Grupo já vinculado a outra comunidade cai em failed[], desvincule antes via /unlink.
Limite de 50 subgrupos por comunidade. Excedentes falham silenciosamente.
O Grupo de Anúncios já pertence à comunidade desde a criação e não pode ser vinculado.
Bot precisa ser admin tanto da comunidade quanto do grupo sendo vinculado.

Erros

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

Envelope:

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

Desvincular grupos

Remover grupos da comunidade.

Listar subgrupos

Confirmar os subgrupos vinculados.

Introdução

Instância

Eventos

Mensagens

Chamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidade

Vincular grupos

Descrição

Exemplos

Vincular 2 grupos

Vincular 1 grupo

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros

Próximo

Desvincular grupos

Listar subgrupos

​Descrição

​Exemplos

​Vincular 2 grupos

​Vincular 1 grupo

​Resposta de sucesso

​Parâmetros de rota

​Headers

​Request body

​Notas

​Erros

​Próximo

Desvincular grupos

Listar subgrupos

Descrição

Exemplos

Vincular 2 grupos

Vincular 1 grupo

Resposta de sucesso

Parâmetros de rota

Headers

Request body

Notas

Erros

Próximo