Zoho crm Logo

更新通话偏好设置

目的

在您的Zoho CRM组织中的通话模块中启用或禁用通话Preferences。

端点

  • PUT /settings/call_preferences

请求详情

请求 URL

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

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

ZohoCRM.settings.modules.UPDATE
(或)
ZohoCRM.settings.modules.ALL 

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/call_preferences"
-X PUT
-d "@updatepreferences.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

输入 JSON

  • call_preferencesJSON object

    包含通话偏好的详细信息在通话模块中。

    • show_to_number Boolean

      启用或禁用“目标号码”字段在通话模块中。

    • show_from_number Boolean

      启用或禁用“From号码”字段在通话模块中。

注意

  • 启用“From号码”或“收件人号码”Preferences将会在通话模块中添加相应的字段。请注意,如果您为这些字段中的任何一个启用了“标记为必填”选项,则您将无法通过UI或此API禁用通话Preferences选项。
  • 如果通话Preferences字段已在验证规则、布局规则或电话集成等功能中配置,则无法在通话模块中禁用这些字段。
  • 当集成电话扩展时,系统会自动启用通话模块中的From号码和收件人号码字段。

示例输入

Copied{
    "call_preferences": {
        "show_to_number": true,
        "show_from_number": true
    }
}

可能的错误

  • INVALID_DATAHTTP 400
    • 输入主体中提供的数据无效
      解决方法:指定有效的值及相应的数据类型。请参阅输入 JSON部分。
    • 输入主体不应为空
      解决方法:在输入主体中指定有效的值。请参阅输入 JSON部分。
    • 给定字段的数据类型无效
      解决方法:“show_to_number”和“show_from_number”数据类型均为布尔值。
  • NOT_ALLOWEDHTTP 400
    • Preferences 不能被禁用,如果 "From Number" 或 "To Number" 字段被标记为必填字段(强制字段)。
      解决方案: 只有在这些字段不是必填时,您才能禁用它们。
    • Preferences 不能被禁用,因为 "From Number" 和 "To Number" 字段正在其他配置中使用,例如布局规则、验证规则和电话集成。
      解决方案: 从配置中移除 From/To Number 字段,然后尝试禁用它们。
  • INVALID_REQUEST_METHODHTTP 400

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

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未授权
    解决方法:客户端没有有效的范围来更新通话模块中的通话偏好字段。请创建一个具有有效范围的新令牌。请参阅范围部分。

  • Authentication_FAILUREHTTP 401

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

  • INVALID_URL_PATTERNHTTP 404

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

  • INTERNAL_ERRORHTTP 500

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

示例响应

Copied{
    "call_preferences": {
        "code": "SUCCESS",
        "details": {},
        "message": "Calls preferences updated successfully",
        "status": "success"
    }
}