Zoho crm Logo

获取记录的电子邮件

电子邮件在潜在客户、联系人、交易、账户、报价、发票、销售订单、采购订单和自定义模块中作为相关列表可用。

目的

使用此API可以获取从任何受支持的模块中的记录发送/接收的电子邮件的详细信息。此API每次API调用返回十封电子邮件。要查看特定电子邮件的详细信息,请使用查看电子邮件API。

端点

GET /{module_api_name}/{record_id}/Emails

请求详情

Request URL

{api_domain}/crm/{version}/{module_api_name}/{record_id}/电子邮件

支持的模块

潜在客户,账户,联系人,交易,报价,发票,销售订单,采购订单,和自定义

头部

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.modules.READ
或
ZohoCRM.modules.{module_name}.READ
和
ZohoCRM.modules.emails.READ

可能的模块名称

潜在客户,账户,联系人,交易,报价,发票,销售订单,采购订单,和自定义

参数

  • typestring, optional

    请注意,当您没有指定这些参数中的任何一个时,您将收到用户和CRM发送的所有电子邮件的响应。
    如果用户没有配置电子邮件,响应将只包含CRM计划和发送的电子邮件。

    • sent_from_crm - 从CRM发送并与给定记录关联的电子邮件。
    • scheduled_in_crm - 计划从CRM发送的电子邮件。
    • drafts - 处于草稿状态的所有电子邮件的列表。
    • user_emails - 通过使用电子邮件集成使用IMAP/POP协议同步的您的电子邮件或共享用户的电子邮件。
    • 对于帐户模块,当:
      • all_contacts_sent_crm_emails - 从CRM发送给联系人的电子邮件。
      • all_contacts_scheduled_crm_emails - 计划从CRM发送给联系人的电子邮件。
      • all_contacts_draft_crm_emails - 与帐户关联的所有联系人的草稿邮件。
    • owner_id整数,可选

      您想要获取其电子邮件的用户的ID。请注意,您只能将此参数与 type=user_emails 一起使用。

  • 索引字符串,可选

    每个API返回前十封电子邮件,且响应中包含键"next_index"。在后续调用中使用此值作为"索引"以获取其他电子邮件。

注意

当你获取特定的电子邮件时,响应中的内容键代表电子邮件的正文。请注意,只有在获取特定的电子邮件时,你才能获取电子邮件的正文,而不能获取记录的所有电子邮件。

样本请求

可能的错误

  • CANNOT_PROCESSHTTP 400

    原因和解决方案:

    • 用于获取电子邮件列表的搜索功能暂时不可用。请过一段时间后再尝试使用API。
    • 当前用户配置的邮箱已被删除。重新配置电子邮件。
    • POP用户的邮箱已被删除,需要备份。如果当前用户是管理员,他们可以发起备份。
    • 用户在Zoho Mail中被停用。移除该用户。
    • 已为邮箱配置了IMAP,同步正在进行中或尚未开始。请等待同步完成后再获取与记录相关的电子邮件。
    • 您已设置Gmail API,但身份验证失败。重新配置Gmail API。

    请参考响应中的"details"键以获取确切的错误并相应地进行纠正。

  • INVALID_DATAHTTP 400

    记录ID无效。
    解决方案:在请求URL中指定有效的潜在客户、交易、联系人或账户ID。

  • INVALID_DATAHTTP 400

    "type"参数的值无效。
    解决方案:为参数指定一个有效的值。请参考"参数"部分以获取可能的值。

  • NO_PERMISSIONHTTP 403

    您没有权限在此模块中查看此记录的电子邮件。
    解决方案:联系您的管理员。

样本回应