Update Phone Number

Update phone number settings and destinations

PATCH /v2/admin/phone-numbers/{id}

Update Phone Number

cURL

curl --request PATCH \
  --url https://api.voxo.co/v2/admin/phone-numbers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "id": 123,
  "number": "<string>",
  "registeredCNAM": "<string>",
  "tenant": {
    "id": 123,
    "name": "<string>"
  },
  "branch": {
    "id": 123,
    "name": "<string>"
  },
  "diCommentName": "<string>",
  "recording": "<string>",
  "fax": "<string>",
  "faxEmail": "<string>",
  "faxStore": 123,
  "namePrefix": "<string>",
  "unconditionalStatus": 123,
  "emailRecording": "<string>",
  "storeAndForwardNumber": "<string>",
  "smsExt": {
    "id": 123,
    "name": "<string>"
  },
  "routingDestinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123
    }
  ],
  "forwardingDestinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123
    }
  ],
  "smsDestinations": [
    {
      "typeSrc": "<string>",
      "destType": "<string>",
      "id": 123,
      "order": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · number · required

Phone number ID

Required range: x > 0

Body

application/json

tenantId · number

Tenant ID

diCommentName · string

Comment/description

Maximum string length: 255

recording · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string>

Recording mode (no, yes, yeschange)

Available options: no

fax · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string>

Fax mode (no, force, forcestoreandforward)

Available options: no

faxEmail · string

Fax email address

Maximum string length: 500

faxStore · Option 1 · enum<number> Option 2 · enum<number>

Store fax (1 = yes, 0 = no)

Available options: 1

namePrefix · string

Caller ID name prefix

Maximum string length: 255

unconditionalStatus · Option 1 · enum<number> Option 2 · enum<number>

Unconditional forwarding (1 = on, 0 = off)

Available options: 1

emailRecording · string

Email address for recording delivery

Maximum string length: 255

storeAndForwardNumber · string

Store and forward number

Maximum string length: 255

branchId · number

Branch ID

routingDestinations · object[]

Routing destinations

Show child attributes

forwardingDestinations · object[]

Forwarding destinations

Show child attributes

smsDestinations · object[]

SMS destinations

Show child attributes

Response

200

application/json

Updated phone number

id · number · required

Phone number ID

number · string · required

Phone number

registeredCNAM · string | null · required

Registered caller ID name

tenant · object · required

Parent tenant

Show child attributes

branch · object · required

Assigned branch

Show child attributes

diCommentName · string | null · required

Comment/description

recording · string | null · required

Recording mode

fax · string | null · required

Fax mode

faxEmail · string | null · required

Fax email

faxStore · number | null · required

Fax store enabled (1/0)

namePrefix · string | null · required

Caller ID name prefix

unconditionalStatus · number | null · required

Unconditional forwarding (1/0)

emailRecording · string | null · required

Recording email address

storeAndForwardNumber · string | null · required

Store and forward number

smsExt · object · required

SMS-assigned extension

Show child attributes

routingDestinations · object[]

Routing destinations

Show child attributes

forwardingDestinations · object[]

Forwarding destinations

Show child attributes

smsDestinations · object[]

SMS destinations

Show child attributes