contact

get blocked contacts

Retrieves a list of all blocked contacts

post/instances/{id}/client/action/get-blocked-contacts

Request

Base URL: https://waapi.app/api/v1
URL: https://waapi.app/api/v1/instances/{id}/client/action/get-blocked-contacts
Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Successfully retrieved blocked contacts.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success",
    "data": {
      "contacts": [
        {
          "id": {
            "server": "c.us",
            "user": "123456789",
            "_serialized": "123456789@c.us"
          },
          "number": "123456789",
          "pushname": "John Doe",
          "type": "in",
          "isUser": true,
          "isWAContact": true,
          "isBlocked": true
        }
      ],
      "count": 7
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/get-blocked-contacts"
  }
}

Changes

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