NEnextcloud
chat

Summarize the next bunch of chat messages from a given offset

Changed on

Required capability: chat-summary-api

post/ocs/v2.php/apps/spreed/api/{apiVersion}/chat/{token}/summarize

Request

  • The document declares no server URL.
  • Auth
    • none
    • or HTTP bearer
    • or HTTP basic

Path parameters

apiVersion'v1' required
tokenstring required

Headers

OCS-APIRequestboolean required

Required to be true for the API request to pass

Request body

fromMessageIdinteger required

Offset from where on the summary should be generated

Response

Summary was scheduled, use the returned taskId to get the status information and output from the TaskProcessing API: OCS TaskProcessing API. If the response data contains nextOffset, not all messages could be handled in a single request. After receiving the response a second summary should be requested with the provided nextOffset.

Changes

  • a2b2faeb5c3fRevision changes
    • warning

      added the new classified enum value to the // response property for the response status