1. Peer-to-Peer
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
    • VoiceMessage
      • Send Voice Message
      • Download Uploded Voice Message File
      • Upload Voice Message File
      • Calculate Voice Message Cost
    • PostalCode
      • Get Available Lines
      • Get Receiver Counts
      • Send Postal Code SMS
      • Get Genders List
    • Simple
      • Send Simple SMS
      • Send Simple SMS from Excel
      • Send Simple SMS from Phonebook
    • Variable-Based
      • Send SMS with Variables
      • Send SMS with Variables from Excel
    • Peer-to-Peer
      • Send Peer-to-Peer SMS
        POST
      • Send Peer-to-Peer SMS from Excel
        POST
    • NumberBank
      • Get List of Avalibale Banks
      • Send to Number Bank
    • LBS
      • Get LBS Requests List
      • Create New LBS Request
      • Show Single LBS Request Details
      • Edit LBS Request
      • Cancel LBS Request
    • Bulk
      • Get Provinces
      • Get Counties
      • Get Cities
      • Get Receiver Count
      • Send Bulk SMS
    • Send Sample SMS
      POST
    • Send Pattern-Based SMS
      POST
    • Calculate Send SMS Cost
      POST
    • Calculate Send SMS Peer To Peer
      POST
  • Phonebook
    • Contacts
      • Get Phonebook Contacts
      • Add New Contact
      • Add Bulk Contact
      • Add Excel Contact
      • Delete Contact
      • Get Bulk Excel Sample
    • Attrebutes
      • Get Phonebook Attributes
      • Create New Phonebook Attribute
    • Get Phonebooks
      GET
    • Create New Phonebook
      POST
    • Update Phonebook
      PUT
  • Patterns
    • Create New Pattern
    • Get Pattern Details
    • Edit Pattern
    • Get List of User's Patterns
  • Tickets
    • Download Ticket Attached File
    • Get List of Tickets
    • Create New Ticket
    • Show Ticket Conversations
    • Replay to Ticket
    • Close Ticket
  • Orders
    • Pay Created Order
    • Apply Discount on Order
    • Cancel an Order
  • Send Requests
    • Get Send Requests
    • Show Send Request Details
    • Get Send Request Items
  • GEO
    • Get Provinces List
    • Get Cities List of Provinces
  • 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. Peer-to-Peer

Send Peer-to-Peer SMS

POST
https://api.iranpayamak.com/ws/v1/sms/peer-to-peer
Send peer-to-peer messages. Each peer contains different text and recipients. Each peer will generate a separate send request record.

Request

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

Body Params application/json

Example
{
  "line_number": "2191307530",
  "number_format": "persian",
  "peers": [
    {
      "text": "تست جدید تایید نشه لطفا",
      "recipients": ["09112176238" , "09203189087"]
    //   "selectedPhoneBooks": [
    //     {
    //       "id": 102904,
    //       "offset": 0,
    //       "limit": 3
    //     }
    //   ]
    },
    {
      "text": "2 تست جدید تایید نشه لطفا",
       "recipients": ["09112176238" , "09203189087"],
    //   "selectedPhoneBooks": [
    //     {
    //       "id": 88592,
    //       "offset": 0,
    //       "limit": 3
    //     }
    //   ]
    }
  ],
  "schedule": ""
}

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 'https://api.iranpayamak.com/ws/v1/sms/peer-to-peer' \
--header 'Accept: application/json' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "line_number": "2191307530",
  "number_format": "persian",
  "peers": [
    {
      "text": "تست جدید تایید نشه لطفا",
      "recipients": ["09112176238" , "09203189087"]
    //   "selectedPhoneBooks": [
    //     {
    //       "id": 102904,
    //       "offset": 0,
    //       "limit": 3
    //     }
    //   ]
    },
    {
      "text": "2 تست جدید تایید نشه لطفا",
       "recipients": ["09112176238" , "09203189087"],
    //   "selectedPhoneBooks": [
    //     {
    //       "id": 88592,
    //       "offset": 0,
    //       "limit": 3
    //     }
    //   ]
    }
  ],
  "schedule": ""
}'

Responses

🟢201All SMS requests are enqueued successfully.
application/json
Bodyapplication/json

Example
{
    "status": "success",
    "data": [
        0
    ],
    "messages": "string"
}
Modified at 2026-07-17 22:22:33
Previous
Send SMS with Variables from Excel
Next
Send Peer-to-Peer SMS from Excel
Built with