Plum / developers
REST APIDevice sessions

End a session

Stop recording a session you host now. The session is `ending` while its recorder uploads the rest of its audio, then `ended`. Ending a session that is already ending or ended changes nothing. Other participants receive 403. See [Devices](/docs/devices#shared-recorders).

POST/devices/sessions/{id}/end

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <token> with one of: an app session access token from /auth/verify-otp or /auth/refresh; an OAuth access token from /oauth/token issued for the API origin (its scopes are its permissions); or a personal access token starting with optima_pat_ (see /docs/personal-access-tokens). Personal access tokens cannot create or list tokens, revoke other tokens, sign out, or delete or restore the account. Content routes need the permission of their layer: audio:read/audio:write for recordings, turns:read/turns:write for turns, contacts, source signals, and events, and insights:read/insights:write for suggestions and session summaries; search and recall need turns:read and insights:read. A request without the permission, or for an account whose layer is turned off, returns 403 FORBIDDEN. See /docs/authentication#scopes.

In: header

Path Parameters

id*string
Formatuuid

Header Parameters

X-API-Version?"1"

Send 1 to pin the documented API contract. If omitted, the latest version is selected.

Default"1"

Value in

  • "1"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/devices/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/end" \  -H "X-API-Version: 1"
{  "success": true,  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "device_id": "string",    "device_name": "string",    "status": "string",    "host": {      "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",      "display_name": "string"    },    "started_at": "2019-08-24T14:15:22Z",    "expires_at": "2019-08-24T14:15:22Z",    "ended_at": "2019-08-24T14:15:22Z",    "end_reason": "string",    "participants": [      {        "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",        "display_name": "string",        "role": "host",        "joined_at": "2019-08-24T14:15:22Z",        "left_at": "2019-08-24T14:15:22Z"      }    ]  }}

Get a session GET

Read a shared session you joined, including after it ends or after you left. Other accounts receive 404.

Extend a session POST

Add 30 minutes to an active session you host. A session lasts at most 240 minutes from its start; going past that returns 409 SESSION_LIMIT, and a session that is ending or ended returns 409 CONFLICT. Other participants receive 403. See [Devices](/docs/devices#shared-recorders).