# Agentes ## GET /pbx/agent > Retorna um agente ```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":{"ResponseAgentControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do agente"},"name":{"type":"string","description":"Nome do agente"},"extension":{"type":"string","description":"Número do ramal do agente"},"codename":{"type":"string","description":"codename do agente"},"email":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"begin":{"type":"string","description":"Horário inicial de login do agente"},"end":{"type":"string","description":"Horário final de login do agente"},"campaign":{"type":"string","description":"ID da equipe do agente"},"tech":{"type":"string","description":"Tecnologia do ramal do agente"},"country_code":{"type":"string","description":"Código do país do ramal Microsoft Teams"},"record_in":{"type":"string","description":"Flag para gravar as chamadas recebidas pelo agente"},"record_out":{"type":"string","description":"Flag para gravar as chamadas realizadas pelo agente"},"extension_lock":{"type":"number","description":"Flag para solicitar senha ao discar ou não"},"dtmf_mode":{"type":"string","description":"Tipo de DTMF do ramal utilizado pelo agente"},"call_limit":{"type":"number","description":"Número máximo de chamadas simultâneas suportadas pelo ramal do agente"},"user_password":{"type":"number","description":"Senha solicitada quando o campo extension_lock está 1"},"allowed_ips":{"type":"string","description":"Lista de redes permitidas para autenticação no ramal do agente"}},"required":["_id","name","extension","codename","email","begin","end","campaign","tech","country_code","record_in","record_out","extension_lock","dtmf_mode","call_limit","user_password","allowed_ips"]}}},"paths":{"/pbx/agent":{"get":{"operationId":"AgentsController_getAgent","summary":"Retorna um agente","parameters":[{"name":"id","required":true,"in":"query","description":"ID do agente","schema":{"type":"string"}},{"name":"sync_auth","required":false,"in":"query","description":"Atualizar a senha do ramal do agente","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseAgentControllerDto"}}}}},"tags":["Agentes"]}}}} ``` ## POST /pbx/agent > Cadastro de agente ```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":{"CreateAgentDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome do agente"},"extension":{"type":"string","description":"Número do ramal do agente"},"codename":{"type":"string","description":"codename do do agente"},"email":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"begin":{"type":"string","description":"Horário inicial de login do agente"},"end":{"type":"string","description":"Horário final de login do agente"},"campaign":{"type":"string","description":"ID da equipe do agente"},"tech":{"type":"string","description":"Tecnologia do ramal do agente"},"country_code":{"type":"string","description":"Código do país do ramal Microsoft Teams"},"record_in":{"type":"string","description":"Flag para gravar as chamadas recebidas pelo agente"},"record_out":{"type":"string","description":"Flag para gravar as chamadas realizadas pelo agente"},"extension_lock":{"type":"number","description":"Flag para solicitar senha ao discar ou não"},"dtmf_mode":{"type":"string","description":"Tipo de DTMF do ramal utilizado pelo agente"},"call_limit":{"type":"number","description":"Número máximo de chamadas simultâneas suportadas pelo ramal do agente"},"user_password":{"type":"number","description":"Senha solicitada quando o campo extension_lock está 1"},"allowed_ips":{"type":"string","description":"Lista de redes permitidas para autenticação no ramal do agente"},"use_main_login":{"type":"string","description":"Usar login como e-mail de recuperação"},"email_forgot_password":{"type":"string","description":"E-mail para recuperar senha"}},"required":["name","extension","codename","email","begin","end","campaign","tech","country_code","record_in","record_out","extension_lock","dtmf_mode","call_limit","user_password","allowed_ips","use_main_login","email_forgot_password"]},"ResponseAgentControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do agente"},"name":{"type":"string","description":"Nome do agente"},"extension":{"type":"string","description":"Número do ramal do agente"},"codename":{"type":"string","description":"codename do agente"},"email":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"begin":{"type":"string","description":"Horário inicial de login do agente"},"end":{"type":"string","description":"Horário final de login do agente"},"campaign":{"type":"string","description":"ID da equipe do agente"},"tech":{"type":"string","description":"Tecnologia do ramal do agente"},"country_code":{"type":"string","description":"Código do país do ramal Microsoft Teams"},"record_in":{"type":"string","description":"Flag para gravar as chamadas recebidas pelo agente"},"record_out":{"type":"string","description":"Flag para gravar as chamadas realizadas pelo agente"},"extension_lock":{"type":"number","description":"Flag para solicitar senha ao discar ou não"},"dtmf_mode":{"type":"string","description":"Tipo de DTMF do ramal utilizado pelo agente"},"call_limit":{"type":"number","description":"Número máximo de chamadas simultâneas suportadas pelo ramal do agente"},"user_password":{"type":"number","description":"Senha solicitada quando o campo extension_lock está 1"},"allowed_ips":{"type":"string","description":"Lista de redes permitidas para autenticação no ramal do agente"}},"required":["_id","name","extension","codename","email","begin","end","campaign","tech","country_code","record_in","record_out","extension_lock","dtmf_mode","call_limit","user_password","allowed_ips"]}}},"paths":{"/pbx/agent":{"post":{"operationId":"AgentsController_createAgent","summary":"Cadastro de agente","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseAgentControllerDto"}}}}},"tags":["Agentes"]}}}} ``` ## PUT /pbx/agent > Atualiza um agente ```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":{"CreateAgentDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome do agente"},"extension":{"type":"string","description":"Número do ramal do agente"},"codename":{"type":"string","description":"codename do do agente"},"email":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"begin":{"type":"string","description":"Horário inicial de login do agente"},"end":{"type":"string","description":"Horário final de login do agente"},"campaign":{"type":"string","description":"ID da equipe do agente"},"tech":{"type":"string","description":"Tecnologia do ramal do agente"},"country_code":{"type":"string","description":"Código do país do ramal Microsoft Teams"},"record_in":{"type":"string","description":"Flag para gravar as chamadas recebidas pelo agente"},"record_out":{"type":"string","description":"Flag para gravar as chamadas realizadas pelo agente"},"extension_lock":{"type":"number","description":"Flag para solicitar senha ao discar ou não"},"dtmf_mode":{"type":"string","description":"Tipo de DTMF do ramal utilizado pelo agente"},"call_limit":{"type":"number","description":"Número máximo de chamadas simultâneas suportadas pelo ramal do agente"},"user_password":{"type":"number","description":"Senha solicitada quando o campo extension_lock está 1"},"allowed_ips":{"type":"string","description":"Lista de redes permitidas para autenticação no ramal do agente"},"use_main_login":{"type":"string","description":"Usar login como e-mail de recuperação"},"email_forgot_password":{"type":"string","description":"E-mail para recuperar senha"}},"required":["name","extension","codename","email","begin","end","campaign","tech","country_code","record_in","record_out","extension_lock","dtmf_mode","call_limit","user_password","allowed_ips","use_main_login","email_forgot_password"]},"ResponseAgentControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do agente"},"name":{"type":"string","description":"Nome do agente"},"extension":{"type":"string","description":"Número do ramal do agente"},"codename":{"type":"string","description":"codename do agente"},"email":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"begin":{"type":"string","description":"Horário inicial de login do agente"},"end":{"type":"string","description":"Horário final de login do agente"},"campaign":{"type":"string","description":"ID da equipe do agente"},"tech":{"type":"string","description":"Tecnologia do ramal do agente"},"country_code":{"type":"string","description":"Código do país do ramal Microsoft Teams"},"record_in":{"type":"string","description":"Flag para gravar as chamadas recebidas pelo agente"},"record_out":{"type":"string","description":"Flag para gravar as chamadas realizadas pelo agente"},"extension_lock":{"type":"number","description":"Flag para solicitar senha ao discar ou não"},"dtmf_mode":{"type":"string","description":"Tipo de DTMF do ramal utilizado pelo agente"},"call_limit":{"type":"number","description":"Número máximo de chamadas simultâneas suportadas pelo ramal do agente"},"user_password":{"type":"number","description":"Senha solicitada quando o campo extension_lock está 1"},"allowed_ips":{"type":"string","description":"Lista de redes permitidas para autenticação no ramal do agente"}},"required":["_id","name","extension","codename","email","begin","end","campaign","tech","country_code","record_in","record_out","extension_lock","dtmf_mode","call_limit","user_password","allowed_ips"]}}},"paths":{"/pbx/agent":{"put":{"operationId":"AgentsController_updateAgent","summary":"Atualiza um agente","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseAgentControllerDto"}}}}},"tags":["Agentes"]}}}} ``` ## DELETE /pbx/agent > Deleta um agente ```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/agent":{"delete":{"operationId":"AgentsController_deleteOneAgent","summary":"Deleta um agente","parameters":[{"name":"id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Agentes"]}}}} ``` ## POST /pbx/agent/multi > Cadastro de múltiplos agentes ```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":{"CreateAgentDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome do agente"},"extension":{"type":"string","description":"Número do ramal do agente"},"codename":{"type":"string","description":"codename do do agente"},"email":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"begin":{"type":"string","description":"Horário inicial de login do agente"},"end":{"type":"string","description":"Horário final de login do agente"},"campaign":{"type":"string","description":"ID da equipe do agente"},"tech":{"type":"string","description":"Tecnologia do ramal do agente"},"country_code":{"type":"string","description":"Código do país do ramal Microsoft Teams"},"record_in":{"type":"string","description":"Flag para gravar as chamadas recebidas pelo agente"},"record_out":{"type":"string","description":"Flag para gravar as chamadas realizadas pelo agente"},"extension_lock":{"type":"number","description":"Flag para solicitar senha ao discar ou não"},"dtmf_mode":{"type":"string","description":"Tipo de DTMF do ramal utilizado pelo agente"},"call_limit":{"type":"number","description":"Número máximo de chamadas simultâneas suportadas pelo ramal do agente"},"user_password":{"type":"number","description":"Senha solicitada quando o campo extension_lock está 1"},"allowed_ips":{"type":"string","description":"Lista de redes permitidas para autenticação no ramal do agente"},"use_main_login":{"type":"string","description":"Usar login como e-mail de recuperação"},"email_forgot_password":{"type":"string","description":"E-mail para recuperar senha"}},"required":["name","extension","codename","email","begin","end","campaign","tech","country_code","record_in","record_out","extension_lock","dtmf_mode","call_limit","user_password","allowed_ips","use_main_login","email_forgot_password"]},"ResponseAgentControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do agente"},"name":{"type":"string","description":"Nome do agente"},"extension":{"type":"string","description":"Número do ramal do agente"},"codename":{"type":"string","description":"codename do agente"},"email":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"begin":{"type":"string","description":"Horário inicial de login do agente"},"end":{"type":"string","description":"Horário final de login do agente"},"campaign":{"type":"string","description":"ID da equipe do agente"},"tech":{"type":"string","description":"Tecnologia do ramal do agente"},"country_code":{"type":"string","description":"Código do país do ramal Microsoft Teams"},"record_in":{"type":"string","description":"Flag para gravar as chamadas recebidas pelo agente"},"record_out":{"type":"string","description":"Flag para gravar as chamadas realizadas pelo agente"},"extension_lock":{"type":"number","description":"Flag para solicitar senha ao discar ou não"},"dtmf_mode":{"type":"string","description":"Tipo de DTMF do ramal utilizado pelo agente"},"call_limit":{"type":"number","description":"Número máximo de chamadas simultâneas suportadas pelo ramal do agente"},"user_password":{"type":"number","description":"Senha solicitada quando o campo extension_lock está 1"},"allowed_ips":{"type":"string","description":"Lista de redes permitidas para autenticação no ramal do agente"}},"required":["_id","name","extension","codename","email","begin","end","campaign","tech","country_code","record_in","record_out","extension_lock","dtmf_mode","call_limit","user_password","allowed_ips"]}}},"paths":{"/pbx/agent/multi":{"post":{"operationId":"AgentsController_createAgents","summary":"Cadastro de múltiplos agentes","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAgentDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseAgentControllerDto"}}}}}},"tags":["Agentes"]}}}} ``` ## GET /pbx/agent/all > Retorna lista de agentes ```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":{"ResponseAgentControllerDto":{"type":"object","properties":{"_id":{"type":"string","description":"ID do agente"},"name":{"type":"string","description":"Nome do agente"},"extension":{"type":"string","description":"Número do ramal do agente"},"codename":{"type":"string","description":"codename do agente"},"email":{"type":"string","description":"E-mail do agente para onde será enviado o link para criação da senha"},"begin":{"type":"string","description":"Horário inicial de login do agente"},"end":{"type":"string","description":"Horário final de login do agente"},"campaign":{"type":"string","description":"ID da equipe do agente"},"tech":{"type":"string","description":"Tecnologia do ramal do agente"},"country_code":{"type":"string","description":"Código do país do ramal Microsoft Teams"},"record_in":{"type":"string","description":"Flag para gravar as chamadas recebidas pelo agente"},"record_out":{"type":"string","description":"Flag para gravar as chamadas realizadas pelo agente"},"extension_lock":{"type":"number","description":"Flag para solicitar senha ao discar ou não"},"dtmf_mode":{"type":"string","description":"Tipo de DTMF do ramal utilizado pelo agente"},"call_limit":{"type":"number","description":"Número máximo de chamadas simultâneas suportadas pelo ramal do agente"},"user_password":{"type":"number","description":"Senha solicitada quando o campo extension_lock está 1"},"allowed_ips":{"type":"string","description":"Lista de redes permitidas para autenticação no ramal do agente"}},"required":["_id","name","extension","codename","email","begin","end","campaign","tech","country_code","record_in","record_out","extension_lock","dtmf_mode","call_limit","user_password","allowed_ips"]}}},"paths":{"/pbx/agent/all":{"get":{"operationId":"AgentsController_getAgents","summary":"Retorna lista de agentes","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ResponseAgentControllerDto"}}}}}},"tags":["Agentes"]}}}} ``` ## DELETE /pbx/agent/all > Deleta todos os agentes ```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/agent/all":{"delete":{"operationId":"AgentsController_deleteAllAgent","summary":"Deleta todos os agentes","parameters":[],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Agentes"]}}}} ``` ## POST /pbx/agent/reset\_password > Envia email para trocar a senha do agent ```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":{"ResetPasswordAgentDto":{"type":"object","properties":{"id":{"type":"string","description":"ID do agente"}},"required":["id"]},"ResponseResetPasswordControllerDto":{"type":"object","properties":{"message":{"type":"string","description":"Mensagem"}},"required":["message"]}}},"paths":{"/pbx/agent/reset_password":{"post":{"operationId":"AgentsController_resetPassword","summary":"Envia email para trocar a senha do agent","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResetPasswordAgentDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseResetPasswordControllerDto"}}}}},"tags":["Agentes"]}}}} ``` ## POST /pbx/agent/pause > Pausa um agente ```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":{"PauseManageQueueMemberDto":{"type":"object","properties":{"agent_id":{"type":"string","description":"Id do agente"},"pause_id":{"type":"string","description":"Id da pausa"},"metadata":{"type":"object","description":"Objeto de informações extras"}},"required":["agent_id","pause_id","metadata"]},"ResponseAgentStatisticsController":{"type":"object","properties":{"paused":{"type":"number","description":""},"cumulative_time":{"type":"number","description":""},"_id":{"type":"string","description":""},"active":{"type":"boolean","description":""},"productive":{"type":"boolean","description":""},"cumulative":{"type":"boolean","description":""},"supervisioned":{"type":"boolean","description":""},"typeMessage":{"type":"string","description":""},"name":{"type":"string","description":""},"description":{"type":"string","description":""},"initialTime":{"type":"string","description":""},"maxTime":{"type":"string","description":""},"message":{"type":"string","description":""},"created_at":{"type":"string","description":""},"updated_at":{"type":"string","description":""},"count_calls_in":{"type":"number","description":""},"count_calls_out":{"type":"number","description":""},"talk_time_average":{"type":"string","description":""},"total_talk_time":{"type":"string","description":""},"metadata":{"type":"object","description":"Objeto de informações extras"}},"required":["paused","cumulative_time","_id","active","productive","cumulative","supervisioned","typeMessage","name","description","initialTime","maxTime","message","created_at","updated_at","count_calls_in","count_calls_out","talk_time_average","total_talk_time","metadata"]}}},"paths":{"/pbx/agent/pause":{"post":{"operationId":"AgentsController_pauseAgent","summary":"Pausa um agente","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PauseManageQueueMemberDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseAgentStatisticsController"}}}}},"tags":["Agentes"]}}}} ``` ## POST /pbx/agent/unpause > Despausar um agente ```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":{"UnpauseManageQueueMemberDto":{"type":"object","properties":{"agent_id":{"type":"string","description":"Id do agente"}},"required":["agent_id"]}}},"paths":{"/pbx/agent/unpause":{"post":{"operationId":"AgentsController_unpauseAgent","summary":"Despausar um agente","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnpauseManageQueueMemberDto"}}}},"responses":{"201":{"description":""}},"tags":["Agentes"]}}}} ``` ## POST /pbx/agent/tabulation > Aplica tabulação ```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":{"ApplyTabulationDto":{"type":"object","properties":{"tabulation_id":{"type":"string","description":"Id da Tabulação"},"agent_id":{"type":"string","description":"Id do agente"},"group_id":{"type":"string","description":"Id do Grupo"},"protocol":{"type":"string","description":"Protocolo"},"contact_id":{"type":"string","description":"Id do Contato"}},"required":["tabulation_id","agent_id","group_id","protocol","contact_id"]},"RemoveCommonResponse":{"type":"object","properties":{"count":{"type":"number","description":"Quantidade de registros deletados"}},"required":["count"]}}},"paths":{"/pbx/agent/tabulation":{"post":{"operationId":"AgentsController_applyTabulation","summary":"Aplica tabulação","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplyTabulationDto"}}}},"responses":{"default":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveCommonResponse"}}}}},"tags":["Agentes"]}}}} ``` --- # 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/agentes.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.