Users

List, add, update, and delete users on your account.

List Users

Lists all users on your account.

Request

GET https://api.telzio.com/users

Response

{
  [
    {
      "UserId": integer,
      "Username": string,
      "Firstname": string,
      "Lastname": string,
      "Email": string,
      "Extension": string,
      "Admin": boolean,
      "Number": {
        "NumberID": integer,
        "E164": string,
      },
      "NumberSelectable": boolean,
      "Holdmusic": {
        "HoldmusicID": integer,
        "Name": string,
      }
      "RecordCalls": boolean,
        "NoAnswerDestination": {
        "Type": string,
        "id": integer,
        "Name": string,
        "Timeout": integer,
      },
      "Groups": [{ 
  	    "id": integer, 
  	    "Name": string,
      }],
      "Permissions": [],
    }
  ]
}

Add User

Adds a new user to your Telzio account.

Request

POST https://api.telzio.com/users

Body Parameters

Parameter Type Description Default
Username string Username for the new user. Must be lower case.
FirstName string First name for the new user.
LastName string Last name for the new user.
Email string Email address of the new user.
Extension string Extension for the new user.
Password string Password for the new user.
Admin boolean Set to true if the user should have full account administrative access, false otherwise. false
NumberId int32 The number id this user calls from (see List Numbers).
NumberSelectable boolean If the user can select their own number on the dashboard or in the Telzio app. false
HoldmusicID int32 Hold Music ID, see Hold Music. Set to zero for no hold music. 0
RecordCalls boolean If calls to or from this user should be recorded. false
NoAnswerDestination string None, Voicemail, CallFlow, User, Group or External None
No AnswerValue string The appropriate value depending on the value provided in NoAnswerDestination. If None or Voicemail is selected, this field should be empty. If CallFlow is used, then this must be the ID of the call flow (see Call Flows), if User is selected, this must be the username of the user, and if External is used, it must be the full E164 number to send the caller to.
NoAnswerTimeout int32 How long the user rings before. NoAnswerDestination is triggered. 60
Groups int32[ ] GroupID's this user will belong to.
Permissions string[ ] Permissions granted to this user. Can by any combination of: call_flow_admin, log_reader, plan_admin, user_admin, monitor_call

Response

{
  "UserId": integer,
  "Username": string,
  "Firstname": string,
  "Lastname": string,
  "Email": string,
  "Extension": string,
  "Admin": boolean,
  "Number": {
    "NumberID": integer,
    "E164": string,
  },
  "NumberSelectable": boolean,
  "Holdmusic": {
    "HoldmusicID": integer,
    "Name": string,
  },
  "RecordCalls": boolean,
  "NoAnswerDestination": string,
  "Groups": [{
    "id": integer,
    "Name": string,
  }],
  "Permissions": [],
  "Registrations": [],
}

Update User

Updates a specific user on your Telzio account.

Request

PUT https://api.telzio.com/users/{username}

Path Parameters

Parameter Type
username string

Body Parameters

Parameter Type Description
FirstName string If set, will update user's first name.
LastName string If set, will update user's last name.
Email string If set, will update user's email.
Extension string If set, will update user's extension.
Password string If set, will update user's password.
Admin boolean If set, will change if user is account administrator.
NumberId int32 If set, will update the number the user calls from.
NumberSelectable boolean If set, will change if user can select which number he calls from.
HoldmusicID int32 If set, will update the user's hold music.
RecordCalls boolean If set, will change if the user's calls are recorded.
NoAnswerDestination string If set, will update No Answer Destination settings.
No AnswerValue string If set, will update No Answer Destination ID.
NoAnswerTimeout int32 If set, will update No Answer Action trigger timeout.
groups int32[ ] If set, will update which groups this user belongs to.
permissions string[ ] If set, will change the user's permissions.

Response

{
  "UserId": integer,
  "Username": string,
  "Firstname": string,
  "Lastname": string,
  "Email": string,
  "Extension": string,
  "Admin": boolean,
  "Number": {
    "NumberID": integer,
    "E164": string,
  },
  "NumberSelectable": boolean,
  "Holdmusic": {
    "HoldmusicID": integer,
    "Name": string,
  },
  "RecordCalls": boolean,
  "NoAnswerDestination": string,
  "Groups": [{
    "id": integer,
    "Name": string,
  }],
  "Permissions": [],
  "Registrations": [],
}

Delete User

Deletes a specific user on your Telzio account.

Request

DELETE https://api.telzio.com/users/{username}

Path Parameters

Parameter Type
username string