获取用户不可用时间
目的
获取用户不可用的详细信息。Admin用户可以获取所有用户的详细信息,而非Admin用户只能获取自己的记录详细信息。
端点
- GET /settings/users_unavailability
- GET /settings/users_unavailability/{user_ID}
请求详情
请求 URL
全部 - {api-domain}/crm/{version}/settings/users_unavailability
特定 - {api-domain}/crm/{version}/settings/users_unavailability/{id}
标题
授权: Zoho-oauthtoken <access_token>
范围
scope=ZohoCRM.settings.users_unavailability.ALL
(或)
scope=ZohoCRM.settings.users_unavailability.READ
参数
- group_ids string, optional
用户所属组的唯一ID。要获取来自多个组的用户,请将它们的组ID作为逗号分隔的值输入。示例:group_ids=111999xxx0000,111xxxxx889966。
- role_ids string,optional
用户所属角色的唯一ID。要获取来自多个角色的用户,请将它们的角色ID作为逗号分隔的值输入。示例:role_ids=4678xxx0000,5678xxxxx966。
- territory_ids string, optional
用户所属区域的唯一ID。要获取属于多个区域的用户,请将其区域ID输入为逗号分隔的值。例如:territory_ids=3546xxx0000,4657xxxxx966。
- include_inner_details string, optional
使用此参数和值 user.zuid 在响应中获取用户的 ZUID。
- filtersJSON object,optional
根据用户不可用的时间段来筛选用户的标准。您可以根据以下组和比较器进行筛选:
group - 包含comparator、value和您希望根据其筛选结果的field的API名称。允许的比较器有equals、not_equals、between、greater_than、greater_equal、less_than和less_equal。
group_operator - 操作符and或or。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/users_unavailability?filters={"comparator":"equal","field":{"api_name":"to"},"value":"2021-02-18T03:30:00-11:00"}&include_inner_details=user.zuid"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET响应 JSON 键
- comments string
用户在标记自己不可用时添加的评论。
- from string
用户将不可用的开始日期和时间,采用ISO8601格式。
- to string
用户将不可用的日期和时间,采用ISO8601格式。
- id string
记录的唯一ID。
- user JSON object
您获取其不可用状态的用户的姓名和ID。如果您在请求中包含参数include_inner_details,该对象中还将包含用户的zuid。
- info JSON object
包含 per_page(每页显示的记录数),page(当前响应的页码),count(响应中显示的记录数),以及 more_records(表示是否在其他页面上有更多记录的布尔字段)。
可能的错误
- NO_CONTENTHTTP 204
没有可用的记录。
解决方法:创建一个记录以标记用户的不可用性。 - INVALID_REQUEST_METHODHTTP 400
您使用了无效的HTTP方法来访问此API。
解决方法:使用正确的HTTP方法。
示例响应
Copied{
"users_unavailability": [
{
"comments": "Unavailable",
"from": "2021-02-18T02:30:00-11:00",
"id": "554xxx01",
"to": "2021-02-18T03:30:00-11:00",
"user": {
"name": "Patricia Boyle",
"id": "554xxx11",
"zuid": "56xxx8"
}
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}