Attach Number to Application

POST

api

Account

{auth_id}

numbers

{number}

application

Attach Number to Application

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/numbers/{number}/application \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "application_id": "<string>"
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/numbers/{number}/application"

payload = { "application_id": "<string>" }
headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<x-auth-id>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({application_id: '<string>'})
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/numbers/{number}/application', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Link a phone number from your account inventory to a voice application. After attaching, all incoming calls to that number are routed through the application’s answer_url and hangup_url webhooks.

This operation lives under the numbers path (lowercase), not under Application: POST /api/v1/Account/{auth_id}/numbers/{number}/application.

Authentication required:

X-Auth-ID - Your account Auth ID
X-Auth-Token - Your account Auth Token
Content-Type: application/json

string

required

Your Vobiz account ID, for example MA_XXXXXXXX.

Path parameters

Field	Type	Required	Description
`auth_id`	string	Yes	Your account Auth ID
`number`	string	Yes	The E.164-formatted phone number, URL-encoded (`+` → `%2B`). Example: `%2B1234567890`

string

required

Your Vobiz account ID. Use the same value in X-Auth-ID.

string

required

The E.164-formatted phone number, URL-encoded (+ → %2B). Example: %2B1234567890.

Body parameters

Field	Type	Required	Description
`application_id`	string	Yes	The `app_id` of the application to attach to this number.

string

required

The app_id of the application to attach 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 attached to application",
  "number": "+919876543210",
  "application": {
    "answer_method": "POST",
    "answer_url": "https://example.com/answer",
    "api_id": "aabbccdd-1234-5678-90ab-cdef12345678",
    "app_id": "12345678901234567",
    "app_name": "Acme Corp",
    "application_type": "XML",
    "created_at": "2026-04-02 12:11:19.740666+00:00",
    "default_app": false,
    "default_endpoint_app": false,
    "enabled": true,
    "fallback_answer_url": null,
    "fallback_method": "POST",
    "hangup_method": "POST",
    "hangup_url": "https://example.com/answer",
    "log_incoming_message": true,
    "message_method": "POST",
    "message_url": null,
    "public_uri": false,
    "resource_uri": "/v1/Account/MA_XXXXXXXX/Application/12345678901234567/",
    "sip_transfer_method": "POST",
    "sip_transfer_url": null,
    "sip_uri": "sip:12345678901234567@app.vobiz.ai",
    "sub_account": null,
    "updated_at": "2026-04-02 12:11:19.740666+00:00"
  }
}

Edge cases

Re-attaching an already-linked number overwrites the previous binding and re-points routing to the new application_id. You do not need to detach first.
Number not in your account or unknown application_id returns a 404. Confirm the number is purchased to your account and the app_id exists with list applications.
URL-encode the number. A raw + in the path will not match; use %2B (for example %2B14155551234).
New numbers created while an application has default_number_app: true are auto-attached to that application, so an explicit attach is only needed to override the default or attach an existing number.

⌘I

Attach Number to Application

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/numbers/{number}/application \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <x-auth-id>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "application_id": "<string>"
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/numbers/{number}/application"

payload = { "application_id": "<string>" }
headers = {
    "X-Auth-ID": "<x-auth-id>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<x-auth-id>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({application_id: '<string>'})
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/numbers/{number}/application', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

​Path parameters

​Body parameters

​Example request

​Response

​Edge cases

Path parameters

Body parameters

Example request

Response

Edge cases