POST

Assign Phone Number to Agent

Routes an owned phone number to this Agent.

POSThttps://api.vantaxai.com/v1/agents/{agent_id}/phone-numbers

Once assigned, inbound calls and messages to the number are handled by the Agent. A number can be assigned to only one Agent at a time.

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…
Content-Typestringrequired
Must be application/json for requests with a body.
example: application/json

Path Parameters

agent_idstringrequired
The Agent to assign the number to.
example: agt_3d9b21

Body Parameters

phone_number_idstringrequired
The owned phone number to assign.
example: pn_55ad12

Request

curl -X POST https://api.vantaxai.com/v1/agents/agt_3d9b21/phone-numbers \
  -H "Authorization: Bearer vx_live_3fa9c2..." \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number_id": "pn_55ad12"
}'

const res = await fetch(
  "https://api.vantaxai.com/v1/agents/agt_3d9b21/phone-numbers",
  {
  method: "POST",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "phone_number_id": "pn_55ad12"
  }),
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// POST /v1/agents/{agent_id}/phone-numbers
const result = await vantax.request("POST", "/v1/agents/{agent_id}/phone-numbers", {
  "phone_number_id": "pn_55ad12"
});

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# POST /v1/agents/{agent_id}/phone-numbers
result = vantax.request("POST", "/v1/agents/{agent_id}/phone-numbers", json={"phone_number_id": "pn_55ad12"})

Response

{
  "success": true,
  "message": "Phone number assigned",
  "data": {
    "id": "pn_55ad12",
    "number": "+14155550142",
    "agent_id": "agt_3d9b21",
    "source": "platform"
  }
}

{
  "success": false,
  "message": "Phone number is already assigned to another Agent"
}