instances

get async request status

Retrieve the status or result of an async request by its reference UUID. Results are cached for up to 5 minutes after processing. An asynchronous send refused by the send protection is attempted up to four times in total (three retries, each after the node's retryAfter); the last refusal is returned inside data with HTTP 200 and the same reason/retryAfter/message fields as the synchronous 429 body.

get/instances/{id}/request/{reference}

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/request/{reference}
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

referencestring uuid required

Reference UUID returned by an async request

Response

The request result or pending status

status'success' | 'error'

Example response

{
  "data": {
    "status": "pending",
    "message": "request still pending"
  },
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.