Get/myProfile

Function


The myProfile method returns a detailed list of of the fields related to a user's TeleConsole's profile including: 


  • Name - the name of the user for the requested profile.
  • Extension - the extension of the requested profile.
  • Address - the address of the requested profile.
  • Language - the language settings for the user of the requested profile.
  • Timezone - the time zone settings for the user of the requested profile.
  • Caller ID - the caller ID for the user of the requested profile.
  • SMS lines - list of SMS lines for of  the requested profile.
  • Fax lines- list of fax lines for of  the requested profile.
  • Voiemail lines - list of voicemails lines for of  the requested profile.
  • ...and many more.

Parameters


There are no parameters to identify the requested profile. It is determined by the account login credentials provided in the basic authentication header.


By default the fields that may contain a list of items are not expanded:


        "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 Get list of phone lines
sms     Boolean Get list of SMS lines
fax Boolean Get list of fax lines
vox Boolean Get list of voice mailboxes



Example


To expand the lists for sms lines and mailboxes use the following syntax:


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

Result:

.

.

.

    "pbx_customer": {
                "id": "1532",
                "name": "ACD super user",
                "callerid": "16466921234"
            },
            "phones": [],
            "people": [],
            "sms_lines": [
                {
                    "sms_line": "16466991360",
                    "sms_linename": "ACD super user"
                },
                {
                    "sms_line": "16466991361",
                    "sms_linename": "ACD super user"
                }
            ],
            "fax_lines": [],
            "fax_boxes": [],
            "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.