Create a group chat

Start an iMessage group chat from your dedicated line and send the first message. Everyone in the group needs iMessage. Lines without group support return 409 group_chats_unsupported. Shared lines return 409 group_requires_dedicated_line. Scope: comms_send.

post/groups

Request

  • Base URL: https://osis.co/api/v1/comms
  • URL: https://osis.co/api/v1/comms/groups
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Lets you retry safely. A retry returns the first group and message with duplicate: true.

Request body

participantsstring[] required

2 to 31 different phone numbers. Use E.164 unless you set default_country. Don't include your own line.

bodystring required

The first message. Required, because sending it is what creates the group.

namestring

A name for the group.

line_e164string

The dedicated line that starts the group. You can also call it from. Required unless you set line_id or your key is tied to a line.

line_idstring

The line's ID. Use this instead of line_e164 if you like.

fromstring

Another name for line_e164.

default_countrystring

Country code, only needed if participants are local numbers without a country code.

idempotency_keystring

Same as the Idempotency-Key header.

channel'imessage' | 'whatsapp'

imessage (default) or whatsapp.

Example request

{
  "participants": [
    "+12125550147",
    "+12125550148"
  ],
  "body": "Welcome to the launch crew.",
  "line_e164": "+12025550101"
}

Response

You already sent this request. Returns the first group and message with duplicate: true. If the first result was unknown you get 202 again, and if it failed you get the same error.

duplicateboolean
delivery_unknownboolean

Changes

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