messages.sendToGroupOfUsers()

Creates a new Group with specified members and current user, and sends a message to it.

Note: If you'd like to send a message to an existing group of users, try searching for the group with the groups.findAllWithSpecificMembers() function.

It is required to specify the organizationId option, since conversations with the same users can be present in different organizations.

Definition

client.messages.sendToGroupOfUsers(
  userIds: string[]|Object[],
  body: string,
  options: Object
)

Parameters

Parameter	Type	Description
`userIds`	`string`\|`Object`	Users to add to the new group
`body`	`string`	Message body
`options`	`?Object`	Options (described below)

Options

Parameter	Type	Description
`attachmentFile`	`Object`	A single message attachment
`attachmentFiles`	`?Array<string`\|`Object>`	A list of message attachments. Currently only a single attachment is supported.
`avatarFile`	File	When sending a message involves creating a group, the avatar of that group
`deleteOnRead`	`?boolean`	Indicates whether message should be deleted after reading (default: `false`)
`description`	`?string`	When sending a message involves creating a group, the description of that group
`escalate`	`?boolean`	Indicates whether message is escalated
`groupMetadata`	`?Object`	When sending a message involves creating a group, the metadata to supply for that group
`groupName`	`?Object`	When sending a message involves creating a group, the name of that group
`metadata`	`?Array<Object>`\|`?Object`	An array (or single object) of message metadata objects of extra information about the message.
`organizationId`	`?string`	When sending a message to a user or role, which organization should have this conversation
`priority`	`?string`	Message priority. Values: `NORMAL` (default), `HIGH`
`senderId`	`?string`	ID of message sender (defaults to current user)
`ttl`	`?number`	Time to live in minutes. Organization settings might override this ttl.

Returns

An error will be thrown if any of the arguments are invalid.

Otherwise, once the returned Promise is resolved, you will have access to the newly created Message.

Example

const userIds = ["userId1", "userId2", "userId3"];
const body = "This is your message body here";
const message = await client.messages.sendToGroupOfUsers(userIds, body);
console.log(
  "sent", message.body, "to", message.recipient.displayName,
  "in group", message.group.displayName
);