Home › Phonebook & Contacts

Get Phonebook Contacts — FarazSMS SMS web service

GET https://api.iranpayamak.com/ws/v1/phone_book_data

Purpose: Get a phonebook's contacts with search and pagination.

Get paged phonebook data for a specific phonebook

Authentication

This endpoint requires the Api-Key header — get the key from the FarazSMS panel. The header name is case-sensitive and the key must never travel in a query string.

Notes for this endpoint

• Gets a phonebook's contacts; pass phone_book_id in the query.
• Paginate with page/limit, search with search.

Responses

• 200 — Phonebook data retrieved successfully.

Related endpoints in Phonebook & Contacts

• GET /example/phone-book/{phone_book}/data.xlsx — Get Bulk Excel Sample
• POST /ws/v1/phone_book — Create New Phonebook
• GET /ws/v1/phone_book — Get Phonebooks
• PUT /ws/v1/phone_book/{id} — Update Phonebook
• POST /ws/v1/phone_book_attribute — Create New Phonebook Attribute
• GET /ws/v1/phone_book_attribute — Get Phonebook Attributes
• POST /ws/v1/phone_book_data/bulk-upsert — Add Bulk Contact
• POST /ws/v1/phone_book_data/excel-upsert — Add Excel Contact

All FarazSMS web services · llms.txt · OpenAPI