iMessage

Start an iMessage group chat

Changed on

Creates a group chat from one of your senders and sends its first message.

The provider processes it asynchronously: the response carries the request id, and the thread appears in the inbox (with its group conversation id) on the first webhook.

Requirements

  • Starting a group counts as messaging new contacts, so the sender needs the provider's init-conversations add-on and the same sending intervals apply. Without it the request fails with 409 recipient_must_message_first.
  • WhatsApp groups need a name.
post/v1/imessage/groups

Request

  • Base URL
    https://zernio.com/api
  • Auth
    HTTP bearer

Request body

accountIdstring required

The iMessage account (sender) that opens the group

contactsstring[] required

Participant handles (E.164 phones or iMessage emails)

textstring required

The first message

namestring

Group name (required for WhatsApp groups)

channel'imessage' | 'sms' | 'rcs' | 'whatsapp'

Response

Group creation accepted

successboolean
requestIdstring

The provider's request id (not the group id)

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    7 more changes in this revision