channels
sms
inbound-sms

Get inbound SMS messages

If you are unable to receive incoming SMS 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. To use this method, you’d need to:<ol><li><a href="https://www.infobip.com/docs/api/platform/numbers/phone-numbers/purchase-number">Buy a number</a> capable of receiving SMS traffic.</li><li>Specify a forwarding endpoint for the number and optionally configure other <a href="https://www.infobip.com/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration">inbound settings</a>.</li></ol>

get/sms/1/inbox/reports

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

limitinteger

Maximum number of messages to be returned in a response. If not set, the latest 50 records are returned. Maximum limit value 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 was sent in the message.

Response

successful response

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.