Skip to main content
The get_legal_call_times tool returns the legal calling windows (start and end times in UTC) for phone numbers on a given date. Use this to schedule calls in advance or display available calling times to agents.

When to Use

  • Planning call schedules for future dates
  • Displaying legal calling windows to agents
  • Building call queues with time-aware scheduling

Parameters

phoneNumbers
array
required
Array of objects containing phone numbers and dates.
loginId
string
API key. Only required if not provided via the x-dncscrub-api-key HTTP header.

Response

success
boolean
Whether the API call succeeded.
results
array
Array of results, one per phone number.
errorCode
string
Machine-readable error code (when failed).
errorMessage
string
Human-readable error description (when failed).

Examples

{
  "phoneNumbers": [
    {
      "phoneNumber": "5039367187",
      "date": "2024-01-15"
    }
  ]
}

Usage Notes

  • Times are returned in UTC - convert to local time for display
  • Some dates may have no legal windows (holidays, emergencies)
  • Use numberOfDays to get windows for multiple consecutive days
  • For real-time “can I call now?” checks, use is_time_legal_to_call instead