Call

/v0.1/RecordStop/

Stops the recording of a given call

post/v0.1/RecordStop/

Request

Base URL
https://eqivo.org (the document declares no server; this is the origin it was published from)
Auth
HTTP basic
TypeScript
https://skmtc.dev/eqivo/apis/eqivo-api/docs/v0.1/RecordStop/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

CallUUIDstring required

Unique identifier of the call

RecordFilestring required

Full path to recording file, as returned by RecordStart; all shorthand is also available

Example request

{
  "CallUUID": "eacfa857-4001-4379-b79a-c7ef6d963bcb",
  "RecordFile": "/tmp/recording/sample.wav"
}

Response

Message'RecordStop Executed' | 'CallUUID Parameter must be present' | 'RecordFile Parameter must be present' | 'RecordStop Failed -- Call not found' | 'RecordStop Failed' required

Response message

Successboolean required

Whether the request was successful or not

Example response

{
  "Message": "RecordStop Executed",
  "Success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.