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

# Ingressar no Grupo via Código

> Ingressar em um grupo usando código de convite

## Descrição

Este endpoint permite ingressar em um grupo usando um código de convite.

## Parâmetros de URL

<ParamField path="session" type="string" required>
  ID único da sessão WhatsApp
</ParamField>

## Body

```json theme={null}
{
  "code": "valor"
}
```

### Parâmetros do Body

| Propriedade | Tipo     | Obrigatório | Descrição                  |
| ----------- | -------- | ----------- | -------------------------- |
| `code`      | `string` | ✅ Sim       | Código de convite do grupo |

## Resposta

<ResponseExample>
  ```json Resposta de Sucesso theme={null}
  {
    "success": true,
    "groupId": "120363XXXXX@g.us",
    "message": "Você ingressou no grupo com sucesso"
  }
  ```
</ResponseExample>

## Códigos de Status

* `200` - Ingresso realizado com sucesso
* `400` - Código inválido
* `401` - Não autorizado
* `404` - Grupo não encontrado

## Exemplo de Uso

<CodeGroup>
  ```bash cURL theme={null}
  curl -X POST https://api.wappfy.com.br/api/my-session/groups/join \
    -H "Content-Type: application/json" \
    -d '{
      "code": "Abc123Xyz456"
    }'
  ```

  ```javascript JavaScript theme={null}
  const session = 'my-session';
  const response = await fetch(`https://api.wappfy.com.br/api/${session}/groups/join`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      code: 'Abc123Xyz456'
    })
  });
  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  session = 'my-session'
  response = requests.post(
    f'https://api.wappfy.com.br/api/{session}/groups/join',
    json={'code': 'Abc123Xyz456'}
  )
  data = response.json()
  print(data)
  ```
</CodeGroup>


## OpenAPI

````yaml viewer.json post /api/{session}/groups/join
openapi: 3.1.0
info:
  title: Wappfy - WhatsApp HTTP API
  version: '2.0'
  contact: {}
servers:
  - url: https://{host}
    description: Servidor Customizável
    variables:
      host:
        default: api.wappfy.com.br
        description: 'URL do servidor (ex: api.wappfy.com.br ou seu-servidor.com)'
security:
  - api_key: []
tags:
  - name: 🖥️ Sessions
    description: >-
      Controlar sessões do WhatsApp (contas) (Control WhatsApp sessions
      (accounts))
  - name: 🔑 Auth
    description: Autenticação
  - name: 🆔 Profile
    description: Informações do seu perfil
  - name: 🖼️ Screenshot
    description: Obter captura de tela do WhatsApp e mostrar código QR
  - name: 📤 Chatting
    description: Métodos de conversação
  - name: 📢 Channels
    description: Métodos de canais (newsletters) (Channels (newsletters) methods)
  - name: 🟢 Status
    description: Métodos de status (aka stories) (Status (aka stories) methods)
  - name: 💬 Chats
    description: Métodos de conversas
  - name: 👤 Contacts
    description: >-
      Métodos de contatos. Use número de telefone (sem +) ou número de telefone
      e `@c.us` no final como `contactId`. Ex: `12312312310` OU
      `12312312310@c.us` (Contacts methods.<br>
                      Use phone number (without +) or phone number and `@c.us` at the end as `contactId`.<br>
                      'E.g: `12312312310` OR `12312312310@c.us`<br>)
  - name: 👥 Groups
    description: Métodos de grupos (Groups methods).<br>
  - name: ✅ Presence
    description: Informações de presença
  - name: 📅 Events
    description: Mensagem de Evento
  - name: 🏷️ Labels
    description: Etiquetas - disponível apenas para contas WhatsApp Business
  - name: 🔍 Observability
    description: Outros métodos
  - name: 🗄️ Storage
    description: Métodos de armazenamento
externalDocs:
  description: Wappfy - WhatsApp HTTP API
  url: https://wappfy.com.br/
paths:
  /api/{session}/groups/join:
    post:
      tags:
        - 👥 Groups
      summary: Entrar no grupo via código
      description: O parâmetro {session} deve ser o instanceName da sessão.
      operationId: GroupsController_joinGroup
      parameters:
        - name: session
          required: true
          in: path
          description: Nome da sessão (instanceName)
          example: my-session
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JoinGroupRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JoinGroupResponse'
      security:
        - api_key: []
components:
  schemas:
    JoinGroupRequest:
      type: object
      properties:
        code:
          type: string
          description: >-
            Código do grupo (123) ou url (https://chat.whatsapp.com/123) (Group
            code (123) or url (https://chat.whatsapp.com/123))
          example: https://chat.whatsapp.com/1234567890abcdef
      required:
        - code
    JoinGroupResponse:
      type: object
      properties:
        id:
          type: string
          description: ID do Grupo
          example: 123@g.us
      required:
        - id
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: apikey
      description: Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

````