HonkIOHonkIO

Référence de l’API

Listes

Listes de contacts d’autorisation et de blocage assignables aux clés API.

get/v1/lists

Lister toutes les listes de contacts

Permissionlists:r

Nécessite lists:r.

Paramètres

ParamètreTypeDescription
limitrequêteinteger
  • Minimum : 1
  • Maximum : 100
  • Par défaut : 50
offsetrequêteinteger
  • Minimum : 0
  • Par défaut : 0

Réponses

  • 200Une page de listes, de la plus récente à la plus ancienne, chacune avec ses entrées.
    ChampTypeDescription
    totalobligatoireinteger

    Nombre total d’enregistrements correspondants.

    limitobligatoireinteger
    offsetobligatoireinteger
    data[]obligatoireobject[]
    idobligatoirestring
    nameobligatoirestring
    descriptionobligatoirestring
    • Peut être null
    entry_countobligatoireinteger
    entries[]obligatoireobject[]
    idobligatoirestring
    phone_numberobligatoirestring

    Défini pour une entrée de numéro direct.

    • Peut être null
    contact_idobligatoirestring

    Défini pour une entrée de contact.

    • Peut être null
    contact_group_idobligatoirestring

    Défini pour une entrée de groupe, qui est remplacée par les membres du groupe au moment de l’envoi.

    • Peut être null
    contact_nameobligatoirestring
    • Peut être null
    contact_phoneobligatoirestring
    • Peut être null
    group_nameobligatoirestring
    • Peut être null
    added_atobligatoirestring
    • Format : date-time
    created_atobligatoirestring
    • Format : date-time
    updated_atobligatoirestring
    • 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/lists \
  -H "Authorization: Bearer mk_live_YOUR_KEY"
post/v1/lists

Créer une liste de contacts

Permissionlists:w

Nécessite lists:w.

Corps de la requête

ChampTypeDescription
nameobligatoirestring
  • Au plus 100 caractères
descriptionstring
  • Au plus 500 caractères

Réponses

  • 201La liste.
    ChampTypeDescription
    idobligatoirestring
    nameobligatoirestring
    descriptionobligatoirestring
    • Peut être null
    entry_countobligatoireinteger
    entries[]obligatoireobject[]
    idobligatoirestring
    phone_numberobligatoirestring

    Défini pour une entrée de numéro direct.

    • Peut être null
    contact_idobligatoirestring

    Défini pour une entrée de contact.

    • Peut être null
    contact_group_idobligatoirestring

    Défini pour une entrée de groupe, qui est remplacée par les membres du groupe au moment de l’envoi.

    • Peut être null
    contact_nameobligatoirestring
    • Peut être null
    contact_phoneobligatoirestring
    • Peut être null
    group_nameobligatoirestring
    • Peut être null
    added_atobligatoirestring
    • Format : date-time
    created_atobligatoirestring
    • Format : date-time
    updated_atobligatoirestring
    • 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_LIST_ALREADY_EXISTS : ce nom est déjà utilisé.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 -X POST https://api.honkio.ca/v1/lists \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "..."
  }'
get/v1/lists/{id}

Obtenir une liste de contacts avec ses entrées

Permissionlists:r

Nécessite lists:r.

Paramètres

ParamètreTypeDescription
idobligatoirecheminstring

Réponses

  • 200La liste, avec ses entrées.
    ChampTypeDescription
    idobligatoirestring
    nameobligatoirestring
    descriptionobligatoirestring
    • Peut être null
    entry_countobligatoireinteger
    entries[]obligatoireobject[]
    idobligatoirestring
    phone_numberobligatoirestring

    Défini pour une entrée de numéro direct.

    • Peut être null
    contact_idobligatoirestring

    Défini pour une entrée de contact.

    • Peut être null
    contact_group_idobligatoirestring

    Défini pour une entrée de groupe, qui est remplacée par les membres du groupe au moment de l’envoi.

    • Peut être null
    contact_nameobligatoirestring
    • Peut être null
    contact_phoneobligatoirestring
    • Peut être null
    group_nameobligatoirestring
    • Peut être null
    added_atobligatoirestring
    • Format : date-time
    created_atobligatoirestring
    • Format : date-time
    updated_atobligatoirestring
    • 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_LIST_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/lists/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"
patch/v1/lists/{id}

Mettre à jour une liste de contacts

Permissionlists:m

Nécessite lists:m.

Paramètres

ParamètreTypeDescription
idobligatoirecheminstring

Corps de la requête

ChampTypeDescription
namestring
  • Au plus 100 caractères
descriptionstring
  • Au plus 500 caractères

Réponses

  • 200La liste mise à jour.
    ChampTypeDescription
    idobligatoirestring
    nameobligatoirestring
    descriptionobligatoirestring
    • Peut être null
    entry_countobligatoireinteger
    entries[]obligatoireobject[]
    idobligatoirestring
    phone_numberobligatoirestring

    Défini pour une entrée de numéro direct.

    • Peut être null
    contact_idobligatoirestring

    Défini pour une entrée de contact.

    • Peut être null
    contact_group_idobligatoirestring

    Défini pour une entrée de groupe, qui est remplacée par les membres du groupe au moment de l’envoi.

    • Peut être null
    contact_nameobligatoirestring
    • Peut être null
    contact_phoneobligatoirestring
    • Peut être null
    group_nameobligatoirestring
    • Peut être null
    added_atobligatoirestring
    • Format : date-time
    created_atobligatoirestring
    • Format : date-time
    updated_atobligatoirestring
    • 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_LIST_NOT_FOUND.Le corps d’erreur standard.
  • 409CONTACT_LIST_ALREADY_EXISTS : ce nom est déjà utilisé.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 -X PATCH https://api.honkio.ca/v1/lists/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Numbers that asked not to be texted"
  }'
delete/v1/lists/{id}

Supprimer une liste de contacts

Permissionlists:d

Nécessite lists:d.

Paramètres

ParamètreTypeDescription
idobligatoirecheminstring

Réponses

  • 204Supprimée. Une clé à laquelle elle était attribuée perd cette restriction.
  • 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_LIST_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/lists/ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"
post/v1/lists/{id}/entries

Ajouter une entrée à une liste de contacts

Permissionlists:m

Fournissez exactement un des champs suivants : phone_number (numéro E.164 direct), contact_id (fiche Contact) ou contact_group_id (ContactGroup : étendu à tous ses membres au moment de l’envoi).

Nécessite lists:m.

Paramètres

ParamètreTypeDescription
idobligatoirecheminstring

Corps de la requête

ChampTypeDescription
phone_numberstring
contact_idstring
contact_group_idstring

Réponses

  • 201L’entrée.
    ChampTypeDescription
    idobligatoirestring
    phone_numberobligatoirestring
    • Peut être null
    contact_idobligatoirestring
    • Peut être null
    contact_group_idobligatoirestring
    • Peut être null
    added_atobligatoirestring
    • 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 ; 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_LIST_NOT_FOUND, CONTACT_NOT_FOUND ou CONTACT_GROUP_NOT_FOUND.Le corps d’erreur standard.
  • 409CONTACT_LIST_ENTRY_EXISTS.Le corps d’erreur standard.
  • 422CONTACT_LIST_ENTRY_INVALID (il faut fournir exactement un champ parmi phone_number, contact_id et contact_group_id), INVALID_PHONE_NUMBER ou CONTACT_HAS_NO_PHONE.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/lists/ID/entries \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+1613XXXXXXX"
  }'
delete/v1/lists/{id}/entries/{entryId}

Retirer une entrée d’une liste de contacts

Permissionlists:m

Nécessite lists:m.

Paramètres

ParamètreTypeDescription
idobligatoirecheminstring
entryIdobligatoirecheminstring

Réponses

  • 204Retrait effectué.
  • 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_LIST_NOT_FOUND ou CONTACT_LIST_ENTRY_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/lists/ID/entries/ENTRY_ID \
  -H "Authorization: Bearer mk_live_YOUR_KEY"