Errores
La API devuelve códigos de estado de error o error HTTP estándar para todas las operaciones. Para errores, la respuesta incluirá el código de error correspondiente, un mensaje corto que describe la causa del error y, opcionalmente, campos adicionales que transmiten información específica de ese error.
Códigos de estado
| code | name | description |
|---|---|---|
| 200 | OK | The request was processed succesfully. |
| 201 | Created | The request was processed successfully, and a new resource instance was created. |
| 400 | Bad Request | The API was unable to process the request as it was malformed in some way. |
| 401 | Unauthorized | The API was unable to find valid credentials in the request. |
| 403 | Forbidden | The credentials provided do not have sufficient permissions to perform the request. |
| 404 | Not Found | The requested resources cannot be found. |
| 429 | Too Many Requests | The request has not been processed as a rate limit has been reached. |
| 5xx | Internal Server Error | An unexpected error occurred while processing the event. |
Códigos de error
invalid-body
La API no pudo procesar el cuerpo de su solicitud. Asegúrese de que el cuerpo de la solicitud sea JSON válido.
invalid-parameter
Uno o más parámetros en el cuerpo de su solicitud no pasaron las verificaciones de validación. Esta respuesta incluirá un atributo de params con más detalles sobre los parámetros ofensivos.
unconfigured
Su organización no tiene la configuración requerida para que la API complete esta solicitud. El mensaje incluirá detalles sobre qué configuración falta.
missing-scope
Su organización, usuario clave o usuario actual no tiene los ámbitos de permiso necesarios para realizar esta solicitud.
limit-exceeded
La solicitud no se pudo completar ya que violaría un límite impuesto a su organización, clave o usuario actual. Por ejemplo, un usuario que está limitado a acceder a dos cuentas de iCloud por mes recibirá este error si intenta acceder a una tercera cuenta.
session-expired
La sesión que está intentando usar para esta solicitud ha sido marcada como caducada por la API. Debe crear una sesión nueva y válida antes de continuar.
invalid-credentials
Las credenciales proporcionadas fueron rechazadas por el servicio externo. O bien la fuente no existe (es decir, el nombre de usuario no es válido) o la carga útil de las credenciales es incorrecta (como una contraseña incorrecta).
source-locked
La fuente ha sido bloqueada por el servicio externo y la API no puede acceder a ella hasta que el usuario la desbloquee. El mensaje API proporcionará instrucciones sobre cómo hacer esto para el servicio relevante.
code-required
La fuente con la que está intentando crear una sesión tiene habilitada la autenticación multifactor (MFA). La API habrá activado el proceso MFA y debe proporcionar el código presentado durante este proceso en su próximo intento de creación de sesión.
Para obtener más detalles sobre el flujo de creación de sesión, consulte la referencia de servicio para el servicio al que intenta acceder.
code-rate-limited
El usuario ha intentado crear una sesión utilizando un código no válido a menudo y el servicio ha limitado su velocidad. Recomendamos que el usuario espere al menos una hora antes de volver a intentarlo.
choice-required
La fuente que está intentando acceder es que tiene habilitada la verificación de 2 pasos (2SV), un subconjunto de autenticación multifactor (MFA). Como parte de esta respuesta, la API proporcionará una lista de dispositivos contra los que puede activar el proceso 2SV; este dispositivo recibirá el código 2SV que se necesitará para el siguiente paso del proceso.
Para obtener más detalles sobre el flujo de creación de sesión, consulte la referencia de servicio para el servicio al que intenta acceder.
task-error
Se produjo un error genérico de la tarea. Volver a intentar la encuesta o la tarea podría resolver el problema. Póngase en contacto con el servicio de asistencia si el problema persiste.
códigos de error del servicio de iCloud
icloud-terms-not-accepted
El usuario no ha aceptado los últimos Términos de servicio de iCloud. Pueden aceptar los términos iniciando sesión en la App Store en un dispositivo iOS o macOS utilizando su cuenta, o visitando iCloud.com .
icloud-account-not-verified
La dirección de correo electrónico principal asociada con la cuenta de iCloud aún no se ha verificado. El usuario debe completar el proceso de verificación de correo electrónico para activar la cuenta. El proceso de verificación se puede administrar iniciando sesión en appleid.apple.com .
icloud-service-not-activated
El servicio de iCloud necesario para completar la operación no se ha activado en la cuenta de iCloud en uso. Por ejemplo, si el usuario no ha habilitado iCloud Photo Library en la cuenta, se generará este error cuando intente recuperar icpl.photos .
Asegúrese de que el usuario haya activado la configuración asociada de un servicio para asegurarse de que esté activado.
icloud-service-outage
La operación no se pudo completar debido a una interrupción de iCloud. Estos son muy raros y típicamente transitorios; volver a intentarlo en unos minutos debería tener éxito. Sin embargo, si el problema persiste, busque más información en la página de estado de iCloud y la página de estado de la API , y póngase en contacto con el soporte.
