User

PreviousDestroy NextPassword

Was this helpful?

Retrieve current user

get

Retrieve details of current 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

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "name": "text",
  "email": "example@example.com",
  "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": true,
  "enable_video_recording": true,
  "enable_dnd": true,
  "enable_acb": true,
  "enable_hot_desking": true,
  "anonymous_outbound_calls": true,
  "delivery_outbound_cid": true,
  "sms": "DISABLE",
  "outbound_caller_ids": [
    {
      "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "caller_id": "text",
      "description": "text"
    }
  ],
  "custom_options": "text",
  "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"
        }
      ]
    }
  },
  "available_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "available_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "available_no_answer_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text",
    "timeout": 1
  },
  "busy_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "busy_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "busy_no_answer_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text",
    "timeout": 1
  },
  "dnd_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "dnd_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "away_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "away_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "lunch_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "lunch_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "trip_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "trip_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "offline_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "offline_non_office_hours_forward_rule": {
    "action": "FORWARD_TO_NUMBER",
    "number": "text"
  },
  "custom_forward_rules": [
    {
      "action": "FORWARD_TO_NUMBER",
      "number": "text",
      "caller_id": "text",
      "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"
            }
          ]
        }
      }
    }
  ],
  "voicemail_prompt": "en-US",
  "enable_voicemail_pin": true,
  "voicemail_pin": "text",
  "enable_voicemail_notify": true,
  "voicemail_play_datetime": "DISABLE",
  "interface": "WEB_DOMAIN",
  "preferred_transport": "UDP",
  "blfs": [
    {
      "key": "text",
      "value": "text",
      "first_name": "text",
      "last_name": "text"
    }
  ],
  "created_at": "2017-07-21T17:32:28Z",
  "avatar_file_name": "text",
  "avatar_file_size": 0,
  "avatar_file_url": "/api/blobs/WexWdABcd5D4PDgzTKV3gAAAEu00WcK",
  "transports": [
    {
      "protocol": "UDP",
      "port": 80,
      "verification": "DISABLE"
    }
  ],
  "profile": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "sync_type": "Microsoft 365"
}

Update current user properties.

post

Update current user properties.

Authorizations

Body

emailall ofoptional

The email address of user.

The email address.

display_namestring · max: 1024optional

The display name of user.

mobile_phonestring · max: 32optional

The mobile phone number of user.

work_phonestring · max: 32optional

The office phone number of user.

home_phonestring · max: 32optional

The home phone number of user.

addressstring · max: 128optional

The address.

departmentstring · max: 128optional

The department of user.

enable_audio_recordingboolean · default: falseoptional

Records all calls and saves audio recordings on server.

enable_video_recordingboolean · default: falseoptional

Records all calls and saves video recordings on server.

enable_dndbooleanoptional

Enable Do Not Disturb or not.

enable_acbbooleanoptional

Enable Automatic Callback or not.

enable_hot_deskingboolean · default: falseoptional

Enable hot desking feature or not.

anonymous_outbound_callsboolean · default: falseoptional

Always make outbound anonymous calls or not.

delivery_outbound_cidboolean · default: trueoptional

Always delivery outbound caller ID or not.

smsstring · enum · default: "DISABLE"optional

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

outbound_caller_idsobject[]optional

A collection of outbound caller IDs.

custom_optionsstringoptional

Some custom configuration options serialized as json string

office_hoursall ofoptional

available_office_hours_forward_ruleobjectoptional

available_non_office_hours_forward_ruleobjectoptional

available_no_answer_forward_ruleobjectoptional

busy_office_hours_forward_ruleobjectoptional

busy_non_office_hours_forward_ruleobjectoptional

busy_no_answer_forward_ruleobjectoptional

dnd_office_hours_forward_ruleobjectoptional

dnd_non_office_hours_forward_ruleobjectoptional

away_office_hours_forward_ruleobjectoptional

away_non_office_hours_forward_ruleobjectoptional

lunch_office_hours_forward_ruleobjectoptional

lunch_non_office_hours_forward_ruleobjectoptional

trip_office_hours_forward_ruleobjectoptional

trip_non_office_hours_forward_ruleobjectoptional

offline_office_hours_forward_ruleobjectoptional

offline_non_office_hours_forward_ruleobjectoptional

custom_forward_rulesobject[]optional

voicemail_promptstringoptional

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: trueoptional

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

voicemail_pinstring · min: 6 · max: 10optional

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: falseoptional

Enable voicemail to email notify.

voicemail_play_datetimestring · enumoptional

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 · enumoptional

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 · enumoptional

The transport protocol:
Can be either:

UDP:
TCP:
TLS:

Options: UDP, TCP, TLS

blfsobject[]optional

A collection of BLFs.

avatar_file_idall ofoptional

The unique ID of the file.

The unique ID of the resource.

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/user' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "example@example.com",
    "display_name": "text",
    "mobile_phone": "text",
    "work_phone": "text",
    "home_phone": "text",
    "address": "text",
    "department": "text",
    "enable_audio_recording": true,
    "enable_video_recording": true,
    "enable_dnd": true,
    "enable_acb": true,
    "enable_hot_desking": true,
    "anonymous_outbound_calls": true,
    "delivery_outbound_cid": true,
    "sms": "DISABLE",
    "outbound_caller_ids": [
      {
        "provider_id": "NzAwNTUxOTA5NzczMTQ4MTYw",
        "caller_id": "text",
        "description": "text"
      }
    ],
    "custom_options": "text",
    "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"
          }
        ]
      }
    },
    "available_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "available_non_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "available_no_answer_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text",
      "timeout": 1
    },
    "busy_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "busy_non_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "busy_no_answer_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text",
      "timeout": 1
    },
    "dnd_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "dnd_non_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "away_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "away_non_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "lunch_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "lunch_non_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "trip_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "trip_non_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "offline_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "offline_non_office_hours_forward_rule": {
      "action": "FORWARD_TO_NUMBER",
      "number": "text"
    },
    "custom_forward_rules": [
      {
        "action": "FORWARD_TO_NUMBER",
        "number": "text",
        "caller_id": "text",
        "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"
              }
            ]
          }
        }
      }
    ],
    "voicemail_prompt": "en-US",
    "enable_voicemail_pin": true,
    "voicemail_pin": "text",
    "enable_voicemail_notify": true,
    "voicemail_play_datetime": "DISABLE",
    "interface": "WEB_DOMAIN",
    "preferred_transport": "UDP",
    "blfs": [
      {
        "key": "text",
        "value": "text",
        "first_name": "text",
        "last_name": "text"
      }
    ],
    "avatar_file_id": "NzAwNTUxOTA5NzczMTQ4MTYw"
  }'

200

4XX

No body

Retrieve current user

Update current user properties.

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes

Show child attributes