HonkIOHonkIO

API reference

Compliance / DNCL

CRTC Do Not Call List lookups (coming soon).

post/v1/compliance/dncl/check

Check if a phone number is on the CRTC Do Not Call List

Permissioncompliance:r

CRTC DNCL checking is coming soon: every call currently answers 501 DNCL_COMING_SOON.

Requires compliance:r.

Request body

FieldTypeDescription
phone_numberrequiredstring

Responses

  • 200The number's DNCL status, once DNCL checking is enabled. Field names are camelCase.
    FieldTypeDescription
    phoneNumberrequiredstring
    isRegisteredrequiredboolean
    checkedAtrequiredstring
    • Format: date-time
    fromCacherequiredboolean
  • 401Missing, invalid, revoked or expired API key.The standard error body.
  • 402The account has no balance, or a LIVE key was used before the first top-up.The standard error body.
  • 403The API key lacks the permission this operation requires, or the account is suspended or closed.The standard error body.
  • 422VALIDATION_ERROR: the request failed validation; details names the fields.The standard error body.
  • 429Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).The standard error body.
  • 500Unexpected server error.The standard error body.
  • 501DNCL_COMING_SOON: DNCL checking is not enabled yet.The standard error body.

Example

cURL
curl -X POST https://api.honkio.ca/v1/compliance/dncl/check \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+1613XXXXXXX"
  }'
post/v1/compliance/dncl/batch-check

Check multiple numbers against the CRTC DNCL

Permissioncompliance:r

CRTC DNCL checking is coming soon: every call currently answers 501 DNCL_COMING_SOON.

Requires compliance:r.

Request body

FieldTypeDescription
phone_numbersrequiredstring[]

Responses

  • 200Each number's DNCL status, once DNCL checking is enabled.
    FieldTypeDescription
    results[]requiredobject[]
    phoneNumberrequiredstring
    isRegisteredrequiredboolean
    checkedAtrequiredstring
    • Format: date-time
    fromCacherequiredboolean
  • 401Missing, invalid, revoked or expired API key.The standard error body.
  • 402The account has no balance, or a LIVE key was used before the first top-up.The standard error body.
  • 403The API key lacks the permission this operation requires, or the account is suspended or closed.The standard error body.
  • 422VALIDATION_ERROR: the request failed validation; details names the fields.The standard error body.
  • 429Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).The standard error body.
  • 500Unexpected server error.The standard error body.
  • 501DNCL_COMING_SOON: DNCL checking is not enabled yet.The standard error body.

Example

cURL
curl -X POST https://api.honkio.ca/v1/compliance/dncl/batch-check \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_numbers": [
      "+1613XXXXXXX"
    ]
  }'