Saltar al contenido
ComdigDocs

Referencia de la API

Verificar token

Devuelve el token (nombre, prefijo, permisos y vencimiento), la empresa a la que pertenece y sus líneas de WhatsApp, con el phone_number_id de cada una.

Úsalo para comprobar un token antes de integrarlo: a qué empresa pertenece, qué permisos tiene, cuándo vence y qué líneas de WhatsApp tiene la empresa, con el phone_number_id de cada una. Funciona con cualquier token válido, sin importar sus permisos.

Solicitud#

GEThttps://api.comdig.co/v1/api-whoami

Permiso requerido: Cualquier token válido

Ejemplo#

Verificar el token
curl -X GET "https://api.comdig.co/v1/api-whoami" \
  -H "X-API-Key: $COMDIG_API_KEY"

Respuestas#

  • 200Token, empresa y líneas

    JSON
    {
      "token": {
        "name": "Mi token",
        "prefix": "sk_live_xxxxxxxx",
        "permissions": [
          "templates:list"
        ],
        "expires_at": null
      },
      "company": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Mi Empresa"
      },
      "lines": [
        {
          "phone_number_id": "123456789012345",
          "inbox_id": "00000000-0000-0000-0000-000000000000",
          "display_phone_number": "+57 300 000 0000",
          "is_active": true
        }
      ]
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · invalid_api_key

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/invalid_api_key",
      "title": "Token ausente o inválido",
      "status": 401,
      "detail": "…",
      "code": "invalid_api_key"
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · api_key_expired

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/api_key_expired",
      "title": "Token vencido",
      "status": 401,
      "detail": "…",
      "code": "api_key_expired"
    }
  • 401Token ausente, inválido, vencido, sin permiso o creador inactivo · token_creator_inactive

    JSON
    {
      "error": "…",
      "type": "https://docs.comdig.co/errores/token_creator_inactive",
      "title": "Quien creó el token ya no es administrador activo",
      "status": 401,
      "detail": "…",
      "code": "token_creator_inactive"
    }
  • 405Método no permitido

  • 429Límite excedido (rate_limited, o too_many_active_batches en api-send-bulk)

    JSON
    {
      "error": "Demasiadas peticiones: máximo 10 por segundo por token. Reintenta tras Retry-After.",
      "type": "https://docs.comdig.co/errores/rate_limited",
      "title": "Demasiadas peticiones",
      "status": 429,
      "detail": "Demasiadas peticiones: máximo 10 por segundo por token. Reintenta tras Retry-After.",
      "code": "rate_limited"
    }

Errores#

Además del código HTTP, cada error trae el campo code. Programa tu integración contra él.