Server SDK

In addition to being able to use Dispatch via the REST APIs, Vonage also provides Server SDK support. The Server SDK provides a straightforward way to build your Dispatch applications. You can call the Server SDK to carry out tasks such as sending messages from your application.

NOTE: Currently Server SDK support is only available for Node.


During Beta, the Vonage Server SDK for Node containing support for the Dispatch API can be installed using:

$ npm install @vonage/server-sdk@beta

If you already have the Server SDK installed the above command will upgrade your SDK to the latest version.


If you decide to use the Server SDK you will need the following information:

Key Description
VONAGE_API_KEY The API key which you can obtain from your Vonage API Dashboard.
VONAGE_API_SECRET The API secret which you can obtain from your Vonage API Dashboard.
VONAGE_APPLICATION_ID The Application ID for your Vonage API Application which can be obtained from your Vonage API Dashboard.
VONAGE_APPLICATION_PRIVATE_KEY_PATH The path to the private.key file that was generated when you created your application.

These variables can then be replaced with actual values in the Server SDK example code.


See the code snippets section for further examples on how to use the Server SDK.