Before you begin

What are building blocks?

Building blocks are short pieces of code you can reuse in your own applications. The building blocks utilise code from the Nexmo Quickstart  repositories.

Please read this information carefully, so you can best use the building blocks.

Prerequisites

  1. Create a Nexmo account
  2. Rent a Nexmo Number
  3. Install the Nexmo Command Line tools
  4. Create a Nexmo Application using the command line tools or Dashboard
  5. Install the Nexmo Library for your programming language
  6. Set up Ngrok 

Other resources:

Replaceable variables

Generic replaceable

The following replaceable information depends on the library and specific call:

Key Description
NEXMO_API_KEY API key.
NEXMO_API_SECRET API secret.
NEXMO_APPLICATION_PRIVATE_KEY_PATH Private key path.
NEXMO_APPLICATION_PRIVATE_KEY Private key.
NEXMO_APPLICATION_ID The Nexmo Application ID.

Numbers

All phone numbers are in E.164 format.

Key Description
NEXMO_NUMBER Replace with your Nexmo Number. E.g. 447700900000
TO_NUMBER Replace with the number you are calling. E.g. 447700900001
SECOND_NUMBER Replace with number you are forwarding to. E.g. 447700900002

UUIDs

UUIDs are typically used in the building blocks to identify a specific call.

Key Description
UUID Replace with the UUID of the call to modify. For example code use: aaaaaaaa-bbbb-cccc-dddd-0123456789ab.

Specific replaceable/variables

Some building blocks have more specialised variables that will need to be replaced by actual values. These may be specified on a per-building block basis.

Webhooks

The main ones you will meet here are:

If you are using Ngrok you will set your webhook URLs in the Nexmo Application object to something like:

Change demo in the above with whatever applies in your case.