添加营业时间
目的
营业时间定义了一个组织的工作时间,通常基于公司的位置。
使用此API来设置您的组织的营业时间。您可以通过此API设置一周五天、一周七天的24小时营业时间,或者在每周的每一天设置自定义时间。
端点
- POST /settings/business_hours
Request详情
Request URL
{api-domain}/crm/{version}/settings/business_hours
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
X-CRM-ORG:{your_org_id}
范围
ZohoCRM.settings.business_hours.ALL
(或者)
ZohoCRM.settings.business_hours.CREATE
样本请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/business_hours"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST输入 JSON
- 类型字符串,必填
表示您是否希望设置五天或七天一周的营业时间,或自定义值。可能的值有24*7,24*5,和自定义。
- week_starts_on字符串,必填
您的业务开始的一周中的哪一天。可能的值包括星期日到星期六。
- business_daysJSON 数组,当您设置 type=24*5 或 custom时必填
您的业务运营的一周中的哪些天。当 type=24*5 或 custom时,此键是必填的。
- same_as_everyday布尔值,可选
表示营业时间是否每天都相同。当此值为 false时,JSON 数组 custom_timing 变为必填。当此值为 true时,JSON 数组 daily_timing 变为必填。
- daily_timingJSON 数组,当same_as_everyday为真时必填
以HH:mm格式表示一周的营业时间。例如:"daily_timing":["10:00","17:00"]
- custom_timingJSON 数组,当 same_as_everyday 为假时必填
数组中的每个 JSON 对象都包含以下键:
- days - 字符串,必填 - 有自定义营业时间的一周中的某一天。例如:"days":"Monday"。
- business_timing - JSON 数组,必填 - 该天的营业时间,格式为 HH:MM。例如:"business_timing":["10:00","17:00"]。
样本输入
Copied{
"business_hours": {
"business_days": [
"星期一",
"星期二",
"星期三",
"星期四",
"星期五"
],
"week_starts_on": "星期一",
"custom_timing": [
{
"days": "星期一",
"business_timing": [
"10:00",
"17:00"
]
},
{
"days": "星期二",
"business_timing": [
"10:30",
"17:00"
]
},
{
"days": "星期三",
"business_timing": [
"11:00",
"17:00"
]
},
{
"days": "星期四",
"business_timing": [
"09:00",
"18:30"
]
},
{
"days": "星期五",
"business_timing": [
"11:30",
"18:30"
]
}
],
"same_as_everyday": false,
"type": "custom"
}
}可能的错误
- MANDATORY_NOT_FOUNDHTTP 400
- 您没有在输入中指定type或week_starts_on键。
解决方案:输入中的type和week_starts_on键是必需的。参考响应中的详细信息键以找出缺失的键。 - 一个或多个必需的键缺失
解决方案:指定所有必需的键。检查输入JSON以确定所需的键。
- 您没有在输入中指定type或week_starts_on键。
- DEPENDENT_FIELD_MISSINGHTTP 400
您没有指定一个或多个依赖字段。
解决方案:- 对于 type=24*5 或 custom,business_days 是必需的。
- 对于 type=custom,same_as_everyday 是必需的。
- 当 same_as_everyday=true 时,daily_timing 是必需的。
- 当 same_as_everyday=false 时,custom_timing 是必需的。
请参考 输入 JSON 部分以了解每个键的结构。
- 无效数据HTTP 400
原因和解决方案:
- 对于type=24*5,您指定的时间超过或少于五个工作日。您必须准确输入五个工作日。
- type的值无效。可能的值是24*7,24*5和自定义。
- 您为business_days指定了无效的值。可能的值有星期日,星期一,星期二,星期三,星期四,星期五和星期六。
- 您为week_starts_on指定了无效的值。可能的值有星期日、星期一、星期二、星期三、星期四、星期五或星期六。
- 您为business_timing或daily_timing指定了无效的值。格式应为HH:mm。
- 要么custom_timing要么daily_timing超出了您的组织的营业时间。如果您的组织的营业时间是从上午10点到下午5点,那么任何特定日的营业时间必须在此时间段内。
- business_days键在输入中的值超过七个。这个数组中的最大值只能是七。请检查您的输入是否有任何重复或无效的值。
- 在"business_days"键中给出的值超过了"type"键中指定的值。请指定在允许的限制内的值。
- 输入主体中给出的数据无效。请指定有效值。请参考输入JSON以了解如何提供正确的值,或者查看上述的错误案例及其各自的解决方案。如果这些无法解决您的问题,请通过向我们发送电子邮件至support@zohocrm.com告知我们您的期望。
- NOT_ALLOWEDHTTP 400
您正在尝试在创建组织之前设置营业时间。
解决方案:只有在创建组织后,您才能添加营业时间。 - INVALID_URL_PATTERNHTTP 404
请检查试图访问的URL是否正确
解决方案:指定的RequestURL不正确。请指定一个有效的RequestURL。请参阅RequestURL部分以获取详细信息。 - OAUTH_SCOPE_MISMATCHHTTP 401
您没有正确的范围来访问此API。
解决方案:使用ZohoCRM.settings.business_hours.ALL或ZohoCRM.settings.business_hours.CREATE范围创建新的令牌。 - MINIMUM_DATA_NOT_FOUNDHTTP 400
给定的值小于"type"键中指定的所需值
解决方案:指定与"type"字段中给定值相对应的值。请参阅输入JSON以获取更多详细信息。 - DEPENDENT_MISMATCHHTTP 400
"结束时间"错误地放在了"开始时间"之前
解决方案:确保"结束时间"在"开始时间"之后指定。 - ALREADY_USEDHTTP 400
在 "business_days" JSON数组中提供了重复的天数
解决方案:"business_days"数组不应包含重复的值。例如,"星期一"不应出现超过一次。
样本回应
Copied{
"business_hours": {
"code": "成功",
"details": {
"id": "3652397000001438001"
},
"message": "营业时间成功保存",
"status": "成功"
}
}