---
title: "Receive incoming message"
method: POST
path: "receive-omni-failover-inbound-messages"
tags: ["channels", "omni-failover", "receive-incoming-messages"]
---

# Receive incoming message

`POST receive-omni-failover-inbound-messages` (webhook)

Incoming messages will be forwarded in real time to the end-point client provided during the setup. This way, 2-way communication will be established, and the enterprise is enabled to create a certain logic for processing incoming messages.

## Payload

- 46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4OttReportResponse
  - `results` 46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4MoReport[]: Collection of reports, one per every received message.
    - union
      - object
        - `from` string: Number which sent the message.
        - `to` string: Sender provided during the activation process.
        - `receivedAt` string, date-time: Date and time when Infobip received the message.
        - `messageId` string: The ID that uniquely identifies the received message.
        - `price` 3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8Price
          - `currency` string: The currency in which the price is displayed.
          - `pricePerMessage` number, double: The price per individual message.
        - `message` 0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99InboundMessage
          - `type` 'TEXT' | 'IMAGE' | 'DOCUMENT' | 'STICKER' | 'LOCATION' | 'CONTACT' | 'VIDEO' | 'VOICE' | 'AUDIO' | 'BUTTON' | 'INTERACTIVE_BUTTON_REPLY' | 'INTERACTIVE_LIST_REPLY' | 'INTERACTIVE_PAYMENT_CONFIRMATION' | 'ORDER' | 'UNSUPPORTED': Type of the message content. Select the type from the dropbox to view their parameters.
          - `context` 0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99Context: Information about the message to which the end user responded.
            - `id` string: MessageId of the message to which the end user responded.
            - `from` string: End user's phone number.
            - `referredProduct` 033803db88cada38464c4e86c919c67cee20aa369072ec632b1c62ea0cc27514ReferredProduct: Product information included in the incoming message.
              - …
          - `identity` 0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99Identity: Information about the identity of the end user.
            - `acknowledged` boolean: Indicates whether identity is acknowledged.
            - `hash` string: Identifier for the latest user_identity_changed system notification
            - `createdAt` string, date-time: Indicates when the identity was changed. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
          - `referral` 0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99Referral: Information about the referral which is either a Facebook ad or a post that triggered the message.
            - `sourceType` 'AD' | 'POST' | 'UNKNOWN': Indicates the source of the referral. Takes the value of `UNKNOWN` if there's no value or the value is different from `AD` or `POST`.
            - `sourceId` string: Facebook ID of an ad or a post.
            - `sourceUrl` string: The URL that leads to a Facebook ad or a post.
            - `headline` string: Headline used in the ad that generated the message.
            - `body` string: Body from the ad that generated the message.
            - `ctwaClickId` string: Unique per click identifier exposed when the end user entering the conversation originated from a Click to WhatsApp (CTWA) ad.
            - `referralMedia` union: Media information of included referral.
              - …
        - `contact` 0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99ContactName
          - `name` string: Contact name
          - `phoneNumber` string: Sender's phone number.
          - `userId` string: User ID
          - `parentUserId` string: parent user ID.
          - `username` string: Username.
      - object
        - `integrationType` 'VIBER': Integration type.
        - `message` 477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aeceMoMessage
          - `type` 'TEXT' | 'FILE'
        - `from` string: Number which sent the message.
        - `to` string: Sender provided during the activation process.
        - `receivedAt` string, date-time: Date and time when Infobip received the message.
        - `messageId` string: The ID that uniquely identifies the received message.
        - `pairedMessageId` string
        - `callbackData` string
        - `price` 3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8Price
          - `currency` string: The currency in which the price is displayed.
          - `pricePerMessage` number, double: The price per individual message.
      - object
        - `integrationType` 'WHATSAPP' | 'VIBER' | 'FACEBOOK': Integration type.
        - `message` object
          - `type` 'TEXT': Message type.
          - `text` string: Incoming message text.
        - `from` string: Number which sent the message.
        - `to` string: Sender provided during the activation process.
        - `receivedAt` string, date-time: Date and time when Infobip received the message.
        - `messageId` string: The ID that uniquely identifies the received message.
        - `pairedMessageId` string
        - `callbackData` string
        - `price` 3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8Price
          - `currency` string: The currency in which the price is displayed.
          - `pricePerMessage` number, double: The price per individual message.
  - `messageCount` integer: Number of returned messages in this request.
  - `pendingMessageCount` integer: Number of remaining new messages on Infobip servers ready to be returned in the next request.

## Acknowledgement `200`

Your server returns this code if it accepts the callback

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)