> For the complete documentation index, see [llms.txt](https://docs.editran.onesait.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.editran.onesait.com/documentacion-editran/editran-connect-v3.3/api/v2/transfers.md).

# Transmisiones

## 1. Descripción

API para consultar y gestionar transferencias (transmisiones o ejecuciones) de canales.

### Operaciones disponibles

* Obtener lista de transferencias de un canal
* Obtener detalle de una transferencia de un canal
* Resetear un canal
* Reintentar una transferencia de un canal
* Iniciar una transferencia de un canal

***

## 2. Obtener lista de transferencias de un canal

### 2.1. Información general

**Método:** `GET`\
**URL:** `https://<tu_servidor>/integration/v2/channels/{channelCode}/transfers` **Descripción:** Obtiene una lista paginada de transferencias de un canal específico. La respuesta incluye información detallada de cada transferencia, como su estado, fecha, dirección y detalles de los archivos involucrados en la transferencia.\
Esta operación requiere autenticación y está restringida a ciertos roles de usuario.

### 2.2. Cabeceras

```http
accept: application/json
Authorization: Bearer <token>
```

### 2.3. Parámetros

| Parámetro   | Tipo   | Obligatorio | Descripción                                                      | Valor por defecto |
| ----------- | ------ | ----------- | ---------------------------------------------------------------- | ----------------- |
| channelCode | string | Sí          | Código del canal. Formato: `codigoLocal-codigoRemoto-aplicacion` |                   |
| initialDate | string | No          | Fecha de ejecución inicial. Formato: `yyyy-MM-dd`                |                   |
| endDate     | string | No          | Fecha de ejecución final. Formato: `yyyy-MM-dd`                  |                   |
| page        | int    | Sí          | Número de página                                                 | 1                 |
| size        | int    | Sí          | Tamaño de página                                                 | 1                 |

### 2.4. Ejemplo de petición

```bash
curl -X 'GET' \
  'https://<tu_servidor>/integration/v2/channels/123456789-987654321-APP001/transfers?page=1&size=10' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJBdXRob3JpemF0...'
```

### 2.5. Seguridad

#### Autenticación

* Esta operación requiere autenticación mediante un token JWT válido.
* El token debe ser incluido en la cabecera `Authorization` con el formato `Bearer <token>`.

#### Roles autorizados

| Código                   | Descripción                        |
| ------------------------ | ---------------------------------- |
| ROLE\_GLOBALADMIN        | Administrador Global               |
| ROLE\_ADMIN              | Administrador                      |
| ROLE\_ADVOPERATOR        | Operador Avanzado                  |
| ROLE\_OPERATOR           | Operador                           |
| ROLE\_ADMINFF            | Administrador de Firma             |
| ROLE\_ADMINCONTROLATORFF | Administrador Controlador de Firma |

### 2.6. Respuestas

#### Códigos de estado

| Código | Descripción                |
| ------ | -------------------------- |
| 200    | Operación exitosa          |
| 401    | No autorizado              |
| 403    | Prohibido                  |
| 404    | No encontrado              |
| 500    | Error interno del servidor |

#### Respuesta 200 OK

Devuelve un objeto paginado con la lista de transferencias del canal.

**Estructura**

```json
{
  "totalPages": 1073741824,
  "totalElements": 9007199254740991,
  "size": 1073741824,
  "content": [
    {
      "channelCode": "string",
      "transferId": "string",
      "transferStartDateTime": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "transferEndDateTime": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
      "direction": "string",
      "status": "string",
      "error": "string",
      "type": "string",
      "encryption": true,
      "files": [
        {
          "fileName": "string",
          "path": "string",
          "hash": "string",
          "size": "string",
          "actionPost": "string",
          "filePathPost": "string"
        }
      ]
    }
  ],
  "number": 1073741824,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "first": true,
  "last": true,
  "pageable": {
    "offset": 9007199254740991,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "pageNumber": 1073741824,
    "pageSize": 1073741824,
    "paged": true,
    "unpaged": true
  },
  "numberOfElements": 1073741824,
  "empty": true
}
```

**Datos de paginación**

| Campo            | Descripción                             |
| ---------------- | --------------------------------------- |
| totalPages       | Número total de páginas                 |
| totalElements    | Número total de elementos               |
| size             | Tamaño de página                        |
| number           | Página actual                           |
| first            | Indica si es la primera página          |
| last             | Indica si es la última página           |
| numberOfElements | Número de elementos en la página actual |
| empty            | Indica si la página está vacía          |

**Contenido**

| Campo   | Descripción                        |
| ------- | ---------------------------------- |
| content | Lista de transferencias del canal. |

***

## 3. Obtener detalle de una transferencia de un canal

### 3.1. Información general

**Método:** `GET`\
**URL:** `https://<tu_servidor>/integration/v2/channels/{channelCode}/transfers/{transferId}` **Descripción:** Obtiene el detalle de una transferencia específica de un canal. La respuesta incluye información detallada de la transferencia, como su estado, fecha, dirección y detalles de los archivos involucrados en la transferencia.\
Esta operación requiere autenticación y está restringida a ciertos roles de usuario.

### 3.2. Cabeceras

```http
accept: application/json
Authorization: Bearer <token>
```

### 3.3. Parámetros

| Parámetro   | Tipo   | Obligatorio | Descripción                                                      | Valor por defecto |
| ----------- | ------ | ----------- | ---------------------------------------------------------------- | ----------------- |
| channelCode | string | Sí          | Código del canal. Formato: `codigoLocal-codigoRemoto-aplicacion` |                   |
| transferId  | string | Sí          | Identificador de la transferencia                                |                   |

### 3.4. Ejemplo de petición

```bash
curl -X 'GET' \
  'https://<tu_servidor>/integration/v2/channels/123456789-987654321-APP001/transfers/20000101000000-123456789-987654321-APP001-E' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJBdXRob3JpemF0...'
```

### 3.5. Seguridad

#### Autenticación

* Esta operación requiere autenticación mediante un token JWT válido.
* El token debe ser incluido en la cabecera `Authorization` con el formato `Bearer <token>`.

#### Roles autorizados

| Código                   | Descripción                        |
| ------------------------ | ---------------------------------- |
| ROLE\_GLOBALADMIN        | Administrador Global               |
| ROLE\_ADMIN              | Administrador                      |
| ROLE\_ADVOPERATOR        | Operador Avanzado                  |
| ROLE\_OPERATOR           | Operador                           |
| ROLE\_ADMINFF            | Administrador de Firma             |
| ROLE\_ADMINCONTROLATORFF | Administrador Controlador de Firma |

### 3.6. Respuestas

#### Códigos de estado

| Código | Descripción                |
| ------ | -------------------------- |
| 200    | Operación exitosa          |
| 401    | No autorizado              |
| 403    | Prohibido                  |
| 404    | No encontrado              |
| 500    | Error interno del servidor |

#### Respuesta 200 OK

Devuelve un objeto con el detalle de la transferencia del canal.

**Estructura**

```json
{
  "channelCode": "string",
  "transferId": "string",
  "transferStartDateTime": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "transferEndDateTime": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
  "direction": "string",
  "status": "string",
  "error": "string",
  "type": "string",
  "encryption": true,
  "files": [
    {
      "fileName": "string",
      "path": "string",
      "hash": "string",
      "size": "string",
      "actionPost": "string",
      "filePathPost": "string"
    }
  ]
}
```

***

## 4. Resetear un canal

### 4.1. Información general

**Método:** `POST`\
**URL:** `https://<tu_servidor>/integration/v2/channels/{channelCode}/transfers/reset` **Descripción:** Permite resetear un canal específico. Esta operación reinicia el estado del canal, eliminando cualquier transferencia pendiente o en curso. Es útil para resolver problemas o errores que puedan haber ocurrido durante las transferencias.\
Esta operación requiere autenticación y está restringida a ciertos roles de usuario.

### 4.2. Cabeceras

```http
accept: */*
Authorization: Bearer <token>
```

### 4.3. Parámetros

| Parámetro   | Tipo   | Obligatorio | Descripción                                                      | Valor por defecto |
| ----------- | ------ | ----------- | ---------------------------------------------------------------- | ----------------- |
| channelCode | string | Sí          | Código del canal. Formato: `codigoLocal-codigoRemoto-aplicacion` |                   |

### 4.4. Ejemplo de petición

```bash
curl -X 'POST' \
  'https://<tu_servidor>/integration/v2/channels/123456789-987654321-APP001/transfers/reset' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJBdXRob3JpemF0...' \
  -d ''
```

### 4.5. Seguridad

#### Autenticación

* Esta operación requiere autenticación mediante un token JWT válido.
* El token debe ser incluido en la cabecera `Authorization` con el formato `Bearer <token>`.

#### Roles autorizados

| Código            | Descripción          |
| ----------------- | -------------------- |
| ROLE\_GLOBALADMIN | Administrador Global |
| ROLE\_ADMIN       | Administrador        |
| ROLE\_ADVOPERATOR | Operador Avanzado    |
| ROLE\_OPERATOR    | Operador             |

### 4.6. Respuestas

#### Códigos de estado

| Código | Descripción                |
| ------ | -------------------------- |
| 200    | Operación exitosa          |
| 400    | Solicitud incorrecta       |
| 401    | No autorizado              |
| 403    | Prohibido                  |
| 404    | No encontrado              |
| 409    | Conflicto                  |
| 500    | Error interno del servidor |

***

## 5. Reintentar una transferencia de un canal

### 5.1. Información general

**Método:** `POST`\
**URL:** `https://<tu_servidor>/integration/v2/channels/{channelCode}/transfers/retry` **Descripción:** Permite reintentar la última transferencia fallida de un canal específico. Esta operación es útil para resolver problemas temporales que puedan haber causado el fallo de una transferencia, como problemas de red o de disponibilidad del servidor.\
Esta operación requiere autenticación y está restringida a ciertos roles de usuario.

### 5.2. Cabeceras

```http
accept: */*
Authorization: Bearer <token>
```

### 5.3. Parámetros

| Parámetro   | Tipo   | Obligatorio | Descripción                                                      | Valor por defecto |
| ----------- | ------ | ----------- | ---------------------------------------------------------------- | ----------------- |
| channelCode | string | Sí          | Código del canal. Formato: `codigoLocal-codigoRemoto-aplicacion` |                   |

### 5.4. Ejemplo de petición

```bash
curl -X 'POST' \
  'https://<tu_servidor>/integration/v2/channels/123456789-987654321-APP001/transfers/retry' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJBdXRob3JpemF0...' \
  -d ''
```

### 5.5. Seguridad

#### Autenticación

* Esta operación requiere autenticación mediante un token JWT válido.
* El token debe ser incluido en la cabecera `Authorization` con el formato `Bearer <token>`.

#### Roles autorizados

| Código            | Descripción          |
| ----------------- | -------------------- |
| ROLE\_GLOBALADMIN | Administrador Global |
| ROLE\_ADMIN       | Administrador        |
| ROLE\_ADVOPERATOR | Operador Avanzado    |
| ROLE\_OPERATOR    | Operador             |

### 5.6. Respuestas

#### Códigos de estado

| Código | Descripción                |
| ------ | -------------------------- |
| 200    | Operación exitosa          |
| 400    | Solicitud incorrecta       |
| 401    | No autorizado              |
| 403    | Prohibido                  |
| 404    | No encontrado              |
| 409    | Conflicto                  |
| 500    | Error interno del servidor |

***

## 6. Iniciar una transferencia de un canal

### 6.1. Información general

**Método:** `POST`\
**URL:** `https://<tu_servidor>/integration/v2/channels/{channelCode}/transfers/send` **Descripción:** Permite iniciar una nueva transferencia en un canal específico. Esta operación es útil para enviar archivos a través del canal, ya sea de forma manual o programada. La transferencia se inicia con los archivos configurados en el canal y sigue el proceso de envío establecido.\
Esta operación requiere autenticación y está restringida a ciertos roles de usuario.

### 6.2. Cabeceras

```http
accept: */*
Authorization: Bearer <token>
```

### 6.3. Parámetros

| Parámetro   | Tipo   | Obligatorio | Descripción                                                      | Valor por defecto |
| ----------- | ------ | ----------- | ---------------------------------------------------------------- | ----------------- |
| channelCode | string | Sí          | Código del canal. Formato: `codigoLocal-codigoRemoto-aplicacion` |                   |

### 6.4. Ejemplo de petición

```bash
curl -X 'POST' \
  'https://<tu_servidor>/integration/v2/channels/123456789-987654321-APP001/transfers/send' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJBdXRob3JpemF0...' \
  -d ''
```

### 6.5. Seguridad

#### Autenticación

* Esta operación requiere autenticación mediante un token JWT válido.
* El token debe ser incluido en la cabecera `Authorization` con el formato `Bearer <token>`.

#### Roles autorizados

| Código            | Descripción          |
| ----------------- | -------------------- |
| ROLE\_GLOBALADMIN | Administrador Global |
| ROLE\_ADMIN       | Administrador        |
| ROLE\_ADVOPERATOR | Operador Avanzado    |
| ROLE\_OPERATOR    | Operador             |

### 6.6. Respuestas

#### Códigos de estado

| Código | Descripción                |
| ------ | -------------------------- |
| 200    | Operación exitosa          |
| 400    | Solicitud incorrecta       |
| 401    | No autorizado              |
| 403    | Prohibido                  |
| 404    | No encontrado              |
| 409    | Conflicto                  |
| 500    | Error interno del servidor |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.editran.onesait.com/documentacion-editran/editran-connect-v3.3/api/v2/transfers.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.