Call Times

Get All Predefined Call Time Settings

API: goGetAllCalltimes


Description

This endpoint retrieves all predefined call time configurations in the system. Each configuration defines allowed call time ranges for each day of the week, typically used for campaign scheduling or restrictions.

🔗 URL

https://DOMAIN.croco-dial.net/goAPIv2/goCalltimes/goAPI.php

Note: Replace DOMAIN with the specific domain you want to query.

📝 Required Parameters

Parameter Value Description
goAction goGetAllCalltimes Action to perform
goUser MyUser API authorized user.
goPass MyPass Authorized user's password.
responsetype json/xml Format of the response (json recommended).

Note: This endpoint uses body parameters for authentication instead of tokens or headers.

Request Examples:

GET:

curl -X GET "https://DOMAIN.croco-dial.net/goAPIv2/goCalltimes/goAPI.php?goAction=goGetAllCalltimes&goUser=MyUser&goPass=MyPass&responsetype=json"

POST (Form Data):

If you prefer to send the data as form parameters:

curl -X POST "https://DOMAIN.croco-dial.net/goAPIv2/goCalltimes/goAPI.php" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "goAction=goGetAllCalltimes" \
  --data-urlencode "goUser=MyUser" \
  --data-urlencode "goPass=MyPass" \
  --data-urlencode "responsetype=json"

  Example Response

{
    "result": "success",
    "call_time_id": [
        "24hrs",
        "7am6pm",
        "CLOSED",
        "7am6pmMF",
        "7am8pmMF",
        "24hours"
    ],
    "call_time_name": [
        "24 Hours",
        "7am6pm",
        "CLOSED",
        "7am6pm M to F",
        "7am8pmMF",
        "24 Hours"
    ],
    "ct_default_start": [
        0,
        700,
        2400,
        700,
        700,
        0
    ],
    "ct_default_stop": [
        2400,
        1800,
        2400,
        1800,
        2000,
        2400
    ],
    "ct_sunday_start": [
        0,
        0,
        0,
        0,
        900,
        0
    ],
    "ct_sunday_stop": [
        0,
        0,
        0,
        0,
        1700,
        0
    ],
    "ct_monday_start": [
        0,
        700,
        0,
        700,
        700,
        0
    ],
    "ct_monday_stop": [
        0,
        1800,
        0,
        1800,
        2000,
        0
    ],
    "ct_tuesday_start": [
        0,
        700,
        0,
        700,
        700,
        0
    ],
    "ct_tuesday_stop": [
        0,
        1800,
        0,
        1800,
        2000,
        0
    ],
    "ct_wednesday_start": [
        0,
        700,
        0,
        700,
        700,
        0
    ],
    "ct_wednesday_stop": [
        0,
        1800,
        0,
        1800,
        2000,
        0
    ],
    "ct_thursday_start": [
        0,
        700,
        0,
        700,
        700,
        0
    ],
    "ct_thursday_stop": [
        0,
        1800,
        0,
        1800,
        2000,
        0
    ],
    "ct_friday_start": [
        0,
        700,
        0,
        700,
        700,
        0
    ],
    "ct_friday_stop": [
        0,
        1800,
        0,
        1800,
        2000,
        0
    ],
    "ct_saturday_start": [
        0,
        700,
        0,
        0,
        700,
        0
    ],
    "ct_saturday_stop": [
        0,
        1600,
        0,
        0,
        1600,
        0
    ],
    "user_group": [
        "---ALL---",
        "---ALL---",
        "---ALL---",
        "---ALL---",
        "---ALL---",
        "---ALL---"
    ]
}

Get Specific Call Time Configuration

API: goGetCalltimeInfo


Description

This endpoint retrieves detailed information about a specific call time configurations. This includes the default call time ranges for each day of the week, any custom after-hours configurations, and comments associated with the call time settings. It is useful for understanding the permitted call windows and any specific rules applied to different days.

🔗 URL

https://DOMAIN.croco-dial.net/goAPIv2/goCalltimes/goAPI.php

Note: Replace DOMAIN with the specific domain you want to query.

📝 Required Parameters

Parameter Value Description
goAction goGetAllCalltimes Action to perform
goUser MyUser API authorized user.
goPass MyPass Authorized user's password.
call_time_id "weekdays-example" The ID of the call time configuration you want to retreive.
responsetype json/xml Format of the response (json recommended).

Note: This endpoint uses body parameters for authentication instead of tokens or headers.

Request Examples:

GET:

curl -X GET "https://DOMAIN.croco-dial.net/goAPIv2/goCalltimes/goAPI.php?goAction=goGetCalltimeInfo&goUser=MyUser&goPass=MyPass&responsetype=json&call_time_id=weekdays-example"

POST (Form Data):

If you prefer to send the data as form parameters:

curl -X POST "https://DOMAIN.croco-dial.net/goAPIv2/goCalltimes/goAPI.php" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "goAction=goGetCalltimeInfo" \
  --data-urlencode "goUser=MyUser" \
  --data-urlencode "goPass=MyPass" \
  --data-urlencode "responsetype=json" \
  --data-urlencode "call-time-id=weekdays-example" \

  Example Response

{
    "result": "success",
    "id": 14,
    "call_time_id": "weekdays-example",
    "call_time_name": "weekdays-example",
    "call_time_comments": "weekdays-example_7am6pm_7am4pm-Saturday",
    "ct_default_start": 700,
    "ct_default_stop": 1800,
    "ct_sunday_start": 0,
    "ct_sunday_stop": 0,
    "ct_monday_start": 700,
    "ct_monday_stop": 1800,
    "ct_tuesday_start": 700,
    "ct_tuesday_stop": 1800,
    "ct_wednesday_start": 700,
    "ct_wednesday_stop": 1800,
    "ct_thursday_start": 700,
    "ct_thursday_stop": 1800,
    "ct_friday_start": 700,
    "ct_friday_stop": 1800,
    "ct_saturday_start": 700,
    "ct_saturday_stop": 1600,
    "ct_state_call_times": "",
    "default_afterhours_filename_override": "",
    "sunday_afterhours_filename_override": "",
    "monday_afterhours_filename_override": "",
    "tuesday_afterhours_filename_override": "",
    "wednesday_afterhours_filename_override": "",
    "thursday_afterhours_filename_override": "",
    "friday_afterhours_filename_override": "",
    "saturday_afterhours_filename_override": "",
    "user_group": "---ALL---",
    "ct_holidays": ""
}

 

📌 Response Fields

Field Description
id The unique identifier for the call time entry.
call_time_id The ID of the call time configuration.
call_time_name The name of the call time configuration.
call_time_comments Additional comments or description for the call time configuration.
ct_default_start Default start time in military format (HHMM).
ct_default_stop Default stop time in military format (HHMM).
ct_sunday_start Call start time for Sunday (HHMM). The value 0 to use the default settings.
ct_sunday_stop Call stop time for Sunday (HHMM). The value 0 to use the default settings.
ct_state_call_times Custom state-specific call times, if any.
default_afterhours_filename_override Custom audio file for after-hours calls (default).
sunday_afterhours_filename_override Custom audio file for after-hours calls on Sunday.
user_group The user group associated with this call time configuration.
ct_holidays Configured holidays for the call time setting.