Zoho crm Logo

变量 API

一个CRM变量可以具有独特的值集合,并且可以广泛用于Email模板、邮件合并模板和Inventory模板中。您还可以将它们用作API中的可重用身份验证参数。

获取变量数据

目的

通过 API 请求检索所有可用的变量。

端点

  • GET /settings/variables
  • GET /settings/variables/{variable_id}?group={variable_group_id}

请求详情

请求 URL

{api-domain}/crm/{version}/settings/variables

获取特定变量:
{api-domain}/crm/{version}/settings/variables/{variable_id}?group={variable_group_id}

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.variables.{operation_type}

可能的操作类型

全部 - 完全访问变量数据
读取 - 获取变量数据

参数

  • group string,mandatory

    指定变量所属组的唯一ID/API名称。

注意

  • 在获取特定变量数据的情况下,组ID/组API名称是必需的。否则,系统会抛出错误。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/variables"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/crm/v8/settings/variables"
	type: GET
	connection:"crm_oauth_connection"
];
info response;

响应 JSON

  • api_namestring

    表示CRM变量的API名称。

  • namestring

    表示变量的显示名称。

  • descriptionstring

    表示变量的描述(如果有)。

  • idstring

    表示变量的唯一ID。

  • typestring

    表示变量的类型。它可以是:文本、整数、百分比、小数、货币、日期、日期时间、电子邮件、电话、网址、文本区域、复选框、长文本。

  • variable_groupJSON object

    表示当前变量所属的变量组的 API 名称和 ID。

  • valuestring

    表示变量的值(如果有)。

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

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

  • AUTHORIZATION_FAILEDHTTP 400

    用户没有足够的权限读取变量数据
    解决方法:用户没有权限检索变量数据。请联系系统管理员。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方案:客户端没有ZohoCRM.settings.variables.READ范围。创建一个具有有效范围的新客户端。请参阅上面的范围部分。

  • NO_PERMISSIONHTTP 403

    没有权限读取
    解决方案:用户没有读取变量数据的权限。请联系系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请检查尝试访问的URL是否正确
    解决方案: 请求的URL不正确。请指定一个有效的请求URL。请参阅上面的请求URL部分。

  • INTERNAL_ERRORHTTP 500

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

示例响应

Copied{
  "variables": [
    {
      "api_name": "sample1",
      "name": "SV1",
      "description": "This is a sample variable.",
      "id": "4150868000002146001",
      "type": "text",
      "variable_group": {
        "api_name": "General",
        "id": "4150868000000597005"
      },
      "value": ""
    },
    {
      "api_name": "sample2",
      "name": "SV2",
      "description": null,
      "id": "4150868000002517007",
      "type": "long",
      "variable_group": {
        "api_name": "General",
        "id": "4150868000000597005"
      },
      "value": ""
    },
    {
      "api_name": "sample3",
      "name": "SV3",
      "description": null,
      "id": "4150868000002517005",
      "type": "textarea",
      "variable_group": {
        "api_name": "General",
        "id": "4150868000000597005"
      },
      "value": ""
    },
    {
      "api_name": "Sample4",
      "name": "SV4",
      "description": null,
      "id": "4150868000002517003",
      "type": "datetime",
      "variable_group": {
        "api_name": "General",
        "id": "4150868000000597005"
      },
      "value": ""
    }
  ]
}