client

client status of instance

retrieve the status of your running client

get/instances/{id}/client/status

Request

Base URL: https://waapi.app/api/v1
URL: https://waapi.app/api/v1/instances/{id}/client/status
Auth: HTTP bearer

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"
    ],
    "instanceCallPolicy": {
      "mode": "reject_with_message",
      "message": "We do not take calls. Please send a message."
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/status"
  },
  "status": "success"
}

Changes

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