Retrieve WhatsApp Status

GET 
/api/v2/instance/:instanceId/chat/whatsapp-status

Get the status message of a WhatsApp user.

Request

Path Parameters

instanceId stringrequired

ID of the instance.

Query Parameters

id stringrequired

Enter the "number" or the "keyRemoteJid".

Responses

200

ProfilePicture

application/json

Schema

Schema

status string
setAt date-time

Example (from schema)

{
  "status": "string",
  "setAt": "2024-04-14T14:11:05.696Z"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...