API Setup allows you to connect external applications to net2phone services. From the browser or desktop app, Admin users can manage API keys, configure webhooks, and enable click-to-call for integrated browser calling.

The API Setup page includes three sections:

• API Keys – Authenticate API requests from external systems.
• Webhooks – Receive real-time event data at an external URL.
• Click-to-Call – Initiate outbound calls from another application.

Access API setup

You must have an Admin login to access API Setup in the Settings portal. 

1. From the browser or desktop app, click your profile icon. 
2. Click Admin Settings.
   You will be redirected to a new browser tab. 
3. From the left navigation menu, click API Setup.

Webhooks

Webhooks send “event data”—such as call activity—from net2phone to an external URL. Multiple webhook endpoints can be configured.

Webhooks can be added through the web app or managed programmatically using the API.

Add a webhook

Use the web app to add a webhook endpoint.

1. Select the Webhook tab.
2. Click Add Webhook.
3. Enter the required field descriptions.
4. Save your changes.

Learn more about webhook supported events, payloads, and subscription behaviour, with net2phone's Developer Webhook API documentation.

Click-to-Call

Click-to-Call allows external applications—such as CRMs or helpdesk tools—to initiate outbound calls through net2phone. Simply, click-to-call allows you to select a phone number on your computer and call them directly through your net2phone extension. If your organization has click-to-call configured, Admin users can manage specific keys in this section of the Settings portal. 

API keys

API keys authenticate requests made to the net2phone API. Similar to how click-to-call keys (above) are a type of API key, web developers can use this section to create, rotate, or revoke keys used by external applications.

For security, newly generated API keys are shown only once.

Create a new API key

Use the steps below to generate a new API key from the web app.

1. Open the API Keys tab.
2. Click Create New API Key.
3. Copy the key and store it securely.

Important: If a key is lost or exposed, revoke it and generate a new one.

Developer setup (advanced)

The sections below are intended for developers building custom integrations. Your organization is responsible for implementing and securing API-based workflows.

Definitions

The placeholders below are used in the example API requests that follow.

• INSERT_CLIENT_ID: Developer Client ID provided by net2phone
• INSERT_ACCESS_TOKEN: Access token returned by the token request
• INSERT_REFRESH_TOKEN: Refresh token returned by the token request
• INSERT_EMAIL_ADDRESS: User email address for authentication
• INSERT_PASSWORD: Password for the authenticated user
• INSERT_USER_ID: User ID returned by the token request
• INSERT_URL: Webhook destination URL
• INSERT_DIALED_NUMBER:
  • USA/Canada: 1 + phone number (example: 19735551212)
  • International: 011 + country code + phone number (example: 011556155555555)

Get token (first time)

Use this request to obtain an access token and a refresh token.

curl --location --request POST 'https://integrate.versature.com/api/oauth/token/' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{"client_id":"INSERT_CLIENT_ID","grant_type":"password","username":"INSERT_EMAIL_ADDRESS","password":"INSERT_PASSWORD"}'

Refresh token

Access tokens expire and must be refreshed periodically.

curl --location --request POST 'https://integrate.versature.com/api/oauth/token/' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{"client_id":"INSERT_CLIENT_ID","grant_type":"refresh_token","refresh_token":"INSERT_REFRESH_TOKEN"}'

Place a call (Click-to-Call)

Once authenticated, use the Click-to-Call endpoint to initiate an outbound call.

curl --location --request POST 'https://integrate.versature.com/api/calls/' \
--header 'Accept: application/vnd.integrate.v1.8.0+json' \
--header 'Authorization: Bearer INSERT_ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{ "to": "INSERT_DIALED_NUMBER" }'

Create a webhook subscription

Use this request to subscribe to call event notifications programmatically. Webhook subscriptions may include expiration settings and require renewal.

curl -X POST 'https://integrate.versature.com/api/subscriptions/' \
-H 'Accept: application/vnd.integrate.v1.8.0+json' \
-H 'Authorization: Bearer INSERT_ACCESS_TOKEN' \
-H 'Content-Type: application/json; charset=utf-8' \
-d '{ "user": "INSERT_USER_ID", "post_uri": "INSERT_URL", "expires_in": "6000", "calls": true }'

Get DIDs assigned to the current user

This request returns the phone numbers assigned to the authenticated user.

curl --location --request GET 'https://integrate.versature.com/api/devices/users/current/' \
--header 'Content-Type: application/json' \
--header 'Accept: application/vnd.integrate.v1.8.0+json' \
--header 'Authorization: Bearer INSERT_TOKEN'

Security best practices

• Store API keys and tokens securely.
• Rotate credentials regularly and revoke unused keys.
• Restrict webhook endpoints to trusted sources.
• Use HTTPS for all webhook endpoints.