Référence de l’API

Contacts

Gérer les numéros de téléphone et les métadonnées des contacts.

get/v1/contacts

Lister tous les contacts

Permissioncontacts:r

Nécessite contacts:r.

Paramètres

Paramètre	Type	Description
`limit`requête	integer	Minimum : 1 Maximum : 100 Par défaut : 50
`offset`requête	integer	Minimum : 0 Par défaut : 0
`search`requête	string	Filtrer par nom, numéro de téléphone ou adresse courriel (insensible à la casse, correspondance partielle)

Réponses

200Une page de contacts, du plus récent au plus ancien.

Champ	Type	Description
`total`obligatoire	integer	Nombre total d’enregistrements correspondants.
`limit`obligatoire	integer
`offset`obligatoire	integer
`data[]`obligatoire	object[]
`id`obligatoire	string
`phone_number`obligatoire	string	Numéro E.164 ; null pour un contact avec courriel seulement. Seuls les contacts ayant un numéro de téléphone peuvent rejoindre des groupes et des listes. Peut être null
`email`obligatoire	string	En minuscules ; null pour un contact uniquement téléphonique. Au moins l’un des champs phone_number et email est renseigné. Peut être null
`name`obligatoire	string	Peut être null
`notes`obligatoire	string	Peut être null
`created_at`obligatoire	string	Format : date-time
`updated_at`obligatoire	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.
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

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

post/v1/contacts

Créer un contact

Permissioncontacts:w

Nécessite contacts:w.

Corps de la requête

Champ	Type	Description
`phone_number`	string	Numéro de téléphone E.164. Fournissez phone_number, email ou les deux.
`email`	string	Enregistré en minuscules. Fournissez phone_number, email, ou les deux. Format : email Au plus 254 caractères
`name`	string	Au plus 200 caractères
`notes`	string	Au plus 1000 caractères

Réponses

201Le contact.

Champ	Type	Description
`id`obligatoire	string
`phone_number`obligatoire	string	Numéro E.164 ; null pour un contact avec courriel seulement. Seuls les contacts ayant un numéro de téléphone peuvent rejoindre des groupes et des listes. Peut être null
`email`obligatoire	string	En minuscules ; null pour un contact uniquement téléphonique. Au moins l’un des champs phone_number et email est renseigné. Peut être null
`name`obligatoire	string	Peut être null
`notes`obligatoire	string	Peut être null
`created_at`obligatoire	string	Format : date-time
`updated_at`obligatoire	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.
409CONTACT_ALREADY_EXISTS : le numéro de téléphone ou l’adresse courriel correspond déjà à un contact.Le corps d’erreur standard.
422VALIDATION_ERROR (ni phone_number ni email, ou adresse courriel mal formée) ou INVALID_PHONE_NUMBER.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

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

get/v1/contacts/{id}

Obtenir un contact

Permissioncontacts:r

Nécessite contacts:r.

Paramètres

Paramètre	Type	Description
`id`obligatoirechemin	string

Réponses

200Le contact.

Champ	Type	Description
`id`obligatoire	string
`phone_number`obligatoire	string	Numéro E.164 ; null pour un contact avec courriel seulement. Seuls les contacts ayant un numéro de téléphone peuvent rejoindre des groupes et des listes. Peut être null
`email`obligatoire	string	En minuscules ; null pour un contact uniquement téléphonique. Au moins l’un des champs phone_number et email est renseigné. Peut être null
`name`obligatoire	string	Peut être null
`notes`obligatoire	string	Peut être null
`created_at`obligatoire	string	Format : date-time
`updated_at`obligatoire	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.
404CONTACT_NOT_FOUND.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

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

patch/v1/contacts/{id}

Mettre à jour un contact

Permissioncontacts:m

Nécessite contacts:m.

Paramètres

Paramètre	Type	Description
`id`obligatoirechemin	string

Corps de la requête

Champ	Type	Description
`phone_number`	string	Numéro E.164, ou null pour l’effacer (refusé avec 409 CONTACT_IN_USE tant que le contact fait partie d’un groupe ou d’une liste, et avec 422 si le contact se retrouvait sans aucun identifiant). Peut être null
`email`	string	Format : email Au plus 254 caractères Peut être null
`name`	string	Au plus 200 caractères Peut être null
`notes`	string	Au plus 1000 caractères Peut être null

Réponses

200Le contact mis à jour.

Champ	Type	Description
`id`obligatoire	string
`phone_number`obligatoire	string	Numéro E.164 ; null pour un contact avec courriel seulement. Seuls les contacts ayant un numéro de téléphone peuvent rejoindre des groupes et des listes. Peut être null
`email`obligatoire	string	En minuscules ; null pour un contact uniquement téléphonique. Au moins l’un des champs phone_number et email est renseigné. Peut être null
`name`obligatoire	string	Peut être null
`notes`obligatoire	string	Peut être null
`created_at`obligatoire	string	Format : date-time
`updated_at`obligatoire	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 lorsqu’une clé de test tente de modifier un élément référencé par la liste d’autorisation ou de blocage d’une clé de production. Aussi FORBIDDEN lorsque la clé ne dispose pas de la permission requise.Le corps d’erreur standard.
404CONTACT_NOT_FOUND.Le corps d’erreur standard.
409CONTACT_ALREADY_EXISTS (le nouveau numéro de téléphone ou la nouvelle adresse courriel appartient à un autre contact) ou CONTACT_IN_USE (retrait du numéro de téléphone d’un contact qui fait partie d’un groupe ou d’une liste).Le corps d’erreur standard.
422VALIDATION_ERROR (le contact n’aurait plus ni phone_number ni email) ou INVALID_PHONE_NUMBER.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

curl -X PATCH https://api.honkio.ca/v1/contacts/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Sam Tremblay",
    "notes": "Prefers texts after 5 p.m."
  }'

delete/v1/contacts/{id}

Supprimer un contact

Permissioncontacts:d

Nécessite contacts:d.

Paramètres

Paramètre	Type	Description
`id`obligatoirechemin	string

Réponses

204Supprimé, avec ses appartenances à des groupes et ses entrées de listes.
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 lorsqu’une clé de test tente de modifier un élément référencé par la liste d’autorisation ou de blocage d’une clé de production ; KEY_FENCED lorsque la modification assouplirait les restrictions d’autorisation et de blocage de la clé appelante elle-même. Aussi FORBIDDEN lorsque la clé ne dispose pas de la permission requise.Le corps d’erreur standard.
404CONTACT_NOT_FOUND.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

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