{"id":27999228,"url":"https://github.com/voximplant/apiclient-nodejs","last_synced_at":"2025-07-15T11:05:34.785Z","repository":{"id":34923058,"uuid":"190559039","full_name":"voximplant/apiclient-nodejs","owner":"voximplant","description":"Voximplant Management API node.js client library","archived":false,"fork":false,"pushed_at":"2025-05-21T08:05:19.000Z","size":756,"stargazers_count":14,"open_issues_count":1,"forks_count":8,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-07-09T13:51:13.574Z","etag":null,"topics":["management-api","voximplant"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voximplant.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-06-06T09:58:57.000Z","updated_at":"2025-05-21T08:05:21.000Z","dependencies_parsed_at":"2024-06-06T14:09:37.353Z","dependency_job_id":"e451e3db-0963-4a68-8b4b-f404412ead81","html_url":"https://github.com/voximplant/apiclient-nodejs","commit_stats":{"total_commits":28,"total_committers":4,"mean_commits":7.0,"dds":0.3928571428571429,"last_synced_commit":"9b9c1b451d2764b17a41a8cd197c92da092c37a3"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/voximplant/apiclient-nodejs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voximplant%2Fapiclient-nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voximplant%2Fapiclient-nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voximplant%2Fapiclient-nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voximplant%2Fapiclient-nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voximplant","download_url":"https://codeload.github.com/voximplant/apiclient-nodejs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voximplant%2Fapiclient-nodejs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265430372,"owners_count":23763991,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["management-api","voximplant"],"created_at":"2025-05-08T22:57:20.956Z","updated_at":"2025-07-15T11:05:34.770Z","avatar_url":"https://github.com/voximplant.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Voximplant API client library\n\n#### Version 4.2.0\n\n## Prerequisites\n\nIn order to use Voximplant Node.js SDK, you need the following:\n\n1. A developer account. If you don't have one, [sign up here](https://voximplant.com/sign-up/).\n1. A private API key. There are 2 options to obtain it:\n    1. Generate it in the [Voximplant Control panel](https://manage.voximplant.com/settings/service_accounts)\n    1. Call the [CreateKey](https://voximplant.com/docs/references/httpapi/managing_role_system#createkey) HTTP API\n       method with the\n       specified [authentication parameters](https://voximplant.com/docs/references/httpapi/auth_parameters). You'll\n       receive a response with the **result** field in it. Save the **result** value in a file (since we don't store the\n       keys, save it securely on your side).\n1. Node.js \u003e= 11\n\n## How to use\n\nGo to your project folder and install the SDK using `npm`:\n\n```bash\nnpm i --save @voximplant/apiclient-nodejs\n```\n\nThen import the SDK in your script\n\n```js\nconst VoximplantApiClient = require('@voximplant/apiclient-nodejs').default;\n```\n\nNext, specify the path to the file with the **result** value either in the constructor or using the environment.\n\n**constructor**:\n\n```js\nconst client = new VoximplantApiClient('/path/to/credentials.json');\n```\n\n**env**:\n\n```bash\nexport VOXIMPLANT_CREDENTIALS=/path/to/credentials.json\n```\n\n## Examples\n\n### Start a scenario\n\n```js\nconst VoximplantApiClient = require('@voximplant/apiclient-nodejs').default;\nconst client = new VoximplantApiClient();\nclient.onReady = function () {\n  // Start the scripts from the account.\n  client.Scenarios.startScenarios({ruleId: '1', scriptCustomData: 'mystr'})\n    .then((ev) =\u003e console.log(ev))\n    .catch((err) =\u003e console.error(err));\n};\n```\n\n### Send an SMS\n\n```js\nconst VoximplantApiClient = require('@voximplant/apiclient-nodejs').default;\nconst client = new VoximplantApiClient();\nclient.onReady = function () {\n  // Send the SMS message with text \"Test message\" from the phone number 447443332211 to the phone number 447443332212.\n  client.SMS.sendSmsMessage({\n    source: '447443332211',\n    destination: '447443332212',\n    smsBody: 'Test message',\n  })\n    .then((ev) =\u003e console.log(ev))\n    .catch((err) =\u003e console.error(err));\n};\n```\n\n### Get a call history item\n\n```js\nconst VoximplantApiClient = require('@voximplant/apiclient-nodejs').default;\nconst client = new VoximplantApiClient();\nclient.onReady = function () {\n  // Get the first call session history record from the 2012-01-01 00:00:00 UTC to the 2014-01-01 00:00:00 UTC\n  client.History.getCallHistory({\n    fromDate: new Date('2012-01-01 00:00:00 GMT'),\n    toDate: new Date('2014-01-01 00:00:00 GMT'),\n    count: '1',\n    timezone: 'Etc/GMT',\n  })\n    .then((ev) =\u003e console.log(ev))\n    .catch((err) =\u003e console.error(err));\n};\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoximplant%2Fapiclient-nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoximplant%2Fapiclient-nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoximplant%2Fapiclient-nodejs/lists"}