Send your first message

Send your first text message in a uni-app or uni-app x application to verify direct and group messaging pipelines. Before proceeding, complete the environment setup in Before you start and authenticate following Authenticate and manage a session.

OpenIM messages can be sent to individual users or groups. Direct messages specify the recipient user via recvID, while group messages specify the target group via groupID.

Prepare target identifiers

Sending your first message validates your complete integration pipeline. Before sending:

• Ensure the direct chat recipient user exists and server permissions permit communication.
• Ensure the target group exists, the current user is an active member, and group speaking privileges are not muted.
• Verify that your client received onConnectSuccess, rather than relying solely on the resolved login() Promise.

Import messaging APIs

Import messaging methods from the plugin root:

import {
  createTextMessage,
  sendMessage,
} from '@/uni_modules/unix-openim-sdk'

Send a direct message

Sending a message involves two steps: construct an unsent OpenIMMessageItem with Create a text message, then pass that item and the target identifier to Send a message:

async function sendFirstDirectMessage() {
  const message = await createTextMessage('Hello, OpenIM')
  if (message == null) return

  const sentMessage = await sendMessage({
    message,
    recvID: 'user_b',
    groupID: '',
    offlinePushInfo: null,
    isOnlineOnly: false,
  })

  appendOutgoingMessage(sentMessage)
}

Replace user_b with a valid recipient user ID. Do not pass user nicknames, phone numbers, or the current user's own userID as recvID.

Send a group message

When sending to a group, set groupID and leave recvID empty:

async function sendFirstGroupMessage() {
  const message = await createTextMessage('Hello everyone')
  if (message == null) return

  const sentMessage = await sendMessage({
    message,
    recvID: '',
    groupID: 'group_123',
    offlinePushInfo: null,
    isOnlineOnly: false,
  })

  appendOutgoingMessage(sentMessage)
}

Replace group_123 with a valid OpenIM group ID. You can reuse an existing group or create one via the admin console, backend APIs, or SDK group methods.

Understand send results

Create a text message returns an uncommitted message object locally. If it returns null, do not call sendMessage(). Creating a message does not transmit data over the network or trigger message events.

Send a message returns the updated OpenIMMessageItem. Resolution indicates the message has been committed and persisted by OpenIMServer. The sender can locate the message in local state using clientMsgID and mark its status as sent. The recipient client receives the message through real-time message events. Verify both sending and receiving sides during integration.

If sending fails, the Promise rejects with an error containing errCode and errMsg. Inspect the error details alongside OpenIMServer logs to troubleshoot.

Verification checklist

1. Confirm the return status and clientMsgID on the sending client.
2. Verify receipt of the message event on a second logged-in client. Determine the conversationID from the message payload and merge it into your active conversation view.
3. Test both direct and group conversations.
4. Simulate network disconnections and reconnections to verify automatic recovery and message replay.

For event registration, listener cleanup, and conversation merging rules, see Receive messages.

Next steps

• Authenticate and manage a session
• Integrate by project and platform