Skip to main content
POST
/
v1.5
/
GeoScrub
/
IsTimeLegalToCall
Returns a boolean true or false if a phone number call is permitted on a provided datetime. If the call is permitted, also provides number of seconds remaining in legal calling window.
curl --request POST \
  --url https://dataapi.dncscrub.com/v1.5/GeoScrub/IsTimeLegalToCall \
  --header 'Content-Type: application/json' \
  --header 'loginId: <api-key>' \
  --data '
{
  "IsTimeLegalToCall": [
    {
      "PhoneNumber": "<string>",
      "CallProposedDateTimeInUTC": "2023-11-07T05:31:56Z",
      "DNCProjId": "<string>"
    }
  ]
}
'
[
  {
    "Response": [
      {
        "PhoneNumber": "<string>",
        "IsCallPermitted": true,
        "SecondsInCallWindow": 123
      }
    ]
  }
]

Authorizations

loginId
string
header
required

LoginId Authentication: Authenticate using the LoginId generated from DNCScrub User Manager. In HTTP header place "loginId: {loginId}"

Headers

loginId
string

LoginId (aka APIKey)

Body

Response

Success

Response
object[] | null