FarazSMS Public APIs
  1. Account
FarazSMS Public APIs
  • Auth
    • Login
      POST
    • Register
      POST
    • Verify 2fa
      POST
    • Show Register Form
      GET
    • Logout
      POST
  • Account
    • Profile
      GET
    • Account Balance
      GET
    • update
      POST
    • Charge wallet
      POST
    • Register
      POST
    • Lines
      GET
  • 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
    • Update Phonebook
      PUT
    • Get Phonebook Attributes
      GET
    • Create New Phonebook Attribute
      POST
    • Get Phonebook Contacts
      GET
    • Add New Contact
      POST
    • Delete Contact
      DELETE
  • Pattern
    • Create New Pattern
    • Get Pattern Details
    • Edit Pattern
    • Get List of User's Patterns
  • LBS
    • index
    • store
    • show
    • update
    • cancel
  • Order
    • pay
    • apply discount
    • cancel
  • Get Paged Inbox Messages
    GET
  • Schemas
    • Schemas
      • SelfSampleRequestDto
      • SimpleRequestDto
      • ApiResultString
      • SimpleFileRequestDto
      • ApiResultPagedPhonebook
      • KeywordRequestDto
      • ApiResultPagedPhonebookAttribute
      • KeywordFileRequestDto
      • ApiResultPagedPhonebookData
      • PeerToPeerRequestDto
      • ApiResultPagedInbox
      • PeerToPeerFileRequestDto
      • PagedPhonebook
      • ApiResultNumber
      • PagedPhonebookAttribute
      • ApiResultNumberArray
      • PagedPhonebookData
      • PagedInboxMessages
      • PhonebookAttribute
      • Phonebook
      • PhonebookDataAttribute
      • PhonebookDataRecord
      • PhonebookCreateRequestDto
      • PhonebookAttributeCreateRequestDto
      • InboxMessage
      • PatternAttribute
      • PatternRequestDto
      • PatternSendRequestDto
    • ApiMessage
    • ApiStatus
  1. Account

Profile

GET
https://api.iranpayamak.com/ws/v1/account/profile
The Login API allows users to authenticate by providing valid credentials like username and password. It typically returns an access token upon successful authentication.

Request

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

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 'https://api.iranpayamak.com/ws/v1/account/profile' \
--header 'Api-Key: <api-key>'

Responses

🟢200Success
application/json
Body

Example
{
    "status": "success",
    "message": {},
    "data": {
        "displayName": "فراز اس‌ام‌اس",
        "mobile": "09XXXXXXXXX",
        "verified": true,
        "blocked": false,
        "plan": {
            "id": 1,
            "title": "اسم پکیج",
            "expiryDate": "2025-02-04T15:41:35.000000Z"
        },
        "permissions": "01ffffffffffffffffff"
    }
}
🟠401Unauthorized
Modified at 2025-08-28 12:51:27
Previous
Logout
Next
Account Balance
Built with