HonkIOHonkIO

Référence de l’API

Conformité / LNNTE

Consultations de la LNNTE du CRTC (bientôt disponible).

post/v1/compliance/dncl/check

Vérifier si un numéro de téléphone figure sur la Liste nationale de numéros de télécommunication exclus (LNNTE) du CRTC

Permissioncompliance:r

La vérification auprès de la LNNTE du CRTC arrive bientôt : chaque appel répond actuellement 501 DNCL_COMING_SOON.

Nécessite compliance:r.

Corps de la requête

ChampTypeDescription
phone_numberobligatoirestring

Réponses

  • 200Le statut LNNTE du numéro, une fois la vérification LNNTE activée. Les noms de champs sont en camelCase.
    ChampTypeDescription
    phoneNumberobligatoirestring
    isRegisteredobligatoireboolean
    checkedAtobligatoirestring
    • Format : date-time
    fromCacheobligatoireboolean
  • 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
  • 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
  • 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
  • 422VALIDATION_ERROR : la requête n’a pas passé la validation ; details indique les champs en cause.Le corps d’erreur standard.
  • 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
  • 500Erreur de serveur inattendue.Le corps d’erreur standard.
  • 501DNCL_COMING_SOON : la vérification auprès de la LNNTE n’est pas encore activée.Le corps d’erreur standard.

Exemple

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

Vérifier plusieurs numéros dans la LNNTE du CRTC

Permissioncompliance:r

La vérification auprès de la LNNTE du CRTC arrive bientôt : chaque appel répond actuellement 501 DNCL_COMING_SOON.

Nécessite compliance:r.

Corps de la requête

ChampTypeDescription
phone_numbersobligatoirestring[]

Réponses

  • 200Le statut LNNTE de chaque numéro, une fois la vérification auprès de la LNNTE activée.
    ChampTypeDescription
    results[]obligatoireobject[]
    phoneNumberobligatoirestring
    isRegisteredobligatoireboolean
    checkedAtobligatoirestring
    • Format : date-time
    fromCacheobligatoireboolean
  • 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
  • 402Le compte n’a aucun solde, ou une clé LIVE a été utilisée avant la première recharge.Le corps d’erreur standard.
  • 403La clé API ne dispose pas de la permission requise pour cette opération, ou le compte est suspendu ou fermé.Le corps d’erreur standard.
  • 422VALIDATION_ERROR : la requête n’a pas passé la validation ; details indique les champs en cause.Le corps d’erreur standard.
  • 429Limite de débit atteinte : 100 requêtes par seconde et par compte, ou une limite propre à la route (Retry-After est défini le cas échéant).Le corps d’erreur standard.
  • 500Erreur de serveur inattendue.Le corps d’erreur standard.
  • 501DNCL_COMING_SOON : la vérification auprès de la LNNTE n’est pas encore activée.Le corps d’erreur standard.

Exemple

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"
    ]
  }'