Call

/v0.1/RecordStart/

Initiates recording of a given call

post/v0.1/RecordStart/

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/RecordStart/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

CallUUIDstring

Unique identifier of the call to be recorded

FileFormat'wav' | 'mp3'

File format (extension)

FilePathstring

Directory path/URI where the recording file will be saved

FileNamestring

Recording file name (without extension); if empty, a timestamp based file name will be generated

TimeLimitinteger

Maximum recording length, in seconds

Example request

{
  "CallUUID": "052d04e4-019a-45ff-a562-f74d4ae99ea2",
  "FileFormat": "wav",
  "FilePath": "/tmp/recordings",
  "FileName": "sample_recording",
  "TimeLimit": 89
}

Response

Response message

RecordFilestring required

Directory path/URI where the recording file will be saved

Successboolean required

Whether the request was successful or not

Example response

{
  "Message": "RecordStart Executed",
  "RecordFile": "/tmp/recordings/sample.wav",
  "Success": true
}

Changes

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