Get Calls Preferences

Enabling/Disabling the "From Number" and "To Number" preferences will add the "From Number" and/remove "ToNumber" fields to the Calls module, respectively.       

Purpose

Retrieve the Calls Preferences details in the Calls module of your Zoho CRM organization. The Call Preferences settings store the From Number and To Number along with details such as the Name, Call Type, Call Start Time, and other information about the caller or callee for all calls.

Endpoints

  • GET /settings/call_preferences

Request Details

Request URL

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

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.modules.READ
(or)
ZohoCRM.settings.modules.ALL 

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/call_preferences"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON

  • call_preferencesJSON object

    Contains the Call Preference details in the Calls module.

    • show_to_number Boolean

      Shows whether the "To Number" field is enabled or disabled.

    • show_from_number Boolean

      Shows whether the "From Number" field is enabled or disabled. 

Possible Errors

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL.
    Specify a valid request method. Refer to the Endpoints section.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: The client does not have a valid scope to know the call preferences details. Create a new token with valid scope. Refer to the Scope section.

  • AUTHENTICATION_FAILUREHTTP 401

    Authentication failed
    Resolution: Pass the access token in the request header of the API call.

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to the Request URL section. Refer to the Request URL section above.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in the server. Contact support team.

Sample Response

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