List inbound messages

Returns received messages, newest first, 100 per page. Webhooks are the recommended way to receive inbound messages; use this endpoint if you need to poll. Pass id_after (the last ID you saw) or created_after to fetch only new messages.

GET

https://app.messageport.com.au/api/v2/inbounds

Authorization

basicAuth
HTTP
required

Query parameters

created_after
optional
string
ISO 8601 date-time. Only return messages received at or after this time.

format: date-time
id_after
optional
integer
Only return messages with an ID greater than this.
page
optional
integer
Page number. Prefer following links.next until it is null.

minimum: 1 · default: 1

Returns

200

A page of inbound messages.

JSON

data
optional
array of
object
- id
  optional
  integer
- content
  optional
  string
- number
  optional
  string
  Sender's number.
- received_by_number
  optional
  string
  Your number that received the message, or SHARED_NUMBER.
- new
  optional
  boolean | integer
  Whether the message is unread.
- optout
  optional
  boolean | integer
  Whether the message was an opt-out request.
- channel
  optional
  webchat
  or
  null
  webchat for web chat messages, otherwise null (SMS).
- media_urls
  optional
  array of
  string
  Direct URLs to inbound MMS media. Empty for SMS.
  
  format: uri
- updated
  optional
  string
  format: date-time
- created
  optional
  string
  format: date-time
- contact
  optional
  The matching contact, if any.
  
  One of the following:
  Contact
  id
  optional
  integer
  user
  optional
  integer
  ID of the user that owns the contact.
  
  account
  optional
  integer
  Account ID. Only present on global contacts.
  
  firstname
  optional
  string | null
  surname
  optional
  string | null
  email
  optional
  string | null
  number
  optional
  string
  metadata
  optional
  object | null
  groups
  optional
  array of
  object
  id
  optional
  integer
  name
  optional
  string
  notes
  optional
  array of
  object
  Notes on the contact. Only returned when getting or updating a single contact.
  
  id
  optional
  integer
  content
  optional
  string
  created_at
  optional
  string
  format: date-time
  updated_at
  optional
  string
  format: date-time
  updated
  optional
  string
  format: date-time
  created
  optional
  string
  format: date-time
  null
- message
  optional
  The outbound message this is a reply to, if any.
  
  One of the following:
  SentMessage
  id
  optional
  integer
  ulid
  optional
  string | null
  campaign
  optional
  integer | null
  country
  optional
  integer | null
  contact
  optional
  integer | null
  number
  optional
  string
  Recipient.
  
  senderid
  optional
  string | null
  message
  optional
  string
  status
  optional
  integer
  unicode
  optional
  boolean | integer
  parts
  optional
  integer
  cost
  optional
  number
  reference
  optional
  string | null
  metadata
  optional
  object | null
  source
  optional
  string | integer | null
  scheduled
  optional
  string | null
  format: date-time
  processed
  optional
  string | null
  format: date-time
  updated
  optional
  string
  format: date-time
  created
  optional
  string
  format: date-time
  null
}
links
optional
object
Links to other pages. next is null on the last page.
- first
  optional
  string | null
  format: uri
- last
  optional
  string | null
  format: uri
- prev
  optional
  string | null
  format: uri
- next
  optional
  string | null
  format: uri
}
meta
optional
object
Position in the result set. Read per_page rather than assuming a page size.
- current_page
  optional
  integer
- from
  optional
  integer | null
- last_page
  optional
  integer
- path
  optional
  string
  format: uri
- per_page
  optional
  integer
- to
  optional
  integer | null
- total
  optional
  integer
- links
  optional
  array of
  object
  Page links for building pagination controls.
  
  url
  optional
  string | null
  label
  optional
  string
  active
  optional
  boolean
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

422

The request failed validation. errors lists the messages for each invalid field.

JSON

message
optional
string
errors
optional
map of
array<string>

429

Rate limit exceeded. Wait before retrying.

JSON

message
string
required