Status da operação

API 0.16.0OpenAPIllms-full.txt

GET/v1/operations/{operation_id}

Retorna o estado atual de uma operação por seu id. Embora status seja igual a queued ou running, a operação não é concluída. Depois de concluído, verifique result em caso de sucesso ou error em caso de erro.

Áreas de autorização e acesso · Erros e repetições

Solicitar

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

Opções

operation_idpathNecessariamente

string · uuid

X-Customer-IDheader

Opção 1

string

Opção 2

null

Respostas

200 Resposta bem-sucedida

application/json

object

id

string · uuid

ID da operação para verificar o status e cancelar um envio pendente.

kind

string

mailbox_id

Opção 1

integer

Opção 2

null

status

string

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

run_at

string

Data e hora em UTC. Se não houver deslocamento, o valor também representa UTC.

created_at

string

Data e hora em UTC. Se não houver deslocamento, o valor também representa UTC.

completed_at

Opção 1

string

Data e hora em UTC. Se não houver deslocamento, o valor também representa UTC.

Opção 2

null

error

O motivo do erro se a operação não foi concluída com êxito.

Opção 1

string

Opção 2

null

result

O resultado da operação. Para envio, contém informações sobre destinatários aceitos e rejeitados.

Opção 1

object

Opção 2

null

401 Login necessário

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

403 Sem acesso

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

404 Recurso não encontrado

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

409 Conflito de estado

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object

422 Erro de validação

application/json

object

detail

array

Elementos da matriz

object

locNecessariamente

array

Elementos da matriz

Opção 1

string

Opção 2

integer

msgNecessariamente

string

typeNecessariamente

string

503 Indisponibilidade temporária

application/json

object

detail

Opção 1

string

Opção 2

object

code

string

message

string

Opção 3

array

Elementos da matriz

object