Saltar al contenido principal

​
Formato de respuesta de error

Cada respuesta de error sigue una estructura de envelope consistente: 
{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "idCountry must be a valid country name, ISO alpha-2, or ISO alpha-3 code.",
    "param": "idCountry"
  }
}
CampoTipoDescripción
typestringCategoría general del error para manejo de alto nivel.
codestringCódigo de error legible por máquina. Los clientes deben hacer switch sobre este valor.
messagestringMensaje de error legible por humanos que termina con un punto.
paramstring o nullEl campo de la solicitud que causó el error, si aplica.

​
Tipos de error

TipoDescripción
invalid_request_errorLa solicitud está malformada o contiene parámetros inválidos.
authentication_errorLa autenticación falló (clave API faltante o inválida).
permission_errorLa clave API no tiene permiso para esta operación.
api_errorOcurrió un error interno o de un servicio upstream.

​
Códigos de error

CódigoEstado HTTPDescripción
parameter_missing400Falta un campo obligatorio en el cuerpo de la solicitud.
parameter_invalid400El valor de un campo está malformado o no es aceptado.
account_invalid400La cuenta asociada a la clave API está mal configurada.
authentication_required401Clave API faltante o inválida.
permission_denied403Permisos insuficientes para esta operación.
resource_not_found404El recurso solicitado no existe.
resource_conflict409Ya existe un recurso con el identificador proporcionado.
service_unavailable503Una dependencia externa está temporalmente caída.

​
Ejemplos

​
Campo obligatorio faltante

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_missing",
    "message": "name is required.",
    "param": "name"
  }
}

​
Clave API inválida

{
  "error": {
    "type": "authentication_error",
    "code": "authentication_required",
    "message": "Invalid API key."
  }
}

​
Recurso no encontrado

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "No session scribe found for the given consultation ID."
  }
}

​
Conflicto de ID de consulta

{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_conflict",
    "message": "consultationInternalId is already in use by a different consultation.",
    "param": "consultationInternalId"
  }
}