获取菜单选项

查询创建和更新功能时需要的菜单选项。

背景信息

在创建或更新功能时,你可以使用此接口查询所需功能的菜单选项。此接口支持查询特定功能的选项详情(如 ID、名称或类型),支持的功能包括 分机、分机组、部门、中继、用户角色、企业联系人群组、群语音信箱、IVR、响铃组、队列与坐席、会议室和 PIN 码列表。

请求 URL

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

请求参数

1.
参数 是否必填 类型 说明
menu String 要查询的菜单。

取值范围

  • extension:分机
  • ext_group:分机组
  • org_list:部门
  • trunk:中继
  • role:用户角色
  • phonebook:企业联系人群组
  • group_vm:群语音信箱
  • IVR:IVR
  • ring_group:响铃组
  • queue:队列
  • queue_agent:队列坐席
  • conference:会议室
  • pinset:PIN 码列表
id Integer
队列的唯一 ID。
注: 在查询队列中的坐席信息时,需要在此参数中填写要队列的 ID。

响应参数

2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
data Array<Options> 菜单选项信息。
Options
3.
参数 类型 说明
text String 菜单选项的名称。
value String 菜单选项的 ID。

例如:查询中继菜单时,此参数显示中继 ID。

type String 菜单选项的类型。

例如:查询中继菜单时,此参数显示中继类型。

item Array<Sub_Org> 子部门信息。
注: 此参数仅在查询部门时返回。
Sub_Org
4.
参数 类型 说明
text String 子部门名称。
value String 子部门 ID。

示例

  • 示例 1:查询用户角色的菜单选项。

    请求示例

    GET /openapi/v1.0/system/get_menuoptions?access_token=ImvFJSbT9DUi9iQpssHgIlQgC2pb5ZHB&menu=role 
    
    Host: yeastardocs.example.yeastarcloud.com

    响应示例

    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"
            }
        ]
    }
  • 示例 2:查询部门的菜单选项。

    请求示例

    GET //openapi/v1.0/system/get_menuoptions?access_token=sIqNaNz22Ph0HKLp25m1aYJJVUbhHyOP&menu=org_list HTTP/1.1
    
    Host: yeastardocs.example.yeastarcloud.com

    响应示例

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