添加办公时间

添加办公时间。

请求 URL

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

请求参数

参数 是否必填 类型 说明
timezone_id 否 Integer 关联时区的 ID。
注： 可通过 查询时区列表 列表查询时区 ID。
months 否 String 办公时间适用的月份。
注：
  • 仅在启用高级时间条件 (time_condition_switch 为 1) 时生效。
  • 多个值使用空格分隔。

取值范围：

  • all：每月
  • jan：一月
  • feb：二月
  • mar：三月
  • apr：四月
  • may：五月
  • jun：六月
  • jul：七月
  • aug：八月
  • sep：九月
  • oct：十月
  • nov：十一月
  • dec：十二月
days_of_week 否 String 办公时间适用的星期。
注：
  • time_condition_switch 为 0 时必填。
  • 多个值使用空格分隔。

取值范围：

  • all：每天
  • sun：周日
  • mon：周一
  • tue：周二
  • wed：周三
  • thu：周四
  • fri：周五
  • sat：周六
days 否 String 办公时间的适用的日期。
注： 仅在启用高级时间条件 (time_condition_switch 为 1) 时生效。

取值范围：

  • all：每月的每一天。
  • 1 - 31：每月指定的日期。
office_times 否 Array<Time_Periods> 办公时间段列表。
注： 至少需指定一个时间段。
reset_times 否 Array<Time_Periods> 休息时间段列表。
注： 至少需指定一个时间段。
time_condition_switch 否 Integer 是否启用高级时间条件。

取值范围：

  • 0：禁用。
  • 1：启用。
    注： 启用后，months 和 days 参数生效。
remark 否 String 办公时间的备注。
Time_Periods
参数 类型 说明
value String 时间段，格式为 HH:MM-HH:MM。
注： 结束时间必须晚于开始时间。

响应参数

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

示例

请求示例

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

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
  "days_of_week": "mon tue wed thu fri",
  "office_times": [
    {
      "value": "09:00-18:00"
    }
  ],
  "reset_times": [
    {
      "value": "12:00-13:00"
    }
  ],
  "time_condition_switch": 0
}

响应示例

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