Network API Sandbox
The Network APIs requires CSPs (Communication Service Providers) approval. This process could take more or less time, but developers can only use the APIs once the first approvals arrive.
The Sandbox allows developers to start using the Network APIs while approval of their business profile by the CSPs. The Sandbox uses live data and allows developers to configure up to 5 test numbers, ensuring that tests can only be performed with or from allowlisted numbers.
There are two main steps to use the Sandbox:
Allowlist Phone Numbers
Open the Vonage Network API Sandbox in your dashboard and select the “Network API Sandbox” tab button. Then, click “View Available CSPs” to uncollapse the list of available network partners that can be used in the Sandbox. You can add up to 5 numbers to be allowlisted from one or more available CSPs.
Click on the “Add numbers” button, and for each test phone number, do the following:
- Choose the country code from the available countries
- Input the phone number you'll use for testing
- Check the box to confirm the number will only be used for test purposes
Click "Verify" and the phone number will receive an authentication code via SMS. Enter the code provided to complete the number verification.
Once the verification code is added and verification is successful, the test number will be allowlisted successfully.
Enable the Sandbox in your Application
Once you have allowlisted the phone numbers you want to test, you will need to create an application.
- Click the “Create Application" button or navigate to the Applications section of your dashboard and "Create a new application".
- Generate a public and private key pair for JWT creation during authentication. You'll need this JWT token to generate access tokens.
- Finally, enable the Network APIs capability in your application and select the “Sandbox” access type.
Once the Sandbox is configured and the Network APIs capability is added to your application, you can begin testing Vonage Network APIs.
Virtual CSP
The Sandbox requires at least one working phone number added to the allowlist from a supporting CSP and, in the case of Number Verification, mobile data access to a supported CSP. There may be scenarios where allowlisting a valid phone number is not possible, such as when testing the Network APIs in a country that is not yet supported.
To solve this situation, the Sandbox offers a Virtual CSP that provides predefined and deterministic API responses based on the parameters of the API request.