FarazSMS Public APIs
    FarazSMS Public APIs
    • Account
      • Profile
        GET
      • Account Balance
        GET
      • update
        POST
      • Charge wallet
        POST
      • Register
        POST
    • Send
      • Send Sample SMS
        POST
      • Send Simple SMS
        POST
      • Send Simple SMS from Excel
        POST
      • Send SMS with Variables
        POST
      • Send SMS with Variables from Excel
        POST
      • Send Peer-to-Peer SMS
        POST
      • Send Peer-to-Peer SMS from Excel
        POST
      • Send Pattern-Based SMS
        POST
    • Phonebook
      • Get Phonebooks
        GET
      • Create New Phonebook
        POST
      • Get Phonebook Attributes
        GET
      • Create New Phonebook Attribute
        POST
      • Get Phonebook Contacts
        GET
    • Pattern
      • Create New Pattern
        POST
      • Get Pattern Details
        GET
      • Edit Pattern
        PUT
      • Get List of User's Patterns
        GET
    • Get Paged Inbox Messages
      GET

      Get Paged Inbox Messages

      GET
      /ws/v1/inbox

      Request

      Authorization
      Add parameter in header
      Api-Key
      Example:
      Api-Key: ********************
      Query Params

      Header Params

      Request Code Samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET '/ws/v1/inbox?page&limit' \
      --header 'Accept: application/json' \
      --header 'Api-Key: <api-key>'

      Responses

      🟢200Inbox messages retrieved successfully.
      application/json
      Body

      Example
      {
          "status": "success",
          "data": {
              "currentPage": 0,
              "totalPages": 0,
              "totalItems": 0,
              "itemsPerPage": 0,
              "items": [
                  {
                      "from": "string",
                      "to": "500012345",
                      "text": "string",
                      "recievedAt": "2019-08-24T14:15:22Z"
                  }
              ]
          },
          "messages": "string"
      }
      Modified at 2025-08-28 12:52:40
      Previous
      Get List of User's Patterns
      Built with