Estado de operación

API 0.16.0OpenAPIllms-full.txt

GET/v1/operations/{operation_id}

Devuelve el estado actual de una operación por su id.. Mientras que status es igual a queued o running, la operación no se completa. Una vez completado, marque result en caso de éxito o error en caso de error.

Zonas de autorización y acceso · Errores y repeticiones.

Pedido

curl -X GET 'https://adapt-mail.com/v1/operations/<operation_id>' \
  -H 'Authorization: Bearer <access_token>'

Opciones

operation_idpathNecesariamente

string · uuid

X-Customer-IDheader

Opción 1

string

Opción 2

null

Respuestas

200 Respuesta exitosa

application/json

object

id

string · uuid

ID de operación para verificar el estado y cancelar un envío pendiente.

kind

string

mailbox_id

Opción 1

integer

Opción 2

null

status

string

Valores válidos: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Fecha y hora en UTC. Si no hay compensación, el valor también representa UTC.

created_at

string

Fecha y hora en UTC. Si no hay compensación, el valor también representa UTC.

completed_at

Opción 1

string

Fecha y hora en UTC. Si no hay compensación, el valor también representa UTC.

Opción 2

null

error

El motivo del error si la operación no se completó correctamente.

Opción 1

string

Opción 2

null

result

El resultado de la operación. Para envío, contiene información sobre los destinatarios aceptados y rechazados.

Opción 1

object

Opción 2

null

401 Iniciar sesión requerido

application/json

object

detail

Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object

403 Sin acceso

application/json

object

detail

Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object

404 Recurso no encontrado

application/json

object

detail

Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object

409 Conflicto de estado

application/json

object

detail

Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object

422 Error de validación

application/json

object

detail

array

elementos de matriz

object

locNecesariamente

array

elementos de matriz

Opción 1

string

Opción 2

integer

msgNecesariamente

string

typeNecesariamente

string

503 Indisponibilidad temporal

application/json

object

detail

Opción 1

string

Opción 2

object

code

string

message

string

Opción 3

array

elementos de matriz

object