查询办公时间列表

请求 URL

GET {base_url}/{api_path}/businesshour/list?access_token={access_token}

请求参数


参数	是否必填	类型	说明
page	否	Integer	定义显示第几个页面。
page_size	否	Integer	定义每页显示几项查询结果。
sort_by	否	String	定义排序字段。取值范围：`id`
order_by	否	String	定义显示顺序。取值范围： `asc`：升序。 `desc`：降序。
timezone_id	否	Integer	时区 ID。注：可通过查询时区列表列表获取时区 ID。

响应参数


参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。
total_number	Integer	办公时间记录总数。
data	Array<Business_Hour>	办公时间列表。

Business_Hour


参数	类型	说明
id	Integer	办公时间的唯一 ID。
timezone_id	Integer	关联时区的 ID。
months	String	办公时间适用的月份。 `all`：每月 `jan`：一月 `feb`：二月 `mar`：三月 `apr`：四月 `may`：五月 `jun`：六月 `jul`：七月 `aug`：八月 `sep`：九月 `oct`：十月 `nov`：十一月 `dec`：十二月
days_of_week	String	办公时间适用的星期。 `all`：每天 `sun`：周日 `mon`：周一 `tue`：周二 `wed`：周三 `thu`：周四 `fri`：周五 `sat`：周六
days	String	办公时间适用的日期。 `all`：每月的每一天 `1-31`：每月指定的日期
time_condition_switch	Integer	是否启用高级时间条件。 `0`：禁用。 `1`：启用。
remark	String	办公时间的备注。

示例

请求示例

GET /openapi/v1.0/businesshour/list?page=1&page_size=2&order_by=desc&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": "",
  "total_number": 1,
  "data": [
    {
      "id": 1,
      "days_of_week": "mon tue wed thu fri",
      "time_condition_switch": 0,
      "months": "",
      "days": "",
      "remark": "",
      "timezone_id": 1
    }
  ]
}