GET/myProfile

Jump to Parameters

Jump to Example


Function


The GET/myProfile method (case sensitive) returns a detailed list of the entries related to a user's Teleconsole's profile based on the basic authentication credentials provided. 


The returned fields are broken into several categories and include: 


Main user details

pbx_customer

rights

phones

sms_lines

fax_lines

fax_boxes

vox_boxes


Main details about the user


This category lists the main details about the user from his profile, availability status, extension, and IDs. 


  • id - a specific ID number for the user on the Telebroad server.
  • username - the user name as it is used to log in to the Teleconsole account of the user. This is usually the same as the user's email.
  • pbx_uid - the unique id of the user on the PBX system of the office.
  • pbx_cid - The PBX customer ID of the user in the general Telebroad PBX database.
  • pbx_role - a numeric value representing a certain role of the user in the PBX system. The role of the user dictates the kind of operations he is permitted to perform. For example, an administrator (role 11) will have much more access privileges and ability to change settings than a regular user (role 4.)
  • title - the title of the user.
  • firstname - the first name of the user for the requested profile.
  • lastname - the last name of the user for the requested profile.
  • email - the email of the user.
  • extension - the extension of the requested profile.
  • mobile - the mobile number of the user
  • address1 - first address field for the user, such as street address etc. 
  • address2 - second address field for the user, such as suite or office number etc.
  • address3 - third address field for the user, such as extended location information etc.
  • address_city - the city of the user's address.
  • address_state - the state of the user's address.
  • address_code - the zip code of the user's address.
  • country - the country of the user's address.
  • language - the default language selected in the settings of the user.
  • timezone - the default time zone selected in the settings for the user.
  • opt_email - an optional email address for the user.
  • photo - a path to a photo of the user on Telebroad's server.
  • status - a value of 1 indicates an "Available" status on the Teleconsole. A value of 0 indicates a "Busy" status. 
  • status_msg - the status message associated with the availability of the user. 
  • status_time - the time and date the status was set by the user.



pbx_customer


Some details about the user as they appear in the  PBX customers database.


  • id - the PBX customer ID of the user (this is the same as pbx_cid.)
  • name - the name of the Teleconsole account.
  • callerid - the main caller ID currently selected by the user for his Teleconsole account.


rights


This category shows certain rights that the user have. The values are not Boolean. If they are listed it means the user have them. This also relates to the PBX role of the user as explained above.


Common rights may include -


  • queues_stats - indicates the user has the right to see statistics about queues.
  • change_callerid - indicates the user has the right to change his caller ID from a list of available caller IDs.
  • callerid_original - indicates the user has the right to create a new original caller ID and add it to the list of already existing  caller IDs.


phones 


A list of phone number lines belonging to the user.


  • name - a name associated with the phone number of the user. By default this is identical to his extension. 
  • description - a description of the phone line. It could be the name of the user, a description of the function of the line, or any other appropriate description.
  • callerIDint - the internal caller ID of the line. This is practically identical to the extension of the user.
  • callerID - a caller ID currently associated with the line.
  • fcode - a fast dialing code for the user. A fast dialing code is associated with a user's extension. It is setup by an administrator and is used fir certain settings in the PBX system (meaning external callers have no access to it and need to use the regular extension)
  • secret - the SIP password for the phone line. 


sms_lines 


A list of business SMS lines belonging to the user.


  • sms_line - the number of the SMS line.
  • sms_linename - the name associated with the SMS line. 


fax_lines 


A list of fax lines available to be used by the user. Since a company usually wants to maintain only one main fax line, what is listed here are all the potential fax lines based on all the caller IDs numbers created by the administrator for the system. Only the fax line indicated as owned by the user is relevant - also relating to the fax boxes category.


  • name - the name (practically the number) of the potential fax line. 
  • owned - a "true" value indicates the line is owned by the user. As explained above, with regard to wanting to maintain one fax line, most lines listed will be indicated by a "false" value. 


fax_boxes  


 The details of the box (storage allotment) where the faxes are actually stored. 


  • name -  the name (practically the number) of the fax box.
  • owned - a "true" value indicates the box is owned by the user. A box can be shared among several users, so it is not required for a user to own a box in order to send or receive faxes.


vox_boxes 


A list of voicemails storage boxes (vox) where voicemails are stored for the user. 


  • name - the name (practically the number) of the voicemail box.
  • owned - a "true" value indicates the box is owned by the user, and this will be so in most cases. The exception is a situation where a departmental voicemail exists and is shared among several users. An administrator can associate a user with such a box, even without the user owning it. A box can be shared among several users, so it is not required for a user to own a box in order to send faxes.


Parameters


The  requested profile is determined by the login credentials provided in the basic authentication header of the request.


By default the phones, sms_lines, fax_lines, and vox_boxes categories are not expanded, and appear like this:


        "phones": [],
        "sms_lines": [],
        "fax_lines": [],
        "vox_boxes": []


To expand them and see the items they contain use the following parameters:


Parameter
Type
Operation
phones
Boolean
A value of 1 will expand the list of phone number lines.
sms    
Boolean
A value of 1 will expand the list of SMS lines.
fax
Boolean
A value of 1 will expand the list fax line.
vox
Boolean
A value of 1 will expand the list voicemail boxes.


Example


To get information about a user profile with expanded lists for SMS lines,  phones, voicemail boxes, and fax lines use the following syntax:


HTTP method: GET


 webserv.telebroad.com/api/teleconsole/rest/myProfile?vox=1&sms=1&fax=1&phones=1

Response:


{"error":null,

    "result":

        {"id":"750",

        "username":"alex_pierce@nmc.com",

        "pbx_uid":"13697",

        "pbx_cid":"1532",

        "pbx_role":"4",

        "title":"Mr.",

        "firstname":"Alex",

        "lastname":"Pierce",

        "email":"alex_pierce@nmc.com",

        "telephone":"3472221450",

        "extension":"1024853",

        "mobile":"347-180-1117",

        "fax":"3472221452",

        "address1":"1914 Cliffside Drive",

        "address2":"Unit 2",

        "address3":"",

        "address_city":"Binghamton",

        "address_state":"NY",

        "address_code":"13901",

        "country":"US",

        "address_other":"",

        "language":"English",

        "timezone":"EST5EDT",

        "opt_email":null,

        "photo":"telebroad.com\/cdn\

        /avatar\/JH\/bC9\

        /042el8bc4923092653ec2f59f3e78348dmez.jpg",

        "status":"1",

        "status_msg":"In a meeting. Chats only.",

        "status_time":"2018-02-15 02:24:49",

        "settings":{},

    "pbx_customer":

        {"id":"1437",

        "name":"NMC PBX",

        "callerid":"13472222000"},

    "rights":

        ["queues_stats",

        "change_callerid",

        "list_common_numbers",

        "callerid_original"],

    "phones":

        [{"name":"1024853",

        "description":"Alex Pierce NMC",

        "callerIDint":"1024853",

        "callerID":"13474367740",

        "fcode":"205",

        "secret":"t171et"}],

    "people":[],

    "sms_lines":

        [{"sms_line":"16468781560",

        "sms_linename":"Alex Pierce NMC"},

        {"sms_line":"16468781561",

        "sms_linename":"Alex Pierce NMC"}

        ],

    "fax_lines":

        [{"name":"12024474477",

        "owned":false},               

         {"name":"13474377710",

        "owned":false},

        {"name":"15558828706",

        "owned":true},       

        {"name":"163328200088",

        "owned":false},],

    "fax_boxes":        

        [{"name":"16466991359",

        "owned":true}],

    "vox_boxes":

        [{"name":"1113840",

        "owned":true}]

    }} 

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.