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

# Info do canal

> Obtém detalhes de um canal por JID, link ou código de convite

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sim

## Descrição

Retorna o `NewsletterChannel` completo. Útil para preview antes de seguir um canal, funciona mesmo que você **não esteja inscrito**.

## Exemplos

### Por JID

Consulta os metadados do canal pelo JID canônico (`@newsletter`). Funciona mesmo que a conta não esteja inscrita, útil para preview antes de chamar `/join`.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name?identifier=120363422585881117@newsletter" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/newsletter/info/${process.env.Instance_Name}?identifier=120363422585881117@newsletter`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

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

  requests.get(
      f"https://ryzeapi.cloud/api/newsletter/info/{os.environ['Instance_Name']}",
      params={"identifier": "120363422585881117@newsletter"},
      headers={
          "token": os.environ["Token_Instance"]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/newsletter/info/"+os.Getenv("Instance_Name")+"?identifier=120363422585881117@newsletter", nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Por link

Consulta o canal pelo link de convite completo. O servidor faz o url-decode e resolve o código antes de buscar os metadados, retornando o mesmo `NewsletterChannel`.

<CodeGroup>
  ```bash cURL theme={null}
  curl -G "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name" \
    --data-urlencode "identifier=https://whatsapp.com/channel/120363422585881117" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  const params = new URLSearchParams({ identifier: "https://whatsapp.com/channel/120363422585881117" });
  await fetch(`https://ryzeapi.cloud/api/newsletter/info/${process.env.Instance_Name}?${params}`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

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

  requests.get(
      f"https://ryzeapi.cloud/api/newsletter/info/{os.environ['Instance_Name']}",
      params={"identifier": "https://whatsapp.com/channel/120363422585881117"},
      headers={
          "token": os.environ["Token_Instance"]
      }
  )
  ```

  ```go Go theme={null}
  package main

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

  func main() {
      q := url.Values{}
      q.Set("identifier", "https://whatsapp.com/channel/120363422585881117")
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/newsletter/info/"+os.Getenv("Instance_Name")+"?"+q.Encode(), nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

### Por código

Consulta o canal apenas com o código de convite (sufixo do link). Mesmo resultado, mais conciso quando você já tem o código extraído.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/newsletter/info/$Instance_Name?identifier=120363422585881117" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/newsletter/info/${process.env.Instance_Name}?identifier=120363422585881117`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

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

  requests.get(
      f"https://ryzeapi.cloud/api/newsletter/info/{os.environ['Instance_Name']}",
      params={"identifier": "120363422585881117"},
      headers={
          "token": os.environ["Token_Instance"]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/newsletter/info/"+os.Getenv("Instance_Name")+"?identifier=120363422585881117", nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Resposta de sucesso

A resposta retorna o `NewsletterChannel` completo, com `channel.jid` canônico, `state` atual (`active`, `suspended`, etc.), nome, descrição, `inviteLink` (quando disponível), `subscriberCount` e `pictureUrl`. Os campos `inviteLink` e `pictureUrl` são opcionais e podem vir ausentes quando a conta não tem permissão para enxergá-los.

```json 200 OK theme={null}
{
  "success": true,
  "message": "Newsletter info retrieved",
  "channel": {
    "jid": "120363422585881117@newsletter",
    "state": "active",
    "name": "Tech News",
    "description": "Latest tech updates",
    "inviteLink": "https://whatsapp.com/channel/120363422585881117",
    "subscriberCount": 500,
    "pictureUrl": "https://exemplo.com/tech.jpg"
  }
}
```

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` ou `TokenInstance`.
</ParamField>

## Query

<ParamField query="identifier" type="string" required>
  JID `@newsletter`, link completo (`https://whatsapp.com/channel/<id>`) ou apenas o código (`<id>`).
</ParamField>

## Notas

<Note>
  * É a forma certa de **preview** antes de chamar [`/join`](/pt/api/newsletter/join).
  * `subscriberCount` pode vir defasado (cache do WhatsApp).
  * Códigos são **case-sensitive**: `ABC123` não é o mesmo que `abc123`.
  * `inviteLink` só vem se a conta tiver permissão para enxergá-lo.
</Note>

## Erros

| HTTP | Mensagem                                                                             |
| ---- | ------------------------------------------------------------------------------------ |
| 400  | `The 'identifier' query parameter is required (JID @newsletter or invite link/code)` |
| 400  | `Invalid newsletter identifier (use JID @newsletter or invite link/code)`            |
| 400  | `newsletter not found or no metadata returned`                                       |
| 500  | `failed to get newsletter info: <reason>`                                            |
| 501  | `WhatsApp client does not support GetNewsletterInfo`                                 |

Envelope:

```json theme={null}
{
  "success": false,
  "error": { "message": "Invalid newsletter identifier (use JID @newsletter or invite link/code)" }
}
```