{"_id":"@adroste/3cx-api","_rev":"5-154db5a6915f182dc4534a8c0e643362","name":"@adroste/3cx-api","dist-tags":{"latest":"0.36.3"},"versions":{"0.36.1":{"name":"@adroste/3cx-api","version":"0.36.1","description":"3CX Phone System API - Updated","main":"dist/index.js","typings":"dist/index.d.ts","scripts":{"create-index":"cti lib --withoutbackup","lint":"tslint --project tsconfig.json","build":"tsc"},"author":{"name":"Alexander Droste"},"contributors":[{"name":"Nikolai Orekhov"}],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/adroste/3cx-api.git"},"devDependencies":{"create-ts-index":"^1.13.7","tslint":"^6.1.3","typescript":"^4.5.3"},"dependencies":{"axios":"^0.24.0"},"bugs":{"url":"https://github.com/adroste/3cx-api/issues"},"homepage":"https://github.com/adroste/3cx-api","engines":{"node":">= 15.0.0","npm":">= 8.0.0"},"gitHead":"fea9af260f6c0e10b12bf7b5bc9b96ca727584d2","_id":"@adroste/3cx-api@0.36.1","_nodeVersion":"16.13.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-XeWDYtwVJw8QcCgEOD0xADOtEWIY+JT2PPfPcbY6LzNY7bWXn173enNLSifw4O3S+oE+BvVBf2+E7quC2d+/fA==","shasum":"b2c273dd367dc090907427f6b1db21a90ffc6d30","tarball":"https://registry.npmjs.org/@adroste/3cx-api/-/3cx-api-0.36.1.tgz","fileCount":214,"unpackedSize":117535,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhviZpCRA9TVsSAnZWagAANjkP/AmKMSqFnh/04gER+LGI\nFeV6I7xvGUatI/Hteyd4fi1VeVoRh2aafAKtzfROCfbJb1Ws5LUNLOf4d/PO\nERAJGKdwNVis6kCYyqwPJ7wXvL8BTyHnH0mwj6ZFPwHpMsYfCv7vLLiHafBg\n5/lkKMEv9dUgL2ibuUJ+siqKZy2mmZAiaYpF2z5yBAghf3gF5l+Y6ZgVQbg4\nISvhwSGhkCcz3Gbw4Higrc930VZYLDZEuJr0bIkmDZtyl6B7mDDDeTr0yQQ/\nN/xv6lWI3a6fVs176wEIkNFyAu7RomIwoyQe/gA1iIrnUUt30Bngww+euhqD\nGkB8G6ZabjIQueJMElXQioV+isNBdLNM9vtt0vORHVD2qjVYdKb9+oujf3rs\nwpBJDLOOOWeQ9wj7nQH08lbAlmBhM+mLDrfD2g9hZhREqcu0bSjo9uEplrJ0\nJF/HgDn88UDexyPc3J2Y5fIt1TAGj5R86fFRABiUdFocXLDFqkWgrWaeCet2\nuk8SjKREy0wsKju3qLqjlXk3Dj8nNZA4qE/20Va2n9KHWI88ZujWxB5t8bPz\nYpsD9EexNzo2cjmPU3NyLuc4FErTekXGumkqflLlLOG8VaiT8rZxtwxy+6y5\nLMvvPPssUFak+cL/AmKxPZBxOPmnyCP1/le1paKga3fa/D20ntQMd0eo66qq\nkDvZ\r\n=53Sa\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAVk61LFRbL62y+4y07yOubzCiO98I+a9a3RhIhxAY2NAiEA/2WiSnq52E0Vw8/zMWA8k7059ALmShe4Qwf9yRcqAGA="}]},"_npmUser":{"name":"adroste","email":"dev@adroste.com"},"directories":{},"maintainers":[{"name":"adroste","email":"dev@adroste.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/3cx-api_0.36.1_1639851625186_0.2959393206774672"},"_hasShrinkwrap":false},"0.36.2-dev.1":{"name":"@adroste/3cx-api","version":"0.36.2-dev.1","description":"3CX Phone System API - Updated","main":"dist/index.js","typings":"dist/index.d.ts","scripts":{"create-index":"cti lib --withoutbackup","lint":"tslint --project tsconfig.json","build":"tsc","build:watch":"tsc -w"},"author":{"name":"Alexander Droste"},"contributors":[{"name":"Nikolai Orekhov"}],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/adroste/3cx-api.git"},"devDependencies":{"@types/tough-cookie":"^4.0.1","create-ts-index":"^1.13.7","tslint":"^6.1.3","typescript":"^4.5.3"},"dependencies":{"axios":"^0.24.0","axios-cookiejar-support":"^2.0.3","tough-cookie":"^4.0.0"},"bugs":{"url":"https://github.com/adroste/3cx-api/issues"},"homepage":"https://github.com/adroste/3cx-api","engines":{"node":">= 15.0.0","npm":">= 8.0.0"},"gitHead":"af7cb1defa95e0dd49613a9368176239567dfcd3","_id":"@adroste/3cx-api@0.36.2-dev.1","_nodeVersion":"16.13.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-EH9QTo0ckVftjgYoM6DF7reVETNPYhcm7E5z7diEZ6KVeKKhnknjS0z6Wr2W5N7jIfcSV2SGbPp+foL9m3Uh9g==","shasum":"3353e73bf4e5a41955ad3b40c424c792d74a7db9","tarball":"https://registry.npmjs.org/@adroste/3cx-api/-/3cx-api-0.36.2-dev.1.tgz","fileCount":214,"unpackedSize":117972,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhx37CCRA9TVsSAnZWagAAmOwP/1xH/cpUHsEda5XjtVQW\nu0e4OmTLrBcF9D7p6jeUWeOswoPxOpqWOwOLdcN3ZyFUhkSALpSjm7YZKKqw\nxFTEZq24kqamdSk/LaWkdXIy5KYN6l9eHK/cF3yPiGYApqpzA63gE5CbStgn\nDN4w2P2TeCnmwqbNzPziF7/K2yww4acIh8ysstlWtuufKgpAvVwtEssVZFcW\nwae899jbA2kpWlo0xWdUe3JHLIpDiSm0INo3PHbGz0vnE/hBw3hh9jQgd6um\n6ThFoO05RUExGVF8OIjXrx6bt4jVXgtsaNLYAimRrbYBOIMCQ0WZZ9VGFbdw\nQQO3kvKJDDdzDanBR14pk8Vw6hhWdwxMJd0W3RKdUNa1BFGO8P5flPGPtinT\nErxhFRcw1VSEOxZeeIA6/uTSIFgUL04f9w2CLtqs+Vm/l553GWXlRof2+Sj9\nIFBCsYN3Fs3lK+QpvRSLzVAHksq9d4bOfeTM9h6u/+6msIenDCLzrvE2WtfS\nSyIedePASBpJgwE7gyzSpyzVXWuisYORgn0ANq17jVyuLQEBLDC1zLj1yBIa\n/PP5GrHrkFLXd315lHLrJNVMDtHkY4qdulre1OjNw9MqqhqQT87Rclpxme92\n8O2jl7QlDcp2UjBKPFr2FsMXt0vbSpPM9X+g84/NoHWPlIYzb24f8V4ZzJnc\nUmx8\r\n=1Rdv\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFZJzlnyp/TNj5EoNSuqztARjXoyzbFfvThIYN4F6P7eAiBotr9S8P5mZsVjuJtDyhuJxdm54pLN5s1bfxHOi/jIDw=="}]},"_npmUser":{"name":"adroste","email":"dev@adroste.com"},"directories":{},"maintainers":[{"name":"adroste","email":"dev@adroste.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/3cx-api_0.36.2-dev.1_1640464066047_0.005390277291626777"},"_hasShrinkwrap":false},"0.36.2-dev.2":{"name":"@adroste/3cx-api","version":"0.36.2-dev.2","description":"3CX Phone System API - Updated","main":"dist/index.js","typings":"dist/index.d.ts","scripts":{"create-index":"cti lib --withoutbackup","lint":"tslint --project tsconfig.json","build":"tsc","build:watch":"tsc -w"},"author":{"name":"Alexander Droste"},"contributors":[{"name":"Nikolai Orekhov"}],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/adroste/3cx-api.git"},"devDependencies":{"@types/tough-cookie":"^4.0.1","create-ts-index":"^1.13.7","tslint":"^6.1.3","typescript":"^4.5.3"},"dependencies":{"axios":"^0.24.0","axios-cookiejar-support":"^2.0.3","tough-cookie":"^4.0.0"},"bugs":{"url":"https://github.com/adroste/3cx-api/issues"},"homepage":"https://github.com/adroste/3cx-api","engines":{"node":">= 15.0.0","npm":">= 8.0.0"},"gitHead":"079ab999ad0470b2f8f95b31986cc2511906fff5","_id":"@adroste/3cx-api@0.36.2-dev.2","_nodeVersion":"16.13.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-LE9bmpfCJREbw6otTzaMFuJE7Np1g2ezGWQSUdnh9xoPyKcKp3qg0vpd5arZgvdhcLBRWOrIGdyfYkJYoaeyUQ==","shasum":"5aa165c864186bc0d778a59d090624a6053319e2","tarball":"https://registry.npmjs.org/@adroste/3cx-api/-/3cx-api-0.36.2-dev.2.tgz","fileCount":216,"unpackedSize":121946,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhzHqvCRA9TVsSAnZWagAAgWkP/0S7fbqQaSC1SqQuMgw5\ngHRyoqGlsi3JS5UQKyNuMxZx9JeUH+1Lpf+yOOnVTE6TyC8zUWAxecWxuG9K\nMk3MZ+AfvAR13Q5rnTCu/O/o2qZE1HgJAfV2EdFkZPeOwC/yVmSaF6wvgnSw\nRm7Zeq5zzZUjvDi2emf5FYtTsAKyyy7LTKO9oJ1KFog4q/IwUXGPv/CGao3L\nZIgNje6K/s/Zy702sUSjyfZC/9nS+XwVQ7+nRScw17zx57oXK4idKvE9TTYS\n3S7sY+KCmcZrWRYkAdhROD1y+ceCPkAYwAiMYC4d4pyXIC91DSePuU2id9F5\ntx1ZR0hi+u1bh92x+0+ACd97P9xSbjtKi+4iyA4Mu/rA+LddTTv/h0cjBYOE\nQUFmSRaDKHCZkMH92m2BKeqK62uUdIRNKjXDxNYGYdnBY3aasSqarLIpQ5hE\ntdN5yigvFzMaSrpRnANiqT8idtHrhSM2Ln3+Q2EbtjoWZzC7tJwgdDlzQTJ1\nsV6xe7lw+ZE5MqZU4PU3fpHjUHZ7RMRbMLkNdk19XFiwj+/MrQc7qcsQhkJI\nK8XIpl/jM8bV5y0cxFRMGcbQgKzchbHXKTCgMOXXVLNqmgUDdn/GuStiyLqv\nn4r4k24k1U6tvWDOkcPQOF5OzErxdZJmfT4xXG3ZVFo5q52rT22uKu7NYRlJ\n4d1w\r\n=aOk4\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCDeFJdU29vS18uaDBBU6Y7QgauXYykeDGkeVqMSAKswQIhAItdumLvHF9JPjwNzgRw+27ZnPPAoyszKDgeFOBEKcqo"}]},"_npmUser":{"name":"adroste","email":"dev@adroste.com"},"directories":{},"maintainers":[{"name":"adroste","email":"dev@adroste.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/3cx-api_0.36.2-dev.2_1640790703210_0.060296627571692296"},"_hasShrinkwrap":false},"0.36.2":{"name":"@adroste/3cx-api","version":"0.36.2","description":"3CX Phone System API - Updated","main":"dist/index.js","typings":"dist/index.d.ts","scripts":{"create-index":"cti lib --withoutbackup","lint":"tslint --project tsconfig.json","build":"tsc","build:watch":"tsc -w"},"author":{"name":"Alexander Droste"},"contributors":[{"name":"Nikolai Orekhov"}],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/adroste/3cx-api.git"},"devDependencies":{"@types/tough-cookie":"^4.0.1","create-ts-index":"^1.13.7","tslint":"^6.1.3","typescript":"^4.5.3"},"dependencies":{"axios":"^0.24.0","axios-cookiejar-support":"^2.0.3","tough-cookie":"^4.0.0"},"bugs":{"url":"https://github.com/adroste/3cx-api/issues"},"homepage":"https://github.com/adroste/3cx-api","engines":{"node":">= 15.0.0","npm":">= 8.0.0"},"gitHead":"d1148a27ebd3d9a670ce1bb50a9603584787c596","_id":"@adroste/3cx-api@0.36.2","_nodeVersion":"16.13.0","_npmVersion":"8.1.0","dist":{"integrity":"sha512-egabOh0q30Rm6pwmgDq37Lnpjrl6F/IAXg0muLqy0r3tlYJjfFcw/k69tXStv+YziZV8wIP4NY3WiE3rOFD3wg==","shasum":"b8a019eab836485d6c32cc20790680a6c9e45530","tarball":"https://registry.npmjs.org/@adroste/3cx-api/-/3cx-api-0.36.2.tgz","fileCount":216,"unpackedSize":121940,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh1bt6CRA9TVsSAnZWagAAU4EP/RPusGdwLZxw9rFfP+jQ\nf6IUXOIZmaQL05FYodOSzlMdOENcn7qXvnrsiZbQxYb95cjReXbzQ/rzyh54\nhxoUrpX2hBrQ1k2sIYBPWNXBAJv4qeaYiSs8+fur7HLFKeAR5LsWMuHbEAb+\nqFwC5aG19FFLq1yEZKldtXFXhzNmp0dQp64Pn8Ob8yKGJ97StYzh7iahqmPK\nNCmVEkYhGTDQqWCwBPOlkswDN5yDTDVQK0Tlent06dncPGGNxDYd5EVoBssM\noCwYFFHHVzvlUdK+iItiyeRyECp9SPWwIYvP4AAH487jfA9xx+r9Tq+D8efv\nxFiF6W4i72noXKWZvfXLSRkKVStEYsWNLShphVjP4BDXETi6OhNlppLRDBBY\nET2qsoQ1KNaMuY5leZJxVDxwfONRw2mUn1ykplH/2e1K0+fQ9GrE2i4+iLxm\nYeOMhgWHF5cqoMJVak+i/E7i0Hy+q19+fs9zJSWgt9xCVCzkSC1N7/53dICj\neZcZ1Ut+joecdzT+J3qUxZnCEzyaAizv9DMoe0xaio0JGKhBl2CqYoM3aZ0c\nrXYZbC1SfMhk3L7Nik2YrrP26QKDN0znZZmJlvrFIWqLjCJMiTN7CSQlyDcZ\nIqZR2StOngUEEyMGmTUntgwlqOA1Ubvq8KYZIlkqUQsJ19V9GXqf8pahksi8\neyz+\r\n=G8Fo\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD1cHDwu6IMEOKZtJH2zrjY7q6k0v7meNEDPCCLWYRnaQIgO6KGDV6vASM38aJ7M0fraVTEAzk7uqSndsiv3MFvblI="}]},"_npmUser":{"name":"adroste","email":"dev@adroste.com"},"directories":{},"maintainers":[{"name":"adroste","email":"dev@adroste.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/3cx-api_0.36.2_1641397113879_0.7280417461283073"},"_hasShrinkwrap":false},"0.36.3":{"name":"@adroste/3cx-api","version":"0.36.3","description":"3CX Phone System API - Updated","main":"dist/index.js","typings":"dist/index.d.ts","scripts":{"create-index":"cti lib --withoutbackup","lint":"tslint --project tsconfig.json","build":"tsc","build:watch":"tsc -w"},"author":{"name":"Alexander Droste"},"contributors":[{"name":"Nikolai Orekhov"}],"license":"MIT","repository":{"type":"git","url":"git+https://github.com/adroste/3cx-api.git"},"devDependencies":{"@types/tough-cookie":"^4.0.1","create-ts-index":"^1.13.7","tslint":"^6.1.3","typescript":"^4.5.3"},"dependencies":{"axios":"^0.24.0","axios-cookiejar-support":"^2.0.3","tough-cookie":"^4.0.0"},"bugs":{"url":"https://github.com/adroste/3cx-api/issues"},"homepage":"https://github.com/adroste/3cx-api","engines":{"node":">= 15.0.0","npm":">= 8.0.0"},"gitHead":"036bd04fa79613591559cc22bbb78c8e4d003e2f","_id":"@adroste/3cx-api@0.36.3","_nodeVersion":"18.16.1","_npmVersion":"9.5.1","dist":{"integrity":"sha512-lS8UWPr4txOiZ4u94bZkmvRjSJvhsaRcBXL5TKE7J41ShujLNu5zU8ueOqOgS/wYE5SGM8YnluQ8Jmx985ovtQ==","shasum":"62f42dc46ed58e3da83c40e9c5a5065b284f734f","tarball":"https://registry.npmjs.org/@adroste/3cx-api/-/3cx-api-0.36.3.tgz","fileCount":216,"unpackedSize":121940,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDSMygb4ohR1C663hNc9P8ySfqIpokaW8GiQ2Es+18fzAiBOoX2POA7/BudpaTx6TYH3B3MUEsVWPcDlBHYeBg+k2w=="}]},"_npmUser":{"name":"adroste","email":"dev@adroste.com"},"directories":{},"maintainers":[{"name":"adroste","email":"dev@adroste.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/3cx-api_0.36.3_1698769292994_0.7586894871305248"},"_hasShrinkwrap":false}},"time":{"created":"2021-12-18T18:20:25.128Z","0.36.1":"2021-12-18T18:20:25.387Z","modified":"2023-10-31T16:21:33.411Z","0.36.2-dev.1":"2021-12-25T20:27:46.204Z","0.36.2-dev.2":"2021-12-29T15:11:43.379Z","0.36.2":"2022-01-05T15:38:34.261Z","0.36.3":"2023-10-31T16:21:33.228Z"},"maintainers":[{"name":"adroste","email":"dev@adroste.com"}],"description":"3CX Phone System API - Updated","homepage":"https://github.com/adroste/3cx-api","repository":{"type":"git","url":"git+https://github.com/adroste/3cx-api.git"},"contributors":[{"name":"Nikolai Orekhov"}],"author":{"name":"Alexander Droste"},"bugs":{"url":"https://github.com/adroste/3cx-api/issues"},"license":"MIT","readme":"# REST-API for 3CX\n\nThis is a fork of the last publicly available 3CX Phone API (see: https://www.npmjs.com/package/@3cx/api).\nAs long as we are waiting for a new public API this is all we got.\nAs I'm working on small side projects  that rely on this api I'll try to maintain it a bit (update dependencies, add missing APIs etc.)\n\nI will accept pull requests that for instance\n* add missing APIs,\n* remove unsupported APIs,\n* fix stuff,\n* introduce handy utils etc.\n\n\n# Related projects\n\n* https://github.com/adroste/3cx-tools\n\n\n# Other APIs for 3CX\n\n* Call Control API \n  * official .NET library for 3CX. Still available, but no longer supported. Documentation was unpublished recently. \n  * e.g. https://github.com/Montesuma80/3cx-web-API : dotnet core based server application to control calls (make calls, drop calls, transfer etc.)\n* MyPhone API (`/MyPhone/MPWebService.asmx`)\n  * Lot of useful endpoints but it uses an undocumented binary format\n  * used by the official webclient\n\n\n# Getting started\n\nInstallation:\n    \n```bash\n# npm\nnpm install --save @adroste/3cx-api\n\n# yarn\nyarn add @adroste/3cx-api\n```\n\n  \n# Usage\n\n```ts\nimport { createClient, ConsoleClient } from '@adroste/3cx-api';\n\nasync function main(){\n    const http = await createClient('http://my-3cx-instance:5000', { Username: 'Admin', Password: '############' });\n    const api = new ConsoleClient(http);\n\n    console.log(await api.getSystemStatus());\n}\n\nmain();\n```\n\n# Docs\n\nUnfortunately, there are no docs available at this moment.\nHowever, the code is very simple. \nI'll suggest you start by looking at the `lib/console-client.ts` as well as `lib/dashboard/dashboard-func.ts`. The majority of available endpoints is implemented those two files.\n\n## Hints\n\n* **DN Properties:** To list/manage DN properties in the Web-Interface go to *Settings -> Paramters* and set `DEVELOPMENT_DNTABLE_EXPOSE` to `1`. Refresh the page and you should see the DN properties tab.","readmeFilename":"README.md"}