Assign an agent to a DID

PUT

phone-numbers

{id}

curl --request PUT \
  --url https://api.vocobase.com/api/v2/phone-numbers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "inbound_enabled": true
}
'

import requests

url = "https://api.vocobase.com/api/v2/phone-numbers/{id}"

payload = {
    "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "inbound_enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({agent_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890', inbound_enabled: true})
};

fetch('https://api.vocobase.com/api/v2/phone-numbers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vocobase.com/api/v2/phone-numbers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'agent_id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'inbound_enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vocobase.com/api/v2/phone-numbers/{id}"

	payload := strings.NewReader("{\n  \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"inbound_enabled\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.vocobase.com/api/v2/phone-numbers/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"inbound_enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocobase.com/api/v2/phone-numbers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"inbound_enabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "f1a2c3d4-1111-2222-3333-444455556666",
    "phone_number": "+918065480085",
    "provider": "VOBIZ",
    "friendly_name": null,
    "status": "ACTIVE",
    "is_default": false,
    "inbound_enabled": true,
    "agent": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Inbound Test Agent"
    }
  }
}

Authorizations

Authorization

string

header

required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Path Parameters

string<uuid>

required

Phone number ID from GET /phone-numbers.

Body

application/json

agent_id

string<uuid> | null

Agent ID to assign. Use null or an empty string to clear assignment. If inbound_enabled is omitted, the number's current inbound setting is preserved — assigning an agent does not enable inbound routing on its own. Clearing the agent, or setting status to anything other than ACTIVE, always disables inbound routing.

inbound_enabled

boolean

Whether this DID should receive inbound calls for the assigned agent. Set false to keep the row available for outbound caller ID use only.

friendly_name

string | null

Maximum string length: 200

status

enum<string>

Available options:

ACTIVE,

INACTIVE

Response

Phone number updated.

success

boolean

data

object

Imported carrier DID managed through the V2 phone-numbers API.

Show child attributes

Assign an agent to a DID

curl --request PUT \
  --url https://api.vocobase.com/api/v2/phone-numbers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "inbound_enabled": true
}
'

import requests

url = "https://api.vocobase.com/api/v2/phone-numbers/{id}"

payload = {
    "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "inbound_enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({agent_id: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890', inbound_enabled: true})
};

fetch('https://api.vocobase.com/api/v2/phone-numbers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vocobase.com/api/v2/phone-numbers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'agent_id' => 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    'inbound_enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vocobase.com/api/v2/phone-numbers/{id}"

	payload := strings.NewReader("{\n  \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"inbound_enabled\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.vocobase.com/api/v2/phone-numbers/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"inbound_enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vocobase.com/api/v2/phone-numbers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n  \"inbound_enabled\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "id": "f1a2c3d4-1111-2222-3333-444455556666",
    "phone_number": "+918065480085",
    "provider": "VOBIZ",
    "friendly_name": null,
    "status": "ACTIVE",
    "is_default": false,
    "inbound_enabled": true,
    "agent": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Inbound Test Agent"
    }
  }
}

Getting Started

Building Agents

Making Calls

Receiving Calls

After the Call

Telephony Providers

Advanced

API Reference

Endpoints

Assign an agent to a DID

Authorizations

Path Parameters

Body

Response