contact

get broadcast

Retrieves broadcast list details for a specified contact.

post/instances/{id}/client/action/get-broadcast

Request

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

Path parameters

idinteger required

Instance ID

Request body

contactIdstring required

The broadcast list contact ID

Example request

{
  "contactId": "1234567890@broadcast"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Broadcast details retrieved successfully.

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"
  }
}

Changes

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