Saltar al contenido principal
PATCH
/
v1
/
phone
/
{phone_id}
Change Phone Agent
import requests

url = "http://localhost:3000/v1/phone/{phone_id}"

payload = {
    "nickname": "<string>",
    "inbound_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outbound_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_date": "2023-11-07T05:31:56Z",
  "number": "<string>",
  "inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inbound_agent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "outbound_agent_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "nickname": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
phone_id
string<uuid>
required

Body

application/json
​
nickname
string | null

The nickname given to the phone number

​
inbound_version_id
string<uuid> | null

The unique identifier for the agent that will receive the call when this phone receives an inbound call

​
outbound_version_id
string<uuid> | null

The unique identifier for the agent that will make the calls when using this phone to make outbound calls

Response

Successful Response

​
id
string<uuid>
required

Unique identifier for the phone record

​
created_date
string<date-time>
required

The datetime when the phone was created

​
number
string
required

The phone number

​
inbound_agent_id
string<uuid> | null

The unique identifier for the agent that will receive the call when this phone receives an inbound call

​
inbound_agent_version_id
string<uuid> | null

The unique identifier for the version of the agent that will receive the call when this phone receives an inbound call

​
outbound_agent_id
string<uuid> | null

The unique identifier for the agent that will make the calls when using this phone to make outbound calls

​
outbound_agent_version_id
string<uuid> | null

The unique identifier for the version of the agent that will make the calls when using this phone to make outbound calls

​
nickname
string | null

The nickname given to the phone number