Sessions
Sessions

Heartbeat Session Stream

Changed on
post/sessions/streams/heartbeat

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/sessions/streams/heartbeat
  • Auth
    API key in header Authorization

Request body

session_idstring required
replica_idstring required
replica_addressstring nullable
turn_idstring nullable
is_runningboolean
namestring nullable

Response

Successful Response

replica_idstring required
is_current_turnboolean

Changes

    • breaking

      added the pattern ^[^\x00-\x1f\x7f]+$ to the request property

    • warning

      the request property's maxLength was set to 128

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status