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

# Cartas & Telegrama

> Crie e acompanhe pedidos dos Correios: cartas, AR, telegramas, mala direta, Sedex e e-Carta.

A API de pedidos `v2` cobre todos os produtos físicos e híbridos. O campo
`shipType` seleciona o produto e determina quais campos são obrigatórios.

## Tipos de envio

| `shipType` | Produto                | Documento      |
| ---------- | ---------------------- | -------------- |
| 1          | Carta Simples          | `pdfFile`      |
| 2          | Carta Registrada       | `pdfFile`      |
| 3          | Carta Registrada + AR  | `pdfFile`      |
| 4          | Telegrama              | `telegram_msg` |
| 5          | Mala Direta            | `pdfFile`      |
| 6          | Sedex                  | `pdfFile`      |
| 7          | Sedex + AR             | `pdfFile`      |
| 8          | eCarta Simples         | `ecarta_msg`   |
| 9          | eCarta Registrada      | `ecarta_msg`   |
| 10         | eCarta Registrada + AR | `ecarta_msg`   |

## Endpoints

| Método   | Caminho                                            | Descrição                   |
| -------- | -------------------------------------------------- | --------------------------- |
| `POST`   | `/api/v2/post`                                     | Criar um pedido             |
| `GET`    | `/api/v2/get/{securityToken}/{job_id}`             | Consultar um pedido         |
| `DELETE` | `/api/v2/delete/{securityToken}/{job_id}`          | Cancelar um pedido          |
| `GET`    | `/api/v2/download/{securityToken}/{job_id}/{type}` | Baixar um arquivo do pedido |

Os schemas completos de requisição/resposta estão na aba **Referência da API**.

## Enviando o documento

O campo `pdfFile` aceita três formas:

* **Base64** — uma string PDF codificada em base64
* **URL** — uma URL pública (buscada no servidor via proxy); links públicos de
  Google Docs/Drive são suportados
* **Upload de arquivo** — uma parte de arquivo `multipart/form-data`

PDFs devem ter **≤ 150 páginas** e **não podem ter senha**.

<Tip>
  Sempre faça uma requisição `test=1` primeiro para validar o endereço, a
  contagem de páginas e o preço sem debitar créditos.
</Tip>

## Telegramas & e-Carta

Esses produtos levam um corpo de texto em vez de um PDF (o conteúdo
renderizado é limitado a **10 páginas**):

* `shipType=4` exige `telegram_msg` (mín. 10 caracteres) **e** as flags
  `telegram_post_dated`, `telegram_sender_copy` e
  `telegram_delivery_confirmation` (cada uma deve estar presente com valor 0
  ou 1). Quando `telegram_post_dated=1`, `telegram_post_dated_date` deve ser
  uma data futura.
* `shipType=8|9|10` exigem `ecarta_msg` (mín. 10 caracteres, pode conter HTML).

## Baixando arquivos

`/api/v2/download/{securityToken}/{job_id}/{type}` retorna o conteúdo em base64. O parâmetro `type` seleciona
o arquivo:

| `type`          | Arquivo                                                                                                    |
| --------------- | ---------------------------------------------------------------------------------------------------------- |
| `pdf`           | O documento enviado                                                                                        |
| `letter_front`  | Frente do envelope renderizada                                                                             |
| `rr`            | Aviso de recebimento físico (AR) — `file_name` opcional seleciona um entre vários; padrão é o mais recente |
| `rr_electronic` | Aviso de recebimento eletrônico — `file_name` opcional, mesmo comportamento                                |
| `sender_copy`   | Via do remetente                                                                                           |