---
title: "Get Inbound and Outbound Details"
method: POST
path: "/reports/message-reports"
tags: ["Reports"]
---

# Get Inbound and Outbound Details

`POST /reports/message-reports`

Generates a paginated report of all inbound and outbound message transmissions  within a specified time frame (supports a maximum date range of up to 2 months).  Supports granular filtering by targeted group IDs, specific transactional message  types (such as Broadcast, TwoWay, OptInResponse, or KeywordResponse), and applies  dynamic time zone offsets to accurately align historical delivery metrics.

## Request body

- ReportRequestParam
  - `groupIds` string[] — An array of unique groupIds used to narrow down the message report metrics to specific subscriber groups.
  - `messageTypes` string[] — An array of transactional message type categories to include in the report.
  - `pageNumber` integer — Specifies the page index of the filtered reporting results to retrieve. Must be greater than or equal to 1.
  - `pageSize` integer — Controls the maximum number of log records returned per page response.
  - `fromDate` string — The starting point of the reporting window formatted as a standard date string (YYYY-MM-DD). The total window spanned between 'fromDate' and 'toDate' must not exceed a maximum duration of 2 months.
  - `toDate` string — The concluding endpoint of the reporting window formatted as a standard date string (YYYY-MM-DD). The total window spanned between 'fromDate' and 'toDate' must not exceed a maximum duration of 2 months.
  - `timeZoneOffset` string — The target numeric or string timezone displacement value used to accurately align historical UTC logs with your local business timeline metrics.

## Response `200`

Success

- InboundOutboundResponsePaginatedResponse3ExternalApiResponseNew
  - `data` InboundOutboundResponsePaginatedResponse3
    - `pageNumber` integer
    - `pageSize` integer
    - `totalCount` integer
    - `totalPages` integer
    - `data` InboundOutboundResponse[], nullable
      - `id` string — The unique identifier generated for the specific message transaction log.
      - `accountId` string — The unique identifier of the top-level PBT account.
      - `divisionId` string — The unique identifier of the brand division or campus associated with the message.
      - `groupId` string — The unique identifier of the group that sent or received the message transmission.
      - `messageType` string — The specific category of the message transaction (e.g., Broadcast, TwoWay, AutoResponse, KeywordResponse).
      - `message` string — The actual raw text content delivered to or received from the subscriber.
      - `subscriberNo` string — The mobile phone number of the subscriber involved in the transmission.
      - `groupName` string — The descriptive name of the messaging group at the time of transmission.
      - `communicationCode` string — The short code or 10DLC phone number used to send or receive the message.
      - `direction` string — Indicates the routing flow of the traffic. Typically 'Inbound' or 'Outbound'.
      - `statusCode` string, nullable — The platform or network aggregator status code string representing delivery state.
      - `statusCodeDescription` string, nullable — A human-readable description of the delivery status code (e.g., Delivered, Message Queued).
      - `transactionTicket` string, nullable — A downstream carrier-level transaction ticket code used for network tracing.
      - `timestamp` string, date-time — The localized timestamp indicating exactly when the message event occurred.
      - `referenceId` string — The client-provided tracking identifier passed during the initial send request.
      - `subscriberFirstName` string, nullable — The first name of the contact, if registered in the subscriber profile.
      - `subscriberLastName` string, nullable — The last name of the contact, if registered in the subscriber profile.
      - `mediaUrl` string, nullable — The hosted public file link for attachments if the transmission was a media-based message (MMS/WhatsApp).
      - `customParams` PropertiesNew[], nullable — Optional key-value metadata parameters attached to the transaction for custom business workflows.
        - `name` string, nullable
        - `value` string, nullable
      - `isFallback` boolean — Indicates whether this transmission was automatically converted to an SMS failover due to an MMS delivery failure.
      - `region` string, nullable — The subscriber geographic territory or country code context assigned to the transmission.
      - `utilizedAmount` string, nullable — The credit total deducted from the account wallet balance for Whatsapp message delivery.
  - `appCode` string, nullable
  - `message` string, nullable
  - `isError` boolean

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/ministrybytext/apis/pbt-api-documentation.md) · [All operations](https://skmtc.net/ministrybytext/apis/pbt-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ministrybytext/pbt-api-documentation/versions/ca6e9c8f430d/schema)