https://github.com/voximplant/apiclient-nodejs
Voximplant Management API node.js client library
https://github.com/voximplant/apiclient-nodejs
management-api voximplant
Last synced: 13 days ago
JSON representation
Voximplant Management API node.js client library
- Host: GitHub
- URL: https://github.com/voximplant/apiclient-nodejs
- Owner: voximplant
- License: apache-2.0
- Created: 2019-06-06T09:58:57.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-21T09:57:17.000Z (about 1 month ago)
- Last Synced: 2025-05-08T22:57:09.236Z (13 days ago)
- Topics: management-api, voximplant
- Language: TypeScript
- Homepage:
- Size: 734 KB
- Stars: 14
- Watchers: 10
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Voximplant API client library
#### Version 4.1.0
## Prerequisites
In order to use Voximplant Node.js SDK, you need the following:
1. A developer account. If you don't have one, [sign up here](https://voximplant.com/sign-up/).
1. A private API key. There are 2 options to obtain it:
1. Generate it in the [Voximplant Control panel](https://manage.voximplant.com/settings/service_accounts)
1. Call the [CreateKey](https://voximplant.com/docs/references/httpapi/managing_role_system#createkey) HTTP API
method with the
specified [authentication parameters](https://voximplant.com/docs/references/httpapi/auth_parameters). You'll
receive a response with the **result** field in it. Save the **result** value in a file (since we don't store the
keys, save it securely on your side).
1. Node.js >= 11
## How to use
Go to your project folder and install the SDK using `npm`:
```bash
npm i --save @voximplant/apiclient-nodejs
```
Then import the SDK in your script
```js
const VoximplantApiClient = require('@voximplant/apiclient-nodejs').default;
```
Next, specify the path to the file with the **result** value either in the constructor or using the environment.
**constructor**:
```js
const client = new VoximplantApiClient('/path/to/credentials.json');
```
**env**:
```bash
export VOXIMPLANT_CREDENTIALS=/path/to/credentials.json
```
## Examples
### Start a scenario
```js
const VoximplantApiClient = require('@voximplant/apiclient-nodejs').default;
const client = new VoximplantApiClient();
client.onReady = function () {
// Start the scripts from the account.
client.Scenarios.startScenarios({ruleId: '1', scriptCustomData: 'mystr'})
.then((ev) => console.log(ev))
.catch((err) => console.error(err));
};
```
### Send an SMS
```js
const VoximplantApiClient = require('@voximplant/apiclient-nodejs').default;
const client = new VoximplantApiClient();
client.onReady = function () {
// Send the SMS message with text "Test message" from the phone number 447443332211 to the phone number 447443332212.
client.SMS.sendSmsMessage({
source: '447443332211',
destination: '447443332212',
smsBody: 'Test message',
})
.then((ev) => console.log(ev))
.catch((err) => console.error(err));
};
```
### Get a call history item
```js
const VoximplantApiClient = require('@voximplant/apiclient-nodejs').default;
const client = new VoximplantApiClient();
client.onReady = function () {
// 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
client.History.getCallHistory({
fromDate: new Date('2012-01-01 00:00:00 GMT'),
toDate: new Date('2014-01-01 00:00:00 GMT'),
count: '1',
timezone: 'Etc/GMT',
})
.then((ev) => console.log(ev))
.catch((err) => console.error(err));
};
```