Home › Reference & Tools

Get Receiver Counts — FarazSMS SMS web service

GET https://api.iranpayamak.com/ws/v1/sms/postal/get-receiver-count

Purpose: Estimate the recipient count before a postal-code send, based on filters (postal code, gender, age range, prefix).

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

• Estimate the recipient count before sending, using filters (postal code, gender, age range, prefix).

Responses

• 401

Related endpoints in Reference & Tools

• GET /cities — Get Cities List of Provinces
• GET /provinces — Get Provinces List
• GET /ws/v1/number_bank — Get List of Avalibale Banks
• GET /ws/v1/number_bank/{number_bank_id} — Get Number Bank Details
• POST /ws/v1/sms/calculate-cost — Calculate Send SMS Cost
• GET /ws/v1/sms/postal/get-available-lines — Get Available Lines
• GET /ws/v1/sms/postal/get-genders — Get Genders List

All FarazSMS web services · llms.txt · OpenAPI