get
https://gw.commpeak.com/textpeak/streams/incoming_messages
Description
Summary: Retrieves a paginated list of incoming messages from streams with optional filtering. Details: This endpoint returns incoming messages with support for filtering by status, stream ID, phone number, destination, and date range. Results are paginated and returned as a JSON array of incoming message objects along with pagination metadata. Each message includes details such as its ID, content, status, associated stream, timestamps, and sender/recipient information.
Authentication & Scopes
Authentication is handled via an API key provided in the Authorization header. No OAuth scopes are defined; access is granted or denied based on the validity of the key.
| Method | Details |
|---|---|
| API Key | Pass your API key directly in the Authorization header value (not as a Bearer token). |
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | The API key that verifies your access to the API. |
accept | No | Expected response format. Default: application/json. |
Content-Type | No | Request content type. Default: application/json. |
Parameters
All parameters are passed as query parameters and are optional.
| Parameter | Type | Required | Description |
|---|---|---|---|
itemsPerPage | number | No | The number of items to include per page. Default: 30. |
page | number | No | The page number for pagination. Default: 1. |
status | number | No | Filter incoming messages by status code (e.g., 2). |
streamId | string | No | Filter incoming messages by stream ID. |
phone | string | No | Filter incoming messages by phone number. |
startDate | string | No | Filter incoming messages created on or after this date. |
endDate | string | No | Filter incoming messages created on or before this date. |
destination | string | No | Filter incoming messages by destination. |
Request Body
This endpoint does not use a request body.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…