SMS

Envoi de messages

Envoyez un SMS depuis un numéro qui vous appartient. L’API vérifie la destination canadienne et le consentement LCAP avant que quoi que ce soit n’atteigne l’opérateur.

Envoi de SMS

Envoyez un message en utilisant un numéro provisionné. L'API valide le numéro de destination canadien, vérifie le consentement LCAP avant la livraison (vérification LNNTE du CRTC à venir).

// "from" is one of your HonkIO numbers; "to" is a real number you hold consent for.
// Reuse the idempotency key on a retry: it returns the original message instead of sending and charging again.
const { data, error } = await honkio.messages.send({
  from: '+1416XXXXXXX',
  to: '+1613XXXXXXX',
  body: 'Hello from HonkIO! 🇨🇦',
}, { idempotencyKey: 'order-1042-shipped' })
if (error) throw new Error(`${error.name}: ${error.message}`)
console.log(data.id, data.status)

# "from" is one of your HonkIO numbers; "to" is a real number you hold consent for.
# Reuse the idempotency key on a retry: it returns the original message instead of sending and charging again.
curl -X POST https://api.honkio.ca/v1/messages \
  -H "Authorization: Bearer mk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-1042-shipped" \
  -d '{
    "from": "+1416XXXXXXX",
    "to":   "+1613XXXXXXX",
    "body": "Hello from HonkIO! 🇨🇦"
  }'

Un contact (POST /v1/contacts) prend un phone_number, un email, ou les deux. Les groupes, les diffusions et les listes d’autorisation ou de blocage utilisent les contacts qui ont un numéro de téléphone ; en ajouter un qui n’en a pas est refusé avec 422 CONTACT_HAS_NO_PHONE, et effacer le numéro d’un contact membre d’un groupe ou d’une liste avec 409 CONTACT_IN_USE.