> 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.9/recording.md).

# Recording

## List call recordings

> Retrieve a collection of call recordings.\
> \
> The \`filter\` query parameter supports \`caller\_display\_name\` and\
> \`callee\_display\_name\` for case-insensitive partial matching. Use\
> \`contains(caller\_display\_name,'john')\` when the type is \`caller\`, or\
> \`contains(callee\_display\_name,'john')\` when the type is \`callee\`.\
> Combine Display Name, extension number, and other filters with \`and\`.<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"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\nThe `filter` query parameter supports `caller_display_name` and\n`callee_display_name` for case-insensitive partial matching. Use\n`contains(caller_display_name,'john')` when the type is `caller`, or\n`contains(callee_display_name,'john')` when the type is `callee`.\nCombine Display Name, extension number, and other filters with `and`.\n","parameters":[{"name":"group_ids","in":"query","required":false,"schema":{"type":"string"},"description":"Optional recording scope. Omit this parameter to include recordings\nfor all active tenant extensions, regardless of user group membership\nor the value of `allow_admin_recordings`.\nUse `all` for members of all tenant groups with\n`allow_admin_recordings=true`, or provide a comma-separated list of\ngroup IDs. Every requested group must belong to the current tenant and\nhave `allow_admin_recordings=true`.\n"},{"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"}],"readOnly":true,"description":"The unique ID of call recording.\n"},"caller":{"type":"string","description":"Caller who started the call.\n"},"caller_display_name":{"type":"string","maxLength":1024,"description":"Display name of the caller.\n"},"callee":{"type":"string","description":"Callee who answered the call.\n"},"callee_display_name":{"type":"string","maxLength":1024,"description":"Display name of the callee.\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":"string","enum":["TRANSCRIPTION_NOTSTARTED","TRANSCRIPTION_QUOTALIMITED","TRANSCRIPTION_RUNNING","TRANSCRIPTION_FAILED","TRANSCRIPTION_SUCCEEDED","ANALYZE_RUNNING","ANALYZE_FAILED","ANALYZE_SUCCEEDED","TRANSCRIPTION_UPLOAD_FAILED","TRANSCRIPTION_OTHER_FAILED"],"description":"AI transcription status.\n- `TRANSCRIPTION_NOTSTARTED`\n- `TRANSCRIPTION_QUOTALIMITED`\n- `TRANSCRIPTION_RUNNING`\n- `TRANSCRIPTION_FAILED`\n- `TRANSCRIPTION_SUCCEEDED`\n- `ANALYZE_RUNNING`\n- `ANALYZE_FAILED`\n- `ANALYZE_SUCCEEDED`\n- `TRANSCRIPTION_UPLOAD_FAILED`\n- `TRANSCRIPTION_OTHER_FAILED`\n"},"status_description":{"type":"string","description":"AI transcription status description.\n"},"sentiment":{"type":"string","enum":["SENTIMENT_POSITIVE","SENTIMENT_NEUTRAL","SENTIMENT_NEGATIVE"],"description":"AI transcription sentiment.\n- `SENTIMENT_POSITIVE`\n- `SENTIMENT_NEUTRAL`\n- `SENTIMENT_NEGATIVE`\n"}}}}}}}}},"400":{"description":"Invalid group_ids value"},"403":{"description":"One or more requested groups are not authorized"},"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.8"},"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"}],"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"},"caller_display_name":{"type":"string","maxLength":1024,"description":"Display name of the caller.\n"},"callee":{"type":"string","description":"Callee who answered the call.\n"},"callee_display_name":{"type":"string","maxLength":1024,"description":"Display name of the callee.\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","enum":["SENTIMENT_POSITIVE","SENTIMENT_NEUTRAL","SENTIMENT_NEGATIVE"],"description":"AI transcription sentiment.\n- `SENTIMENT_POSITIVE`: positive\n- `SENTIMENT_NEUTRAL`: neutral\n- `SENTIMENT_NEGATIVE`: negative\n"}}}}}}}}},"4XX":{"description":"Error"}}}}}}
```

## Delete call recording

> Delete a call recording<br>

```json
{"openapi":"3.1.0","info":{"title":"PortSIP PBX Rest API","version":"22.8"},"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"}],"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"}}}}}}
```
