story

[BETA] get stories

Retrieves all available stories/status updates that are visible to the authenticated user. This includes both viewed and unviewed stories from contacts. Note: This endpoint is currently in beta and may change without notice.

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

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/get-stories
  • 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 stories.

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": {
      "stories": [
        {
          "id": {
            "server": "c.us",
            "user": "1234567890",
            "_serialized": "1234567890@c.us"
          },
          "timestamp": 1732860512,
          "totalCount": 1,
          "unreadCount": 1,
          "msgs": [
            {
              "mediaKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX=",
              "id": {
                "remote": {
                  "server": "broadcast",
                  "user": "status",
                  "_serialized": "status@broadcast"
                },
                "participant": {
                  "server": "c.us",
                  "user": "1234567890",
                  "_serialized": "1234567890@c.us"
                }
              },
              "type": "video",
              "timestamp": 1732860512,
              "from": "status@broadcast",
              "to": "1234567890@c.us",
              "author": "1234567890@c.us"
            }
          ]
        }
      ],
      "textStatuses": [
        {
          "id": {
            "server": "c.us",
            "user": "1234567890",
            "_serialized": "1234567890@c.us"
          },
          "status": "Hey there!."
        }
      ]
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/get-stories"
  }
}

Changes

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