INinfobip
platform
messages-api
inbound-messages

Get inbound messages

If you are unable to receive incoming messages to the endpoint of your choice in real-time, you can use this API call to fetch messages. Each request will return a batch of received messages, only once. The API request will only return new messages that arrived since the last API request.

get/messages-api/1/inbound

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Query parameters

channel'APPLE_MB' | 'MESSENGER' | 'MMS' | 'SMS' | 'VIBER_BM' | 'WHATSAPP' required

Messaging channel for which inbound messages will be fetched.

limitinteger

Maximum number of messages to be returned in a response. If not set, last 50 records are returned. Maximum limit is 1000 and you can only access messages for the last 48h.

applicationIdstring

Application ID that the message is linked to. For more details, see our documentation.

entityIdstring

Entity ID that the message is linked to. For more details, see our documentation.

campaignReferenceIdstring

ID of a campaign that message belongs to.

Response

OK

messageCountinteger

The number of messages returned in the results array.

pendingMessageCountinteger

The number of messages that have not been pulled in.

Changes

No recorded changes to this operation across all 1 revision of this API.