FarazSMS Public APIs
  1. Phonebook
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
  1. Phonebook

Get Phonebook Attributes

GET
/ws/v1/phone_book_attribute
Get paged list of phonebook attributes

Request

Authorization
Add parameter in header
Api-Key
Example:
Api-Key: ********************
Query 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/phone_book_attribute?page&limit' \
--header 'Api-Key: <api-key>'

Responses

🟢200Phonebook attributes retrieved successfully.
application/json
Body

Example
{
    "status": "success",
    "data": {
        "currentPage": 0,
        "totalPages": 0,
        "totalItems": 0,
        "itemsPerPage": 0,
        "items": [
            {
                "id": 0,
                "title": "string",
                "type": "date",
                "code": "string"
            }
        ]
    },
    "messages": "string"
}
Modified at 2025-04-25 21:47:44
Previous
Create New Phonebook
Next
Create New Phonebook Attribute
Built with