Comptes

Obtenir les détails du compte

Paramètres

Réponses

• 200Le compte avec ses clés API actives.›

  Champ	Type	Description
  accountobligatoire	object	Un compte, tel que le renvoient l’inscription et PATCH /v1/accounts/{id}.
  idobligatoire	string
  nameobligatoire	string
  emailobligatoire	string
  stripe_customer_idobligatoire	string	Peut être null
  email_verified_atobligatoire	string	Format : date-time Peut être null
  statusobligatoire	string	Une valeur parmi : PENDING_PAYMENT | ACTIVE | SUSPENDED | CLOSED
  balance_centsobligatoire	integer	Solde de crédit en cents CAD.
  verified_phoneobligatoire	string	Peut être null
  phone_verified_atobligatoire	string	Format : date-time Peut être null
  email_undeliverableobligatoire	boolean	Vaut true lorsque les courriels de la plateforme envoyés à cette adresse rebondissent ou sont signalés comme pourriels.
  email_undeliverable_atobligatoire	string	Le rebond ou la plainte qui a rendu l’adresse injoignable. Format : date-time Peut être null
  email_undeliverable_reasonobligatoire	string	BOUNCE ou COMPLAINT. Peut être null
  terms_accepted_atobligatoire	string	Moment où le propriétaire a accepté les Conditions d’utilisation et la Politique de confidentialité. Format : date-time Peut être null
  terms_versionobligatoire	string	La version des Conditions (date de dernière mise à jour) qui a été acceptée. Peut être null
  created_atobligatoire	string	Format : date-time
  monthly_rent_centsobligatoire	integer	Loyer mensuel dû pour chaque numéro non encore libéré (ACTIVE et SUSPENDED).
  low_balanceobligatoire	boolean	Vaut true lorsque le solde créditeur ne suffirait pas à couvrir le loyer des numéros de téléphone du mois prochain. Toujours false tant que le compte est offert gratuitement.
  rent_owed_centsobligatoire	integer	Loyer dû (en cents CAD) pour un numéro libéré pendant sa suspension, 0 lorsque rien n’est dû. Tant que ce montant est supérieur à 0, les envois payants et les achats de numéros sont refusés avec RENT_OWED; un rechargement le paie en premier. Non appliqué tant que le compte est offert gratuitement.
  phone_number_limitobligatoire	integer	Nombre maximal de numéros de téléphone que ce compte peut détenir.
  phone_numbers_usedobligatoire	integer	Numéros actuellement détenus (ACTIVE et SUSPENDED).
  email_domain_limit	integer	Nombre maximal de domaines d’envoi de production que ce compte peut détenir. Présent uniquement lorsque le courriel est offert.
  email_domains_used	integer	Domaines d’envoi de production détenus (tous les statuts sauf FAILED). Présent uniquement lorsque le courriel est offert.
  inbound_email_daily_cap	integer	Nombre de courriels reçus que ce compte peut accepter par période glissante de 24 h avant que les courriels suivants soient stockés comme rejetés, sans facturation (0 = illimité) ; la valeur propre au compte, ou la valeur par défaut de la plateforme. Présent uniquement lorsque le service de courriel est offert.
  inbound_email_received_24h	integer	Courriels reçus comptabilisés dans le plafond ci-dessus, pour la fenêtre glissante actuelle de 24 h. Présent uniquement lorsque le service de courriel est offert.
  inbound_email_daily_mb_cap	integer	Mo facturables de courriel reçu (les Mo entamés au-delà du premier Mo de chaque message, la part facturée au Mo) que ce compte peut accepter par fenêtre glissante de 24 h ; un message qui le dépasserait est stocké refusé (daily_mb_cap) et n’est pas facturé (0 = illimité). Le remplacement propre au compte, ou la valeur par défaut de la plateforme. Présent uniquement lorsque le service de courriel est offert.
  inbound_email_mb_received_24h	integer	Mo facturables comptabilisés dans le plafond en Mo ci-dessus, pour la fenêtre glissante actuelle de 24 h. Présent uniquement lorsque le service de courriel est offert.
  inbound_sms_daily_capobligatoire	integer	Nombre de segments SMS reçus (l’unité facturée : un long texto en compte plusieurs) que ce compte peut accepter par période glissante de 24 h avant que les SMS suivants soient stockés sans facturation et ne soient pas transmis en tant que message.received (0 = illimité) ; la valeur propre au compte, ou la valeur par défaut de la plateforme.
  inbound_sms_received_24hobligatoire	integer	Segments SMS reçus comptabilisés dans le plafond ci-dessus, pour la fenêtre glissante actuelle de 24 h.
  api_keys[]obligatoire	object[]	Les clés USER actives du compte (les clés de session du tableau de bord ne sont pas listées).
  idobligatoire	string
  keyPrefixobligatoire	string	Préfixe non secret, pour l’affichage et l’identification.
  modeobligatoire	string	Une valeur parmi : LIVE | TEST
  labelobligatoire	string	Peut être null
  createdAtobligatoire	string	Format : date-time
  lastUsedAtobligatoire	string	Format : date-time Peut être null
  defaultDenyobligatoire	boolean	Présent dans GET /v1/accounts/me et /v1/accounts/{id} ; absent de la réponse de connexion.
  permissionsobligatoire	object	Permissions par ressource. Chaque clé de l’objet est le nom d’une ressource ; la valeur est une chaîne de lettres désignant les opérations permises : r=lecture, w=écriture/création, m=modification/mise à jour, d=suppression. Si une ressource est absente, tout accès à celle-ci est refusé.
  email_domain_idsobligatoire	string[]	Les domaines de courriel à partir desquels cette clé peut envoyer (identifiants provenant de /v1/email-domains) : null en l’absence de restriction, [] lorsqu’elle n’est autorisée pour aucun domaine (ses domaines ont été supprimés). Présent dans GET /v1/accounts/me et /v1/accounts/{id} ; absent de la réponse de connexion. Peut être null
  oauth_grantobligatoire	boolean	Vaut true lorsqu’une connexion OAuth détient cette clé : elle peut être révoquée, mais pas renouvelée (409 CONFLICT, details.reason "oauth_grant"). Présent sur GET /v1/accounts/me et /v1/accounts/{id} ; absent de la réponse de connexion.
  featuresobligatoire	object	Fonctionnalités de la plateforme actuellement offertes à ce compte.
  emailobligatoire	boolean	Vaut true lorsque le produit courriel est offert ; false tant que son accès est encore restreint.
  push	boolean	Présent, et vaut true, lorsque le produit de notifications push est en service.
  notify	boolean	Présent, et vaut true, lorsque Notify (/v1/notify, /v1/recipients) est en service.
  honkio_auth	boolean	Présent, et vaut true, lorsque HonkIO Auth est offert à ce compte.
  compedobligatoire	object	Présent tant que HonkIO offre ce compte gratuitement : rien n’est prélevé sur le solde, qui reste tel quel. Null autrement. Peut être null
  sinceobligatoire	string	Moment où le compte est devenu gratuit. Format : date-time
  month_cost_centsobligatoire	integer	Ce que l’utilisation de ce compte a coûté à HonkIO ce mois civil (heure de l’Est), en cents CAD.
  threshold_centsobligatoire	integer	L’utilisation mensuelle, en cents CAD, au-delà de laquelle le propriétaire reçoit un courriel, au plus une fois par mois. L’envoi continue au-delà.
• 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.
• 403FORBIDDEN : l’identifiant n’appartient pas au compte de la clé appelante, ou la clé n’a pas l’autorisation requise par cette opération.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

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

Mettre à jour le nom ou les paramètres du compte

Paramètres

Corps de la requête

Réponses

• 200Le compte mis à jour.›

  Champ	Type	Description
  idobligatoire	string
  nameobligatoire	string
  emailobligatoire	string
  stripe_customer_idobligatoire	string	Peut être null
  email_verified_atobligatoire	string	Format : date-time Peut être null
  statusobligatoire	string	Une valeur parmi : PENDING_PAYMENT | ACTIVE | SUSPENDED | CLOSED
  balance_centsobligatoire	integer	Solde de crédit en cents CAD.
  verified_phoneobligatoire	string	Peut être null
  phone_verified_atobligatoire	string	Format : date-time Peut être null
  email_undeliverableobligatoire	boolean	Vaut true lorsque les courriels de la plateforme envoyés à cette adresse rebondissent ou sont signalés comme pourriels.
  email_undeliverable_atobligatoire	string	Le rebond ou la plainte qui a rendu l’adresse injoignable. Format : date-time Peut être null
  email_undeliverable_reasonobligatoire	string	BOUNCE ou COMPLAINT. Peut être null
  terms_accepted_atobligatoire	string	Moment où le propriétaire a accepté les Conditions d’utilisation et la Politique de confidentialité. Format : date-time Peut être null
  terms_versionobligatoire	string	La version des Conditions (date de dernière mise à jour) qui a été acceptée. 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.
• 403FORBIDDEN : l’identifiant n’appartient pas au compte de la clé appelante, ou la clé n’a pas l’autorisation requise par cette opération.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.

Exemple

curl -X PATCH https://api.honkio.ca/v1/accounts/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Clinics"
  }'

Obtenir le compte auquel appartient la clé API

Réponses

• 200Le compte auquel appartient la clé API, et qui appelle.›

  Champ	Type	Description
  accountobligatoire	object	Un compte, tel que le renvoient l’inscription et PATCH /v1/accounts/{id}.
  idobligatoire	string
  nameobligatoire	string
  emailobligatoire	string
  stripe_customer_idobligatoire	string	Peut être null
  email_verified_atobligatoire	string	Format : date-time Peut être null
  statusobligatoire	string	Une valeur parmi : PENDING_PAYMENT | ACTIVE | SUSPENDED | CLOSED
  balance_centsobligatoire	integer	Solde de crédit en cents CAD.
  verified_phoneobligatoire	string	Peut être null
  phone_verified_atobligatoire	string	Format : date-time Peut être null
  email_undeliverableobligatoire	boolean	Vaut true lorsque les courriels de la plateforme envoyés à cette adresse rebondissent ou sont signalés comme pourriels.
  email_undeliverable_atobligatoire	string	Le rebond ou la plainte qui a rendu l’adresse injoignable. Format : date-time Peut être null
  email_undeliverable_reasonobligatoire	string	BOUNCE ou COMPLAINT. Peut être null
  terms_accepted_atobligatoire	string	Moment où le propriétaire a accepté les Conditions d’utilisation et la Politique de confidentialité. Format : date-time Peut être null
  terms_versionobligatoire	string	La version des Conditions (date de dernière mise à jour) qui a été acceptée. Peut être null
  created_atobligatoire	string	Format : date-time
  monthly_rent_centsobligatoire	integer	Loyer mensuel dû pour chaque numéro non encore libéré (ACTIVE et SUSPENDED).
  low_balanceobligatoire	boolean	Vaut true lorsque le solde créditeur ne suffirait pas à couvrir le loyer des numéros de téléphone du mois prochain. Toujours false tant que le compte est offert gratuitement.
  rent_owed_centsobligatoire	integer	Loyer dû (en cents CAD) pour un numéro libéré pendant sa suspension, 0 lorsque rien n’est dû. Tant que ce montant est supérieur à 0, les envois payants et les achats de numéros sont refusés avec RENT_OWED; un rechargement le paie en premier. Non appliqué tant que le compte est offert gratuitement.
  phone_number_limitobligatoire	integer	Nombre maximal de numéros de téléphone que ce compte peut détenir.
  phone_numbers_usedobligatoire	integer	Numéros actuellement détenus (ACTIVE et SUSPENDED).
  email_domain_limit	integer	Nombre maximal de domaines d’envoi de production que ce compte peut détenir. Présent uniquement lorsque le courriel est offert.
  email_domains_used	integer	Domaines d’envoi de production détenus (tous les statuts sauf FAILED). Présent uniquement lorsque le courriel est offert.
  inbound_email_daily_cap	integer	Nombre de courriels reçus que ce compte peut accepter par période glissante de 24 h avant que les courriels suivants soient stockés comme rejetés, sans facturation (0 = illimité) ; la valeur propre au compte, ou la valeur par défaut de la plateforme. Présent uniquement lorsque le service de courriel est offert.
  inbound_email_received_24h	integer	Courriels reçus comptabilisés dans le plafond ci-dessus, pour la fenêtre glissante actuelle de 24 h. Présent uniquement lorsque le service de courriel est offert.
  inbound_email_daily_mb_cap	integer	Mo facturables de courriel reçu (les Mo entamés au-delà du premier Mo de chaque message, la part facturée au Mo) que ce compte peut accepter par fenêtre glissante de 24 h ; un message qui le dépasserait est stocké refusé (daily_mb_cap) et n’est pas facturé (0 = illimité). Le remplacement propre au compte, ou la valeur par défaut de la plateforme. Présent uniquement lorsque le service de courriel est offert.
  inbound_email_mb_received_24h	integer	Mo facturables comptabilisés dans le plafond en Mo ci-dessus, pour la fenêtre glissante actuelle de 24 h. Présent uniquement lorsque le service de courriel est offert.
  inbound_sms_daily_capobligatoire	integer	Nombre de segments SMS reçus (l’unité facturée : un long texto en compte plusieurs) que ce compte peut accepter par période glissante de 24 h avant que les SMS suivants soient stockés sans facturation et ne soient pas transmis en tant que message.received (0 = illimité) ; la valeur propre au compte, ou la valeur par défaut de la plateforme.
  inbound_sms_received_24hobligatoire	integer	Segments SMS reçus comptabilisés dans le plafond ci-dessus, pour la fenêtre glissante actuelle de 24 h.
  api_keys[]obligatoire	object[]	Les clés USER actives du compte (les clés de session du tableau de bord ne sont pas listées).
  idobligatoire	string
  keyPrefixobligatoire	string	Préfixe non secret, pour l’affichage et l’identification.
  modeobligatoire	string	Une valeur parmi : LIVE | TEST
  labelobligatoire	string	Peut être null
  createdAtobligatoire	string	Format : date-time
  lastUsedAtobligatoire	string	Format : date-time Peut être null
  defaultDenyobligatoire	boolean	Présent dans GET /v1/accounts/me et /v1/accounts/{id} ; absent de la réponse de connexion.
  permissionsobligatoire	object	Permissions par ressource. Chaque clé de l’objet est le nom d’une ressource ; la valeur est une chaîne de lettres désignant les opérations permises : r=lecture, w=écriture/création, m=modification/mise à jour, d=suppression. Si une ressource est absente, tout accès à celle-ci est refusé.
  email_domain_idsobligatoire	string[]	Les domaines de courriel à partir desquels cette clé peut envoyer (identifiants provenant de /v1/email-domains) : null en l’absence de restriction, [] lorsqu’elle n’est autorisée pour aucun domaine (ses domaines ont été supprimés). Présent dans GET /v1/accounts/me et /v1/accounts/{id} ; absent de la réponse de connexion. Peut être null
  oauth_grantobligatoire	boolean	Vaut true lorsqu’une connexion OAuth détient cette clé : elle peut être révoquée, mais pas renouvelée (409 CONFLICT, details.reason "oauth_grant"). Présent sur GET /v1/accounts/me et /v1/accounts/{id} ; absent de la réponse de connexion.
  featuresobligatoire	object	Fonctionnalités de la plateforme actuellement offertes à ce compte.
  emailobligatoire	boolean	Vaut true lorsque le produit courriel est offert ; false tant que son accès est encore restreint.
  push	boolean	Présent, et vaut true, lorsque le produit de notifications push est en service.
  notify	boolean	Présent, et vaut true, lorsque Notify (/v1/notify, /v1/recipients) est en service.
  honkio_auth	boolean	Présent, et vaut true, lorsque HonkIO Auth est offert à ce compte.
  compedobligatoire	object	Présent tant que HonkIO offre ce compte gratuitement : rien n’est prélevé sur le solde, qui reste tel quel. Null autrement. Peut être null
  sinceobligatoire	string	Moment où le compte est devenu gratuit. Format : date-time
  month_cost_centsobligatoire	integer	Ce que l’utilisation de ce compte a coûté à HonkIO ce mois civil (heure de l’Est), en cents CAD.
  threshold_centsobligatoire	integer	L’utilisation mensuelle, en cents CAD, au-delà de laquelle le propriétaire reçoit un courriel, au plus une fois par mois. L’envoi continue au-delà.
  callerobligatoire	object	Qui appelle : le mode de la clé et, pour une connexion OAuth, son client.
  modeobligatoire	string	Le mode de la clé qui a fait cette requête. Une clé TEST est un bac à sable : rien de ce qu’elle envoie n’est transmis à un opérateur ni facturé. Une valeur parmi : LIVE | TEST
  oauth_clientobligatoire	object	Le client OAuth auquel le jeton d’accès de cette requête a été accordé ; null quand la requête utilise une clé API. Peut être null
  idobligatoire	string	L’identifiant du client : l’URL de son document de métadonnées, ou un identifiant dcr_ pour un client qui s’est inscrit lui-même.
  nameobligatoire	string	Le nom du client affiché sur la page de consentement quand la connexion a été approuvé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.
• 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/accounts/me \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Allocation de recharge (plafond de solde et plafond sur 30 jours glissants)

Paramètres

Réponses

• 200Montant qu’il est possible d’ajouter maintenant. Les montants sont en cents CAD.›

  Champ	Type	Description
  max_topup_now_centsobligatoire	integer	La recharge la plus élevée acceptée actuellement : la plus petite des deux marges disponibles.
  headroom_balance_centsobligatoire	integer	Marge restante sous le plafond de solde.
  headroom_30d_centsobligatoire	integer	Marge restante sous le plafond glissant de 30 jours.
  max_balance_centsobligatoire	integer
  max_30d_centsobligatoire	integer
  balance_centsobligatoire	integer
  topped_up_30d_centsobligatoire	integer
• 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.
• 403FORBIDDEN : l’identifiant n’appartient pas au compte de la clé appelante, ou la clé n’a pas l’autorisation requise par cette opération.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

curl https://api.honkio.ca/v1/accounts/ID/topup-allowance \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Obtenir le résumé d’utilisation d’une période de facturation

Paramètres

Réponses

• 200Utilisation pour la période. Les noms de champs sont en camelCase, contrairement au reste de l’API.›

  Champ	Type	Description
  totalMessagesobligatoire	integer	Tous les messages de la période, y compris les messages entrants et ceux en mode test.
  testMessagesobligatoire	integer	Nombre de messages, parmi totalMessages, qui étaient des simulations en mode test, sans aucuns frais.
  outboundMessagesobligatoire	integer
  inboundMessagesobligatoire	integer
  liveOutboundMessagesobligatoire	integer	La part LIVE de outboundMessages.
  liveInboundMessagesobligatoire	integer	La part LIVE de inboundMessages.
  totalCostCentsobligatoire	integer	Coût des messages LIVE, en cents CAD. Les courriels, les numéros de téléphone et les forfaits HonkIO Auth n’y sont pas inclus.
  segmentCountobligatoire	integer	Segments SMS facturés en mode LIVE.
  emailsSent	integer	Courriels LIVE remis au fournisseur pendant la période (envoyés, livrés, rejetés ou signalés comme pourriel). Présent uniquement lorsque le courriel est offert.
  emailsReceived	integer	Courriels LIVE reçus et remis au compte pendant la période (sans ceux refusés au-delà du plafond de réception). Présent uniquement lorsque le courriel est offert.
  emailCostMillicents	integer	Prix de emailsSent et emailsReceived, en millièmes de cent CAD. Présent uniquement lorsque le courriel est offert.
  deliveryobligatoire	object
  liveOutboundobligatoire	integer
  deliveredobligatoire	integer
  failedobligatoire	integer
  undeliveredobligatoire	integer
  pendingobligatoire	integer	Accepté, aucun verdict de l’opérateur pour l’instant.
  failureRatePctobligatoire	number	(failed + undelivered) / liveOutbound x 100, arrondi à une décimale ; 0 en l’absence de trafic.
  byNumber[]obligatoire	object[]	Les mêmes statistiques de livraison par numéro d’envoi, du plus actif au moins actif.
  fromobligatoire	string
  liveOutboundobligatoire	integer
  deliveredobligatoire	integer
  failedobligatoire	integer
  undeliveredobligatoire	integer
  failureRatePctobligatoire	number
  periodobligatoire	object
  fromobligatoire	string	Format : date-time
  toobligatoire	string	Fin exclusive de la période. 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.
• 403FORBIDDEN : l’identifiant n’appartient pas au compte de la clé appelante, ou la clé n’a pas l’autorisation requise par cette opération.Le corps d’erreur standard.
• 422VALIDATION_ERROR : date mal formée, ou to antérieur à from.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/accounts/ID/usage \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Lister les transactions du solde (grand livre), des plus récentes aux plus anciennes

Paramètres

Réponses

• 200Registre paginé des transactions du solde›

  Champ	Type	Description
  transactions[]	object[]
  id	string
  amount_cents	integer	Valeur signée : positive = crédit, négative = débit
  balance_after_cents	integer
  reason	string	Raison du mouvement de solde : topup, refund, dispute, phone_rent, provisioning, activation, verification et leurs annulations *_refund ; admin_adjustment pour les modifications faites par notre équipe. Les frais SMS par message n’apparaissent pas ici : ils figurent sur les messages eux-mêmes. Les corrections ponctuelles portent leurs propres raisons (inbound_backfill, overcharge_refund, sweep_reversal).
  tax_cents	integer	Recharges seulement, lorsque des taxes de vente ont été perçues : la TPS/TVH facturée en sus de amount_cents. amount_cents correspond toujours au crédit, avant taxes. Absent dans les autres cas.
  charged_cents	integer	Recharges seulement, lorsque des taxes de vente ont été perçues : le montant débité de la carte, soit amount_cents plus tax_cents. Absent dans les autres cas.
  created_at	string	Format : date-time
  has_more	boolean
• 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 : également lorsque l’id n’est pas celui du compte de la clé appelante (404 plutôt que 403, afin de ne pas confirmer l’existence du grand livre).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.

Exemple

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

Émettre une nouvelle clé API

Paramètres

Corps de la requête

Réponses

• 201Clé API émise. La clé brute n’est affichée qu’une seule fois : conservez-la en lieu sûr.›

  Champ	Type	Description
  key	string	Clé API complète (affichée une seule fois)
  prefix	string	Préfixe non secret pour l’affichage et l’identification
  mode	string	Une valeur parmi : live | test
  permissions	object	Permissions par ressource.
  email_domain_ids	string[]	Peut être null
  notice	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.
• 403FORBIDDEN (ce n’est pas votre compte), LIVE_KEY_REQUIRED (une clé de test a demandé une clé de production), KEY_FENCED (la clé appelante est restreinte par une liste d’autorisation ou de blocage), PERMISSION_ESCALATION (autorisations ou domaines courriel plus étendus que ceux de la clé appelante, ou clé de session du tableau de bord, sans confirmation par mot de passe api_keys:elevate) ou ACCOUNT_EMAIL_NOT_VERIFIED (le compte n’a pas encore vérifié son adresse courriel ; aucune clé, de production ou de test, n’est créée avant cela).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.

Exemple

curl -X POST https://api.honkio.ca/v1/accounts/ID/api-keys \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "mode": "live",
    "label": "Production server"
  }'

Renouveler une clé API (émettre une clé de remplacement et révoquer l’ancienne de façon atomique)

Paramètres

Réponses

• 201La clé de remplacement, affichée une seule fois. L’ancienne clé est révoquée dans la même opération ; la nouvelle conserve son mode, son libellé, ses permissions, son paramètre de refus par défaut, ses listes et sa restriction de domaines de courriel.›

  Champ	Type	Description
  keyobligatoire	string	La nouvelle clé API complète (affichée une seule fois).
  prefixobligatoire	string
  modeobligatoire	string	Une valeur parmi : live | test
  revoked_idobligatoire	string	L’identifiant de la clé que celle-ci a remplacée.
  noticeobligatoire	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.
• 403FORBIDDEN (ce n’est pas votre compte), LIVE_KEY_REQUIRED (une clé de test tente de renouveler une clé de production), KEY_FENCED (une clé restreinte par une liste d’autorisation ou de blocage tente de renouveler une autre clé qu’elle-même), PERMISSION_ESCALATION (la clé cible détient plus d’autorisations que la clé appelante, ou l’appelant est une clé de session du tableau de bord, sans confirmation par mot de passe api_keys:elevate) ou ACCOUNT_EMAIL_NOT_VERIFIED (le compte n’a pas encore vérifié son adresse courriel).Le corps d’erreur standard.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
• 409CONFLICT : la clé est déjà révoquée, est en cours de renouvellement par une autre requête, est une clé de session du tableau de bord (details.reason vaut session_key) ou est détenue par une connexion OAuth (details.reason vaut oauth_grant).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 -X POST https://api.honkio.ca/v1/accounts/ID/api-keys/KEY_ID/rotate \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Révoquer une clé API

Paramètres

Réponses

• 204Révocation effectué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.
• 403FORBIDDEN (ce n’est pas votre compte) ou LIVE_KEY_REQUIRED (une clé de test tente de révoquer une clé de production).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

curl -X DELETE https://api.honkio.ca/v1/accounts/ID/api-keys/KEY_ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Activer ou désactiver le mode de refus par défaut d’une clé API

Paramètres

Corps de la requête

Réponses

• 200Le nouveau paramètre de refus par défaut de la clé.›

  Champ	Type	Description
  api_key_idobligatoire	string
  default_denyobligatoire	boolean
• 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.
• 403FORBIDDEN (ce n’est pas votre compte), LIVE_KEY_REQUIRED (une clé de test tente de modifier une clé de production) ou KEY_FENCED (une clé restreinte tente de modifier son propre refus par défaut ou celui d’une autre clé).Le corps d’erreur standard.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.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.

Exemple

curl -X PATCH https://api.honkio.ca/v1/accounts/ID/api-keys/KEY_ID/default-deny \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "default_deny": false
  }'

Obtenir les listes d’autorisation et de blocage attribuées à une clé API

Paramètres

Réponses

• 200Les listes d’autorisation et de blocage de la clé, null si aucune n’est attribuée.›

  Champ	Type	Description
  allow_listobligatoire	object | any
  deny_listobligatoire	object | any
• 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.
• 403FORBIDDEN : l’identifiant n’appartient pas au compte de la clé appelante, ou la clé n’a pas l’autorisation requise par cette opération.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

curl https://api.honkio.ca/v1/accounts/ID/api-keys/KEY_ID/lists \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Assigner une liste d’autorisation ou de blocage à une clé API

Paramètres

Corps de la requête

Réponses

• 200La liste désormais attribuée.›

  Champ	Type	Description
  api_key_idobligatoire	string
  modeobligatoire	string	Une valeur parmi : ALLOW | DENY
  list_idobligatoire	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.
• 403FORBIDDEN (ce n’est pas votre compte), LIVE_KEY_REQUIRED (une clé de test tente de modifier une clé de production) ou KEY_FENCED (une clé restreinte tente de modifier ses propres listes ou celles d’une autre clé).Le corps d’erreur standard.
• 404NOT_FOUND (clé inexistante) ou CONTACT_LIST_NOT_FOUND (liste inexistante, ou liste de l’autre mode : une clé ne prend que des listes de son propre mode).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.

Exemple

curl -X PUT https://api.honkio.ca/v1/accounts/ID/api-keys/KEY_ID/lists/MODE \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "list_id": "..."
  }'

Retirer une liste d’autorisation ou de blocage d’une clé API

Paramètres

Réponses

• 204Attribution retirée (également lorsque rien n’était attribué).
• 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.
• 403FORBIDDEN (ce n’est pas votre compte), LIVE_KEY_REQUIRED (une clé de test tente de modifier une clé de production) ou KEY_FENCED (une clé restreinte tente de modifier ses propres listes ou celles d’une autre clé).Le corps d’erreur standard.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.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.

Exemple

curl -X DELETE https://api.honkio.ca/v1/accounts/ID/api-keys/KEY_ID/lists/MODE \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Démarrer la vérification du numéro du propriétaire du compte

Paramètres

Corps de la requête

Réponses

• 200Le code a été envoyé par SMS.›

  Champ	Type	Description
  sentobligatoire	boolean	Une valeur parmi : true
  expires_in_secondsobligatoire	integer
• 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.
• 403FORBIDDEN (ce n’est pas votre compte) ou LIVE_KEY_REQUIRED (la vérification du propriétaire nécessite une clé de production).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.
• 429RATE_LIMITED : 3 codes par heure et par compte.Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.
• 502CARRIER_ERROR : l’opérateur n’a pas accepté le SMS.Le corps d’erreur standard.
• 503SERVICE_UNAVAILABLE : la vérification du numéro du propriétaire n’est pas configurée. CARRIER_THROTTLED : l’opérateur nous a demandé de ralentir et n’a pas pris le SMS ; redemandez après le délai Retry-After.Le corps d’erreur standard.

Exemple

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

Confirmer le code de vérification (NPU) pour terminer la vérification du numéro de téléphone

Paramètres

Corps de la requête

Réponses

• 200Vérifié : les envois réels sont débloqués.›

  Champ	Type	Description
  verifiedobligatoire	boolean	Une valeur parmi : true
  verified_phoneobligatoire	string
  verified_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.
• 403FORBIDDEN (ce n’est pas votre compte) ou LIVE_KEY_REQUIRED (la vérification du propriétaire nécessite une clé de production).Le corps d’erreur standard.
• 422VALIDATION_ERROR, VERIFICATION_EXPIRED (aucun code en attente ; statusCode 422 dans le corps) ou VERIFICATION_INVALID_CODE.Le corps d’erreur standard.
• 429VERIFICATION_MAX_ATTEMPTS : cinq codes erronés ; demandez-en un nouveau.Le corps d’erreur standard.
• 500Erreur de serveur inattendue.Le corps d’erreur standard.

Exemple

curl -X POST https://api.honkio.ca/v1/accounts/ID/phone-verification/confirm \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "123456"
  }'

Vos paramètres de rechargement automatique

Réponses

• 200Paramètres du rechargement automatique, résumé de la carte enregistrée, état de pause et tentatives récentes.›

  Champ	Type	Description
  availableobligatoire	boolean	Vaut false lorsque le rechargement automatique ne peut pas être utilisé sur cette plateforme pour le moment. Les autres champs décrivent toujours vos paramètres.
  enabledobligatoire	boolean	Indique si le rechargement automatique est activé. Il peut être activé et en pause (paused_at).
  threshold_centsobligatoire	integer	Lorsque votre solde passe sous ce seuil, en cents CAD, votre carte est débitée. Null avant la première activation du rechargement automatique. Peut être null
  amount_centsobligatoire	integer	Le crédit ajouté par chaque rechargement automatique, en cents CAD, avant taxes. Toujours au moins égal à threshold_cents, de sorte qu’un seul rechargement ramène le solde à ce niveau. Null avant la première activation du rechargement automatique. Peut être null
  cardobligatoire	object | any	La carte enregistrée que débite le rechargement automatique. Null lorsqu’aucune carte n’est enregistrée.
  paused_atobligatoire	string	Moment où le rechargement automatique a été mis en pause. Rien n’est débité pendant la pause. Vous le reprenez avec « Recharger pour reprendre » dans la section Rechargement automatique de la page Facturation du tableau de bord, ce qui crée une nouvelle recharge qui enregistre de nouveau votre carte. Une pause pour ACCOUNT_REVIEW ne peut pas être reprise de cette façon (voir paused_reason). Format : date-time Peut être null
  paused_reasonobligatoire	string	Raison de la pause : la carte a été refusée, exigeait une authentification, a expiré ou a été retirée ; l’adresse de facturation n’a pas pu servir au calcul des taxes ; un paiement a été remboursé et retiré du solde (REFUND) ; la limite de 3 prélèvements en 24 heures a été atteinte (CHARGE_LIMIT) ; le compte est en cours d’examen ; ou le personnel de HonkIO l’a mis en pause. Vous pouvez reprendre pour toutes les raisons sauf ACCOUNT_REVIEW, avec « Recharger pour reprendre » dans le tableau de bord. Vous ne pouvez pas reprendre vous-même après ACCOUNT_REVIEW. L’événement webhook account.auto_topup_paused porte la même valeur dans reason. Une valeur parmi : DECLINED | AUTHENTICATION_REQUIRED | EXPIRED_CARD | CARD_REMOVED | BILLING_ADDRESS | ACCOUNT_REVIEW | ADMIN | REFUND | CHARGE_LIMIT Peut être null
  cap_blockedobligatoire	boolean	Vaut true tant que le rechargement automatique ignore les prélèvements parce qu’un prélèvement dépasserait votre solde maximal ou votre limite de rechargement sur 30 jours.
  setup_pendingobligatoire	boolean	Vaut true lorsqu’une configuration a été commencée sans être terminée : les paramètres ont été choisis dans le tableau de bord et la recharge qui enregistre la carte n’est pas encore terminée. Ils ne prennent effet qu’à ce moment. Vaut false une fois la recharge terminée, ainsi qu’après la modification des paramètres ou la désactivation du rechargement automatique.
  monthly_rent_centsobligatoire	integer	Loyer mensuel des numéros que vous détenez, en cents CAD. Le rechargement automatique recharge aussi à l’avance lorsqu’un loyer est dû dans la journée.
  attempts[]obligatoire	object[]	Les 10 tentatives les plus récentes, de la plus récente à la plus ancienne.
  idobligatoire	string	ata_…
  triggerobligatoire	string	threshold : le solde est passé sous threshold_cents. rent : le solde était inférieur au loyer des numéros dû dans les 24 heures. Une valeur parmi : threshold | rent
  statusobligatoire	string	skipped_cap : aucun prélèvement, car la recharge aurait dépassé votre solde maximal ou votre limite de rechargement sur 30 jours. Une valeur parmi : pending | succeeded | failed | skipped_cap
  amount_centsobligatoire	integer	Le crédit ajouté à votre solde, en cents CAD.
  tax_centsobligatoire	integer	Taxe de vente ajoutée à amount_cents, en cents CAD. Null lorsqu’aucune taxe n’a été calculée. Peut être null
  total_centsobligatoire	integer	Le montant débité sur la carte, en cents CAD : amount_cents plus tax_cents. Null avant le prélèvement. Peut être null
  failure_codeobligatoire	string	Raison de l’échec d’une tentative : un code de carte comme card_declined ou expired_card, ou platform_error lorsque l’échec vient de HonkIO (le rechargement automatique n’est pas mis en pause et réessaie). Les tentatives qui n’ont rien débité ni rien mis en pause (abandoned, not_needed) ne sont jamais affichées. Peut être null
  created_atobligatoire	string	Format : date-time
  settled_atobligatoire	string	Format : date-time Peut être null
• 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.autoTopup.get()
if (error) throw new Error(error.message)
console.log(data.enabled, data.paused_at)

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

Vos limites d’envoi et votre utilisation actuelle

Réponses

• 200Limites d’envoi, utilisation et demandes de volume antérieures.›

  Champ	Type	Description
  daily_limitobligatoire	integer	Envois réels depuis des numéros locaux autorisés sur une période mobile de 24 heures. null quand le compte n’a pas de limite quotidienne. Peut être null
  sent_last_24hobligatoire	integer
  remainingobligatoire	integer	null quand le compte n’a pas de limite quotidienne. Peut être null
  window_hoursobligatoire	integer
  approved_daily_limitobligatoire	integer	Le volume standard accordé par défaut à une demande.
  probation_daysobligatoire	integer
  recipient_rate_per_hourobligatoire	integer	Messages qu’un même destinataire peut recevoir du compte par heure.
  recipient_rate_per_dayobligatoire	integer	Messages qu’un même destinataire peut recevoir du compte par jour.
  probationobligatoire	object
  started_atobligatoire	string	Le premier envoi réel ; null avant celui-ci. Format : date-time Peut être null
  ends_atobligatoire	string	Format : date-time Peut être null
  eligible_to_requestobligatoire	boolean
  paused_untilobligatoire	string	Défini pendant que l’envoi est en pause. Format : date-time Peut être null
  pause_reasonobligatoire	string	Raison de la pause des envois : OPT_OUT_RATE, FAILURE_RATE ou MANUAL. Peut être null
  verify_pauseobligatoire	any | object	Codes de vérification réels suspendus par la détection du pompage de SMS (POST /v1/verify répond 403 SENDING_PAUSED avec details.channel « verify ») ; les messages ne sont pas touchés. null quand rien n’est suspendu. DELETE /v1/verify/pause lève la suspension.
  toll_freeobligatoire	object	L’allocation distincte des envois depuis des numéros sans frais. Les envois depuis des numéros locaux ne comptent que dans les chiffres de premier niveau.
  daily_limitobligatoire	integer	Envois réels depuis des numéros sans frais autorisés sur une période mobile de 24 heures. Il n’y a pas de probation. null quand le compte n’a pas de limite quotidienne. Peut être null
  sent_last_24hobligatoire	integer	Envois réels depuis des numéros sans frais au cours des 24 dernières heures.
  remainingobligatoire	integer	null quand le compte n’a pas de limite quotidienne. Peut être null
  fanout_max_recipientsobligatoire	integer	Destinataires distincts qu’un même corps de message peut atteindre depuis des numéros sans frais en 24 heures.
  broadcast_max_recipientsobligatoire	integer	Membres qu’une diffusion de groupe de contacts depuis un numéro sans frais peut atteindre.
  broadcasts_per_dayobligatoire	integer	Diffusions de groupe de contacts depuis des numéros sans frais par période mobile de 24 heures.
  number_queues[]obligatoire	object[]	La file d’attente de chacun de vos numéros actifs chez l’opérateur : l’opérateur envoie les segments de message d’un numéro à un rythme fixe, si bien qu’une liste prend du temps. Une estimation, d’après les segments déjà transmis.
  phone_numberobligatoire	string
  parts_per_minuteobligatoire	integer	Segments de message que l’opérateur envoie depuis ce numéro par minute (10 pour un numéro local).
  queued_partsobligatoire	integer	Parties en attente en ce moment. Un envoi est refusé avec NUMBER_RATE_LIMITED tant qu’une minute de parties est en attente.
  clears_atobligatoire	string	Le moment où les segments en attente devraient tous être partis ; null quand rien n’attend. Format : date-time Peut être null
  requests[]obligatoire	object[]
  idobligatoire	string
  requested_limitobligatoire	integer	Nombre de messages par jour demandé ; null demande le volume approuvé standard. Peut être null
  limit_at_requestobligatoire	integer
  sent_last_30d_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.
• 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.sendLimit.get()
if (error) throw new Error(error.message)
// daily_limit and remaining are null when the account has no daily limit.
if (data.daily_limit === null) console.log('no daily limit')
else console.log(data.remaining, 'of', data.daily_limit, 'left')
for (const q of data.number_queues) console.log(q.phone_number, q.queued_parts, q.clears_at)

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

Lister vos demandes de volume

Réponses

• 200Les demandes de volume du compte, des plus récentes aux plus anciennes.›

  Champ	Type	Description
  data[]obligatoire	object[]
  idobligatoire	string
  requested_limitobligatoire	integer	Nombre de messages par jour demandé ; null demande le volume approuvé standard. Peut être null
  limit_at_requestobligatoire	integer
  sent_last_30d_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/send-limit/requests \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Demander un volume d’envoi quotidien plus élevé

Corps de la requête

Réponses

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

  Champ	Type	Description
  idobligatoire	string
  requested_limitobligatoire	integer	Nombre de messages par jour demandé ; null demande le volume approuvé standard. Peut être null
  limit_at_requestobligatoire	integer
  sent_last_30d_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), SEND_LIMIT_REQUEST_TOO_EARLY (période probatoire non terminée ; details.eligible_at) ou LIVE_KEY_REQUIRED.Le corps d’erreur standard.
• 404NOT_FOUND : aucune ressource correspondante sur ce compte.Le corps d’erreur standard.
• 409SEND_LIMIT_REQUEST_PENDING : une demande est déjà en attente.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.
• 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/send-limit/requests \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "..."
  }'

Obtenir votre vérification d’entreprise

Réponses

• 200Votre profil de vérification d’entreprise, ou null avant qu’un profil soit enregistré.
• 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: profile, error } = await honkio.businessVerification.get()
if (error) throw new Error(error.message)
console.log(profile?.status ?? 'not started')

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

Enregistrer votre profil de vérification d’entreprise

Corps de la requête

Réponses

• 200Le profil enregistré.›

  Champ	Type	Description
  idobligatoire	string
  statusobligatoire	string	DRAFT, puis IN_REVIEW (équipe de HonkIO), puis VERIFIED. Un profil CHANGES_REQUESTED ou DECLINED peut être modifié et soumis de nouveau ; seul le personnel de HonkIO peut rétablir un profil REVOKED. Un profil VERIFIED modifié revient à DRAFT pour un nouvel examen. Une valeur parmi : DRAFT | IN_REVIEW | VERIFIED | CHANGES_REQUESTED | DECLINED | REVOKED
  verifiedobligatoire	boolean	Indique si l’entreprise est considérée comme vérifiée. La valeur reste true pendant le nouvel examen des renseignements modifiés d’une entreprise vérifiée (état DRAFT, IN_REVIEW ou CHANGES_REQUESTED), et passe à false lorsque l’équipe de HonkIO refuse les modifications ou révoque la vérification.
  verified_atobligatoire	string	Date de la dernière vérification de l’entreprise par l’équipe de HonkIO ; null lorsqu’elle n’est pas vérifiée. Format : date-time Peut être null
  verified_detailsobligatoire	object | any	L’entreprise telle que l’équipe HonkIO l’a vérifiée la dernière fois. Pendant qu’un nouvel examen porte sur des modifications, les champs ci-dessous montrent les modifications et celui-ci garde ce qui a été vérifié : la vérification de numéro sans frais lit son numéro d’entreprise. Null quand l’entreprise n’est pas vérifiée.
  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	Peut être null
  business_addressobligatoire	object | any
  websiteobligatoire	string	Peut être null
  business_descriptionobligatoire	string	Peut être null
  contactobligatoire	object
  first_nameobligatoire	string	Peut être null
  last_nameobligatoire	string	Peut être null
  emailobligatoire	string	Peut être null
  phoneobligatoire	string	Peut être null
  reviewer_noteobligatoire	string	Ce que l’équipe de HonkIO a demandé de modifier, ou pourquoi elle a refusé le profil. Peut être null
  revoked_reasonobligatoire	string	Pourquoi l’équipe de HonkIO a révoqué la vérification. Peut être null
  submitted_atobligatoire	string	Format : date-time Peut être null
  reviewed_atobligatoire	string	Format : date-time Peut être null
  revoked_atobligatoire	string	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.
• 403LIVE_KEY_REQUIRED : une clé de test ne peut pas modifier le profil d’une entreprise vérifiée, y compris lorsque ses modifications sont en cours d’examen. Elle peut enregistrer un profil qui n’a jamais été vérifié. 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.
• 409BUSINESS_VERIFICATION_NOT_EDITABLE : le profil est en cours d’examen ou révoqué.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.

Exemple

const { error } = await honkio.businessVerification.save({
  businessName: 'Acme Clinics Inc.',
  entityType: 'PRIVATE_PROFIT',
  businessRegistrationNumber: '123456789RC0001', // optional for a sole proprietor
  businessAddress: { line1: '100 King St W', city: 'Toronto', province: 'ON', postalCode: 'M5X 1A9' },
  website: 'https://acme.ca',
  businessDescription: 'Three clinics in Toronto that text patients appointment reminders.',
  contact: { firstName: 'Ada', lastName: 'Lovelace', email: 'ada@acme.ca', phone: '+1416XXXXXXX' },
})
if (error) throw new Error(`${error.name}: ${error.message}`)

curl -X PUT https://api.honkio.ca/v1/business-verification \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "business_name": "...",
    "entity_type": "SOLE_PROPRIETOR",
    "business_address": {
      "line1": "...",
      "city": "...",
      "province": "AB",
      "postal_code": "..."
    },
    "website": "...",
    "business_description": "...",
    "contact": {
      "first_name": "...",
      "last_name": "...",
      "email": "sam@example.com",
      "phone": "+1613XXXXXXX"
    }
  }'

Soumettre votre entreprise pour vérification

Réponses

• 200Le profil, maintenant IN_REVIEW.›

  Champ	Type	Description
  idobligatoire	string
  statusobligatoire	string	DRAFT, puis IN_REVIEW (équipe de HonkIO), puis VERIFIED. Un profil CHANGES_REQUESTED ou DECLINED peut être modifié et soumis de nouveau ; seul le personnel de HonkIO peut rétablir un profil REVOKED. Un profil VERIFIED modifié revient à DRAFT pour un nouvel examen. Une valeur parmi : DRAFT | IN_REVIEW | VERIFIED | CHANGES_REQUESTED | DECLINED | REVOKED
  verifiedobligatoire	boolean	Indique si l’entreprise est considérée comme vérifiée. La valeur reste true pendant le nouvel examen des renseignements modifiés d’une entreprise vérifiée (état DRAFT, IN_REVIEW ou CHANGES_REQUESTED), et passe à false lorsque l’équipe de HonkIO refuse les modifications ou révoque la vérification.
  verified_atobligatoire	string	Date de la dernière vérification de l’entreprise par l’équipe de HonkIO ; null lorsqu’elle n’est pas vérifiée. Format : date-time Peut être null
  verified_detailsobligatoire	object | any	L’entreprise telle que l’équipe HonkIO l’a vérifiée la dernière fois. Pendant qu’un nouvel examen porte sur des modifications, les champs ci-dessous montrent les modifications et celui-ci garde ce qui a été vérifié : la vérification de numéro sans frais lit son numéro d’entreprise. Null quand l’entreprise n’est pas vérifiée.
  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	Peut être null
  business_addressobligatoire	object | any
  websiteobligatoire	string	Peut être null
  business_descriptionobligatoire	string	Peut être null
  contactobligatoire	object
  first_nameobligatoire	string	Peut être null
  last_nameobligatoire	string	Peut être null
  emailobligatoire	string	Peut être null
  phoneobligatoire	string	Peut être null
  reviewer_noteobligatoire	string	Ce que l’équipe de HonkIO a demandé de modifier, ou pourquoi elle a refusé le profil. Peut être null
  revoked_reasonobligatoire	string	Pourquoi l’équipe de HonkIO a révoqué la vérification. Peut être null
  submitted_atobligatoire	string	Format : date-time Peut être null
  reviewed_atobligatoire	string	Format : date-time Peut être null
  revoked_atobligatoire	string	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.
• 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 profil n’a encore été enregistré.Le corps d’erreur standard.
• 409BUSINESS_VERIFICATION_NOT_EDITABLE : seul un profil DRAFT, CHANGES_REQUESTED ou DECLINED peut être soumis.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.

Exemple

const { data, error } = await honkio.businessVerification.submit()
if (error) throw new Error(error.message)
console.log(data.status) // 'IN_REVIEW'

curl -X POST https://api.honkio.ca/v1/business-verification/submit \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Lister vos demandes de limites de rechargement

Réponses

• 200Les demandes de limites de rechargement du compte, des plus récentes aux plus anciennes.›

  Champ	Type	Description
  data[]obligatoire	object[]
  idobligatoire	string
  requested_max_balance_centsobligatoire	integer	Le solde maximal demandé, en cents CAD ; null s’il n’a pas été demandé. Peut être null
  requested_max_30d_centsobligatoire	integer	Le maximum sur 30 jours consécutifs demandé, en cents CAD ; null s’il n’a pas été demandé. Peut être null
  reasonobligatoire	string
  statusobligatoire	string	Une valeur parmi : PENDING | APPROVED | DECLINED
  granted_max_balance_centsobligatoire	integer	Peut être null
  granted_max_30d_centsobligatoire	integer	Peut être null
  decision_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

const { data, error } = await honkio.topupCapRequests.list()
if (error) throw new Error(error.message)
for (const r of data.data) console.log(r.status, r.decision_note)

curl https://api.honkio.ca/v1/account/topup-cap-requests \
  -H "Authorization: Bearer mk_live_YOUR_KEY"

Demander des limites de rechargement plus élevées

Corps de la requête

Réponses

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

  Champ	Type	Description
  idobligatoire	string
  requested_max_balance_centsobligatoire	integer	Le solde maximal demandé, en cents CAD ; null s’il n’a pas été demandé. Peut être null
  requested_max_30d_centsobligatoire	integer	Le maximum sur 30 jours consécutifs demandé, en cents CAD ; null s’il n’a pas été demandé. Peut être null
  reasonobligatoire	string
  statusobligatoire	string	Une valeur parmi : PENDING | APPROVED | DECLINED
  granted_max_balance_centsobligatoire	integer	Peut être null
  granted_max_30d_centsobligatoire	integer	Peut être null
  decision_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.
• 409TOPUP_CAP_REQUEST_PENDING : une demande est déjà en attente.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.
• 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

const { data: request, error } = await honkio.topupCapRequests.create({
  requestedMaxBalanceCents: 100_000, // $1,000.00
  reason: 'Appointment reminders for our three clinics.',
})
if (error) throw new Error(`${error.name}: ${error.message}`)
console.log(request.status) // 'PENDING'

curl -X POST https://api.honkio.ca/v1/account/topup-cap-requests \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "..."
  }'