FarazSMS Public APIs
  1. Phonebook
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. Phonebook

Create New Phonebook

POST
https://api.iranpayamak.com/ws/v1/phone_book

Request

Authorization
Add parameter in header
Api-Key
Example:
Api-Key: ********************
Body Params application/json

Example
{
    "title": "test title",
    "attributes": [2] // nullable
}

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 POST 'https://api.iranpayamak.com/ws/v1/phone_book' \
--header 'Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "title": "test title",
    "attributes": [2] // nullable
}'

Responses

🟢201Phonebook created successfully.
application/json
Body

Example
{
    "status": "success",
    "data": 0,
    "messages": "string"
}
Modified at 2025-11-03 14:55:50
Previous
Get Phonebooks
Next
Update Phonebook
Built with