Skip to Content

Get Menu Options

Query the menu option details when creating and updating features.

Background information

When creating and updating features, you can use the interface to query the menu options of desired features. The interface supports to query the option details (ID, name, or type) of specific features including extension, extension group, organization, trunk, user role, phonebook, group voicemail, IVR, call flow, ring group, queue, queue agent, conference, PIN list, system prompt, custom prompt, certificates, AI receptionist, etc.

Request URL

GET {base_url}/{api_path}/system/get_menuoptions?access_token={access_token}

Request parameters

ParameterRequiredTypeDescription
menuYesStringThe menu that you want to query.

Valid value:

  • extension: Extension.
  • ext_group: Extension group.
  • org_list: Organization list.
  • trunk: Trunk.
  • role: User role.
  • phonebook: Phonebook.
  • group_vm: Group voicemail.
  • ivr: IVR.
  • call_flow: Call flow.
  • ring_group: Ring group.
  • queue: Queue.
  • queue_agent: Queue agent.
  • conference: Conference.
  • pinset: PIN list.
  • system_prompt: System prompt.
  • custom_prompt: Custom prompt.
  • paging_custom_prompt: Custom prompts available for paging group.
  • disposition_code: Call disposition code.
  • message_channel: Message channel.
  • message_queue: Message queue.
  • trunk_did_id: The ID of DID number.
  • certificate: The available HTTPs certificates for PBX web server.
  • ai_receptionist: AI receptionist.
idNoIntegerThe unique ID of the queue.Note:This parameter is required when querying the agents included in a queue.

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note:You can check the error code and error message in Error Code and Error Message.
errmsgStringReturned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
dataArray<Options>The information of the menu options.

Options

ParameterTypeDescription
textStringThe name of the menu options.
valueStringThe ID of the menu options.

For example, when the menu is trunk, the value displays the trunk ID.

typeStringThe type of the menu options.

For example, when the menu is trunk, the type displays the trunk type.

itemArray<Sub_Org>The information of the sub-organization.Note:This parameter is returned only when querying organization list.

Sub_Org

ParameterTypeDescription
textStringThe name of the sub-organization.
valueStringThe ID of the sub-organization.

Examples

  • Example 1: Query the menu options of user role.

    Request example

    GET /openapi/v1.0/system/get_menuoptions?access_token=ImvFJSbT9DUi9iQpssHgIlQgC2pb5ZHB&menu=role 
Host: 192.168.5.150:8088

    Response example

    HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "text": "None",
            "value": "0"
        },
        {
            "text": "Administrator",
            "value": "1"
        },
        {
            "text": "Supervisor",
            "value": "2"
        },
        {
            "text": "Operator",
            "value": "3"
        },
        {
            "text": "Employee",
            "value": "4"
        },
        {
            "text": "Human Resource",
            "value": "5"
        },
        {
            "text": "Accounting",
            "value": "6"
        }
    ]
}

  • Example 2: Query the menu options of organization.

    Request example

    GET /openapi/v1.0/system/get_menuoptions?access_token=sIqNaNz22Ph0HKLp25m1aYJJVUbhHyOP&menu=org_list HTTP/1.1
Host: 192.168.5.150:8088

    Response example

    HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "text": "Yeastar",
            "value": "1",
            "item": [
                {
                    "text": "Tech support",
                    "value": "2"
                },
                {
                    "text": "Sales",
                    "value": "3"
                }
            ]
        }
    ]
}