Delete a Session
This command deletes an existing session.
Authorizations: All
Request
deleteSession sessionId |
Parameters
| Parameter | Description/Values |
|---|---|
sessionId | The ID of a HMP session |
Result
Success
OK |
Error
| Error | Description |
|---|---|
| Calling deleteSession requires 1 parameter. |
| The sessionId provided must be a UUID. |
| The 'session' with UUID 'sessionId' was not found. |
| The session is being recorded. All recordings for this session must be stopped before it can be removed. |
| Database returned an error while removing session. Please see calypso.log for details. |
Example
The following example deletes a session entitled “Test Session1”. The system returns OK.
|