Contact Groups

Send an SMS to all members of a contact group

Always answers 207, whether every member sent or every member failed: check each entry in results rather than the HTTP status. Each result names the member to number. A live broadcast repeated with the same Idempotency-Key within 24 hours answers with the first attempt's stored 207, without running the whole-group checks again or using another daily broadcast slot. A later retry with that key runs the checks again (and can use a slot) but never re-messages a member the first attempt already reached.

Requires messages:w.

post/v1/contact-groups/{id}/messages

Request

  • Base URL: https://api.honkio.ca
  • URL: https://api.honkio.ca/v1/contact-groups/{id}/messages
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

idstring required

Headers

idempotency-keystring

Request body

fromstring required

Sending number (E.164, must be owned by account)

bodystring required

Up to 1600 characters and 10 SMS parts. Longer bodies are rejected with 422 MESSAGE_TOO_LONG before any member is messaged.

skip_consent_checkboolean

Response

Always 207: check each result, not the status. A live broadcast repeated with the same Idempotency-Key within 24 hours answers with the first attempt's stored result.

group_idstring required
sent_tointeger required

Members not failed.

failedinteger required
estimated_completion_atstring date-time nullable

An estimate of when the carrier will have sent the last member, from the sending number's queue. Null in test mode. Absent from a stored replay of a broadcast sent before it existed.

Changes

No recorded changes to this operation across all 1 revision of this API.