Zoho crm Logo

获取富文本字段

富文本字段 允许用户输入最多 50,000 个字符 的格式化文本,包括 HTML 元素。它非常适合需要样式和结构的条目,例如产品描述或客户沟通。

目的

用于检索特定记录或多条记录的富文本字段及其内容。

端点

  • GET /{module_api_name}/{record_id}/actions/fetch_full_data
  • GET /{module_api_name}/{record_id}/actions/fetch_full_data?fields={rich_text_field_1},{rich_text_field_2},...
  • GET /{module_api_name}/actions/fetch_full_data?ids={record_id_1},{record_id_2},{record_id_3}...&fields={rich_text_field_1},{rich_text_field_2},...

请求详情

请求 URL

要为多个记录检索富文本字段:
{api-domain}/crm/{version}/{module_api_name}/actions/fetch_full_data?ids={record_id_1},{record_id_2},{record_id_3}...&fields={rich_text_field_1},{rich_text_field_2},... 
要为特定记录检索富文本字段:
{api-domain}/crm/{version}/{module_api_name}/{record_id}/actions/fetch_full_data

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.modules.ALL 
(或) 
ZohoCRM.modules.{module_name}.READ
 

参数

  • ids字符串,在检索多个记录的富文本字段时为必填项 

    指定要检索其富文本字段值的记录的唯一 ID。最多可指定 200 个记录 ID。

  • fields字符串,在检索多个记录的富文本字段时为必填项 

    指定要检索其值的富文本字段的 API 名称。若在获取特定记录的富文本字段时省略此参数,将返回该记录的所有富文本字段。

注意事项

  • 此 API 仅获取富文本字段及其数据。对其他任何字段类型的检索不支持。
  • 您只能从富文本多行字段中检索数据。检索其他类型的多行字段(例如 small 和 large)不支持。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/111112000000070427/actions/fetch_full_data"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

响应 JSON 键

  • id字符串

    表示该记录的 ID。

  • {rich_text_field_api_name}字符串

    包含特定富文本字段的值。请注意,此键会根据您模块中富文本字段的 API 名称而有所不同。

示例响应

Copied<p>{ "data": [ { "Multi_Line_RTF1": "<span style='\"background-color:rgb(255,'><b><i>Zoho CRM</i></b></span> can be easily customized to meet the specific needs of any business type and size. Modern CRM systems such as Zoho CRM are used by <b>初创企业、大型企业,以及房地产、医疗保健、保险、法律、媒体、餐饮、旅游、银行业、税务、自由职业者和非营利组织等垂直领域,以提升其在销售、市场营销和客户支持方面的成效</b>.", "Multi_Line_RTF2": "<span style='\"background-color:rgb(255,'><b><i>Zoho CRM</i></b></span> can be easily customized to meet the specific needs of any business type and size. Modern CRM systems such as Zoho CRM are used by <b>初创企业、大型企业,以及房地产、医疗保健、保险、法律、媒体、餐饮、旅游、银行业、税务、自由职业者和非营利组织等垂直领域,以提升其在销售、市场营销和客户支持方面的成效</b>.", "id": "111112000000070427" } ] }</p>

可能的错误

  • REQUIRED_PARAM_MISSINGHTTP 400

    缺少一个预期的参RAM数
    解决方案: 在检索多个记录的富文本字段时,fields 参RAM数和 ids 参RAM数为必填。

  • UNABLE_TO_PARSE_DATA_TYPEHTTP 400

    请求正文或参数的格式不正确
    解决方案:以正确的格式传递请求正文和参数。

  • INVALID_REQUESTHTTP 400

    无法处理您的请求。请核实您输入的方法名称、参数和参数值是否正确。该错误可能在以下情况下发生
     

    • 在为多个记录检索富文本字段时,如果参数中传入超过 200 个记录 ID。
    • 在为多个记录检索富文本字段时,如果参数中传入超过 8 个字段 API。

    解决方案:

    • 在为多个记录检索富文本字段时,请勿在参数中传入超过 200 个记录 ID。
    • 在为多个记录检索富文本字段时,请勿在参数中传入超过 8 个字段 API。
  • INVALID_DATAHTTP 400

    提供的记录 ID 似乎无效
    解决方案:请指定有效的记录 ID。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方案: 客户端没有有效的作用域来获取富文本字段值。请生成具有有效作用域的新令牌。请参考上面的作用域部分。

  • Authentication_失败HTTP 401

    Authentication 失败
    解决方案: 在 API 调用的请求头中传递访问令牌。

  • INVALID_URL_PATTERNHTTP 404

    请检查您尝试访问的 URL 是否正确
    解决方案: 指定的请求 URL 不正确。请指定有效的请求 URL。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方案:服务器中发生了意外且未处理的异常。请联系支持团队。