Sign in
chat

Schedules the sending of a new chat message to the given room

The author and timestamp are automatically set to the current user and time. Required capability: scheduled-messages

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

Path parameters

apiVersion'v1' required
tokenstring required

Headers

OCS-APIRequestboolean required

Required to be true for the API request to pass

Request body

messagestring required

The message to send

sendAtinteger required

When to send the scheduled message

replyTointeger

Parent id which this scheduled message is a reply to

silentboolean

If sent silent the scheduled message will not create any notifications when sent

threadTitlestring

Only supported when not replying, when given will create a thread (requires threads capability)

threadIdinteger

Thread id without quoting a specific message (requires threads capability)

Response

Message scheduled successfully

Changes

Changed in 5 of the 62 revisions of this API.4110

  • dc2b6567a07b5See the full diff
    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the optional property ocs/data/parent/allOf[subschema #2]/metaData/replyToActorDisplayName to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property ocs/data/parent/allOf[subschema #2]/metaData/replyToConversationName to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property ocs/data/parent/allOf[subschema #2]/metaData/replyToConversationToken to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property ocs/data/parent/allOf[subschema #2]/metaData/replyToMessageId to the response with the 201 status

      response-optional-property-added

  • 2dd98af77e492See the full diff
    • ○

      added the optional property ocs/data/parent/allOf[subschema #2]/metaData/threadId to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property ocs/data/parent/allOf[subschema #2]/metaData/threadTitle to the response with the 201 status

      response-optional-property-added

  • 5ffe9b2c44ea1See the full diff
    • ○

      added the optional property ocs/data/originalSendAt to the response with the 201 status

      response-optional-property-added

  • a1ee27cbe6bb411See the full diff
    • ▲

      the ocs/data/id response's property type/format changed from integer/int64 to string/ for status 201

      response-property-type-changed

    • ▲

      removed the required property ocs/data/metaData from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property ocs/data/parentId from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property ocs/data/roomId from the response with the 201 status

      response-required-property-removed

    • ●

      removed the optional property ocs/data/threadExists from the response with the 201 status

      response-optional-property-removed

    • ○

      added the required property ocs/data/silent to the response with the 201 status

      response-required-property-added

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

  • 6ef64fbefde31See the full diff
    • ○

      endpoint added

      endpoint-added