Robeeta Cloud Msg4 API Document

Robeeta Cloud Msg4 API Document

Read Interactive Message List

Robeeta Cloud Msg4 API Documentation - Read Interactive Messages

Retrieves a list of interactive WhatsApp messages with filtering, pagination, and search capabilities. The API allows you to fetch messages within a specific date range with various filtering options.

POST https://api.msg4.cloud.robeeta.com/Message/ReadWbaInteractiveMessageList

Authorization: Api key

Header: Content-Type: application/json

Request Body

  • ApiKey: string - (required) Your API key for authentication.
  • SenderNumber: string - (required) Registered sender number from which messages were sent.
  • StartTime: string - (required) Start time for filtering messages ("dd-MMM-yyyy HH:mm:ss").
  • EndTime: string - (required) End time for filtering messages ("dd-MMM-yyyy HH:mm:ss"). Must be same date.
  • PageNumber: integer - (optional) Page number for pagination (default: 1).
  • RowsPerPage: integer - (optional) Rows per page (default: 10).
  • QuickSearch: string - (optional) Search text across message, mobile number, and reply type.
  • SortColumn: string - (optional) Sort column (default: "MessageId").
  • SortDescending: boolean - (optional) Sort order (default: false).

Response Body

  • Response: string - Description of request result.
  • StatusCode: integer - Status code.
  • TotalPages: integer - Total pages available.
  • TotalRows: integer - Total message rows.
  • WbaInteractiveMessageList: array
    • MessageId: string
    • BaseMessageId: string
    • ReplyType: string
    • ReplyId: string
    • MessageText: string
    • MobileNumber: string
    • MessageType: string
    • OriginType: string

Status Codes and Descriptions:

StatusCode Response Description
200OKRequest successful
400Invalid Sender NumberSender number missing or invalid
400Start/End Date ErrorDates must be same day
401Invalid AccessAPI key failed
402Message Count ExceedsCannot exceed 100
403Invalid AccessSender number unauthorized
500ErrorInternal error
500Unknown ErrorUnexpected error
1705Invalid Mobile NumberMobile number empty
1704Invalid ApiKeyApiKey empty

Important Notes:

  • StartTime and EndTime must be same date.
  • Only interactive MessageType is returned.
  • QuickSearch checks MessageText, MobileNumber, ReplyType.
Sample Request:
curl -X POST \
https://api.msg4.cloud.robeeta.com
/Message/ReadWbaInteractiveMessageList \
-H "Content-Type: application/json" \
-d '{
  "ApiKey": "string",
  "SenderNumber": "string",
  "StartTime": "string",
  "EndTime": "string",
  "PageNumber": 0,
  "RowsPerPage": 0,
  "QuickSearch": "string",
  "SortColumn": "string",
  "SortDescending": false
}'
Response:
{
  "Response": "string",
  "StatusCode": 0,
  "TotalPages": 0,
  "TotalRows": 0,
  "WbaInteractiveMessageList": [
    {
      "MessageId": "string",
      "BaseMessageId": "string",
      "ReplyType": "string",
      "ReplyId": "string",
      "MessageText": "string",
      "MobileNumber": "string",
      "MessageType": "string",
      "OriginType": "string"
    }
  ]
}