# Pausas ## GET /pbx/pauses > Retorna lista de pausas ```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"}}},"paths":{"/pbx/pauses":{"get":{"operationId":"PausesController_pauses","summary":"Retorna lista de pausas","parameters":[{"name":"limit","required":false,"in":"query","description":"Número máximo de itens por página.","schema":{"default":10,"type":"number"}},{"name":"page","required":false,"in":"query","description":"Número da página a ser retornada.","schema":{"default":1,"type":"number"}},{"name":"sort_order","required":false,"in":"query","description":"Ordem da listagem, podendo ser \"ASC\" para ascendente ou \"DESC\" para descendente.","schema":{"default":"ASC","enum":["asc","desc"],"type":"string"}},{"name":"sort_field","required":false,"in":"query","description":"Campo pelo qual será ordenado.","schema":{"default":"name","type":"string"}},{"name":"search_fields","required":false,"in":"query","description":"Lista de campos a serem filtrados.","schema":{"type":"string"}},{"name":"search_value","required":false,"in":"query","description":"Lista de valores correspondentes aos campos filtrados.","schema":{"type":"string"}},{"name":"search_text","required":false,"in":"query","description":"Texto a ser usado para busca em todos os campos.","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["Pausas"]}}}} ``` ## POST /pbx/pauses > Cadastro de pausa ```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":{"CreatePauseDto":{"type":"object","properties":{"active":{"type":"boolean","description":"Indica se a pausa está ativa ou não"},"productive":{"type":"boolean","description":"Indica se a pausa é produtiva ou não"},"cumulative":{"type":"boolean","description":"Indica se a pausa é do tipo acumulativa ou não"},"supervisioned":{"type":"boolean","description":"Indica se a pausa é supervisionada ou não"},"name":{"type":"string","description":"Nome da pausa"},"description":{"type":"string","description":"Descrição da pausa"},"initialTime":{"type":"string","description":"Indica a partir de qual horário a pausa poderá ser usada"},"maxTime":{"type":"string","description":"Indica a quantidade máxima de tempo em segundos que esta pausa será usada"},"icon":{"type":"string","description":"Nome do ícone"}},"required":["active","productive","cumulative","supervisioned","name","description","initialTime","maxTime","icon"]},"ResponsePauseControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da playlist"},"active":{"type":"boolean","description":"Indica se a pausa está ativa ou não"},"productive":{"type":"boolean","description":"Indica se a pausa é produtiva ou não"},"cumulative":{"type":"boolean","description":"Indica se a pausa é do tipo acumulativa ou não"},"supervisioned":{"type":"boolean","description":"Indica se a pausa é supervisionada ou não"},"name":{"type":"string","description":"Nome da pausa"},"description":{"type":"string","description":"Descrição da pausa"},"initialTime":{"type":"string","description":"Indica a partir de qual horário a pausa poderá ser usada"},"maxTime":{"type":"string","description":"Indica a quantidade máxima de tempo em segundos que esta pausa será usada"},"icon":{"type":"string","description":"Nome do ícone"}},"required":["_id","active","productive","cumulative","supervisioned","name","description","initialTime","maxTime","icon"]}}},"paths":{"/pbx/pauses":{"post":{"operationId":"PausesController_createPause","summary":"Cadastro de pausa","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePauseDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePauseControllerDto"}}}}},"tags":["Pausas"]}}}} ``` ## PUT /pbx/pauses > Atualiza uma pausa ```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":{"UpdatePauseDto":{"type":"object","properties":{"active":{"type":"boolean","description":"Indica se a pausa está ativa ou não"},"productive":{"type":"boolean","description":"Indica se a pausa é produtiva ou não"},"cumulative":{"type":"boolean","description":"Indica se a pausa é do tipo acumulativa ou não"},"supervisioned":{"type":"boolean","description":"Indica se a pausa é supervisionada ou não"},"name":{"type":"string","description":"Nome da pausa"},"description":{"type":"string","description":"Descrição da pausa"},"initialTime":{"type":"string","description":"Indica a partir de qual horário a pausa poderá ser usada"},"maxTime":{"type":"string","description":"Indica a quantidade máxima de tempo em segundos que esta pausa será usada"},"icon":{"type":"string","description":"Nome do ícone"},"_id":{"type":"string","description":"ID da operadora/tronco"}},"required":["active","productive","cumulative","supervisioned","name","description","initialTime","maxTime","icon","_id"]},"ResponsePauseControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID da playlist"},"active":{"type":"boolean","description":"Indica se a pausa está ativa ou não"},"productive":{"type":"boolean","description":"Indica se a pausa é produtiva ou não"},"cumulative":{"type":"boolean","description":"Indica se a pausa é do tipo acumulativa ou não"},"supervisioned":{"type":"boolean","description":"Indica se a pausa é supervisionada ou não"},"name":{"type":"string","description":"Nome da pausa"},"description":{"type":"string","description":"Descrição da pausa"},"initialTime":{"type":"string","description":"Indica a partir de qual horário a pausa poderá ser usada"},"maxTime":{"type":"string","description":"Indica a quantidade máxima de tempo em segundos que esta pausa será usada"},"icon":{"type":"string","description":"Nome do ícone"}},"required":["_id","active","productive","cumulative","supervisioned","name","description","initialTime","maxTime","icon"]}}},"paths":{"/pbx/pauses":{"put":{"operationId":"PausesController_updatePause","summary":"Atualiza uma pausa","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePauseDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponsePauseControllerDto"}}}}},"tags":["Pausas"]}}}} ``` ## DELETE /pbx/pauses > Deleta uma pausa ```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":{"DeletePausesByIdDto":{"type":"object","properties":{"ids":{"description":"Id das pausas a serem removidas","type":"array","items":{"type":"string"}}},"required":["ids"]},"RemoveCommonResponse":{"type":"object","properties":{"count":{"type":"number","description":"Quantidade de registros deletados"}},"required":["count"]}}},"paths":{"/pbx/pauses":{"delete":{"operationId":"PausesController_deletePauses","summary":"Deleta uma pausa","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePausesByIdDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Pausas"]}}}} ``` --- # 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/pausas.md?ask= ``` 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.