Numéros de téléphone

Lister les provinces et leurs indicatifs régionaux actifs

Réponses

• 200Provinces et leurs indicatifs régionaux actifs.›

  Champ	Type	Description
  data[]obligatoire	object[]
  provinceobligatoire	string
  countryobligatoire	string
  area_codesobligatoire	string[]
• 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.
• 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.

Exemple

const { data, error } = await honkio.phoneNumbers.areaCodes()
if (error) throw new Error(error.message)
console.log(data.data)

curl https://api.honkio.ca/v1/phone-numbers/area-codes \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Rechercher des numéros de téléphone canadiens disponibles à provisionner

Paramètres

Réponses

• 200Numéros disponibles. Un tableau simple, non enveloppé dans data.›

  Champ	Type	Description
  phone_numberobligatoire	string	E.164
  country_codeobligatoire	string
  area_codeobligatoire	string	Peut être null
  regionobligatoire	string	Province ou territoire, lorsque l’indicatif régional y correspond. Peut être null
  capabilitiesobligatoire	string[]
  monthly_cost_centsobligatoire	integer	Loyer récurrent en cents CAD, selon la catégorie (local ou sans frais) à laquelle ce numéro serait vendu.
  upfront_cost_centsobligatoire	integer	Le loyer du premier mois, facturé lors du provisionnement du numéro.
  activation_fee_centsobligatoire	integer	Frais d’activation uniques facturés avec le premier mois. Non remboursés à la libération.
  currencyobligatoire	string	Une valeur parmi : CAD
• 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 (details.area_codes énumère les indicatifs qui ne sont pas offerts) ou TOO_MANY_AREA_CODES.Le corps d’erreur standard.
• 429RATE_LIMITED : 30 recherches par minute et par compte, ou 100 requêtes par seconde.Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.
• 502NUMBER_SEARCH_FAILED : la recherche auprès de l’opérateur a échoué.Le corps d’erreur standard.

Exemple

const { data: available, error } = await honkio.phoneNumbers.search({ areaCodes: ['416', '647'], limit: 5 })
if (error) throw new Error(error.message)
for (const n of available) console.log(n.phone_number, n.monthly_cost_cents)

curl https://api.honkio.ca/v1/phone-numbers/search \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Lister les numéros de téléphone provisionnés du compte

Réponses

• 200Les numéros du compte, à l’exclusion des numéros libérés, des plus récents aux plus anciens. Non paginé.›

  Champ	Type	Description
  data[]obligatoire	object[]
  idobligatoire	string
  phone_numberobligatoire	string	E.164
  area_codeobligatoire	string
  regionobligatoire	string	Province ou territoire, lorsque l’indicatif régional y correspond. Peut être null
  capabilitiesobligatoire	string[]
  statusobligatoire	string	Une valeur parmi : ACTIVE | SUSPENDED | RELEASING | RELEASED
  monthly_cost_centsobligatoire	integer	Loyer récurrent en cents CAD.
  provisioned_atobligatoire	string	Format : date-time
  released_atobligatoire	string	Format : date-time Peut être null
  number_typeobligatoire	string	Les numéros sans frais (833, 844, 855, 866, 877, 888) doivent avoir une vérification sans frais approuvée avant de pouvoir envoyer des SMS. Une valeur parmi : local | toll_free
  toll_free_verificationobligatoire	object	La plus récente demande de vérification sans frais pour ce numéro, hors demandes annulées. Null pour un numéro local ou un numéro sans frais qui n’a jamais fait l’objet d’une demande. Peut être null
  idobligatoire	string	tfv_…
  statusobligatoire	string	Le numéro envoie des SMS dès que ce statut est APPROVED. Une valeur parmi : DRAFT | AWAITING_PAYMENT | IN_REVIEW | CHANGES_REQUESTED | SUBMITTED | APPROVED | REJECTED | DECLINED
• 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.
• 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.

Exemple

const { data, error } = await honkio.phoneNumbers.list()
if (error) throw new Error(error.message)
for (const n of data.data) console.log(n.phone_number, n.status)

curl https://api.honkio.ca/v1/phone-numbers \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Provisionner (acheter) un numéro de téléphone

Corps de la requête

Réponses

• 201Le numéro provisionné.›

  Champ	Type	Description
  idobligatoire	string
  phone_numberobligatoire	string	E.164
  area_codeobligatoire	string
  regionobligatoire	string	Province ou territoire, lorsque l’indicatif régional y correspond. Peut être null
  capabilitiesobligatoire	string[]
  statusobligatoire	string	Une valeur parmi : ACTIVE | SUSPENDED | RELEASING | RELEASED
  monthly_cost_centsobligatoire	integer	Loyer récurrent en cents CAD.
  provisioned_atobligatoire	string	Format : date-time
  released_atobligatoire	string	Format : date-time Peut être null
  number_typeobligatoire	string	Les numéros sans frais (833, 844, 855, 866, 877, 888) doivent avoir une vérification sans frais approuvée avant de pouvoir envoyer des SMS. Une valeur parmi : local | toll_free
  toll_free_verificationobligatoire	object	La plus récente demande de vérification sans frais pour ce numéro, hors demandes annulées. Null pour un numéro local ou un numéro sans frais qui n’a jamais fait l’objet d’une demande. Peut être null
  idobligatoire	string	tfv_…
  statusobligatoire	string	Le numéro envoie des SMS dès que ce statut est APPROVED. Une valeur parmi : DRAFT | AWAITING_PAYMENT | IN_REVIEW | CHANGES_REQUESTED | SUBMITTED | APPROVED | REJECTED | DECLINED
• 401Clé API manquante, invalide, révoquée ou expirée.Le corps d’erreur standard.
• 402INSUFFICIENT_BALANCE : le solde ne couvre pas le premier mois et les frais d’activation. RENT_OWED : un loyer est dû pour un numéro libéré pendant sa suspension; rechargez d’abord pour le payer. Rien n’a été facturé ni commandé.Le corps d’erreur standard.
• 403NUMBER_LIMIT_REACHED (details contient limit et used), LIVE_KEY_REQUIRED (les clés de test ne peuvent pas provisionner) ou ACCOUNT_NOT_VERIFIED (le compte n’a pas vérifié de numéro mobile du propriétaire).Le corps d’erreur standard.
• 409CONFLICT (le numéro est déjà détenu), PURCHASE_IN_PROGRESS (un autre achat est en cours pour ce compte ; réessayez sous peu) ou COMPED_TOLL_FREE (les numéros sans frais ne sont pas offerts pour ce compte).Le corps d’erreur standard.
• 422NON_CANADIAN_NUMBER ou VALIDATION_ERROR.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.
• 500INTERNAL_ERROR : la facturation a échoué pour une raison autre que le solde.Le corps d’erreur standard.
• 501TOLLFREE_800_COMING_SOON : les numéros 1-800 ne sont pas encore offerts.Le corps d’erreur standard.
• 502PROVISIONING_FAILED : l’opérateur n’a pas provisionné le numéro. Le montant facturé est remboursé.Le corps d’erreur standard.

Exemple

const { data: number, error } = await honkio.phoneNumbers.provision({ phoneNumber: '+1416XXXXXXX' })
if (error) throw new Error(error.message)
console.log(number.id, number.status)

curl -X POST https://api.honkio.ca/v1/phone-numbers \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+1613XXXXXXX"
  }'

Obtenir un numéro de téléphone par identifiant

Paramètres

Réponses

• 200Le numéro, y compris s’il a été libéré.›

  Champ	Type	Description
  idobligatoire	string
  phone_numberobligatoire	string	E.164
  area_codeobligatoire	string
  regionobligatoire	string	Province ou territoire, lorsque l’indicatif régional y correspond. Peut être null
  capabilitiesobligatoire	string[]
  statusobligatoire	string	Une valeur parmi : ACTIVE | SUSPENDED | RELEASING | RELEASED
  monthly_cost_centsobligatoire	integer	Loyer récurrent en cents CAD.
  provisioned_atobligatoire	string	Format : date-time
  released_atobligatoire	string	Format : date-time Peut être null
  number_typeobligatoire	string	Les numéros sans frais (833, 844, 855, 866, 877, 888) doivent avoir une vérification sans frais approuvée avant de pouvoir envoyer des SMS. Une valeur parmi : local | toll_free
  toll_free_verificationobligatoire	object	La plus récente demande de vérification sans frais pour ce numéro, hors demandes annulées. Null pour un numéro local ou un numéro sans frais qui n’a jamais fait l’objet d’une demande. Peut être null
  idobligatoire	string	tfv_…
  statusobligatoire	string	Le numéro envoie des SMS dès que ce statut est APPROVED. Une valeur parmi : DRAFT | AWAITING_PAYMENT | IN_REVIEW | CHANGES_REQUESTED | SUBMITTED | APPROVED | REJECTED | DECLINED
• 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.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.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.

Exemple

const { data, error } = await honkio.phoneNumbers.get('NUMBER_ID')
if (error) throw new Error(error.message)
console.log(data.phone_number, data.status)

curl https://api.honkio.ca/v1/phone-numbers/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Libérer (annuler) un numéro de téléphone

Paramètres

Réponses

• 204Libéré, ou déjà libéré chez l’opérateur.
• 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.
• 403LIVE_KEY_REQUIRED : les clés de test ne peuvent pas accéder ici aux ressources de production. Aussi FORBIDDEN lorsque la clé ne dispose pas de la permission requise par cette opération, ou lorsque le compte est suspendu ou fermé.Le corps d’erreur standard.
• 404NOT_FOUND : aucun numéro correspondant sur ce compte, ou il a déjà été libéré.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.
• 502RELEASE_FAILED : l’opérateur n’a pas accepté la libération. Le numéro vous appartient toujours, inchangé ; réessayez.Le corps d’erreur standard.

Exemple

const { error } = await honkio.phoneNumbers.release('NUMBER_ID')
if (error) throw new Error(error.message)

curl -X DELETE https://api.honkio.ca/v1/phone-numbers/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Lister vos demandes d’allocation de numéros de téléphone

Réponses

• 200Les demandes d’allocation du compte, des plus récentes aux plus anciennes.›

  Champ	Type	Description
  data[]obligatoire	object[]
  idobligatoire	string
  requested_limitobligatoire	integer	Nombre total de numéros demandés, et non un incrément.
  limit_at_requestobligatoire	integer
  held_at_requestobligatoire	integer
  reasonobligatoire	string
  statusobligatoire	string	Une valeur parmi : PENDING | APPROVED | DENIED
  granted_limitobligatoire	integer	Peut être null
  staff_noteobligatoire	string	Peut être null
  decided_atobligatoire	string	Format : date-time Peut être null
  created_atobligatoire	string	Format : date-time
• 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.
• 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.

Exemple

curl https://api.honkio.ca/v1/phone-numbers/allowance-requests \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Demander une allocation de numéros de téléphone plus élevée

Corps de la requête

Réponses

• 201La demande, en attente d’examen.›

  Champ	Type	Description
  idobligatoire	string
  requested_limitobligatoire	integer	Nombre total de numéros demandés, et non un incrément.
  limit_at_requestobligatoire	integer
  held_at_requestobligatoire	integer
  reasonobligatoire	string
  statusobligatoire	string	Une valeur parmi : PENDING | APPROVED | DENIED
  granted_limitobligatoire	integer	Peut être null
  staff_noteobligatoire	string	Peut être null
  decided_atobligatoire	string	Format : date-time Peut être null
  created_atobligatoire	string	Format : date-time
• 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.
• 403BUSINESS_VERIFICATION_REQUIRED : vérifiez d’abord votre entreprise (PUT /v1/business-verification, puis soumettez-la). Aussi LIVE_KEY_REQUIRED pour une clé de test, ou FORBIDDEN lorsque la clé ne dispose pas de la permission requise par cette opération.Le corps d’erreur standard.
• 409ALLOWANCE_REQUEST_PENDING : une demande est déjà en attente.Le corps d’erreur standard.
• 422VALIDATION_ERROR, ou INVALID_ALLOWANCE_REQUEST lorsque requested_limit n’est pas supérieur à la limite actuelle.Le corps d’erreur standard.
• 429RATE_LIMITED : 3 requêtes par jour et par compte.Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

curl -X POST https://api.honkio.ca/v1/phone-numbers/allowance-requests \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "requested_limit": 2,
    "reason": "..."
  }'

Lister les options de vérification sans frais

Réponses

• 200Les listes d’options et les frais.›

  Champ	Type	Description
  use_cases[]obligatoire	object[]
  valueobligatoire	string
  label_enobligatoire	string
  label_frobligatoire	string
  monthly_volumes[]obligatoire	object[]
  valueobligatoire	string
  label_enobligatoire	string
  label_frobligatoire	string
  entity_types[]obligatoire	object[]
  valueobligatoire	string
  label_enobligatoire	string
  label_frobligatoire	string
  provinces[]obligatoire	object[]
  valueobligatoire	string
  label_enobligatoire	string
  label_frobligatoire	string
  fee_centsobligatoire	integer	Les frais de vérification, en cents CAD, facturés une seule fois par demande.
• 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.
• 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.

Exemple

const { data: options, error } = await honkio.tollFreeVerifications.options()
if (error) throw new Error(error.message)
for (const u of options.use_cases) console.log(u.value, u.label_en)
console.log(options.fee_cents)

curl https://api.honkio.ca/v1/toll-free-verifications/options \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Lister les demandes de vérification sans frais

Paramètres

Réponses

• 200Les demandes du compte, de la plus récente à la plus ancienne.›

  Champ	Type	Description
  data[]obligatoire	object[]
  idobligatoire	string
  statusobligatoire	string	DRAFT, puis AWAITING_PAYMENT, IN_REVIEW (équipe HonkIO), SUBMITTED (chez l’opérateur) et APPROVED. Une demande CHANGES_REQUESTED ou REJECTED (par l’opérateur) peut être modifiée et soumise de nouveau, et une demande REJECTED peut être retirée (CANCELLED) ; DECLINED (par HonkIO) et CANCELLED sont définitifs. Une valeur parmi : DRAFT | AWAITING_PAYMENT | IN_REVIEW | CHANGES_REQUESTED | SUBMITTED | APPROVED | REJECTED | DECLINED | CANCELLED
  phone_numbers[]obligatoire	object[]
  idobligatoire	string
  phone_numberobligatoire	string
  applicationobligatoire	object	La demande telle qu’elle est enregistrée : tous les champs, avec le numéro d’entreprise, le code postal et le téléphone normalisés.
  business_nameobligatoire	string
  doing_business_asobligatoire	string	Peut être null
  entity_typeobligatoire	string	Une valeur parmi : SOLE_PROPRIETOR | PRIVATE_PROFIT | PUBLIC_PROFIT | NON_PROFIT | GOVERNMENT
  business_registration_numberobligatoire	string
  business_addressobligatoire	object
  line1obligatoire	string
  cityobligatoire	string
  provinceobligatoire	string
  postal_codeobligatoire	string
  contactobligatoire	object
  first_nameobligatoire	string
  last_nameobligatoire	string
  emailobligatoire	string
  phoneobligatoire	string
  websiteobligatoire	string
  use_caseobligatoire	string	Une valeur parmi : 2FA | App Notifications | Appointments | Auctions | Auto Repair Services | Bank Transfers | Billing | Booking Confirmations | Business Updates | COVID-19 Alerts | Career Training | Chatbot | Conversational / Alerts | Courier Services & Deliveries | Emergency Alerts | Events & Planning | Financial Services | Fraud Alerts | Fundraising | General Marketing | General School Updates | HR / Staffing | Healthcare Alerts | Housing Community Updates | Insurance Services | Job Dispatch | Legal Services | Mixed | Motivational Reminders | Notary Notifications | Order Notifications | Political | Public Works | Real Estate Services | Religious Services | Repair and Diagnostics Alerts | Rewards Program | Surveys | System Alerts | Voting Reminders | Waitlist Alerts | Webinar Reminders | Workshop Alerts
  use_case_summaryobligatoire	string
  sample_messagesobligatoire	string[]
  opt_in_workflowobligatoire	string
  opt_in_image_urlsobligatoire	string[]
  opt_in_confirmation_messageobligatoire	string
  help_messageobligatoire	string
  privacy_policy_urlobligatoire	string
  terms_urlobligatoire	string	Peut être null
  monthly_volumeobligatoire	string	Une valeur parmi : 10 | 100 | 1,000 | 10,000 | 100,000 | 250,000 | 500,000 | 750,000 | 1,000,000 | 5,000,000 | 10,000,000+
  age_gatedobligatoire	boolean
  additional_informationobligatoire	string	Peut être null
  fee_centsobligatoire	integer	Les frais de vérification de cette demande, en cents CAD.
  payment_urlobligatoire	string	Pendant AWAITING_PAYMENT : la page du tableau de bord où les frais sont payés. Null autrement. Peut être null
  paid_atobligatoire	string	Format : date-time Peut être null
  refunded_atobligatoire	string	Format : date-time Peut être null
  reviewer_noteobligatoire	string	Ce que l’équipe HonkIO a demandé de modifier, ou la raison pour laquelle elle a refusé la demande. Peut être null
  carrier_statusobligatoire	string	Où en est l’examen de l’opérateur une fois qu’il a reçu la demande : pending, action_needed (l’opérateur a posé une question à HonkIO ; rien à faire de votre côté pour l’instant), approved ou rejected. Null avant la soumission. Une valeur parmi : pending | action_needed | approved | rejected Peut être null
  carrier_rejection_reasonobligatoire	string	La raison pour laquelle l’opérateur a rejeté la demande, le cas échéant. Peut être null
  submitted_atobligatoire	string	Format : date-time Peut être null
  decided_atobligatoire	string	Le moment où l’opérateur l’a approuvée ou rejetée. Format : date-time Peut être null
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
• 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.
• 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.

Exemple

const { data, error } = await honkio.tollFreeVerifications.list({ status: 'CHANGES_REQUESTED' })
if (error) throw new Error(error.message)
for (const v of data.data) console.log(v.id, v.reviewer_note)

curl https://api.honkio.ca/v1/toll-free-verifications \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Créer une demande de vérification sans frais

Corps de la requête

Réponses

• 201La demande, à l’état DRAFT.›

  Champ	Type	Description
  idobligatoire	string
  statusobligatoire	string	DRAFT, puis AWAITING_PAYMENT, IN_REVIEW (équipe HonkIO), SUBMITTED (chez l’opérateur) et APPROVED. Une demande CHANGES_REQUESTED ou REJECTED (par l’opérateur) peut être modifiée et soumise de nouveau, et une demande REJECTED peut être retirée (CANCELLED) ; DECLINED (par HonkIO) et CANCELLED sont définitifs. Une valeur parmi : DRAFT | AWAITING_PAYMENT | IN_REVIEW | CHANGES_REQUESTED | SUBMITTED | APPROVED | REJECTED | DECLINED | CANCELLED
  phone_numbers[]obligatoire	object[]
  idobligatoire	string
  phone_numberobligatoire	string
  applicationobligatoire	object	La demande telle qu’elle est enregistrée : tous les champs, avec le numéro d’entreprise, le code postal et le téléphone normalisés.
  business_nameobligatoire	string
  doing_business_asobligatoire	string	Peut être null
  entity_typeobligatoire	string	Une valeur parmi : SOLE_PROPRIETOR | PRIVATE_PROFIT | PUBLIC_PROFIT | NON_PROFIT | GOVERNMENT
  business_registration_numberobligatoire	string
  business_addressobligatoire	object
  line1obligatoire	string
  cityobligatoire	string
  provinceobligatoire	string
  postal_codeobligatoire	string
  contactobligatoire	object
  first_nameobligatoire	string
  last_nameobligatoire	string
  emailobligatoire	string
  phoneobligatoire	string
  websiteobligatoire	string
  use_caseobligatoire	string	Une valeur parmi : 2FA | App Notifications | Appointments | Auctions | Auto Repair Services | Bank Transfers | Billing | Booking Confirmations | Business Updates | COVID-19 Alerts | Career Training | Chatbot | Conversational / Alerts | Courier Services & Deliveries | Emergency Alerts | Events & Planning | Financial Services | Fraud Alerts | Fundraising | General Marketing | General School Updates | HR / Staffing | Healthcare Alerts | Housing Community Updates | Insurance Services | Job Dispatch | Legal Services | Mixed | Motivational Reminders | Notary Notifications | Order Notifications | Political | Public Works | Real Estate Services | Religious Services | Repair and Diagnostics Alerts | Rewards Program | Surveys | System Alerts | Voting Reminders | Waitlist Alerts | Webinar Reminders | Workshop Alerts
  use_case_summaryobligatoire	string
  sample_messagesobligatoire	string[]
  opt_in_workflowobligatoire	string
  opt_in_image_urlsobligatoire	string[]
  opt_in_confirmation_messageobligatoire	string
  help_messageobligatoire	string
  privacy_policy_urlobligatoire	string
  terms_urlobligatoire	string	Peut être null
  monthly_volumeobligatoire	string	Une valeur parmi : 10 | 100 | 1,000 | 10,000 | 100,000 | 250,000 | 500,000 | 750,000 | 1,000,000 | 5,000,000 | 10,000,000+
  age_gatedobligatoire	boolean
  additional_informationobligatoire	string	Peut être null
  fee_centsobligatoire	integer	Les frais de vérification de cette demande, en cents CAD.
  payment_urlobligatoire	string	Pendant AWAITING_PAYMENT : la page du tableau de bord où les frais sont payés. Null autrement. Peut être null
  paid_atobligatoire	string	Format : date-time Peut être null
  refunded_atobligatoire	string	Format : date-time Peut être null
  reviewer_noteobligatoire	string	Ce que l’équipe HonkIO a demandé de modifier, ou la raison pour laquelle elle a refusé la demande. Peut être null
  carrier_statusobligatoire	string	Où en est l’examen de l’opérateur une fois qu’il a reçu la demande : pending, action_needed (l’opérateur a posé une question à HonkIO ; rien à faire de votre côté pour l’instant), approved ou rejected. Null avant la soumission. Une valeur parmi : pending | action_needed | approved | rejected Peut être null
  carrier_rejection_reasonobligatoire	string	La raison pour laquelle l’opérateur a rejeté la demande, le cas échéant. Peut être null
  submitted_atobligatoire	string	Format : date-time Peut être null
  decided_atobligatoire	string	Le moment où l’opérateur l’a approuvée ou rejetée. Format : date-time Peut être null
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
• 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.
• 409NUMBER_IN_OPEN_VERIFICATION : un numéro figure déjà dans une autre demande en cours (details.phone_number_id).Le corps d’erreur standard.
• 422VALIDATION_ERROR (details nomme les champs), NOT_A_TOLL_FREE_NUMBER (un numéro ne fait pas partie de vos numéros sans frais ; details.phone_number_id) ou LIVE_MODE_REQUIRED pour une clé de test.Le corps d’erreur standard.
• 429RATE_LIMITED : 10 nouvelles demandes par jour par compte.Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

const { data: application, error } = await honkio.tollFreeVerifications.create({
  phoneNumberIds: ['NUMBER_ID'], // your toll-free numbers, 1 to 5
  application: {
    businessName: 'Acme Clinics Inc.',
    entityType: 'PRIVATE_PROFIT',
    businessRegistrationNumber: '123456789RC0001',
    businessAddress: { line1: '100 King St W', city: 'Toronto', province: 'ON', postalCode: 'M5X 1A9' },
    contact: { firstName: 'Ada', lastName: 'Lovelace', email: 'ada@acme.ca', phone: '+1416XXXXXXX' },
    website: 'https://acme.ca',
    useCase: 'Appointments',
    useCaseSummary: 'Appointment reminders for our patients.',
    sampleMessages: ['Acme Clinics: your appointment is tomorrow at 2 pm. Reply STOP to opt out.'],
    optInWorkflow: 'Patients tick an unchecked SMS box on the booking form.',
    optInImageUrls: ['https://acme.ca/img/booking-form-sms-box.png'],
    optInConfirmationMessage: 'Acme Clinics: you are subscribed to appointment texts. Reply STOP to opt out.',
    helpMessage: 'Acme Clinics: visit acme.ca/help. Reply STOP to opt out.',
    privacyPolicyUrl: 'https://acme.ca/privacy',
    monthlyVolume: '10,000',
  },
})
if (error) throw new Error(`${error.name}: ${error.message}`)
console.log(application.id, application.status) // 'DRAFT'

curl -X POST https://api.honkio.ca/v1/toll-free-verifications \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number_ids": [
      "+1613XXXXXXX"
    ],
    "application": {
      "business_name": "...",
      "entity_type": "SOLE_PROPRIETOR",
      "business_registration_number": "+1613XXXXXXX",
      "business_address": {
        "line1": "...",
        "city": "...",
        "province": "AB",
        "postal_code": "..."
      },
      "contact": {
        "first_name": "...",
        "last_name": "...",
        "email": "sam@example.com",
        "phone": "+1613XXXXXXX"
      },
      "website": "...",
      "use_case": "2FA",
      "use_case_summary": "...",
      "sample_messages": [
        "..."
      ],
      "opt_in_workflow": "...",
      "opt_in_image_urls": [
        "..."
      ],
      "opt_in_confirmation_message": "...",
      "help_message": "...",
      "privacy_policy_url": "https://example.com/webhooks/honkio",
      "monthly_volume": "10"
    }
  }'

Obtenir une demande de vérification sans frais

Paramètres

Réponses

• 200La demande.›

  Champ	Type	Description
  idobligatoire	string
  statusobligatoire	string	DRAFT, puis AWAITING_PAYMENT, IN_REVIEW (équipe HonkIO), SUBMITTED (chez l’opérateur) et APPROVED. Une demande CHANGES_REQUESTED ou REJECTED (par l’opérateur) peut être modifiée et soumise de nouveau, et une demande REJECTED peut être retirée (CANCELLED) ; DECLINED (par HonkIO) et CANCELLED sont définitifs. Une valeur parmi : DRAFT | AWAITING_PAYMENT | IN_REVIEW | CHANGES_REQUESTED | SUBMITTED | APPROVED | REJECTED | DECLINED | CANCELLED
  phone_numbers[]obligatoire	object[]
  idobligatoire	string
  phone_numberobligatoire	string
  applicationobligatoire	object	La demande telle qu’elle est enregistrée : tous les champs, avec le numéro d’entreprise, le code postal et le téléphone normalisés.
  business_nameobligatoire	string
  doing_business_asobligatoire	string	Peut être null
  entity_typeobligatoire	string	Une valeur parmi : SOLE_PROPRIETOR | PRIVATE_PROFIT | PUBLIC_PROFIT | NON_PROFIT | GOVERNMENT
  business_registration_numberobligatoire	string
  business_addressobligatoire	object
  line1obligatoire	string
  cityobligatoire	string
  provinceobligatoire	string
  postal_codeobligatoire	string
  contactobligatoire	object
  first_nameobligatoire	string
  last_nameobligatoire	string
  emailobligatoire	string
  phoneobligatoire	string
  websiteobligatoire	string
  use_caseobligatoire	string	Une valeur parmi : 2FA | App Notifications | Appointments | Auctions | Auto Repair Services | Bank Transfers | Billing | Booking Confirmations | Business Updates | COVID-19 Alerts | Career Training | Chatbot | Conversational / Alerts | Courier Services & Deliveries | Emergency Alerts | Events & Planning | Financial Services | Fraud Alerts | Fundraising | General Marketing | General School Updates | HR / Staffing | Healthcare Alerts | Housing Community Updates | Insurance Services | Job Dispatch | Legal Services | Mixed | Motivational Reminders | Notary Notifications | Order Notifications | Political | Public Works | Real Estate Services | Religious Services | Repair and Diagnostics Alerts | Rewards Program | Surveys | System Alerts | Voting Reminders | Waitlist Alerts | Webinar Reminders | Workshop Alerts
  use_case_summaryobligatoire	string
  sample_messagesobligatoire	string[]
  opt_in_workflowobligatoire	string
  opt_in_image_urlsobligatoire	string[]
  opt_in_confirmation_messageobligatoire	string
  help_messageobligatoire	string
  privacy_policy_urlobligatoire	string
  terms_urlobligatoire	string	Peut être null
  monthly_volumeobligatoire	string	Une valeur parmi : 10 | 100 | 1,000 | 10,000 | 100,000 | 250,000 | 500,000 | 750,000 | 1,000,000 | 5,000,000 | 10,000,000+
  age_gatedobligatoire	boolean
  additional_informationobligatoire	string	Peut être null
  fee_centsobligatoire	integer	Les frais de vérification de cette demande, en cents CAD.
  payment_urlobligatoire	string	Pendant AWAITING_PAYMENT : la page du tableau de bord où les frais sont payés. Null autrement. Peut être null
  paid_atobligatoire	string	Format : date-time Peut être null
  refunded_atobligatoire	string	Format : date-time Peut être null
  reviewer_noteobligatoire	string	Ce que l’équipe HonkIO a demandé de modifier, ou la raison pour laquelle elle a refusé la demande. Peut être null
  carrier_statusobligatoire	string	Où en est l’examen de l’opérateur une fois qu’il a reçu la demande : pending, action_needed (l’opérateur a posé une question à HonkIO ; rien à faire de votre côté pour l’instant), approved ou rejected. Null avant la soumission. Une valeur parmi : pending | action_needed | approved | rejected Peut être null
  carrier_rejection_reasonobligatoire	string	La raison pour laquelle l’opérateur a rejeté la demande, le cas échéant. Peut être null
  submitted_atobligatoire	string	Format : date-time Peut être null
  decided_atobligatoire	string	Le moment où l’opérateur l’a approuvée ou rejetée. Format : date-time Peut être null
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
• 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.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.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.

Exemple

const { data, error } = await honkio.tollFreeVerifications.get('VERIFICATION_ID')
if (error) throw new Error(error.message)
console.log(data.status, data.reviewer_note, data.carrier_rejection_reason)

curl https://api.honkio.ca/v1/toll-free-verifications/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Modifier une demande de vérification sans frais

Paramètres

Corps de la requête

Réponses

• 200La demande modifiée.›

  Champ	Type	Description
  idobligatoire	string
  statusobligatoire	string	DRAFT, puis AWAITING_PAYMENT, IN_REVIEW (équipe HonkIO), SUBMITTED (chez l’opérateur) et APPROVED. Une demande CHANGES_REQUESTED ou REJECTED (par l’opérateur) peut être modifiée et soumise de nouveau, et une demande REJECTED peut être retirée (CANCELLED) ; DECLINED (par HonkIO) et CANCELLED sont définitifs. Une valeur parmi : DRAFT | AWAITING_PAYMENT | IN_REVIEW | CHANGES_REQUESTED | SUBMITTED | APPROVED | REJECTED | DECLINED | CANCELLED
  phone_numbers[]obligatoire	object[]
  idobligatoire	string
  phone_numberobligatoire	string
  applicationobligatoire	object	La demande telle qu’elle est enregistrée : tous les champs, avec le numéro d’entreprise, le code postal et le téléphone normalisés.
  business_nameobligatoire	string
  doing_business_asobligatoire	string	Peut être null
  entity_typeobligatoire	string	Une valeur parmi : SOLE_PROPRIETOR | PRIVATE_PROFIT | PUBLIC_PROFIT | NON_PROFIT | GOVERNMENT
  business_registration_numberobligatoire	string
  business_addressobligatoire	object
  line1obligatoire	string
  cityobligatoire	string
  provinceobligatoire	string
  postal_codeobligatoire	string
  contactobligatoire	object
  first_nameobligatoire	string
  last_nameobligatoire	string
  emailobligatoire	string
  phoneobligatoire	string
  websiteobligatoire	string
  use_caseobligatoire	string	Une valeur parmi : 2FA | App Notifications | Appointments | Auctions | Auto Repair Services | Bank Transfers | Billing | Booking Confirmations | Business Updates | COVID-19 Alerts | Career Training | Chatbot | Conversational / Alerts | Courier Services & Deliveries | Emergency Alerts | Events & Planning | Financial Services | Fraud Alerts | Fundraising | General Marketing | General School Updates | HR / Staffing | Healthcare Alerts | Housing Community Updates | Insurance Services | Job Dispatch | Legal Services | Mixed | Motivational Reminders | Notary Notifications | Order Notifications | Political | Public Works | Real Estate Services | Religious Services | Repair and Diagnostics Alerts | Rewards Program | Surveys | System Alerts | Voting Reminders | Waitlist Alerts | Webinar Reminders | Workshop Alerts
  use_case_summaryobligatoire	string
  sample_messagesobligatoire	string[]
  opt_in_workflowobligatoire	string
  opt_in_image_urlsobligatoire	string[]
  opt_in_confirmation_messageobligatoire	string
  help_messageobligatoire	string
  privacy_policy_urlobligatoire	string
  terms_urlobligatoire	string	Peut être null
  monthly_volumeobligatoire	string	Une valeur parmi : 10 | 100 | 1,000 | 10,000 | 100,000 | 250,000 | 500,000 | 750,000 | 1,000,000 | 5,000,000 | 10,000,000+
  age_gatedobligatoire	boolean
  additional_informationobligatoire	string	Peut être null
  fee_centsobligatoire	integer	Les frais de vérification de cette demande, en cents CAD.
  payment_urlobligatoire	string	Pendant AWAITING_PAYMENT : la page du tableau de bord où les frais sont payés. Null autrement. Peut être null
  paid_atobligatoire	string	Format : date-time Peut être null
  refunded_atobligatoire	string	Format : date-time Peut être null
  reviewer_noteobligatoire	string	Ce que l’équipe HonkIO a demandé de modifier, ou la raison pour laquelle elle a refusé la demande. Peut être null
  carrier_statusobligatoire	string	Où en est l’examen de l’opérateur une fois qu’il a reçu la demande : pending, action_needed (l’opérateur a posé une question à HonkIO ; rien à faire de votre côté pour l’instant), approved ou rejected. Null avant la soumission. Une valeur parmi : pending | action_needed | approved | rejected Peut être null
  carrier_rejection_reasonobligatoire	string	La raison pour laquelle l’opérateur a rejeté la demande, le cas échéant. Peut être null
  submitted_atobligatoire	string	Format : date-time Peut être null
  decided_atobligatoire	string	Le moment où l’opérateur l’a approuvée ou rejetée. Format : date-time Peut être null
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
• 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.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
• 409VERIFICATION_NOT_EDITABLE (pas à l’état DRAFT, CHANGES_REQUESTED ou REJECTED) ou NUMBER_IN_OPEN_VERIFICATION.Le corps d’erreur standard.
• 422VALIDATION_ERROR, NOT_A_TOLL_FREE_NUMBER ou LIVE_MODE_REQUIRED pour une clé de test.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.

Exemple

const { error } = await honkio.tollFreeVerifications.update('VERIFICATION_ID', {
  application: { optInImageUrls: ['https://acme.ca/img/booking-form-v2.png'] },
})
if (error) throw new Error(error.message)

curl -X PATCH https://api.honkio.ca/v1/toll-free-verifications/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "application": {
      "opt_in_image_urls": [
        "https://acme.ca/img/booking-form-v2.png"
      ]
    }
  }'

Annuler ou retirer une demande de vérification sans frais

Paramètres

Réponses

• 204Annulée.
• 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.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
• 409VERIFICATION_NOT_EDITABLE : seules les demandes à l’état DRAFT ou AWAITING_PAYMENT peuvent être annulées.Le corps d’erreur standard.
• 422LIVE_MODE_REQUIRED pour une clé de test.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.

Exemple

const { error } = await honkio.tollFreeVerifications.cancel('VERIFICATION_ID')
if (error) throw new Error(error.message)

curl -X DELETE https://api.honkio.ca/v1/toll-free-verifications/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Soumettre une demande de vérification sans frais

Paramètres

Réponses

• 200La demande, à l’état AWAITING_PAYMENT avec payment_url, ou de retour à IN_REVIEW.›

  Champ	Type	Description
  idobligatoire	string
  statusobligatoire	string	DRAFT, puis AWAITING_PAYMENT, IN_REVIEW (équipe HonkIO), SUBMITTED (chez l’opérateur) et APPROVED. Une demande CHANGES_REQUESTED ou REJECTED (par l’opérateur) peut être modifiée et soumise de nouveau, et une demande REJECTED peut être retirée (CANCELLED) ; DECLINED (par HonkIO) et CANCELLED sont définitifs. Une valeur parmi : DRAFT | AWAITING_PAYMENT | IN_REVIEW | CHANGES_REQUESTED | SUBMITTED | APPROVED | REJECTED | DECLINED | CANCELLED
  phone_numbers[]obligatoire	object[]
  idobligatoire	string
  phone_numberobligatoire	string
  applicationobligatoire	object	La demande telle qu’elle est enregistrée : tous les champs, avec le numéro d’entreprise, le code postal et le téléphone normalisés.
  business_nameobligatoire	string
  doing_business_asobligatoire	string	Peut être null
  entity_typeobligatoire	string	Une valeur parmi : SOLE_PROPRIETOR | PRIVATE_PROFIT | PUBLIC_PROFIT | NON_PROFIT | GOVERNMENT
  business_registration_numberobligatoire	string
  business_addressobligatoire	object
  line1obligatoire	string
  cityobligatoire	string
  provinceobligatoire	string
  postal_codeobligatoire	string
  contactobligatoire	object
  first_nameobligatoire	string
  last_nameobligatoire	string
  emailobligatoire	string
  phoneobligatoire	string
  websiteobligatoire	string
  use_caseobligatoire	string	Une valeur parmi : 2FA | App Notifications | Appointments | Auctions | Auto Repair Services | Bank Transfers | Billing | Booking Confirmations | Business Updates | COVID-19 Alerts | Career Training | Chatbot | Conversational / Alerts | Courier Services & Deliveries | Emergency Alerts | Events & Planning | Financial Services | Fraud Alerts | Fundraising | General Marketing | General School Updates | HR / Staffing | Healthcare Alerts | Housing Community Updates | Insurance Services | Job Dispatch | Legal Services | Mixed | Motivational Reminders | Notary Notifications | Order Notifications | Political | Public Works | Real Estate Services | Religious Services | Repair and Diagnostics Alerts | Rewards Program | Surveys | System Alerts | Voting Reminders | Waitlist Alerts | Webinar Reminders | Workshop Alerts
  use_case_summaryobligatoire	string
  sample_messagesobligatoire	string[]
  opt_in_workflowobligatoire	string
  opt_in_image_urlsobligatoire	string[]
  opt_in_confirmation_messageobligatoire	string
  help_messageobligatoire	string
  privacy_policy_urlobligatoire	string
  terms_urlobligatoire	string	Peut être null
  monthly_volumeobligatoire	string	Une valeur parmi : 10 | 100 | 1,000 | 10,000 | 100,000 | 250,000 | 500,000 | 750,000 | 1,000,000 | 5,000,000 | 10,000,000+
  age_gatedobligatoire	boolean
  additional_informationobligatoire	string	Peut être null
  fee_centsobligatoire	integer	Les frais de vérification de cette demande, en cents CAD.
  payment_urlobligatoire	string	Pendant AWAITING_PAYMENT : la page du tableau de bord où les frais sont payés. Null autrement. Peut être null
  paid_atobligatoire	string	Format : date-time Peut être null
  refunded_atobligatoire	string	Format : date-time Peut être null
  reviewer_noteobligatoire	string	Ce que l’équipe HonkIO a demandé de modifier, ou la raison pour laquelle elle a refusé la demande. Peut être null
  carrier_statusobligatoire	string	Où en est l’examen de l’opérateur une fois qu’il a reçu la demande : pending, action_needed (l’opérateur a posé une question à HonkIO ; rien à faire de votre côté pour l’instant), approved ou rejected. Null avant la soumission. Une valeur parmi : pending | action_needed | approved | rejected Peut être null
  carrier_rejection_reasonobligatoire	string	La raison pour laquelle l’opérateur a rejeté la demande, le cas échéant. Peut être null
  submitted_atobligatoire	string	Format : date-time Peut être null
  decided_atobligatoire	string	Le moment où l’opérateur l’a approuvée ou rejetée. Format : date-time Peut être null
  created_atobligatoire	string	Format : date-time
  updated_atobligatoire	string	Format : date-time
• 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.
• 403BUSINESS_VERIFICATION_REQUIRED (vérifiez d’abord votre entreprise) ou BUSINESS_NUMBER_REQUIRED (votre profil d’entreprise vérifié n’a pas de numéro d’entreprise de l’ARC, que la vérification de numéro sans frais exige).Le corps d’erreur standard.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
• 409VERIFICATION_NOT_EDITABLE : seules les demandes à l’état DRAFT, CHANGES_REQUESTED ou REJECTED peuvent être soumises. COMPED_TOLL_FREE : les numéros sans frais ne sont pas offerts pour ce compte.Le corps d’erreur standard.
• 422LIVE_MODE_REQUIRED pour une clé de test, ou NOT_A_TOLL_FREE_NUMBER lorsqu’un numéro a été libéré depuis.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.

Exemple

const { data, error } = await honkio.tollFreeVerifications.submit('VERIFICATION_ID')
if (error) throw new Error(error.message)
console.log(data.status, data.payment_url) // a draft: 'AWAITING_PAYMENT' and where to pay the fee

curl -X POST https://api.honkio.ca/v1/toll-free-verifications/ID/submit \
  -H "Authorization: Bearer mk_live_YOUR_KEY"