> For the complete documentation index, see [llms.txt](https://support.portsip.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.portsip.com/development-portsip/rest-apis/version-22.5/recording.md).

# Recording

## List call recordings

> Retrieve a collection of call recordings.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.4"},"tags":[],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/recordings":{"get":{"tags":["Recording"],"operationId":"listRecordings","summary":"List call recordings","description":"Retrieve a collection of call recordings.\n","parameters":[{"name":"filter","in":"query","required":false,"schema":{"type":"string"},"description":"Use the `filter` query parameter to retrieve just a subset of a collection.\n"},{"name":"search","in":"query","required":false,"schema":{"type":"string"},"description":"Use the `search` query parameter to restrict the results of a request to match a search criterion.\n"},{"name":"orderby","in":"query","required":false,"schema":{"type":"string"},"description":"Use the `orderby` query parameter to specify the sort order of the items returned from server.  \nThe default order is ascending order.\n"},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":0,"default":0},"description":"Use the `skip` query parameter to set the number of items to skip at the start of a collection.\n"},{"name":"top","in":"query","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":100},"description":"Use the `top` query parameter to specify the page size of the result set.\n"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"count":{"type":"integer","format":"int64","minimum":0,"description":"Total number of resource.\n"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"readOnly":true,"description":"The unique ID of call recording.\n"},"caller":{"type":"string","description":"Caller who started the call.\n"},"callee":{"type":"string","description":"Callee who answered the call.\n"},"started_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Time on which the call is answered.\n"},"ended_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Time on which the call is ended.\n"},"status":{"type":"integer","description":"AI transcription status.\n- 0 = NotTranscribed\n- 1 = TranscriptionNotStarted\n- 2 = TranscriptionQuotaLimited\n- 3 = TranscriptionRunning\n- 4 = TranscriptionFailed\n- 5 = TranscriptionSucceeded\n- 6 = AnalyzeRunning\n- 7 = AnalyzeFailed\n- 8 = AnalyzeSucceeded\n- 9 = TranscriptionUploadFailed\n- 10 = TranscriptionOtherFailed\n","enum":[0,1,2,3,4,5,6,7,8,9,10]},"status_description":{"type":"string","description":"AI transcription status description.\n"},"sentiment":{"type":"integer","description":"AI transcription sentiment.\n- 1 = SentimentPositive\n- 2 = SentimentNeutral\n- 3 = SentimentNegative\n","enum":[1,2,3]}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```

## Retrieve a call recording

> Get details of a call recording.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.4"},"tags":[],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/recordings/{id}":{"get":{"tags":["Recording"],"operationId":"showRecording","summary":"Retrieve a call recording","description":"Get details of a call recording.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"readOnly":true,"description":"The unique ID of call recording.\n"},"description":"The unique ID of the call recording."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"caller":{"type":"string","description":"Caller who started the call.\n"},"callee":{"type":"string","description":"Callee who answered the call.\n"},"started_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Time on which the call is answered.\n"},"ended_at":{"allOf":[{"type":"string","format":"date_time","description":"The RFC 3339 format is defined by\nThe date_time notation as defined by [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), \nfor example, 2017-07-21T17:32:28Z\n"}],"description":"Time on which the call is ended.\n"},"duration":{"type":"integer","format":"int32","description":"The playback time (in seconds).\n"},"file_name":{"type":"string","description":"The name of the file.\n"},"file_size":{"type":"integer","format":"int64","minimum":0,"description":"The file size in bytes.\n"},"file_url":{"type":"string","readOnly":true,"description":"The relative path to file url for file downloading.\n"},"status":{"type":"string","description":"AI transcription status.\n- TranscriptionNotStarted\n- TranscriptionQuotaLimited\n- TranscriptionRunning\n- TranscriptionFailed\n- TranscriptionSucceeded\n- AnalyzeRunning\n- AnalyzeFailed\n- AnalyzeSucceeded\n- TranscriptionUploadFailed\n- TranscriptionOtherFailed\n","enum":["TRANSCRIPTION_NOTSTARTED","TRANSCRIPTION_QUOTALIMITED","TRANSCRIPTION_RUNNING","TRANSCRIPTION_FAILED","TRANSCRIPTION_SUCCEEDED","ANALYZE_RUNNING","ANALYZE_FAILED","ANALYZE_SUCCEEDED","TRANSCRIPTION_UPLOAD_FAILED","TRANSCRIPTION_OTHER_FAILED"]},"status_description":{"type":"string","description":"AI transcription status description."},"sentiment":{"type":"string","description":"AI transcription sentiment.\n- SentimentPositive\n- SentimentNeutral\n- SentimentNegative\n","enum":["SENTIMENT_POSITIVE","SENTIMENT_NEUTRAL","SENTIMENT_NEGATIVE"]}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```

## Delete call recording

> Delete a call recording<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.4"},"tags":[],"servers":[{"url":"{protocol}://{hostname}:{port}/api","variables":{"protocol":{"description":"Self-hosted Enterprise Server protocol.","default":"https"},"hostname":{"description":"Self-hosted Enterprise Server hostname.","default":"HOSTNAME"},"port":{"description":"Self-hosted Enterprise Server port.","default":"8887"}}}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer"}}},"paths":{"/recordings/{id}/destroy":{"post":{"tags":["Recording"],"operationId":"deleteRecording","summary":"Delete call recording","description":"Delete a call recording\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"allOf":[{"type":"string","description":"The unique ID of the resource.\n"}],"readOnly":true,"description":"The unique ID of call recording.\n"},"description":"The unique ID of the recording."}],"responses":{"204":{"description":"No Content"},"4XX":{"description":"Error"}}}}}}
```
