Home › Reference & Tools
Get List of Avalibale Banks — FarazSMS SMS web service
GET https://api.iranpayamak.com/ws/v1/number_bank
Purpose: List the available number banks for targeted sending (filter by province/city).
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
- Lists number banks for targeted sends (filter by province/city).
- Use the result in “Send to Number Bank”.
Responses
200— Phonebooks retrieved successfully.
Related endpoints in Reference & Tools
GET /cities— Get Cities List of ProvincesGET /provinces— Get Provinces ListGET /ws/v1/number_bank/{number_bank_id}— Get Number Bank DetailsPOST /ws/v1/sms/calculate-cost— Calculate Send SMS CostGET /ws/v1/sms/postal/get-available-lines— Get Available LinesGET /ws/v1/sms/postal/get-genders— Get Genders ListGET /ws/v1/sms/postal/get-receiver-count— Get Receiver Counts