Get/myProfile

Function


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


  • name
  • extension
  • address
  • language
  • timezone
  • caller ID
  • SMS lines
  • fax lines
  • Voiemail lines
  • ...and many more.


Parameters


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:


  • phones:Get list of phones: 1 - yes, 0 - no
  • sms:Get list of sms lines: 1 - yes, 0 - no
  • fax: Get list of fax maiboxes: 1 - yes, 0 - no
  • vox: Get list of voice maiboxes: 1 - yes, 0 - no


Example


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


    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.