> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oxenty.api.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Link de Convite

> Obtém ou revoga link de convite do grupo

Gerencia o link de convite de um grupo WhatsApp.

## Obter Link de Convite

<api method="GET" path="/api/groups/invite-code" />

Obtém o código e link de convite atual do grupo.

### Query Parameters

<ParamField query="sessionId" type="string" required>
  ID da sessão WhatsApp.
</ParamField>

<ParamField query="groupJid" type="string" required>
  JID do grupo.
</ParamField>

### Resposta

<ResponseField name="success" type="boolean">
  Se a operação foi bem-sucedida.
</ResponseField>

<ResponseField name="code" type="string">
  Código de convite.
</ResponseField>

<ResponseField name="link" type="string">
  Link completo de convite.
</ResponseField>

<RequestExample>
  ```bash cURL theme={"system"}
  curl -X GET "https://api.oxenty.api.br/api/groups/invite-code?sessionId=550e8400-e29b-41d4-a716-446655440000&groupJid=123456789@g.us" \
    -H "X-API-Key: YOUR_API_KEY"
  ```

  ```typescript TypeScript theme={"system"}
  const invite = await client.groups.getInviteCode({
    sessionId: '550e8400-e29b-41d4-a716-446655440000',
    groupJid: '123456789@g.us',
  });

  console.log(invite.link); // https://chat.whatsapp.com/ABC123...
  ```
</RequestExample>

<ResponseExample>
  ```json 200 OK theme={"system"}
  {
    "success": true,
    "code": "ABC123XYZ",
    "link": "https://chat.whatsapp.com/ABC123XYZ"
  }
  ```
</ResponseExample>

***

## Revogar Link de Convite

<api method="POST" path="/api/groups/invite-code/revoke" />

Revoga o link de convite atual e gera um novo.

```bash theme={"system"}
curl -X POST "https://api.oxenty.api.br/api/groups/invite-code/revoke" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "groupJid": "123456789@g.us"
  }'
```

```json theme={"system"}
{
  "success": true,
  "code": "NEW456CODE",
  "link": "https://chat.whatsapp.com/NEW456CODE"
}
```

***

## Entrar em Grupo por Convite

<api method="POST" path="/api/groups/join" />

Entra em um grupo usando o código de convite.

```bash theme={"system"}
curl -X POST "https://api.oxenty.api.br/api/groups/join" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "code": "ABC123XYZ"
  }'
```

```json theme={"system"}
{
  "success": true,
  "groupJid": "123456789@g.us"
}
```

<Note>
  O código de convite é a parte final da URL: `https://chat.whatsapp.com/**ABC123XYZ**`
</Note>