# Playlists

## GET /pbx/playlists

> Retorna uma playlist

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"ResponsePlaylistControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da playlist"},"name":{"type":"string","description":"Nome da playlist"},"sort":{"type":"string","description":"Ordem de execução dos áudios da playlist"}},"required":["_id","name","sort"]}}},"paths":{"/pbx/playlists":{"get":{"operationId":"PlaylistsController_getPlaylist","summary":"Retorna uma playlist","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePlaylistControllerDto"}}}}},"tags":["Playlists"]}}}}
```

## POST /pbx/playlists

> Cadastro de playlist

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"CreatePlaylistDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da playlist"},"sort":{"type":"string","description":"Ordem de execução dos áudios da playlist"}},"required":["name","sort"]},"ResponsePlaylistControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da playlist"},"name":{"type":"string","description":"Nome da playlist"},"sort":{"type":"string","description":"Ordem de execução dos áudios da playlist"}},"required":["_id","name","sort"]}}},"paths":{"/pbx/playlists":{"post":{"operationId":"PlaylistsController_createPlaylist","summary":"Cadastro de playlist","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlaylistDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePlaylistControllerDto"}}}}},"tags":["Playlists"]}}}}
```

## PUT /pbx/playlists

> Atualiza uma playlist

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"UpdatePlaylistDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome da playlist"},"sort":{"type":"string","description":"Ordem de execução dos áudios da playlist"},"_id":{"type":"string","description":"ID da operadora/tronco"}},"required":["name","sort","_id"]},"ResponsePlaylistControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da playlist"},"name":{"type":"string","description":"Nome da playlist"},"sort":{"type":"string","description":"Ordem de execução dos áudios da playlist"}},"required":["_id","name","sort"]}}},"paths":{"/pbx/playlists":{"put":{"operationId":"PlaylistsController_updatePlaylist","summary":"Atualiza uma playlist","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePlaylistDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePlaylistControllerDto"}}}}},"tags":["Playlists"]}}}}
```

## DELETE /pbx/playlists

> Deleta uma playlist

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"RemoveCommonResponse":{"type":"object","properties":{"count":{"type":"number","description":"Quantidade de registros deletados"}},"required":["count"]}}},"paths":{"/pbx/playlists":{"delete":{"operationId":"PlaylistsController_deletePlaylist","summary":"Deleta uma playlist","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Playlists"]}}}}
```

## GET /pbx/playlists/all

> Retorna lista de playlists

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"ResponsePlaylistControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da playlist"},"name":{"type":"string","description":"Nome da playlist"},"sort":{"type":"string","description":"Ordem de execução dos áudios da playlist"}},"required":["_id","name","sort"]}}},"paths":{"/pbx/playlists/all":{"get":{"operationId":"PlaylistsController_getPlaylists","summary":"Retorna lista de playlists","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponsePlaylistControllerDto"}}}}}},"tags":["Playlists"]}}}}
```

## DELETE /pbx/playlists/all

> Deleta todas as playlists

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"RemoveCommonResponse":{"type":"object","properties":{"count":{"type":"number","description":"Quantidade de registros deletados"}},"required":["count"]}}},"paths":{"/pbx/playlists/all":{"delete":{"operationId":"PlaylistsController_deletePlaylists","summary":"Deleta todas as playlists","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Playlists"]}}}}
```

## GET /pbx/playlists/audios

> Retorna lista dos audios de uma playlist

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"ResponseAudioControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da rota da equipe"},"name":{"type":"string","description":"Nome do áudio"},"extension":{"type":"string","description":"Extensão do arquivo de áudio (WAV ou mp3)"},"size":{"type":"string","description":"Tamanho do arquivo de áudio"},"playlist_id":{"type":"string","description":"ID da playlist "}},"required":["_id","name","extension","size","playlist_id"]}}},"paths":{"/pbx/playlists/audios":{"get":{"operationId":"PlaylistsController_getAudioByPlaylistId","summary":"Retorna lista dos audios de uma playlist","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseAudioControllerDto"}}}}},"tags":["Playlists"]}}}}
```

## POST /pbx/playlists/audios

> Cadastro de áudio

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"ResponseAudioControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da rota da equipe"},"name":{"type":"string","description":"Nome do áudio"},"extension":{"type":"string","description":"Extensão do arquivo de áudio (WAV ou mp3)"},"size":{"type":"string","description":"Tamanho do arquivo de áudio"},"playlist_id":{"type":"string","description":"ID da playlist "}},"required":["_id","name","extension","size","playlist_id"]}}},"paths":{"/pbx/playlists/audios":{"post":{"operationId":"PlaylistsController_createAudio","summary":"Cadastro de áudio","parameters":[{"name":"playlist_id","required":true,"in":"query","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"audios":{"type":"array","items":{"type":"string","format":"binary"}}}}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseAudioControllerDto"}}}}}},"tags":["Playlists"]}}}}
```

## DELETE /pbx/playlists/audios

> Deleta todos os audios de uma playlist

```json
{"openapi":"3.0.0","info":{"title":"API pública do Voice","version":"1.0"},"tags":[],"servers":[{"url":"v1"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"RemoveCommonResponse":{"type":"object","properties":{"count":{"type":"number","description":"Quantidade de registros deletados"}},"required":["count"]}}},"paths":{"/pbx/playlists/audios":{"delete":{"operationId":"PlaylistsController_deleteAudioByPlaylistId","summary":"Deleta todos os audios de uma playlist","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Playlists"]}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fortics.com.br/voice-api-reference/reference/playlists.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.