User

PreviousDestroy NextPassword

Was this helpful?

Retrieve current user

Retrieve details of current user.

get

/user

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/user' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "name": "text",
  "display_name": "text",
  "role": "User",
  "enabled": true,
  "mobile_phone": "text",
  "work_phone": "text",
  "home_phone": "text",
  "address": "text",
  "department": "text",
  "extension_number": "text",
  "enable_audio_recording": false,
  "enable_video_recording": false,
  "enable_dnd": true,
  "enable_acb": true,
  "enable_hot_desking": false,
  "anonymous_outbound_calls": false,
  "delivery_outbound_cid": true,
  "custom_options": "text",
  "voicemail_prompt": "en-US",
  "enable_voicemail_pin": true,
  "voicemail_pin": "text",
  "enable_voicemail_notify": false,
  "avatar_file_name": "text",
  "avatar_file_size": 0,
  "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "sms": "DISABLE",
  "voicemail_play_datetime": "DISABLE",
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "sync_type": "Microsoft 365",
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "email": "example@example.com",
  "created_at": "2017-07-21T17:32:28Z",
  "profile": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "available_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "available_non_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "available_no_answer_forward_rule": {
    "number": "text",
    "timeout": 60,
    "action": "FORWARD_TO_NUMBER"
  },
  "busy_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "busy_non_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "busy_no_answer_forward_rule": {
    "number": "text",
    "timeout": 60,
    "action": "FORWARD_TO_NUMBER"
  },
  "dnd_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "dnd_non_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "away_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "away_non_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "lunch_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "lunch_non_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "trip_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "trip_non_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "offline_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "offline_non_office_hours_forward_rule": {
    "number": "text",
    "action": "FORWARD_TO_NUMBER"
  },
  "blfs": [
    {
      "key": "text",
      "value": "text",
      "first_name": "text",
      "last_name": "text"
    }
  ],
  "transports": [
    {
      "protocol": "UDP",
      "verification": "DISABLE",
      "port": 80
    }
  ],
  "outbound_caller_ids": [
    {
      "description": "text",
      "caller_id": "text",
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
    }
  ],
  "office_hours": {
    "mode": "CUSTOM",
    "monday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "tuesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "wednesday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "thursday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "friday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "saturday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    },
    "sunday": {
      "enabled": true,
      "ranges": [
        {
          "from": "09:00",
          "to": "17:00"
        }
      ]
    }
  },
  "custom_forward_rules": [
    {
      "number": "text",
      "caller_id": "text",
      "action": "FORWARD_TO_NUMBER",
      "type": "ALL_HOURS",
      "hours": {
        "monday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "tuesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "wednesday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "thursday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "friday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "saturday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        },
        "sunday": {
          "enabled": true,
          "ranges": [
            {
              "from": "09:00",
              "to": "17:00"
            }
          ]
        }
      }
    }
  ]
}

Update current user properties.

post

/user

Authorizations

Body

display_namestring · max: 1024

The display name of user.

mobile_phonestring · max: 32

The mobile phone number of user.

work_phonestring · max: 32

The office phone number of user.

home_phonestring · max: 32

The home phone number of user.

addressstring · max: 128

The address.

departmentstring · max: 128

The department of user.

enable_audio_recordingboolean · default: false

Records all calls and saves audio recordings on server.

enable_video_recordingboolean · default: false

Records all calls and saves video recordings on server.

enable_dndboolean

Enable Do Not Disturb or not.

enable_acbboolean

Enable Automatic Callback or not.

enable_hot_deskingboolean · default: false

Enable hot desking feature or not.

anonymous_outbound_callsboolean · default: false

Always make outbound anonymous calls or not.

delivery_outbound_cidboolean · default: true

Always delivery outbound caller ID or not.

custom_optionsstring

Some custom configuration options serialized as json string

voicemail_promptstring

BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US.

Example: en-US

enable_voicemail_pinboolean · default: true

Whether the PIN is required to access voice mail of extension.

voicemail_pinstring · min: 6 · max: 10

The PIN number for accessing.
The PIN policies include:

A sequence of numbers 6-10 digits in length.
No repeating numbers (e.g. "111", "222")
No sequential numbers (e.g. "012", "789")

enable_voicemail_notifyboolean · default: false

Enable voicemail to email notify.

smsstring · enum · default: DISABLE

The preferred configuration for SMS/MMS.
Note: Only users with UserManagement::Users privilege can change this property.

DISABLE: Disable user SMS/MMS feature.
ALLOW: Enable user SMS/MMS feature but with outbound caller ID.
ALLOW_WITH_SENDER_ID: Enable user SMS/MMS but with trunk sender ID.

Options: DISABLE, ALLOW, ALLOW_WITH_SENDER_ID

voicemail_play_datetimestring · enum

Announces Date and Time of Message.

DISABLE: Do not read;
12_HOUR_CLOCK: Read in 12-hour clock;
24_HOUR_CLOCK: Read in 24-hour clock.

Options: DISABLE, 12_HOUR_CLOCK, 24_HOUR_CLOCK

interfacestring · enum

The interface type for QR code or auto provisioning.
Can be neither:

WEB_DOMAIN:
PUBLIC_IPV4:
PUBLIC_IPV6:
PRIVATE_IPV4:
PRIVATE_IPV6:
SBC_DOMAIN:

Options: WEB_DOMAIN, PUBLIC_IPV4, PUBLIC_IPV6, PRIVATE_IPV4, PRIVATE_IPV6, SBC_DOMAIN

preferred_transportstring · enum

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Options: UDP, TCP, TLS

emailall of

The email address of user.

The email address.

avatar_file_idall of

The unique ID of the file.

The unique ID of the resource.

available_office_hours_forward_ruleobject

available_non_office_hours_forward_ruleobject

available_no_answer_forward_ruleobject

busy_office_hours_forward_ruleobject

busy_non_office_hours_forward_ruleobject

busy_no_answer_forward_ruleobject

dnd_office_hours_forward_ruleobject

dnd_non_office_hours_forward_ruleobject

away_office_hours_forward_ruleobject

away_non_office_hours_forward_ruleobject

lunch_office_hours_forward_ruleobject

lunch_non_office_hours_forward_ruleobject

trip_office_hours_forward_ruleobject

trip_non_office_hours_forward_ruleobject

offline_office_hours_forward_ruleobject

offline_non_office_hours_forward_ruleobject

blfsobject[]

outbound_caller_idsobject[]

office_hoursall of

custom_forward_rulesobject[]