# Atividades

> Gerencie conversas e interações com contatos

- Página: https://tbit.app/pt/docs/api/activities
- URL base: `https://rest-api.tbit.app/v1`
- Autenticação: cabeçalho `X-API-Key` com a sua chave em cada requisição (os exemplos a leem da variável de ambiente `TBIT_API_KEY`)

## Visão geral

As atividades representam conversas entre o seu agente e os contatos. Cada atividade acompanha uma conversa em um ou mais canais, incluindo status, etiquetas e atribuição.

## Endpoints

| Método | Rota | Descrição |
| --- | --- | --- |
| `GET` | `/v1/activities` | Listar atividades |
| `GET` | `/v1/activities/:id` | Obter o detalhe de uma atividade |
| `PATCH` | `/v1/activities/:id` | Atualizar uma atividade |
| `POST` | `/v1/activities/:id/tags` | Adicionar etiquetas a uma atividade |
| `DELETE` | `/v1/activities/:id/tags?tag_id=X` | Remover uma etiqueta de uma atividade |

## Parâmetros de consulta

O endpoint de listagem aceita os seguintes parâmetros de consulta:

| Parâmetro | Tipo | Descrição |
| --- | --- | --- |
| `limit` | `number` | Resultados por página (padrão: 20, máx.: 100) |
| `offset` | `number` | Quantidade de resultados a pular (padrão: 0) |
| `status` | `string` | Filtrar por status: open, closed, pending |
| `tag` | `string` | Filtrar por ID de etiqueta |
| `search` | `string` | Buscar por nome ou telefone do contato |

## Listar atividades

`GET /v1/activities`

```bash
curl "https://rest-api.tbit.app/v1/activities?limit=20&offset=0&status=open" \
  -H "X-API-Key: $TBIT_API_KEY"
```

## Obter o detalhe de uma atividade

`GET /v1/activities/64f1a2b3c4d5e6f7a8b9c0d1`

```bash
curl "https://rest-api.tbit.app/v1/activities/64f1a2b3c4d5e6f7a8b9c0d1" \
  -H "X-API-Key: $TBIT_API_KEY"
```

## Atualizar atividade

`PATCH /v1/activities/64f1a2b3c4d5e6f7a8b9c0d1`

```bash
curl -X PATCH "https://rest-api.tbit.app/v1/activities/64f1a2b3c4d5e6f7a8b9c0d1" \
  -H "X-API-Key: $TBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "closed",
    "assigned_to": "agent_user_id",
    "profile_name": "John Doe"
  }'
```

## Adicionar etiquetas

`POST /v1/activities/64f1a2b3c4d5e6f7a8b9c0d1/tags`

```bash
curl -X POST "https://rest-api.tbit.app/v1/activities/64f1a2b3c4d5e6f7a8b9c0d1/tags" \
  -H "X-API-Key: $TBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tag_ids": [
      "tag_id_1",
      "tag_id_2"
    ]
  }'
```

## Remover etiqueta

`DELETE /v1/activities/64f1a2b3c4d5e6f7a8b9c0d1/tags`

```bash
curl -X DELETE "https://rest-api.tbit.app/v1/activities/64f1a2b3c4d5e6f7a8b9c0d1/tags?tag_id=tag_id_1" \
  -H "X-API-Key: $TBIT_API_KEY"
```

## Formato da resposta

Os endpoints de listagem retornam resultados paginados:

```json
{
  "data": [
    {
      "id": "64f1a2b3c4d5e6f7a8b9c0d1",
      "status": "open",
      "profile_name": "John Doe",
      "channel_identifiers": ["573001234567"],
      "tags": [
        { "id": "tag_1", "name": "VIP", "color": "#ef4444" }
      ],
      "assigned_to": null,
      "created_at": "2024-09-01T12:00:00Z",
      "updated_at": "2024-09-01T14:30:00Z"
    }
  ],
  "pagination": {
    "total": 100,
    "limit": 20,
    "offset": 0,
    "has_more": true
  }
}
```