Skip to content

Hold the shared session a message request attached

GET /message-requests/{id}/holdView source specification ↗

Keeps the shared RTC session subscriber that this message request attached (an rtc-session initiate-session-with-offer with sessionMode SHARED) alive while the call stays open. Open it after the answer arrives and keep it open while attached. The response arrives only when the subscriber's attachment ends, with the reason; it can take up to the session's 3600 second lifetime. A hold that drops without disconnect-session leaves the subscriber 30 seconds to open a new hold before it is detached. Only the request's creator may hold it.

Required scope

message:send

Path parameters

idstringRequired

Identifier of the message request that attached the subscriber.

Returns

200

The subscriber's attachment ended.

Fields

reasonstringRequired

DETACHED: the subscriber left (disconnect-session, its peer went away, or no hold was open for 30 seconds). SESSION_CLOSED: the shared session ended for every subscriber. EXPIRED: the subscriber reached its session duration.

Allowed values

  • DETACHED
  • SESSION_CLOSED
  • EXPIRED

Errors

404 NOT_FOUND

The request was not found for the caller, or it holds no live shared session subscriber.

Verify the target identifier and that its endpoint or plugin route still exists.