搜索假期

搜索假期。

请求 URL

GET {base_url}/{api_path}/holidays/search?access_token={access_token}

请求参数


参数	是否必填	类型	说明
page	否	Integer	定义显示第几个页面。
page_size	否	Integer	定义每页显示几项查询结果。
search_value	否	String	用于搜索假期的关键字。
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<Holiday>	匹配的假期列表。

Holiday


参数	类型	说明
id	Integer	假期的唯一 ID。
timezone_id	Integer	关联时区的 ID。
name	String	假期名称。
type	String	假期类型。 `date`：按日期 (例：二零二五年一月一日) `month`：按月份 (例：每年一月一日) `week`：按星期 (例：每年五月的第三个星期的星期一) `weekday`：按星期 (例：每年五月的第三个星期一)
month	String	假期所在的月份。 `jan`：一月 `feb`：二月 `mar`：三月 `apr`：四月 `may`：五月 `jun`：六月 `jul`：七月 `aug`：八月 `sep`：九月 `oct`：十月 `nov`：十一月 `dec`：十二月
how_week	Integer	假期所在的月份中的第几周。 `1`：第一周 `2`：第二周 `3`：第三周 `4`：第四周 `5`：最后一周
weekday	String	假期所在的星期几。 `sun`：周日 `mon`：周一 `tue`：周二 `wed`：周三 `thu`：周四 `fri`：周五 `sat`：周六
date	String	假期的日期或日期范围。
time_period	String	时间段，格式为 HH:MM-HH:MM。

示例

请求示例

GET /openapi/v1.0/holidays/search?page=1&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,
      "name": "Holiday",
      "type": "date",
      "date": "2026/12/25-2026/12/26",
      "month": "",
      "how_week": 0,
      "weekday": "",
      "time_period": "",
      "timezone_id": 1
    }
  ]
}