Phone numbers

Connect a number to an agent

POSThttps://voxa.abhinavyadav.in/api/v1/numbers/{number}/connect

Routes inbound calls on one of your numbers to an agent. The number moves off any other agent.

Authorization

A signed-in member with the numbers.manage permission (Authorization: Bearer session token). API keys can’t do this.

Authorization: Bearernumbers.manage

Path parameters

numberstringrequired

A phone number in E.164 (+918035000000).

Query parameters

timezonestringdefault: "Asia/Kolkata"

IANA time zone for every timestamp in the response (at, date, timestamp and *_at fields), as ISO 8601 with the offset. The X-Timezone header works too; the zone used comes back in the X-Timezone response header. An unknown zone is a 400.

Body application/json

agent_idstringrequired

The agent that should answer the number.

Response

200Success.

See the 200 example next to the code samples.

401No credentials, or they are invalid or revoked.

detailstring

What went wrong, in plain words.

403Your role (or an API key) lacks the permission.

detailstring

What went wrong, in plain words.

422Validation Error

detailobject[]

Show item attributes

locstring | integer[]

msgstring

typestring

curl --request POST \
  --url 'https://voxa.abhinavyadav.in/api/v1/numbers/{number}/connect?timezone=Asia/Kolkata' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "agent_id": "9b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e"
}'

import requests

url = "https://voxa.abhinavyadav.in/api/v1/numbers/{number}/connect"
params = {
    "timezone": "Asia/Kolkata",
}
headers = {
    "Authorization": "Bearer <token>",
}
payload = {
    "agent_id": "9b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e",
}

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

const response = await fetch("https://voxa.abhinavyadav.in/api/v1/numbers/{number}/connect?timezone=Asia/Kolkata", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "agent_id": "9b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e"
  }),
})
const data = await response.json()
console.log(response.status, data)

Response

{
  "number": "+918035000000",
  "agent_id": "9b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e"
}

{
  "detail": "sign in required"
}

{
  "detail": "your role cannot do this (numbers.manage)"
}

{
  "detail": [
    {
      "type": "missing",
      "loc": [
        "body",
        "name"
      ],
      "msg": "Field required",
      "input": {}
    }
  ]
}