---
title: "Get incoming RCS messages"
method: GET
path: "/v4/rcs/incoming/messages"
tags: ["RCS - Incoming"]
---

# Get incoming RCS messages

`GET /v4/rcs/incoming/messages`

## Request

- Base URL: `https://api.inmobile.com`
- URL: `https://api.inmobile.com/v4/rcs/incoming/messages`
- Auth: one of:
  - HTTP basic
  - API key in query parameter `apikey`

Each message will only be returned once. Once called, the message has been marked as read from our side and cannot be retrieved again using this method.

## Query parameters

- `limit` integer

## Response `200`

A list of messages

- IncomingRcsMessageListApiModel
  - `messages` IncomingRcsMessageApiModel[]
    - `from` RcsNumberDetails
      - `countryCode` string: The country code part of the msisdn, e.g. 45.
      - `phoneNumber` string: The phone number part of the msisdn, e.g. 12345678. Null if the message has been anonymized.
      - `msisdn` string: The final cleansed msisdn. If the message has been anonymized, this is the partially anonymized msisdn, e.g. 451122????.
      - `isAnonymized` boolean: Specifies whether the message has been anonymized or not.
    - `to` RcsAgentApiModel
      - `id` string, guid: The id of the RCS agent.
      - `name` string: The name of the RCS agent.
    - `content` union: Exactly one of text, file, location, or suggestionResponse is present.
      - object: The text content of the message.
        - `messageType` integer: The type of RCS message content. 1 = Text 2 = File 3 = Location 4 = SuggestionResponse
        - `text` IncomingRcsTextContentApiModel, required
          - `text` string: The actual text received
      - object: The file content of the message.
        - `messageType` integer: The type of RCS message content. 1 = Text 2 = File 3 = Location 4 = SuggestionResponse
        - `file` IncomingRcsFileContent, required
          - `thumbnail` IncomingRcsFileThumbnail
            - `mimeType` string: The mimetype of the thumbnail.
            - `fileSizeInBytes` integer: The size of the thumbnail in bytes.
            - `fileUri` string: URI of the thumbnail received.
          - `payload` IncomingRcsFilePayload
            - `mimeType` string: The mimetype of the file.
            - `fileSizeInBytes` integer: The size of the file in bytes.
            - `fileName` string: The name of the file.
            - `fileUri` string: URI of the file received.
      - object: The location content of the message.
        - `messageType` integer: The type of RCS message content. 1 = Text 2 = File 3 = Location 4 = SuggestionResponse
        - `location` IncomingRcsLocationContent, required
          - `latitude` number, double: The latitude in degrees.
          - `longitude` number, double: The longitude in degrees.
      - object: The suggestion response of the message
        - `messageType` integer: The type of RCS message content. 1 = Text 2 = File 3 = Location 4 = SuggestionResponse
        - `suggestionResponse` IncomingRcsSuggestionResponseContentApiModel, required
          - `postbackData` string: The postback data specified by the agent when the agent sent the suggestion to the user.
          - `text` string: The user-visible text of the suggestion that the user tapped.
          - `suggestionResponseType` integer: Code describing the type of suggestion response. 1 = Action 2 = Reply
          - `suggestionResponseTypeDescription` string: A text description of the suggestion response type.
    - `receivedAt` string: The time the message was received e.g., 2001-02-30T14:50:23Z (UTC time).

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `500`: Internal server error

---

[API](https://skmtc.dev/inmobile/apis/inmobile-rest-api.md) · [All operations](https://skmtc.dev/inmobile/apis/inmobile-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/inmobile/apis/inmobile-rest-api/revisions/197a90ad5f8f?raw)
