Sign in
Chat

List webchat sessions

Required scope: chat

get/api/v1/chat/sessions

Query parameters

pageinteger
page_sizeinteger
usernamestring

Response

Standard AstrBot success response

status'ok' required
messagestring
{"stackTrail":"components:schemas:SuccessEnvelope:properties:data","oasType":"schema","type":"unknown"}

Changes

Changed in 2 of the 13 revisions of this API.8522

  • 6b73b947caab1511See the full diff
    • ▲

      the data response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      deleted the query request parameter platform_id

      request-parameter-removed

    • ●

      removed the optional property data/page from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/page_size from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/sessions from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/total from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id listChatSessions was added

      api-operation-id-added

    • ○

      the endpoint scheme security ApiKeyHeader was removed from the API

      api-security-removed

    • ○

      api tag Chat added

      api-tag-added

    • ○

      api tag Open API removed

      api-tag-removed

    • ○

      the query request parameter username became optional

      request-parameter-became-optional

    • ○

      for the query request parameter page_size, the max was increased from 100.00 to 200.00

      request-parameter-max-increased

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

    • ○

      the response property data became required for the status 200

      response-property-became-required

    • ○

      the response property status became required for the status 200

      response-property-became-required

    • ○

      the status response property const value ok was added for the status 200

      response-property-const-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3d43cee2622a711See the full diff
    • ▲

      the query request parameter username became required

      request-parameter-became-required

    • ▲

      for the query request parameter page_size, the max was decreased from 200.00 to 100.00

      request-parameter-max-decreased

    • ▲

      the response property message became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data became optional for the status 200

      response-property-became-optional

    • ▲

      the response property status became optional for the status 200

      response-property-became-optional

    • ▲

      the status response property const value ok was removed for the status 200

      response-property-const-removed

    • ▲

      the data response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ○

      api operation id listChatSessions removed and replaced with

      api-operation-id-removed

    • ○

      the endpoint scheme security ApiKeyHeader was added to the API

      api-security-added

    • ○

      api tag Open API added

      api-tag-added

    • ○

      api tag Chat removed

      api-tag-removed

    • ○

      added the new optional query request parameter platform_id

      new-optional-request-parameter

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the optional property data/page to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/page_size to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/sessions to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/total to the response with the 200 status

      response-optional-property-added

    This revision also has 48 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog