添加假期

添加假期。

请求 URL

POST {base_url}/{api_path}/holidays/create?access_token={access_token}

请求参数

参数 是否必填 类型 说明
timezone_id 否 Integer 关联时区的 ID。
注： 可通过 查询时区列表 接口获取时区 ID。
name 是 String 假期名称。
type 是 String 假期类型。

取值范围：

  • date：按日期 (例：二零二五年一月一日)
  • month：按月份 (例：每年一月一日)
  • week：按星期 (例：每年五月的第三个星期的星期一)
  • weekday：按星期 (例：每年五月的第三个星期一)
month 否 String 假期所在的月份。
注： 当 type 为 week 或 weekday 时必填。

取值范围：

  • jan：一月
  • feb：二月
  • mar：三月
  • apr：四月
  • may：五月
  • jun：六月
  • jul：七月
  • aug：八月
  • sep：九月
  • oct：十月
  • nov：十一月
  • dec：十二月
how_week 否 Integer 假期所在月份的第几周。
注： 当 type 为 week 或 weekday 时必填。

取值范围：

  • 1：第一周
  • 2：第二周
  • 3：第三周
  • 4：第四周
  • 5：最后一周
weekday 否 String 假期所在的星期几。
注： 当 type 为 week 或 weekday 时必填。

取值范围：

  • sun：周日
  • mon：周一
  • tue：周二
  • wed：周三
  • thu：周四
  • fri：周五
  • sat：周六
date 否 String 假期的日期或日期范围。
注：
  • 当 type 为 date 或 month 是必填。
  • 需遵循系统日期格式。可通过 查询 PBX 信息 接口获取系统日期格式。
time_period 否 String 假期的时间段，格式为 HH:MM-HH:MM。
注： 当 type 为 week 或 weekday 时必填。
prompt 否 String 假期使用的自定义提示音文件名称。
注： 可通过 搜索自定义提示音 接口查询可用的提示音。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
id Integer 假期 ID。

示例

请求示例

POST /openapi/v1.0/holidays/create?access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
  "name": "Christmas",
  "type": "date",
  "date": "2026/12/25-2026/12/25"
}

响应示例

HTTP/1.1 200 OK
{
  "errcode": 0,
  "errmsg": "SUCCESS",
  "submsg": "",
  "id": 1
}