v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
client

client status of instance

retrieve the status of your running client

get/instances/{id}/client/status

Path parameters

idinteger required

Instance ID

Response

Client Status Response

status'success' | 'error'

Example response

{
  "clientStatus": {
    "status": "success",
    "instanceId": "1",
    "name": "My first Instance",
    "instanceStatus": "ready",
    "instanceWebhook": "https://my.url.com/webhook/handler",
    "instanceEvents": [
      "message"
    ]
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/status"
  },
  "status": "success"
}