État de l'opération

API 0.16.0OpenAPIllms-full.txt

GET/v1/operations/{operation_id}

Renvoie l'état actuel d'une opération par son id. Alors que status est égal à queued ou running, l'opération n'est pas terminée. Une fois terminé, cochez result en cas de succès ou error en cas d'erreur.

Zones d’autorisation et d’accès · Erreurs et répétitions

Demande

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

Possibilités

operation_idpathNécessairement

string · uuid

X-Customer-IDheader

Option 1

string

Option 2

null

Réponses

200 Réponse réussie

application/json

object

id

string · uuid

ID d'opération pour vérifier le statut et annuler une soumission en attente.

kind

string

mailbox_id

Option 1

integer

Option 2

null

status

string

Valeurs valides: "queued" "running" "succeeded" "failed" "uncertain" "cancelled"

run_at

string

Date et heure en UTC. S'il n'y a pas de décalage, la valeur représente également UTC.

created_at

string

Date et heure en UTC. S'il n'y a pas de décalage, la valeur représente également UTC.

completed_at

Option 1

string

Date et heure en UTC. S'il n'y a pas de décalage, la valeur représente également UTC.

Option 2

null

error

La raison de l'erreur si l'opération n'a pas abouti.

Option 1

string

Option 2

null

result

Le résultat de l'opération. Pour l'envoi, contient des informations sur les destinataires acceptés et rejetés.

Option 1

object

Option 2

null

401 Connexion requise

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

403 Pas d'accès

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

404 Ressource introuvable

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

409 Conflit d'État

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object

422 Erreur de validation

application/json

object

detail

array

Éléments du tableau

object

locNécessairement

array

Éléments du tableau

Option 1

string

Option 2

integer

msgNécessairement

string

typeNécessairement

string

503 Indisponibilité temporaire

application/json

object

detail

Option 1

string

Option 2

object

code

string

message

string

Option 3

array

Éléments du tableau

object