Proveedores de Despacho

GET /api/dispatch-providers

Lista todos los proveedores de despacho globales con sus definiciones de canales.

Auth: Requerida — permiso VIEW_ACTIVITIES

Respuesta `200 OK`

[
  {
    "id": "660e8400-e29b-41d4-a716-446655440000",
    "code": "YOM",
    "name": "YOM Provider",
    "protocolType": "REST",
    "isActive": true,
    "channelDefinitions": [
      {
        "channel": "SALESMAN",
        "credentialSchema": [
          {
            "key": "apiKey",
            "label": "API Key",
            "type": "password",
            "required": true
          }
        ],
        "settingsSchema": []
      }
    ]
  }
]

GET /api/dispatch-providers/:id/channel-definitions

Lista las definiciones de canales de un proveedor de despacho específico.

Auth: Requerida — permiso VIEW_ACTIVITIES

Parámetros de Ruta

Parámetro	Tipo	Descripción
`id`	UUID	ID del proveedor de despacho

Ejemplo

curl https://api.reten.ai/api/dispatch-providers/660e8400-e29b-41d4-a716-446655440000/channel-definitions \
  -H "Authorization: Bearer <token>"

const providerId = "660e8400-e29b-41d4-a716-446655440000";
const response = await fetch(`https://api.reten.ai/api/dispatch-providers/${providerId}/channel-definitions`, {
  headers: { "Authorization": "Bearer <token>" },
});
const definitions = await response.json();

import requests

provider_id = "660e8400-e29b-41d4-a716-446655440000"
response = requests.get(
    f"https://api.reten.ai/api/dispatch-providers/{provider_id}/channel-definitions",
    headers={"Authorization": "Bearer <token>"},
)
definitions = response.json()

Respuesta `200 OK`

[
  {
    "id": "770e8400-e29b-41d4-a716-446655440000",
    "dispatchProviderId": "660e8400-e29b-41d4-a716-446655440000",
    "channel": "SALESMAN",
    "credentialSchema": [
      {
        "key": "apiKey",
        "label": "API Key",
        "type": "password",
        "required": true
      }
    ],
    "settingsSchema": [],
    "createdAt": "2025-01-15T10:00:00.000Z",
    "updatedAt": "2025-01-15T10:00:00.000Z"
  }
]

Respuestas de Error

Estado	Descripción
`404`	Proveedor de despacho no encontrado

POST /api/dispatch-providers

Crea un nuevo proveedor de despacho global.

Auth: Requerida — permiso MANAGE_ACTIVITY_CONFIG

Cuerpo de la Solicitud

Campo	Tipo	Requerido	Descripción
`code`	string	Sí	Código único del proveedor
`name`	string	Sí	Nombre del proveedor
`protocol_type`	string	Sí	`REST`, `WEBHOOK`, `EMAIL`, `SMS` o `WSP`

Respuesta `201 Created`

PATCH /api/dispatch-providers/:id

Actualiza un proveedor de despacho.

Auth: Requerida — permiso MANAGE_ACTIVITY_CONFIG

Cuerpo de la Solicitud

Campo	Tipo	Requerido	Descripción
`name`	string	No	Nombre del proveedor
`protocol_type`	string	No	Tipo de protocolo
`is_active`	boolean	No	Estado activo