---
title: "User message"
method: POST
path: "userMessage"
tags: ["Webhooks"]
---

# User message

`POST userMessage` (webhook)

The end user has sent a message, file, location, or response to your RCS agent.

## Headers

- `X-Vibes-Eventclass` unknown, required
- `X-Vibes-Signature` unknown, required

## Payload

- UserMessage: An event delivering a message that the user sent to the agent.
  - `agentId` string: The agent's unique identifier.
  - `sendTime` string, Timestamp: Timestamp (RFC 3339) at which the webhook event was sent.
  - `senderPhoneNumber` string: User device phone number in E.164 format.
  - `messageId` string: Unique identifier of the message.
  - `text` string: Text body of the message, when the user sent text.
  - `userFile` UserFile: A file attachment sent by the user.
    - `category` 'FILE_CATEGORY_UNSPECIFIED' | 'IMAGE' | 'VIDEO' | 'AUDIO': The category the file belongs to.
    - `thumbnail` FileInfo: Metadata describing a file.
      - `mimeType` string: MIME type of the file.
      - `fileSizeBytes` integer: Size of the file in bytes.
      - `fileName` string: Original file name.
      - `fileUri` string: URI from which the file can be retrieved.
    - `payload` FileInfo: Metadata describing a file.
      - `mimeType` string: MIME type of the file.
      - `fileSizeBytes` integer: Size of the file in bytes.
      - `fileName` string: Original file name.
      - `fileUri` string: URI from which the file can be retrieved.
  - `location` UserMessageLatLng: A geographic location shared by the user, expressed as latitude/longitude.
    - `latitude` number, double: The latitude in degrees. Must be in the range [-90.0, +90.0].
    - `longitude` number, double: The longitude in degrees. Must be in the range [-180.0, +180.0].
  - `suggestionResponse` SuggestionResponse: The user's response to a suggested reply or action.
    - `postbackData` string: Postback data associated with the suggestion the user tapped.
    - `text` string: Text of the suggestion the user tapped.
    - `type` 'UNKNOWN' | 'ACTION' | 'REPLY': Whether the response came from a suggested action or reply.
  - `richMessageClassification` UserMessageRichMessageClassification: Billing classification for a user message.
    - `classificationType` 'RICH_MESSAGE' | 'RICH_MEDIA_MESSAGE': Specifies the message's classification for billing purposes.
    - `segmentCount` integer: The number of 160-byte segments for the message's text, always rounded up.
  - `googleCarrier` string: Carrier reported by Google for the sender.

## Acknowledgement `200`

Return 200 to acknowledge receipt of the webhook.

---

[API](https://skmtc.dev/vibes/apis/vibes-rcs-business-messaging-api.md) - [All operations](https://skmtc.dev/vibes/apis/vibes-rcs-business-messaging-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vibes/apis/vibes-rcs-business-messaging-api/revisions/94076f49389f?raw)