Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
contact

get blocked contacts

Retrieves a list of all blocked contacts

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

Path parameters

idinteger required

Instance ID

Response

Successfully retrieved blocked contacts

statusstring
instanceIdstring

Example response

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