Rent and configure your virtual number using Node.js

After searching for a number, rent and configure that number for SMS, Voice or both.

Note:

Before you can get started, you need the following already set up:

All Numbers API prerequisite steps.
Node.js and a familiarity with how to create a new app.
Your Node.js application for use with the Numbers API.
A virtual number you have confirmed to be available.

Learn how to quickly configure SMS for your number in a Node.js application with the Sinch Numbers API.

Rent and configure your virtual number

Fill in your parameters

Paste the Rent and configure a virtual number code in place of the search for a virtual number code in the index.js file.
Replace following parameter values on your index.js file:

Parameter	Your value
`YOUR_username`	your `client_id` or `key_id` found in the Sinch Customer Dashboard.
`YOUR_password`	Your `client_secret` or `key_secret`. This is generated upon new key creation in the Customer Dashboard. Generate a new key if you have lost your secret key.
`YOUR_servicePlanId`	Your SMS service plan IDThis is only required for SMS configuration.
`YOUR_10DLC_campaignId`	Your 10DLC campaign ID for this campaign. Found on the TCR platform. Remove this parameter entirely for non-10DLC numbers.
`YOUR_appId`	The Voice app ID or voice API `key`. Found in the Customer Dashboard. This is only required for Voice configuration.
`YOUR_ProjectID`	The project ID found in the Customer Dashboard.
`YOUR_PhoneNumber`	The virtual phone number that you previously searched for and would like to rent.

Then, save the file.

Run the file

Run the following command:

Copy

Copied

node index.js

Response

You should get a response similar to this one:

Copy

Copied

{
  "phoneNumber": "+12025550134",
  "projectId": "51bc3f40-f266-4ca8-8938-a1ed0ff32b9a",
  "displayName": "string",
  "regionCode": "US",
  "type": "MOBILE",
  "capability": [
    "SMS"
  ],
  "money": {
    "currencyCode": "USD",
    "amount": "2.00"
  },
  "paymentIntervalMonths": 0,
  "nextChargeDate": "2019-08-24T14:15:22Z",
  "expireAt": "2019-08-24T14:15:22Z",
  "smsConfiguration": {
    "servicePlanId": "82b42acf74924bd687ef9fb212f2060c",
    "scheduledProvisioning": {
      "servicePlanId": "82b42acf74924bd687ef9fb212f20611",
      "status": "WAITING",
      "lastUpdatedTime": "2019-08-24T14:15:22Z",
      "campaignId": "string",
      "errorCodes": [
        "INTERNAL_ERROR"
      ]
    },
    "campaignId": "string"
  },
  "voiceConfiguration": {
    "appId": "string",
    "scheduledVoiceProvisioning": {
      "appId": "string",
      "status": "WAITING",
      "lastUpdatedTime": "2019-08-24T14:15:22Z"
    },
    "lastUpdatedTime": "2019-08-24T14:15:22Z"
  }
}

Next steps

Send a message to yourself using the SMS API or the Voice API (after setting each up accordingly) to verify that the configuration was successful.

Additional resources

Explore the API specification to test more endpoints.
Follow the number rental process in the Customer Dashboard UI rather than through this API.