Update Phone

import requests url = "https://api.diga.io/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", "number": "<string>", "nickname": "<string>", "released_at": "2023-11-07T05:31:56Z", "scheduled_release_at": "2023-11-07T05:31:56Z", "assigned_at": "2023-11-07T05:31:56Z", "inbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "outbound_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }

Autorizaciones

Authorization

string

header

requerido

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

Parámetros de ruta

phone_id

string<uuid>

requerido

Cuerpo

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

Respuesta

Successful Response

string<uuid>

requerido

Unique identifier for the phone register record

number

string<phone>

requerido

The phone number

telephony_provider

enum<string>

requerido

The telephony provider (NETELIP for purchased numbers, CUSTOM for imported numbers)

Opciones disponibles:

netelip,

custom

status

enum<string>

requerido

Current status of the phone register (RESERVED, ASSIGNED, RELEASED, FINISHED)

Opciones disponibles:

reserved,

assigned,

released,

finished

nickname

string | null

The nickname given to the phone number

released_at

string<date-time> | null

The date and time when the phone was released

scheduled_release_at

string<date-time> | null

The date and time when the phone is scheduled to be released. If set, the phone will be released at this time at the end of the billing period.

assigned_at

string<date-time> | null

The date and time when the phone was assigned

inbound_agent_id

string<uuid> | null

The unique identifier for 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