Recordings

Get Recording

Retrieves details for a specific recording.

GET https://api.speaking-partner.com/v1/recordings/{recordingid}

URL Parameters

Name	Required?	Description
RecordingId	Yes	The ID of the recording.

Example Request

GET: https://api.speaking-partner.com/v1/recordings/1234

Example Response

{
    "ContentType":"audio/mpeg",
    "CreationDate":1351877405,
    "Extension": "mp3",
    "IsPrivate":false,
    "Name":"Recording_20121102_173005.mp3",
    "RecordingId":1234,
    "SessionId":77728,
    "Size":1325320,
    "Url":".../Recording_20121102_173005.mp3"
}

Update Recording

Updates details for a specific recording.

POST https://api.speaking-partner.com/v1/recordings/{recordingid}

URL Parameters

Name	Required?	Description
RecordingId	Yes	The ID of the recording.

Request Parameters

Name	Required?	Description
Url	No	The URL location of the recording file. Only set this when the file is hosted outside of Speaking Partners. Must be URL Encoded.
IsPrivate	No	Indicates if the recording should be hidden from students and teachers and only accessible by Speaking Partners staff.

Example Request

POST: https://api.speaking-partner.com/v1/recordings/1234

isprivate=true

Example Response

{
    "ContentType":null,
    "CreationDate":1351877405,
    "Extension":null,
    "IsPrivate":true,
    "Name":null,
    "RecordingId":1234,
    "SessionId":77728,
    "Size":1325320,
    "Url":"http://example.com/customer/externalrecording.mp3"
}

Upload File

Uploads a file for a specific recording.

POST https://api.speaking-partner.com/v1/recordings/{recordingid}/file

URL Parameters

Name	Required?	Description
RecordingId	Yes	The ID of the recording.

Request Parameters

Name	Required?	Description
Body	Yes	The body of this request must only contain the raw bytes for the file.

Example Request

POST: https://api.speaking-partner.com/v1/recordings/2345/file

(raw bytes for file)

Example Response

{
    "ContentType":"audio/mpeg",
    "CreationDate":1351877405,
    "Extension": "mp3",
    "IsPrivate":false,
    "Name":"Recording_20121102_173005.mp3",
    "RecordingId":2345,
    "SessionId":77728,
    "Size":1325320,
    "Url":".../Recording_20121102_173005.mp3"
}