Zoho crm Logo

轮班时间

班次时间允许您根据员工的工作时间或时区分配班次,并使您能够根据用户的可用性分配活动。

目的

通过API为您的组织设置班次时间。请注意,班次时间必须在为您的组织配置的营业时间内。

端点

  • POST /settings/business_hours/shift_hours

Request 详情

Request URL

{api-domain}/crm/{version}/settings/business_hours/shift_hours

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
X-CRM-ORG:{your_org_id}

范围

scope=ZohoCRM.settings.business_hours.ALL
(或者)
scope=ZohoCRM.settings.business_hours.CREATE

样本请求

输入 JSON

  • 时区字符串,必填

    代表您想要设置班次时间的时区。

  • 名称字符串,必填

    班次的名称。请注意,特殊字符~ , ` , # , % , & , + , = , [ , ] , { , } , | , ; , < , > , ^是不允许的。

  • shift_daysJSON 数组,必填

    您想要设置班次时间的一周中的哪些天。请注意,您只能在您的业务运营日设置班次时间。

  • same_as_everyday布尔值,必填

    表示班次时间是否每天相同。当此值为 false时,JSON 数组 custom_timing 变为必填。当此值为 true时,JSON 数组 daily_timing 变为必填。

  • daily_timingJSON 数组,当 same_as_everyday 为 true 时必填

    以 HH:mm 格式表示一周的班次时间。例如:"daily_timing":["10:00","17:00"]。

  • custom_timingJSON 数组,当 same_as_everyday 为假时必填

    数组中的每个 JSON 对象都包含以下键:

    • days - 字符串,必填 - 有自定义时间的班次的一周中的某一天。例如:"days":"Monday"。
    • shift_timing - JSON 数组,必填 - 该天的班次时间,格式为 HH:MM。例如:"shift_timing":["10:00","17:00"]。
  • break_hoursJSON 数组,可选

    每个JSON数组对象中包含以下键:

    • same_as_everyday - 布尔值,必填 - true 表示每天的休息时间相同,此时daily_timing为必填项。当此值为false时,custom_timing数组变为必填项。
    • break_days - JSON 数组,必填 - 允许休息的一周中的天数。
    • daily_timing(当same_as_everyday为true时) - JSON 数组,必填 - 以HH:MM格式表示当天的休息时间。例如:"daily_timing":["10:00","10:30"]。请注意,每天的休息时间不能超过两小时,每天只能有两次休息。
    • custom_timing(当same_as_everyday为false时) - JSON 数组,必填 - 以HH:MM格式表示某天的休息时间。例如:"custom_timing":["11:00","01:00"]。请注意,每天的休息时间不能超过两小时,每天只能有两次休息。


      days - 字符串,必填 - 自定义休息时间适用的班次日。

  • 假期JSON 数组,可选

    使用此数组在创建班次小时时创建新的假期。
    此数组必须包含以下键:

    • name - 字符串,必填 - 假期的唯一名称。请注意,特殊字符 ~ , ` , # , % , & , + , = , [ , ] , { , } , | , ; , < , > , ^ 是不允许的。
    • date - 字符串,必填 - 假期落在的日期,格式为YYYY-MM-DD。
  • 用户JSON 数组,可选

    您想要分配这些班次小时数的用户的ID。使用键effective_from在此日期将此班次分配给用户。格式为YYYY-DD-MM。
    当您不指定此键时,用户会立即被分配到班次。

注意

  • 您的组织最多可以创建 50个班次小时。

输入JSON

可能的错误

  • INVALID_DATAHTTP 400

    原因:

    • 以下数据之一或多个无效 - 班次时间,时区,休息时间,生效日期。
    • 输入包含超过两个休息时间。
    • 输入包含超过七个班次天数或休息天数。
    • 班次名称包含一个或多个特殊字符 - ~ , ` , # , % , & , + , = , [ , ] , { , } , | , ; , < , > , ^。
    • 休息时间重叠。
    • 休息时间超出班次时间。
    • 生效日期不大于当前日期。

    解决方案:
    请参考响应中的"details"键,查看输入中出错字段的API名称。

  • MANDATORY_NOT_FOUNDHTTP 400

    您没有在输入中指定班次时间的名称或时区。
    解决方案: 输入中的班次时间名称和时区是必须的。请参考响应中的详细信息键以找出缺失的键。

  • DEPENDENT_FIELD_MISSINGHTTP 400

    您没有指定一个或多个依赖字段。
    解决方案:

    • 对于自定义的工作时间,天数是必须的。
    • 当 same_as_everyday=true时,daily_timing是必须的。
    • 当 same_as_everyday=false时,custom_timing是必须的。

    请参考样本输入以了解这些键的结构。

  • LIMIT_EXCEEDEDHTTP 400

    您正在尝试为您的组织创建超过50个班次小时。
    解决方案:一个组织最多可以有50个班次小时。

  • NOT_ALLOWEDHTTP 400

    您正在尝试在为您的组织设置营业时间之前设置班次时间。
    解决方案:只有在添加营业时间后,您才能添加班次时间。

  • NOT_ALLOWEDHTTP 400

    您正在尝试设置超过两小时的休息时间。
    解决方案:每个班次的休息时间最多可以有两个小时。

  • INVALID_URL_PATTERNHTTP 404

    请检查尝试访问的URL是否正确
    解决方案:指定的请求URL不正确。请指定一个有效的请求URL。请参考上面的请求URL部分。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您没有正确的范围来访问此API。
    解决方案:使用ZohoCRM.settings.business_hours.ALL或ZohoCRM.settings.business_hours.CREATE范围创建新的令牌。

样本回应