Rent and configure your virtual number using .NET SDK

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.
.NET 7 SDK or later and a familiarity with how to create a new app.
Your .NET application for use with the Numbers API.
A virtual number you have confirmed to be available.

Rent and configure your virtual number

Open the Program.cs from your Search Available Numbers .NET project.

Paste the Rent and configure a virtual number code in place of the search for a virtual number code in the Program.cs file.

Modify your application

The code provided includes placeholder parameters. You'll need to update the parameters detailed in the following subsections with your values.

Initialize the client

Before initializing a client using this SDK, you'll need three pieces of information:

Your Project ID
An access key ID
An access key Secret

These values can be found on the Access Keys page of the Customer Dashboard. You can also create new access key IDs and Secrets, if required.

Note:

If you have trouble accessing the above link, ensure that you have gained access to the Conversation API by accepting the corresponding terms and conditions.

Fill in remaining parameters

Replace following parameter values on your Program.cs file:

Parameter	Your value
`YOUR_service_plan_id`	Your SMS service plan IDThis is only required for SMS configuration.
`YOUR_app_id`	The Voice app ID or voice API `key`. Found in the Customer Dashboard.
`YOUR_phone_number`	The virtual phone number that you previously searched for and would like to rent.

Save the file.

Build and run your project

Before executing your code, you must first compile your application. Execute the following command:

Copy

Copied

dotnet build

Now you can execute the code. Run the following command:

Copy

Copied

dotnet run

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.