Vobiz Logo|API Docs
Console ↗

Link Numbers

Manage the association between your phone numbers and voice applications. You can attach a number to an application to handle incoming calls, or detach it to remove the association.

Attach Number to Application

POSThttps://api.vobiz.ai/api/v1/account/{authID}/numbers/{number}/application

Authentication Required:

  • • X-Auth-ID: Your account ID (e.g., {Auth_ID})
  • • X-Auth-Token: Your account Auth Token

Parameters

Request Parameters

NameTypeDescription
numberRequired
stringThe E.164 formatted phone number (URL encoded, e.g., %2B1234567890)
application_idRequired
stringThe ID of the application to link to this number.

Example Request

cURL
curl -X POST "https://api.vobiz.ai/api/v1/account/{Auth_ID}/numbers/%2B1234567890/application" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "application_id": "app_xxxxxxxxxxxx"
  }'

Response

Success Response (200 OK)
{
  "message": "Number linked successfully",
  "number": "+1234567890",
  "application_id": "app_xxxxxxxxxxxx"
}

Detach Number from Application

DELETEhttps://api.vobiz.ai/api/v1/account/{authID}/numbers/{number}/application

Authentication Required:

  • • X-Auth-ID: Your account ID (e.g., {Auth_ID})
  • • X-Auth-Token: Your account Auth Token

Parameters

Request Parameters

NameTypeDescription
numberRequired
stringThe E.164 formatted phone number (URL encoded) to detach from its application.

Example Request

cURL
curl -X DELETE "https://api.vobiz.ai/api/v1/account/{Auth_ID}/numbers/%2B1234567890/application" \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN"

Response

Success Response (200 OK)
{
  "message": "Number detached successfully",
  "number": "+1234567890"
}
List All Applications
Sub-Accounts