Route a Phone number to an Agent

PATCH /v1/phone-numbers/{phone_number_id}

Replaces the routing at the revision If-Match names and writes the Audit event phone_number.update with the Agent and the pinned version before and after, never the number (1.22.0, FR-telephony-2). A Phone number or an Agent of another Organization answers 404 not_found, so an Organization can never route a number it does not hold; an archived Agent, or a pinned version that is not published, answers 409 agent_version_unavailable. The api refuses the route to a test key with 403 forbidden, because a Phone number carries live Calls only. A Call in progress keeps its version; the next inbound Call runs the new routing.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the telephony:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X PATCH "$VOCAL_API/v1/phone-numbers/pn_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"' \
  -H "Content-Type: application/json" \
  -d '{ "agent_id": "agt_..." }'

const response = await fetch(`${process.env.VOCAL_API}/v1/phone-numbers/pn_...`, {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "agent_id": "agt_..."
  }),
});
console.log(response.status, await response.text());

import os

import requests

response = requests.patch(
    f"{os.environ['VOCAL_API']}/v1/phone-numbers/pn_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
    json={
        "agent_id": "agt_...",
    },
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: PhoneNumberUpdateRequest.

Responses

Fields of the 200 answer

The shape is PhoneNumber.