Bem vindo a documentação da API Nexchat
\nAbaixo você encontra todos nossos endpoints disponíveis até o momento e como utiliza-los.
Todos os endpoints necessitam autenticação, o token é gerado em seu sistema Nexchat no cadastro de usuários, lembre-se de criar um perfil de permissões do tipo API.
Todos os endpoints possuem um dominio e token genéricos a fins de exemplo, você deve subsituir pelo domínio do seu Nexchat e o token pelo que você gerar.
\nQualquer dúvida nosso time de suporte estará disponível para ajuda-lo.
\nVamos lá?
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33495116","collectionId":"a2b6a209-aa0e-41cb-a34a-a1a86859956e","publishedId":"2sA2xh2sZf","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"00ff7f"},"publishDate":"2025-01-08T15:09:29.000Z"},"item":[{"name":"Atendimentos","item":[{"name":"Buscar atendimento populado","id":"cf3a801e-c07f-4830-97da-5a3bd23e508c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/atendimento/629a65d61a34596fc382a4b0","description":"Endpoint responsável por trazer um único registro filtrado pelo ID inserido na URL.
Caso exista algum campo de relacionamento este campo virá populado com as informações invés de somente o ID.
Endpoint responsável pela listagem dos atendimentos. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todos os atendimentos.
\nAlém dos filtros você pode definir opções.
\nFiltros disponiveis
\n\n\n\n
protocolodataInicialAberturadataFinalAbertura\ndataInicialEncerramento\ndataFinalEncerramento
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","atendimento"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"a9ad0887-6afb-46cb-9ebf-64fb7aae4038","name":"Listar atendimentos","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/atendimento"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": [\n {\n \"_id\": \"657c407f95a89d4dd802ca1c\",\n \"id_cliente\": \"646657ac0940d216c59e95ea\",\n \"id_user\": \"1532837c61b23cfec1d35918\",\n \"id_atendente\": \"5d1242134b16a50312cc8f43\",\n \"setor\": \"5bf13d1d126f7d2b0d647a61\",\n \"descricao\": \"\",\n \"status\": \"F\",\n \"canal\": \"page\",\n \"canal_id\": \"12a3a36ddcfd22baf4990e2f\",\n \"canal_cliente\": \"c1b22a37-fb6a-4875-bd3c-dae9735393c6\",\n \"protocolo\": \"OPA20232025\",\n \"tags\": [],\n \"avaliacoes\": [],\n \"observacoes\": [],\n \"date\": \"2023-12-15T12:03:11.406Z\",\n \"fim\": \"2023-12-15T19:11:02.391Z\"\n },\n {\n \"_id\": \"657ca4c795a89d4dd105ce04\",\n \"id_cliente\": \"646657ac0940d486c51e25ea\",\n \"id_user\": \"6539837c12b53cfec1d35918\",\n \"id_atendente\": \"1d1246ad4b16a50312cc8f4d\",\n \"setor\": \"1bf72d1d186f7d2b0d647a61\",\n \"descricao\": \"\",\n \"status\": \"F\",\n \"canal\": \"page\",\n \"canal_id\": \"62a3a24ddcfd29baf4120e2f\",\n \"canal_cliente\": \"c7b25a32-fb6a-4175-bd1c-dae9735393c6\",\n \"protocolo\": \"OPA20232016\",\n \"tags\": [],\n \"avaliacoes\": [],\n \"observacoes\": [],\n \"date\": \"2023-12-15T19:11:03.400Z\",\n \"fim\": \"2023-12-15T19:11:33.786Z\"\n }\n ]\n}"}],"_postman_id":"61be48a0-2ad2-45eb-9846-76518fe2fab1"}],"id":"bae8a019-9bc5-4aa0-a3b5-37b9337be854","_postman_id":"bae8a019-9bc5-4aa0-a3b5-37b9337be854","description":""},{"name":"Mensagens","item":[{"name":"Listar mensagens atendimento","id":"d6224cea-d5c0-4bca-84a7-e5bb47463cc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"id_rota\": \"62a8c296cba8621f428b50d5\"\n },\n \"options\": {\n \"limit\": 100\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://meudominio.com.br/api/v1/atendimento/mensagem","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Endpoint responsável pela listagem das mensagens do atendimento. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todas as mensagens.
\nAlém dos filtros você pode definir opções.
\nFiltros disponiveis
\n\n\n\n
id_rota
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","atendimento","mensagem"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"a82659aa-3530-42a1-b9af-4692e0d9f46e","name":"Listar mensagens atendimento","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/atendimento/mensagem"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": [\n {\n \"_id\": \"657ca4c795a89d4dd806ce11\",\n \"id_rota\": \"62a8c296cba8621f428b50d5\",\n \"id_atend\": \"5d1642ad4b16a50312cc8f4d\",\n \"mensagem\": \"Protocolo OPA20232006\",\n \"tipo\": \"\",\n \"objeto\": null,\n \"chamada\": null,\n \"canalComunicacao\": \"62a3a36ddcfd29baf4990e2f\",\n \"destinatario\": \"6539837c61b23cfec1d35918\",\n \"tipoDestinatario\": \"clientes_users\",\n \"statusEnvio\": {\n \"status\": \"\",\n \"observacao\": \"\"\n },\n \"data\": \"2023-12-15T19:11:03.488Z\",\n \"createdAt\": \"2023-12-15T19:11:03.490Z\",\n \"updatedAt\": \"2023-12-15T19:11:03.490Z\",\n \"__v\": 0\n },\n {\n \"_id\": \"657ca4c795a89d4dd806ce14\",\n \"id_rota\": \"62a8c296cba8621f428b50d5\",\n \"id_user\": \"6539837c61b23cfec1d35918\",\n \"mensagem\": \"Teste\",\n \"tipo\": \"texto\",\n \"objeto\": null,\n \"chamada\": null,\n \"canalComunicacao\": \"62a3a36ddcfd29baf4990e2f\",\n \"destinatario\": \"5d1642ad4b16a50312cc8f4d\",\n \"tipoDestinatario\": \"usuarios\",\n \"id_mensagem_citada\": null,\n \"idMensagemCanal\": null,\n \"statusEnvio\": {\n \"status\": \"\",\n \"observacao\": \"\"\n },\n \"data\": \"2023-12-15T19:11:03.548Z\",\n \"createdAt\": \"2023-12-15T19:11:03.554Z\",\n \"updatedAt\": \"2023-12-15T19:11:03.554Z\",\n \"__v\": 0\n },\n {\n \"_id\": \"657ca4c895a89d4dd806ce19\",\n \"id_rota\": \"62a8c296cba8621f428b50d5\",\n \"id_atend\": \"5d1642ad4b16a50312cc8f4d\",\n \"mensagem\": {\n \"titulo\": \"Menu escolha\",\n \"opcoes\": [\n {\n \"id\": \"1\",\n \"texto\": \"Escolha 1\",\n \"descricao\": \"\"\n },\n {\n \"id\": \"2\",\n \"texto\": \"Escolha 2\",\n \"descricao\": \"\"\n },\n {\n \"id\": \"3\",\n \"texto\": \"Escolha 3\",\n \"descricao\": \"\"\n },\n {\n \"id\": \"4\",\n \"texto\": \"Escolha 4\",\n \"descricao\": \"\"\n }\n ]\n },\n \"tipo\": \"menuInterativo\",\n \"objeto\": null,\n \"chamada\": null,\n \"canalComunicacao\": \"62a3a36ddcfd29baf4990e2f\",\n \"destinatario\": \"6539837c61b23cfec1d35918\",\n \"tipoDestinatario\": \"clientes_users\",\n \"statusEnvio\": {\n \"status\": \"sent\",\n \"observacao\": \"\"\n },\n \"data\": \"2023-12-15T19:11:04.787Z\",\n \"createdAt\": \"2023-12-15T19:11:04.789Z\",\n \"updatedAt\": \"2023-12-15T19:11:04.809Z\",\n \"__v\": 0\n },\n {\n \"_id\": \"657ca4e595a89d4dd806ce27\",\n \"id_rota\": \"62a8c296cba8621f428b50d5\",\n \"id_atend\": \"5d1642ad4b16a50312cc8f4d\",\n \"mensagem\": \"Mensagem de teste dali\",\n \"tipo\": \"\",\n \"objeto\": null,\n \"chamada\": null,\n \"canalComunicacao\": \"62a3a36ddcfd29baf4990e2f\",\n \"destinatario\": \"6539837c61b23cfec1d35918\",\n \"tipoDestinatario\": \"clientes_users\",\n \"statusEnvio\": {\n \"status\": \"sent\",\n \"observacao\": \"\"\n },\n \"data\": \"2023-12-15T19:11:33.717Z\",\n \"createdAt\": \"2023-12-15T19:11:33.719Z\",\n \"updatedAt\": \"2023-12-15T19:11:33.752Z\",\n \"__v\": 0\n },\n {\n \"_id\": \"657ca4e595a89d4dd806ce41\",\n \"id_rota\": \"62a8c296cba8621f428b50d5\",\n \"id_atend\": \"5d1642ad4b16a50312cc8f4d\",\n \"mensagem\": \"Mensagem de teste daqui\",\n \"tipo\": \"\",\n \"objeto\": null,\n \"chamada\": null,\n \"canalComunicacao\": \"62a3a36ddcfd29baf4990e2f\",\n \"destinatario\": \"6539837c61b23cfec1d35918\",\n \"tipoDestinatario\": \"clientes_users\",\n \"statusEnvio\": {\n \"status\": \"\",\n \"observacao\": \"\"\n },\n \"data\": \"2023-12-15T19:11:33.845Z\",\n \"createdAt\": \"2023-12-15T19:11:33.850Z\",\n \"updatedAt\": \"2023-12-15T19:11:33.850Z\",\n \"__v\": 0\n }\n ]\n}"}],"_postman_id":"d6224cea-d5c0-4bca-84a7-e5bb47463cc2"},{"name":"Buscar mensagem atendimento pupulada","id":"c78a440d-e402-430a-8b8c-dd69037f4d1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/atendimento/mensagem/5d1642434b16a50312cc8f43","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Endpoint responsável por trazer um único registro filtrado pelo ID inserido na URL.
Caso exista algum campo de relacionamento este campo virá populado com as informações invés de somente o ID.
Endpoint responsável pela listagem dos canais de comunicação. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todos os canais de comunicação.
\nAlém dos filtros você pode definir opções.
\nFiltros disponiveis
\n\n\n\n
nomeid_atendentestatuscanal(valores disponíveis: 'Whatsapp', 'Instagram', 'Page', 'Telegram', 'Messenger' ou 'Telefonia').integracao(valores disponíveis: 'facebook' ou 'dialog360').
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","canal-comunicacao",""],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"1e8dde90-a999-4fa3-ab6b-fd32d0824cde","name":"Listar canais de comunicação","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/canal-comunicacao/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": [\n {\n \"_id\": \"212b435c1cc6221ac1zf125a\",\n \"nome\": \"Canal 360dialog\",\n \"id_atendente\": \"116d2132b4x5fe04ehd76f68\",\n \"status\": \"A\",\n \"canal\": \"Whatsapp\",\n \"integracao\": \"dialog360\",\n \"prioridadeListagemAtendimentos\": 5\n }\n ]\n}"}],"_postman_id":"f5877d3a-351d-474d-bc88-ce0cc6646816"},{"name":"Buscar canal de comunicação populado","id":"4eef90ff-d562-47e8-907d-d12a5b7f376c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/canal-comunicacao/212b435c1cc6221ac1zf125a","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Endpoint responsável por trazer um único registro filtrado pelo ID inserido na URL.
Caso exista algum campo de relacionamento este campo virá populado com as informações invés de somente o ID.
Endpoint responsável por trazer os templates de mensagem relacionados ao canal de comunicação.
\n","urlObject":{"protocol":"https","path":["api","v1","canal-comunicacao","625ac335dadd05f1bd084040","template"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"3a431caa-9974-4fdc-86d1-b3c3c4f9ceab","name":"Buscar os templates de mensagem por canal","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/canal-comunicacao/625ac335dadd05f1bd084040/template"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": [\n {\n \"_id\": \"13197eb7dfcx7928f233512f\",\n \"texto\": \"Olá {{nome_usuario}} segue link de assinatura digital do seu contrato {{protocolo}}\",\n \"atalho\": \"assinatura_digital\",\n \"dados\": \"{\\\"element_name\\\":\\\"assinatura_digital\\\",\\\"id\\\":\\\"\\\",\\\"namespace\\\":\\\"q1xfg921_f0f5_61dx_1260_3ca2417b0f21\\\",\\\"idioma\\\":\\\"pt_BR\\\",\\\"category\\\":\\\"UTILITY\\\",\\\"templateType\\\":\\\"simpleTextTemplate\\\",\\\"headerContentType\\\":\\\"textHeader\\\",\\\"mediaType\\\":\\\"\\\",\\\"title\\\":\\\"\\\",\\\"midia\\\":\\\"\\\",\\\"footer\\\":\\\"\\\",\\\"buttonType\\\":\\\"\\\",\\\"textButton1\\\":\\\"\\\",\\\"textButton2\\\":\\\"\\\",\\\"url\\\":\\\"\\\"}\",\n \"identificadorCanal\": \" Oxi9iMOL\",\n \"tipo_mensagem\": \"dialog360\",\n \"departamentos\": [\n \"5bf26c1f186f7d2b1c647a15\"\n ],\n \"anexo\": null,\n \"flow\": null,\n \"createdAt\": \"2023-12-13T12:08:23.315Z\",\n \"updatedAt\": \"2023-12-13T12:08:23.315Z\",\n \"__v\": 0\n }\n ]\n}"}],"_postman_id":"4609923a-e5ba-49e4-a661-ea843c0b72e1"},{"name":"Buscar limites diários de envio de templates de mensagem","id":"ab0d27f5-f91f-4eff-a0bf-64ca5708b36b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/canal-comunicacao/625ac335dadd05f1bd084040/template/limites-diarios-envio ","description":"Endpoint responsável por trazer os limites diários de envio de mensagens do canal (Templates fora da janela de 24 horas), pelo ID inserido na URL.
Caso o canal não possua limites de mensagens, virá como objeto vazio.
Endpoint responsável pela listagem dos templates de mensagens. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todos os canais de comunicação.
\nTambém é possível definir opções.
\nFiltros disponiveis
\n\n\n\n
atalhotipo_mensagem
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","template"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"844c465c-abf4-47b6-bca0-4767166304a5","name":"Listar templates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/template"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": \"success\",\n\t\"code\": 200,\n\t\"data\": [\n\t\t{\n\t\t\t\"_id\": \"12452eb7dfcc7928f522912e\",\n\t\t\t\"texto\": \"Olá {{nome_usuario}} segue link de assinatura digital do seu contrato {{protocolo}}\",\n\t\t\t\"atalho\": \"assinatura_digital\",\n\t\t\t\"tipo_mensagem\": \"dialog360\",\n\t\t\t\"departamentos\": [\n\t\t\t\t\"1bf26d1d136f7d2b0d247a61\"\n\t\t\t]\n\t\t}\n\t]\n}"}],"_postman_id":"441d17b3-d069-4be8-9449-246c0f818bbd"},{"name":"Buscar template populado","id":"404b0b0a-8a52-488c-a6d3-ec7d0ad8474e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/template/625ac335dadd05f1bd084040","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Endpoint responsável por trazer um único registro filtrado pelo ID inserido na URL.
Caso exista algum campo de relacionamento este campo virá populado com as informações invés de somente o ID.
Este endpoint realiza o envio de um template de mensagem para o seu cliente, podendo ser usado para avisos, notificações etc. O envio só pode ser feito através de um canal de comunicação ativo do tipo Whatsapp, Telegram, Messenger e Instagram.
\nNão será possível enviar templates para contatos que já estiverem em atendimento.
\nParâmetros:
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","template","send"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"f29fb142-6211-4a98-a9b0-eceeba493ee0","name":"Enviar template","originalRequest":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"contato\": {\n\t\t\"canalCliente\": \"+5599999999999\"\n\t},\n \"template\": {\n \"_id\": \"624c358355802dbdd2eb944a\",\n \"variaveis\": [\"variavel 1\", \"variavel 2\"]\n },\n \"canal\": \"622f8e310d7149ee66bb654c\"\n}","options":{"raw":{"language":"json"}}},"url":"https://meudominio.com.br/api/v1/template/send"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": {\n \"message\": \"Template has been succesfully sent.\",\n \"messageSentId\": \"659c365bfdf5907fd69e28XX\"\n }\n}"}],"_postman_id":"13cb61de-df7e-4448-9baf-3397a26ce59b"}],"id":"7536bf85-64ac-4a90-ae9d-7c28f5d6ba13","_postman_id":"7536bf85-64ac-4a90-ae9d-7c28f5d6ba13","description":""},{"name":"Cliente","item":[{"name":"Criar cliente","id":"17b3bfa9-9648-426f-90f1-3a04d3d516b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"nome\": \"Arnold Schwarzenegger\",\n\t\"cpf_cnpj\": \"640.642.910-93\",\n\t\"status\": \"A\",\n\t\"cliente\": true,\n\t\"prospect\": false,\n\t\"fornecedor\": false,\n\t\"prestadorServico\": false,\n \"tags\": [\"62878ee28d8911cd3916e8d4\", \"62878efe8d8911cd3916e8ee\"]\n}"},"url":"https://meudominio.com.br/api/v1/cliente/","description":"*
\ncontato.canalCliente: identificador do usuário referente a um canal de comunicação, por exemplo, em um canal do tipo Whatsapp o canalCliente é um número de whatsapp válido (incluindo o +DDI).
*template._id: id do template que será enviado.template.variaveis: uma lista das váriaveis que deseja inserir no template.
*canal: id do canal de comunicação que fará o envio da mensagem.
Este endpoint é responsável por criar um novo cliente.
\nParâmetros:
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","cliente",""],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"a1f67978-b3a3-4654-b17b-32181fac7ac2","name":"Criar cliente","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"nome\": \"Arnold Schwarzenegger\",\n\t\"cpf_cnpj\": \"640.642.910-93\",\n\t\"status\": \"A\",\n\t\"cliente\": true,\n\t\"prospect\": false,\n\t\"fornecedor\": false,\n\t\"prestadorServico\": false,\n \"tags\": [\"62878ee28d8911cd3916e8d4\", \"62878efe8d8911cd3916e8ee\"]\n}"},"url":"https://meudominio.com.br/api/v1/cliente/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": {\n \"_id\": \"658485e719e7444bbc9f4273\"\n }\n}"}],"_postman_id":"17b3bfa9-9648-426f-90f1-3a04d3d516b4"},{"name":"Editar cliente","id":"a83dfb68-6d14-43b6-8c6f-29305d69509e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"nome\": \"Arnold Schwarzenegger\",\n\t\"cpf_cnpj\": \"640.642.910-93\",\n\t\"status\": \"I\",\n\t\"cliente\": true,\n\t\"prospect\": false,\n\t\"fornecedor\": false,\n\t\"prestadorServico\": false\n}"},"url":"https://meudominio.com.br/api/v1/cliente/625ac335dadd05f1bd084040","description":"\n
id: id do seu sistema de origem (integrações erp).id_fornecedor: id do seu sistema de origem caso o cliente seja um fornecedor.id_filial: id da filial do seu sistema de origem.
*nome: nome completo do cliente.fantasia: nome fantasia do cliente.cpf_cnpj: cpf ou cnpj do cliente.
*status: status que indica se o cliente é ativo ou inativo.
*prospect: indica se o cliente é um prospect.
*cliente: indica se é um cliente.
*fornecedor: indica se o cliente é um fornecedor.
*prestadorServico: indica se o cliente é um prestador de serviço
*publicKey: chave pública do cliente.tags: array com o id das etiquetas de atendimento.
Este endpoint é responsável por atualizar um cliente. Os parâmetros obrigatórios precisam ser enviados mesmo que não sejam editados, recomendamos sempre consultar o registro antes de atualiza-lo.
Clientes provenientes de integração não poderão ser editados.
Parâmetros:
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","cliente","625ac335dadd05f1bd084040"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"83354dac-f84a-46cc-937d-05b45f68d522","name":"Editar cliente","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"nome\": \"Arnold Schwarzenegger\",\n\t\"cpf_cnpj\": \"640.642.910-93\",\n\t\"status\": \"I\",\n\t\"cliente\": true,\n\t\"prospect\": false,\n\t\"fornecedor\": false,\n\t\"prestadorServico\": false\n}"},"url":"https://meudominio.com.br/api/v1/cliente/625ac335dadd05f1bd084040"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": {\n \"_id\": \"65848df5ae1d33ee2c1ce988\"\n }\n}"}],"_postman_id":"a83dfb68-6d14-43b6-8c6f-29305d69509e"},{"name":"Editar parcialmente cliente","id":"9a56626f-2b7a-42c2-9b02-70038022027f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"I\"\n}"},"url":"https://meudominio.com.br/api/v1/cliente/625ac335dadd05f1bd084040","description":"*
\nnome: nome completo do cliente.fantasia: nome fantasia do cliente.cpf_cnpj: cpf ou cnpj do cliente.
*status: status que indica se o cliente é ativo ou inativo.
*prospect: indica se o cliente é um prospect.
*cliente: indica se é um cliente.
*fornecedor: indica se o cliente é um fornecedor.
*prestadorServico: indica se o cliente é um prestador de serviço.publicKey: chave pública do cliente.
Este endpoint é responsável por atualizar parcialmente os dados de um cliente, ou seja, não é necessário enviar todos os dados para ocorrer uma atualização.
\nClientes provenientes de integração não poderão ser editados.
\nParâmetros:
\nnome : nome completo do cliente.fantasia : nome fantasia do cliente.cpf_cnpj : cpf ou cnpj do cliente.status : status que indica se o cliente é ativo ou inativo.prospect : indica se o cliente é um prospect.cliente : indica se é um cliente.fornecedor : indica se o cliente é um fornecedor.prestadorServico : indica se o cliente é um prestador de serviço.publicKey : chave pública do cliente.
Endpoint responsável pela listagem dos clientes. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todos os clientes.
\nTambém é possível definir opções.
\nFiltros disponiveis
\n\n\n\n
idid_fornecedorid_filialnomefantasiacpf_cnpjstatusprospectclientefornecedor
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","cliente",""],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"3b086060-7a45-4372-bed6-65b42b16b073","name":"Listar clientes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/cliente/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": [\n {\n \"_id\": \"658485e719e7444bbc9f4273\",\n \"nome\": \"Arnold Schwarzenegger\",\n \"fantasia\": \"\",\n \"cpf_cnpj\": \"64064291093\",\n \"status\": \"A\",\n \"prospect\": false,\n \"cliente\": true,\n \"fornecedor\": false,\n \"prestadorServico\": false\n }\n ]\n}"}],"_postman_id":"d55ed097-2bab-4879-95c7-5af004669a93"},{"name":"Buscar cliente populado","id":"89481b8e-5c69-4e7c-b2b5-713e455d742c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/cliente/625ac335dadd05f1bd084040","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Endpoint responsável por trazer um único registro filtrado pelo ID inserido na URL.
Caso exista algum campo de relacionamento este campo virá populado com as informações invés de somente o ID.
Endpoint responsável por excluir um cliente.
Não será possível excluir clientes que já realizaram atendimentos.
Endpoint responsável pela listagem dos usuários. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todos os usuários.
\nTambém é possível definir opções.
\nFiltros disponiveis
\n\n\n\n
nomestatus(valores disponíveis: 'A' para ativo e 'I' para inativo)tipo(valores disponíveis: 'user', 'bot' ou 'callCenter')
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","usuario",""],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"d513b3eb-5c28-4cac-b1c2-0afab1a87da4","name":"Listar usuários","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/usuario/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": [\n {\n \"_id\": \"5d1642434b16a50312cc8f43\",\n \"nome\": \"Lucas Silva\",\n \"status\": \"A\",\n \"tipo\": \"user\"\n }\n ]\n}"}],"_postman_id":"3e25003d-321c-4910-bfae-db569b75acd8"}],"id":"b7e99447-56b2-480a-9382-1da3533bd497","_postman_id":"b7e99447-56b2-480a-9382-1da3533bd497","description":""},{"name":"Contatos","item":[{"name":"Criar contato","id":"d05757de-a9fd-498f-a635-faa3455bb203","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"nome\": \"Arnold Schwarzenegger\",\n \"celularCompleto\": \"+5549988776655\",\n \"requerAutenticacaoSempre\": true,\n \"habilitarAlerta\": true,\n \"lead\": false,\n \"historico_email\": true,\n \"senha\": \"senha\",\n \"repetirSenha\": \"senha\"\n}"},"url":"https://meudominio.com.br/api/v1/contato/","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Este endpoint é responsável por criar um novo contato.
\nParâmetros:
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","contato",""],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"3b6215bc-0871-4e85-b518-f2c0c835d46d","name":"Criar contato","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"nome\": \"Arnold Schwarzenegger\",\n \"celularCompleto\": \"+5549988776655\",\n \"requerAutenticacaoSempre\": true,\n \"habilitarAlerta\": true,\n \"lead\": false,\n \"historico_email\": true,\n \"senha\": \"senha\",\n \"repetirSenha\": \"senha\"\n}"},"url":"https://meudominio.com.br/api/v1/contato/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": {\n \"_id\": \"6584973019e7444bbc9f435f\"\n }\n}"}],"_postman_id":"d05757de-a9fd-498f-a635-faa3455bb203"},{"name":"Editar contato","id":"96923659-a080-4325-b5c0-ba1a29e6e90a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"nome\": \"Arnold Schwarzenegger\",\n \"celularCompleto\": \"+5549988776655\",\n \"requerAutenticacaoSempre\": true,\n \"habilitarAlerta\": true,\n \"lead\": false,\n \"historico_email\": true\n}"},"url":"https://meudominio.com.br/api/v1/contato/625ac335dadd05f1bd084040","description":"\n
id_contato: id do seu sistema de origem (integrações erp).id_cliente: id do seu sistema de origem (integrações erp).id_fornecedor: id do seu sistema de origem (integrações erp).
*nome: nome do contatoclassificacao: classificação do contato, podendo ser: 'titular', 'familiar', 'amigo', 'trabalho', 'outro'.foneResidencialCompleto: telefone residencial completo com +ddi e ddd.foneComercialCompleto: telefone comercial completo com +ddi e ddd.celularCompleto: telefone celular completo com +ddi e ddd.WhatsappCompleto: whatsapp completo com +ddi e ddd.
*requerAutenticacaoSempre: define se o contato deve se autenticar sempre ao entrar em contato.
*habilitarAlerta: habilita o alerta de notificações.
*lead: define se o contato é um lead.
*historico_email: define se o contato deve receber um email com o histórico do atendimentos.email_principal: email do contato.mensagemAlerta: mensagem que será enviada na notificação.\n*senha: senha do contato.\n*repetirSenha: repetição da senha do contato.
Este endpoint é responsável por atualizar um contato. Os parâmetros obrigatórios precisam ser enviados mesmo que não sejam editados, recomendamos sempre consultar o registro antes de atualiza-lo.
Contatos provenientes de integração não poderão ser editados.
Parâmetros:
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","contato","625ac335dadd05f1bd084040"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"19547540-fd4e-4df0-ad52-cea767da3f54","name":"Editar contato","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"nome\": \"Arnold Schwarzenegger\",\n \"celularCompleto\": \"+5549988776655\",\n \"requerAutenticacaoSempre\": true,\n \"habilitarAlerta\": true,\n \"lead\": false,\n \"historico_email\": true\n}"},"url":"https://meudominio.com.br/api/v1/contato/625ac335dadd05f1bd084040"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": {\n \"_id\": \"6584973019e7444bbc9f435f\"\n }\n}"}],"_postman_id":"96923659-a080-4325-b5c0-ba1a29e6e90a"},{"name":"Listar contatos","id":"71965668-8a45-48ce-8772-d88d3b8e2733","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"nome\": \"Arnold Schwarzenegger\"\n },\n \"options\": {\n \"limit\": 100\n }\n}"},"url":"https://meudominio.com.br/api/v1/contato/","description":"*
\nnome: nome do contatocelularCompleto: telefone celular completo com +ddi e ddd
*requerAutenticacaoSempre: define se o contato deve se autenticar sempre ao entrar em contato.
*habilitarAlerta: habilita o alerta de notificações
*lead: define se o contato é um lead
*historico_email: define se o contato deve receber um email com o histórico do atendimentos
Endpoint responsável pela listagem dos contatos. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todos os contatos.
\nTambém é possível definir opções.
\nFiltros disponiveis
\n\n\n\n
nomeemail_principal\"fones.numero\"classificacaocli_emp
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","contato",""],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"b90c0cc2-48a1-49f5-b96f-a1955bfefaf4","name":"Listar contatos","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/contato/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": [\n {\n \"_id\": \"6584973019e7444bbc9f435f\",\n \"nome\": \"Arnold Schwarzenegger\",\n \"email_principal\": null,\n \"cli_emp\": null,\n \"fones\": [\n {\n \"numero\": \"+5549988776655\",\n \"tipo\": \"Celular\",\n \"whatsapp\": false,\n \"celular\": true,\n \"integracao\": false,\n \"_id\": \"6584973019e7444bbc9f4360\"\n }\n ],\n \"lead\": false,\n \"historico_email\": true,\n \"habilitarAlerta\": true,\n \"requerAutenticacaoSempre\": true,\n \"classificacao\": \"\",\n \"opt_in_opt_out\": []\n }\n ]\n}"}],"_postman_id":"71965668-8a45-48ce-8772-d88d3b8e2733"},{"name":"Buscar contato populado","id":"79e48c80-5aac-4d8f-a1cb-b718ff4a0066","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/contato/625ac335dadd05f1bd084040","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Endpoint responsável por trazer um único registro filtrado pelo ID inserido na URL.
Caso exista algum campo de relacionamento este campo virá populado com as informações invés de somente o ID.
Endpoint responsável por excluir um contato.
Não será possível excluir contatos que já realizaram atendimentos.
Este endpoint é responsável por criar um novo contato.
\nParâmetros:
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","etiqueta",""],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"457d499b-0fb9-4514-ba0f-bf3b474d4751","name":"Criar etiqueta","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"nome\": \"Nome da Etiqueta\",\n\t\"cor\": \"#F5F5F5\",\n\t\"tipo\": \"empresa\"\n}"},"url":"https://meudominio.com.br/api/v1/etiqueta/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": \"success\",\n\t\"code\": 200,\n\t\"data\": {\n\t\t\"_id\": \"6584995a19e7444bbc9f4440\"\n\t}\n}"}],"_postman_id":"95de1089-0ec2-4515-852d-c1454badf256"},{"name":"Listar etiquetas","id":"01f20d72-02e4-494e-b154-951946effd4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"nome\": \"Etiqueta de serviço\"\n },\n \"options\": {\n \"limit\": 100\n }\n}"},"url":"https://meudominio.com.br/api/v1/etiqueta/","description":"*
\nnome: nome da etiqueta.
*cor: valor HEX da cor da etiqueta.
*tipo: a etiqueta pode ser do tipo \"empresa\" ou \"usuario\".id_criador: se o tipo for \"usuario\", deve ser informado o id desse usuário.
Endpoint responsável pela listagem das etiquetas. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todas as etiquetas.
\nTambém é possível definir opções.
\nFiltros disponiveis
\n\n\n\n
nomeid_criadortipo
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","etiqueta",""],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"0d32bdeb-a1e1-4912-8aff-b18ee717ec0d","name":"Listar etiquetas","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/etiqueta/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": 200,\n \"data\": [\n {\n \"_id\": \"6584995a19e7444bbc9f4440\",\n \"nome\": \"Nome da Etiqueta\",\n \"cor\": \"#F5F5F5\"\n }\n ]\n}"}],"_postman_id":"01f20d72-02e4-494e-b154-951946effd4d"}],"id":"e6c01ef9-e478-4e8b-b42c-7fac37e51a81","_postman_id":"e6c01ef9-e478-4e8b-b42c-7fac37e51a81","description":""},{"name":"Notificação","item":[{"name":"Enviar notificação","id":"cde91b61-ba2f-479a-a49c-351f5db561a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"users\": [\"636e3b59d3469e7108b67d49\", \"636e3b75043d5f805ff40fa8\"],\n \"type\": \"news\",\n \"title\": \"Notificação 1\",\n \"description\": \"Descrição notificação 1\",\n \"link\": \"https://google.com.br\"\n}"},"url":"https://meudominio.com.br/api/v1/notificacao/send","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Este endpoint realiza o envio de notificações para os usuários (atendentes) do sistema. As notificações podem ser utilizadas para o informe de novidades e alertas, além de ser possível enviar pesquisas aos usuários.
\nParâmetros:
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","notificacao","send"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"d6575065-f1de-4f5c-b915-ba8ae9158b68","name":"Enviar notificação","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"users\": [\"636e3b59d3469e7108b67d49\", \"636e3b75043d5f805ff40fa8\"],\n \"type\": \"news\",\n \"title\": \"Notificação 1\",\n \"description\": \"Descrição notificação 1\",\n \"link\": \"https://google.com.br\"\n}"},"url":"https://meudominio.com.br/api/v1/notificacao/send"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": \"success\",\n\t\"code\": 200,\n\t\"data\": [\n\t\t\"658499df19e7444bbc9f4453\"\n\t]\n}"}],"_postman_id":"cde91b61-ba2f-479a-a49c-351f5db561a1"}],"id":"94a23ca8-2638-4553-b615-c2e8982a4a78","_postman_id":"94a23ca8-2638-4553-b615-c2e8982a4a78","description":""},{"name":"Departamentos","item":[{"name":"Criar departamento","id":"a1c35364-d11f-4594-a222-b926ae3d5652","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"nome\": \"Teste API\",\n \"status\": \"A\",\n \"tipoEncaminhamentoLigacoes\": \"S\"\n}","options":{"raw":{"language":"json"}}},"url":"https://meudominio.com.br/api/v1/departamento/","description":"\n
users: array contendo os ids (ObjectId) dos usuários a serem notificados. Caso não forem informados destinatários, as notificações serão enviadas para todos usuários ativos do sistema.*
\ntype: tipo da notificação enviada, a mesma pode conter um dos 3 valores: alert, news ou survey.*
\ntitle: título da notificação.*
\ndescription: descrição da notificação.\n
link: campo para a adição de algum link de redirecionamento da notificação.
Este endpoint é responsável por criar um novo departamento.
\nParâmetros:
\n*nome : nome do departamento.
*status : status do departamento, podendo ser 'A' ou 'I', ativo ou inativo respectivamente.token : token do departamento.ordem : ordem do departamento.parametros : parametros do departamento, array que pode conter os parâmetros 'notifica_ag', 'motivo_atendimento', 'observacaoAtendimento' e 'realizaAtendimento'.flowAvaliacao : id do fluxo de comunicação da pesquisa de satisfação.encerramentoInatividadeAvaliacao : tempo máximo de inatividade em minutos da pesquisa de satisfação.mensagemEncerramentoInatividade : mensagem de encerramento da pesquisa de satisfação por inatividade.cod_pabx : código PABX do departamento para transferências de ligações.
*tipoEncaminhamentoLigacoes : encaminhamento de ligações, podendo ser 'S' ou 'T', encaminhamento simultâneo ou transbordo respectivamente.departamentoTransbordoAlternativo : id do departamento para transferir ligação do transbordo.encaminharLigacao : quantidade de atendentes que receberão a chamada no tipo simultâneo.encerrarAtendPabxAoDesligar : encerrar atendimento quando o cliente desligar o telefone.
Endpoint responsável pela listagem dos departamentos. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todos os departamentos.
\nTambém é possível definir opções.
\nFiltros disponiveis
\n\n\n\n
nometokencod_pabxrealizaAtendimento
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","departamento",""],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"960116a3-9f28-441a-829c-40bba2c4b3c6","name":"Listar departamentos","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/departamento/"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": \"success\",\n\t\"code\": 200,\n\t\"data\": [\n\t\t{\n\t\t\t\"_id\": \"65849a5cae1d33ee2c1cea6d\",\n\t\t\t\"nome\": \"Teste API\",\n\t\t\t\"descricao\": \"\",\n\t\t\t\"status\": \"A\",\n\t\t\t\"ordem\": 25,\n\t\t\t\"notifica_ag\": \"I\",\n\t\t\t\"motivo_atendimento\": false,\n\t\t\t\"realizaAtendimento\": false,\n\t\t\t\"observacaoAtendimento\": false,\n\t\t\t\"flowAvaliacao\": null,\n\t\t\t\"encerramentoInatividadeAvaliacao\": 30,\n\t\t\t\"cod_pabx\": 126,\n\t\t\t\"tipoEncaminhamentoLigacoes\": \"S\",\n\t\t\t\"encaminharLigacaoTodosAtendentes\": false,\n\t\t\t\"encerrarAtendPabxAoDesligar\": false\n\t\t}\n\t]\n}"}],"_postman_id":"190113b3-3cee-4a05-afb0-84a8fe876115"},{"name":"Buscar departamento populado","id":"4a94bbb2-5d46-4ea0-953b-090be226c6d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/departamento/625ac335dadd05f1bd084040","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Endpoint responsável por trazer um único registro filtrado pelo ID inserido na URL.
Caso exista algum campo de relacionamento este campo virá populado com as informações invés de somente o ID.
Este endpoint é responsável por atualizar um departamento. Os parâmetros obrigatórios precisam ser enviados mesmo que não sejam editados, recomendamos sempre consultar o registro antes de atualiza-lo.
\nParâmetros:
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","departamento","625ac335dadd05f1bd084040"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"1d7e5308-4a48-4491-870d-06ca73580b93","name":"Editar departamento","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"nome\": \"Departamento\",\n\t\"status\": \"I\",\n\t\"tipoEncaminhamentoLigacoes\": \"S\",\n\t\"cod_pabx\": \"332\"\n}"},"url":"https://meudominio.com.br/api/v1/departamento/625ac335dadd05f1bd084040"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": \"success\",\n\t\"code\": 200,\n\t\"data\": {\n\t\t\"_id\": \"65849a5cae1d33ee2c1cea6d\"\n\t}\n}"}],"_postman_id":"1874bdcf-4c2b-4dae-bebc-f1dde0fb4651"}],"id":"d66c4ac5-4f8f-45f0-b750-6951725b2f7c","_postman_id":"d66c4ac5-4f8f-45f0-b750-6951725b2f7c","description":""},{"name":"Motivos","item":[{"name":"Listar motivos","id":"795922cf-513a-4500-a6a4-797e7ce032ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"departamentos\": \"625ac335dadd05f1bd084040\"\n },\n \"options\": {\n \"limit\": 100\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://meudominio.com.br/api/v1/atendimento/motivo","description":"*
\nnome: nome do departamento.\n*status: indica o status do departamento.
*tipoEncaminhamentoLigacoes: indica o tipo de encaminhamento de ligações\n*cod_pabx: código pabx do departamento.
Endpoint responsável pela listagem dos motivos de atendimento. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todos os motivos.
\nAlém dos filtros você pode definir opções.
\nFiltros disponiveis
\n\n\n\n
motivodepartamentos
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","atendimento","motivo"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"dc85feba-daa0-46b2-b011-2a481a97c71b","name":"Listar motivos","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/atendimento/motivo"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": \"success\",\n\t\"code\": 200,\n\t\"data\": [\n\t\t{\n\t\t\t\"_id\": \"65849b48ae1d33ee2c1cea94\",\n\t\t\t\"motivo\": \"Teste API\",\n\t\t\t\"departamentos\": [\n\t\t\t\t\"65849b33ae1d33ee2c1cea8d\"\n\t\t\t]\n\t\t}\n\t]\n}"}],"_postman_id":"795922cf-513a-4500-a6a4-797e7ce032ed"},{"name":"Buscar motivo","id":"4feb4dc4-7706-4612-96aa-7c5546eb0869","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/atendimento/motivo/:id","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Endpoint responsável pela listagem de um motivos de atendimento.
\nAlém dos filtros você pode definir opções.
\nOpções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","atendimento","motivo",":id"],"host":["meudominio","com","br"],"query":[],"variable":[{"id":"f5388f4d-15f1-4163-abc3-a40bfb59d203","type":"any","value":"","key":"id"}]}},"response":[{"id":"d02cd450-6c20-440d-94f7-8c3c9eaffa2a","name":"Buscar motivo","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://meudominio.com.br/api/v1/atendimento/motivo/:id","protocol":"https","host":["meudominio","com","br"],"path":["api","v1","atendimento","motivo",":id"],"variable":[{"key":"id","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": \"success\",\n\t\"code\": 200,\n\t\"data\": {\n\t\t\"_id\": \"65849b48ae1d33ee2c1cea94\",\n\t\t\"motivo\": \"Teste API\",\n\t\t\"departamentos\": [\n\t\t\t\"65849b33ae1d33ee2c1cea8d\"\n\t\t]\n\t}\n}"}],"_postman_id":"4feb4dc4-7706-4612-96aa-7c5546eb0869"}],"id":"ef8317be-5705-4ef7-adda-442a37d4263a","_postman_id":"ef8317be-5705-4ef7-adda-442a37d4263a","description":""},{"name":"Períodos","item":[{"name":"Listar períodos","id":"02edf04e-7bf2-4e80-a6d0-867a11d669d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"filter\": {\n\t\t\"segunda\": true,\n\t\t\"terca\": true,\n\t\t\"quarta\": true,\n\t\t\"quinta\": true,\n\t\t\"sexta\": true,\n\t\t\"sabado\": true,\n\t\t\"domingo\": false,\n\t\t\"feriado\": false,\n\t\t\"nome\": \"Comercial\",\n\t\t\"horaInicio\": \"1970-01-01T08:00:00.000Z\",\n\t\t\"horaFim\": \"1970-01-01T22:00:00.000Z\"\n\t},\n\t\"options\": {\n\t\t\"limit\": 100\n\t}\n}\n}","options":{"raw":{"language":"json"}}},"url":"https://meudominio.com.br/api/v1/atendimento/periodo","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Endpoint responsável pela listagem dos períodos de atendimento. Para montar seus filtros use o body. Caso nenhum filtro seja passado o resultado trará todos os períodos.
\nAlém dos filtros você pode definir opções.
\nFiltros disponiveis
\n\n\n\n
nomedepartamentoativoperiodos.nomeperiodos.nome periodos.horaInicio periodos.horaFim periodos.segunda periodos.terca periodos.quarta periodos.quinta periodos.sexta periodos.sabado periodos.domingo periodos.feriado
Opções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","atendimento","periodo"],"host":["meudominio","com","br"],"query":[],"variable":[]}},"response":[{"id":"ff9b5d1e-267c-404e-beb0-dd04dc8dadc6","name":"Listar períodos","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/atendimento/periodo"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": \"success\",\n\t\"code\": 200,\n\t\"data\": [\n\t\t{\n\t\t\t\"_id\": \"5fd0dc3f29ed4439abb789d3\",\n\t\t\t\"nome\": \"Comercial\",\n\t\t\t\"ativo\": true,\n\t\t\t\"periodos\": [\n\t\t\t\t{\n\t\t\t\t\t\"_id\": \"5fd0dc5929ed4439abb789d4\",\n\t\t\t\t\t\"segunda\": true,\n\t\t\t\t\t\"terca\": true,\n\t\t\t\t\t\"quarta\": true,\n\t\t\t\t\t\"quinta\": true,\n\t\t\t\t\t\"sexta\": true,\n\t\t\t\t\t\"sabado\": true,\n\t\t\t\t\t\"domingo\": false,\n\t\t\t\t\t\"feriado\": false,\n\t\t\t\t\t\"nome\": \"Manhã\",\n\t\t\t\t\t\"horaInicio\": \"1970-01-01T08:00:00.000Z\",\n\t\t\t\t\t\"horaFim\": \"1970-01-01T12:00:00.000Z\"\n\t\t\t\t}\n\t\t\t]\n\t\t}\n\t]\n}"}],"_postman_id":"02edf04e-7bf2-4e80-a6d0-867a11d669d9"},{"name":"Buscar período","id":"5c1cc1ba-0300-4dfd-95f3-85c354af8792","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://meudominio.com.br/api/v1/atendimento/periodo/:id","description":"\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir
Endpoint responsável pela listagem de um período de atendimento.
\nAlém dos filtros você pode definir opções.
\nOpções disponíves
\n\n\n","urlObject":{"protocol":"https","path":["api","v1","atendimento","periodo",":id"],"host":["meudominio","com","br"],"query":[],"variable":[{"id":"6632e179-98b7-4c31-959f-94bf249522d4","type":"any","value":"","key":"id"}]}},"response":[{"id":"bba5c5a9-974c-4f56-a279-f8b8a757a0b6","name":"Buscar período","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer MEUTOKEN","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://meudominio.com.br/api/v1/atendimento/periodo/:id","protocol":"https","host":["meudominio","com","br"],"path":["api","v1","atendimento","periodo",":id"],"variable":[{"key":"id","value":""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","name":"Content-Type","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"status\": \"success\",\n\t\"code\": 200,\n\t\"data\": {\n\t\t\"_id\": \"5fd0dc3f29ed4439abb789d3\",\n\t\t\"nome\": \"Comercial\",\n\t\t\"ativo\": true,\n\t\t\"periodos\": [\n\t\t\t{\n\t\t\t\t\"_id\": \"5fd0dc5929ed4439abb789d4\",\n\t\t\t\t\"segunda\": true,\n\t\t\t\t\"terca\": true,\n\t\t\t\t\"quarta\": true,\n\t\t\t\t\"quinta\": true,\n\t\t\t\t\"sexta\": true,\n\t\t\t\t\"sabado\": true,\n\t\t\t\t\"domingo\": false,\n\t\t\t\t\"feriado\": false,\n\t\t\t\t\"nome\": \"Manhã\",\n\t\t\t\t\"horaInicio\": \"1970-01-01T08:00:00.000Z\",\n\t\t\t\t\"horaFim\": \"1970-01-01T12:00:00.000Z\"\n\t\t\t}\n\t\t]\n\t}\n}"}],"_postman_id":"5c1cc1ba-0300-4dfd-95f3-85c354af8792"}],"id":"a48b8719-aaef-4bd5-bd14-57fd9518ceb5","_postman_id":"a48b8719-aaef-4bd5-bd14-57fd9518ceb5","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"2e693e01-5164-45ab-824c-f34ba3f68815"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"df18aab5-dafe-4d80-a1ac-9138a303c3d8"}}]}\n
skip: quantidade de registros que deseja \"pular\" (paginação)limit: limite máximo de registros para exibir