Zoho crm Logo

获取预约偏好

目的

获取您的组织中的预约偏好详情。

端点

  • GET /settings/appointment_preferences

Request 详情

Request URL

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

标题

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope=ZohoCRM.settings.modules.{operation_type}

可能的操作类型

ALL - 对预约偏好数据的完全访问
READ - 检索预约偏好

参数

  • include optional

    在when_appointment_completed:create_deal时获取交易记录配置。
    可能的值:deal_record_configuration

样本请求

Response JSON Keys

  • allow_booking_outside_businesshours Boolean

    表示是否可以在营业时间外创建预约。
    可能的值:
    true:可以在营业时间外创建预约。
    false:不能在营业时间外创建预约。

  • allow_booking_outside_service_availability Boolean

    表示您是否可以在服务可用性之外创建预约。
    可能的值:
    true:您可以在服务可用性之外创建预约。
    false:您不能在服务可用性之外创建预约。

  • when_duration_exceeds sstring

    表示当服务持续时间结束时,谁需要将预约标记为'已完成'。
    可能的值:
    ask_appointment_provider_to_complete - 用户需要手动将预约标记为'已完成'。
    mark_as_complete -

    预约会自动标记为'已完成'。

  • show_job_sheet布尔值

    表示是否必须填写工作单才能将预约标记为“已完成”。
    可能的值:
    true:完成预约必须填写工作单。
    false:完成预约不必填写工作单。

  • when_appointment_completed string

    表示完成预约时是否需要创建交易。
    可能的值:
    create_deal - 任何预约标记为'已完成'时,都会创建交易。
    do_not_create_deal - 任何预约标记为'已完成'时,都不会创建交易。

  • deal_record_configurationJSON 对象

    包含了从预约模块中的交易记录配置的字段映射和布局细节。

可能的错误

  • API_NOT_SUPPORTEDHTTP 400

    此版本不支持API。
    解决方案:此API仅从版本3开始支持。

  • INVALID_REQUEST_METHODHTTP 400

    您给出了无效的HTTP请求方法类型。
    解决方案:在请求URL中只使用GET方法来访问此API。

  • INVALID_REQUESTHTTP 400

    您在参数或参数值中给出了无效的值。
    解决方案:只使用'include'参数,并将' deal_record_configuration '作为参数值来访问此API。

  • INVALID_TOKENHTTP 401

    您使用的oauth令牌无效。
    解决方案:您使用的访问令牌已过期。请刷新您的令牌并重试。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您使用错误的oauth范围创建了授权令牌。
    解决方案:使用ZohoCRM.settings.modules.READ或ZohoCRM.settings.modules.ALL范围来创建一个新的有效授权令牌。

  • INTERNAL_ERRORHTTP 500

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

样本回应