笔记APIs
注释用于提供有关联系人、账户、交易或任务的一些额外信息。您可以在大多数模块中找到注释部分。因此,通过注释API,您可以创建、删除或更新注释。您可以对单个或多个注释执行操作。
获取笔记
目的
获取笔记列表。
端点
- GET /Notes
- GET /Notes/{note_id}
- GET /{module_API_name}/{record_ID}/Notes
Request 详情
Request URL
{api-domain}/crm/{version}/Notes
获取特定的笔记:
{api-domain}/crm/{version}/Notes/{note_id}
从特定记录中获取笔记:
{api-domain}/crm/{version}/{module_api_name}/{record_id}/Notes
Supported modules
潜在客户,账户,联系人,交易,活动,任务,案例,事件,呼叫,解决方案,产品,供应商,价格书,报价,销售订单,采购订单,发票,预约,服务和自定义
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.modules.ALL
(或者)
ZohoCRM.modules.{module_name}.{operation_type}
(和)
ZohoCRM.modules.notes.{operation_type}
可能的模块名称
潜在客户,账户,联系人,交易,活动,任务,事件,电话,案例,事件,电话,解决方案,产品,供应商,价格表,报价,销售订单,采购订单,发票,预约,服务和自定义
可能的操作类型
ALL - 完全访问笔记
READ - 获取笔记数据
参数
- page数字,可选
获取相应页面的记录列表。默认值为1。
- per_page数字,可选
获取每页可用的记录列表。默认值和可能的最大值为200。
- fields字符串,必填
指定您希望在响应中接收其详细信息的字段的API名称。
注意
- 您每次API调用最多可以获取200条记录。使用页面和每页参数进行分页,并在后续调用中获取剩余记录。
- 默认情况下,笔记在API响应中按时间顺序排序和显示,即最旧的笔记首先显示。然而,如果您在CRM的web UI中选择"最新优先",则会根据最新的笔记进行排序。请注意,您在web UI中选择的选项是特定于用户的,并适用于所有具有笔记作为相关列表的模块。
- 具有管理员权限的用户可以访问以下端点:GET /Notes。
样本请求
Response JSON 键
- 所有者JSON 对象
代表记录所有者的名称,ID和电子邮件。
- Modified_Time string
表示当前笔记最后一次修改的日期和时间。
- $attachments JSON array
表示附件的详细信息(如果当前笔记有的话)。
- Created_Time string
表示创建笔记的日期和时间。
- Parent_Id字符串
代表父记录的显示名称和唯一ID,以及父模块的API名称和ID。
- $editable boolean
表示用户是否可以编辑当前笔记。
true: 用户可以编辑当前笔记。
false: 用户无法编辑当前笔记。 - Modified_By JSON 对象
代表最后修改笔记的用户的姓名,ID和电子邮件。
- id string
表示当前笔记的唯一ID。
- Created_By JSON object
表示创建当前笔记的用户的姓名,ID和电子邮件。
- Note_Title string
代表当前笔记的标题。
- Note_Content string
代表当前笔记的内容。
- $is_shared_to_client布尔值
表示笔记是否与客户门户用户共享。
- size integer
表示语音笔记的大小(如果有的话),以字节为单位。
- $voice_note boolean
表示当前笔记是否附带有语音笔记。
可能的错误
- INVALID_MODULEHTTP 400
给出的模块名称似乎无效
解决方案:您指定的模块名称无效,或者没有标签权限,或者该模块可能已从可用模块中删除。请指定一个有效的模块API名称。 - INVALID_MODULEHTTP 400
给定的模块在API中不受支持
解决方案:当前API不支持诸如文档和项目等模块。(一旦这些模块得到支持,将不会显示此错误)。请指定一个有效的模块API名称。 - INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案:指定的请求URL不正确。请指定一个有效的请求URL。请参考上述请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有ZohoCRM.modules.notes.READ范围。创建一个具有有效范围的新客户端。请参考上面的范围部分。 - NO_PERMISSIONHTTP 403
拒绝访问笔记详情
解决方案:用户没有权限获取笔记数据。请联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系支持团队。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方案:您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考上面的端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限来阅读笔记
解决方案:用户没有权限获取笔记数据。请联系您的系统管理员。 - REQUIRED_PARAM_MISSINGHTTP 400
缺少预期的参数之一
解决方案:指定必需的参数。有关更多详细信息,请参阅上面的参数部分。