Zoho crm Logo

特定功能信息

目的

获取有关您将分配区域给其或从其中移除区域的记录的详细信息。

请求详情

请求 URL

{api-domain}/crm/{version}/{module_api_name}/actions/get_feature_specific_info

支持的模块

潜在客户、Account、联系人和交易

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.modules.ALL/READ

可能的模块名称

线索,客户、联系人和交易

参数

  • 标识符可选

    表示您为其分配辖区或移除辖区的记录的唯一 ID。您可以指定用逗号分隔的最多 100 个记录 ID。您也可以不使用此参数,而是在模块的 API 名称之后,将记录 ID 包含在请求URL中。示例:crm/{version}/{module_api_name}/{record_id}actions/get_feature_specific_info。

  • features可选

    表示您想要获取其详细信息的功能。要获取已计划进行辖区分配或移除的记录的详细信息,该值为 territory_scheduled_jobs。

样本请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Accounts/actions/get_feature_specific_info?features=territory_scheduled_jobs&ids= 554023000003635023"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d @removeterritories.json
-X GET

响应 JSON 键

  • job_id string

    表示在您分配或移除区域时创建的作业 ID。

  • 来源字符串
    • 表示在分配或移除区域时该作业是如何被调度的。可能的取值为:
      • creation - 当在启用区域规则的模块中创建记录时,调度了该作业。
      • update - 当在启用区域规则的模块中更新记录时,调度了该作业。
      • manual_territory_removal - 当你使用移除区域 API 手动移除记录的区域时,调度了该作业。
      • manual_territory_assignment - 当你使用分配区域 API 手动为记录分配区域时,调度了该作业。
  • status string

    表示区域分配或移除作业的状态。可能的取值为 SCHEDULED 和 FAILED。

  • 类型 字符串

    值 territory_scheduled_jobs 表示该作业因区域分配或移除而被调度。

  • id string

    向其分配或从中移除辖区的记录的 ID。

可能的错误

  • INVALID_REQUEST_METHOD HTTP 400

    所用的 HTTP 请求方法类型无效
    解决方法: 您为访问 API URL 指定了无效的 HTTP 方法。请指定有效的请求方法。请参阅上面的端点部分。

  • TERRITORY_DISABLED HTTP 400

    此模块未启用区域功能。
    解决方案: 在该模块中启用区域管理。若希望为潜在客户模块启用区域规则,请联系 support@zohocrm.com。

  • INVALID_DATA HTTP 400

    URL 或 "ids" 参数中的记录 ID 无效。
    解决方案:为 URL 或 "ids" 参数中的记录指定正确的 ID。如果 "ids" 参数中的记录 ID 无效,响应中的 "details" 键将包含 "id" 键,其中包含该无效的 ID。如果记录 ID 位于 URL 中,"details" 键将包含 "resource_path_index",用于指示 URL 中无效数据的索引。

  • OAUTH_SCOPE_MISMATCH HTTP 401

    用于访问此 URL 的 OAuth 作用域无效
    解决方案:客户端不具备 ZohoCRM.modules.{module_name}.ALL/READ 作用域。创建一个具有有效作用域的新客户端。请参阅上方的作用域部分。

  • INTERNAL_ERROR HTTP 500

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

示例回应

Copied{
    "data": [
        {
            "features_info": [
                {
                    "details": [
                        {
                            "job_id": "554023000003908007",
                            "source": "manual_territory_assignment",
                            "status": "SCHEDULED"
                        }
                    ],
                    "type": "territory_scheduled_jobs"
                }
            ],
            "id": "554023000003635023"
        }
    ]
}