# FarazSMS Public APIs

## Docs
- [Send](https://docs.iranpayamak.com/send-2959532f0.md): 

## API Docs
- Auth [Login](https://docs.iranpayamak.com/login-24945813e0.md): 
- Auth [Register](https://docs.iranpayamak.com/register-24945818e0.md): 
- Auth [Verify 2fa](https://docs.iranpayamak.com/verify-2fa-24945819e0.md): 
- Auth [Show Register Form](https://docs.iranpayamak.com/show-register-form-24945820e0.md): 
- Auth [Logout](https://docs.iranpayamak.com/logout-24946032e0.md): 
- Account [Profile](https://docs.iranpayamak.com/profile-13716723e0.md): The Login API allows users to authenticate by providing valid credentials like username and password. It typically returns an access token upon successful authentication.
- Account [Account Balance](https://docs.iranpayamak.com/account-balance-13717911e0.md): 
- Account [update](https://docs.iranpayamak.com/update-22119667e0.md): 
- Account [Charge wallet](https://docs.iranpayamak.com/charge-wallet-23341923e0.md): 
- Account [Register](https://docs.iranpayamak.com/register-23342012e0.md): 
- Account [Lines](https://docs.iranpayamak.com/lines-27039797e0.md): 
- Send > VoiceMessage [Send Voice Message](https://docs.iranpayamak.com/send-voice-message-31200965e0.md): Send a Voice message toward many recipients.
- Send > VoiceMessage [Download Uploded Voice Message File](https://docs.iranpayamak.com/download-uploded-voice-message-file-31202797e0.md): 
- Send > VoiceMessage [Upload Voice Message File](https://docs.iranpayamak.com/upload-voice-message-file-31202956e0.md): 
- Send > VoiceMessage [Calculate Voice Message Cost](https://docs.iranpayamak.com/calculate-voice-message-cost-31202960e0.md): 
- Send > PostalCode [Get Available Lines](https://docs.iranpayamak.com/get-available-lines-31205874e0.md): 
- Send > PostalCode [Get Receiver Counts](https://docs.iranpayamak.com/get-receiver-counts-31205984e0.md): 
- Send > PostalCode [Send Postal Code SMS](https://docs.iranpayamak.com/send-postal-code-sms-31206192e0.md): 
- Send > PostalCode [Get Genders List](https://docs.iranpayamak.com/get-genders-list-31283518e0.md): 
- Send > Simple [Send Simple SMS](https://docs.iranpayamak.com/send-simple-sms-13909967e0.md): Send a simple message with one text toward many recipients
- Send > Simple [Send Simple SMS from Excel](https://docs.iranpayamak.com/send-simple-sms-from-excel-13909968e0.md): Send a simple message with recipients from excel file.
- Send > Simple [Send Simple SMS from Phonebook](https://docs.iranpayamak.com/send-simple-sms-from-phonebook-31206570e0.md): Send a Voice message toward many recipients.
- Send > Variable-Based [Send SMS with Variables](https://docs.iranpayamak.com/send-sms-with-variables-13909969e0.md): Send a message containing variable keywords. The keywords (attributes) must be wrapped inside % signs within the text (E.g: Hello %first_name%)
- Send > Variable-Based [Send SMS with Variables from Excel](https://docs.iranpayamak.com/send-sms-with-variables-from-excel-13909970e0.md): Send a message with keywords with its data coming from an excel or CSV file. The keywords (attributes) must be wrapped inside % signs within the text (E.g: Hello %first_name%)
- Send > Peer-to-Peer [Send Peer-to-Peer SMS](https://docs.iranpayamak.com/send-peer-to-peer-sms-13909971e0.md): Send peer-to-peer messages. Each peer contains different text and recipients. Each peer will generate a separate send request record.
- Send > Peer-to-Peer [Send Peer-to-Peer SMS from Excel](https://docs.iranpayamak.com/send-peer-to-peer-sms-from-excel-13909972e0.md): Send peer-to-peer messages with file input. Each peer contains different text and recipients. Each peer will generate a separate send request record.
- Send > NumberBank  [Get List of Avalibale Banks](https://docs.iranpayamak.com/get-list-of-avalibale-banks-31200901e0.md): 
- Send > NumberBank  [Send to Number Bank](https://docs.iranpayamak.com/send-to-number-bank-31283521e0.md): 
- Send > LBS [Get LBS Requests List](https://docs.iranpayamak.com/get-lbs-requests-list-25851391e0.md): 
- Send > LBS [Create New LBS Request](https://docs.iranpayamak.com/create-new-lbs-request-25851390e0.md): 
- Send > LBS [Show Single LBS Request Details](https://docs.iranpayamak.com/show-single-lbs-request-details-25851392e0.md): 
- Send > LBS [Edit LBS Request](https://docs.iranpayamak.com/edit-lbs-request-25851393e0.md): 
- Send > LBS [Cancel LBS Request](https://docs.iranpayamak.com/cancel-lbs-request-25851394e0.md): 
- Send [Send Sample SMS](https://docs.iranpayamak.com/send-sample-sms-13909966e0.md): Send a sample of message to the account owner
- Send [Send Pattern-Based SMS](https://docs.iranpayamak.com/send-pattern-based-sms-13925177e0.md): Send a pattern-based message, the pattern UID must be creadted and get from user panel.
- Send [Calculate Send SMS Cost](https://docs.iranpayamak.com/calculate-send-sms-cost-31206056e0.md): This API used for calculate cost for this SMS Type:
- Phonebook [Get Phonebooks](https://docs.iranpayamak.com/get-phonebooks-13925171e0.md): Get paged list of phonebooks
- Phonebook [Create New Phonebook](https://docs.iranpayamak.com/create-new-phonebook-13925172e0.md): 
- Phonebook [Update Phonebook](https://docs.iranpayamak.com/update-phonebook-23747776e0.md): 
- Phonebook [Get Phonebook Attributes](https://docs.iranpayamak.com/get-phonebook-attributes-13925173e0.md): Get paged list of phonebook attributes
- Phonebook [Create New Phonebook Attribute](https://docs.iranpayamak.com/create-new-phonebook-attribute-13925174e0.md): Create a new phonebook attribute like birthdate, national code and etc
- Phonebook [Get Phonebook Contacts](https://docs.iranpayamak.com/get-phonebook-contacts-13925175e0.md): Get paged phonebook data for a specific phonebook
- Phonebook [Add New Contact](https://docs.iranpayamak.com/add-new-contact-23655867e0.md): 
- Phonebook [Delete Contact](https://docs.iranpayamak.com/delete-contact-23696624e0.md): 
- Patterns [Create New Pattern](https://docs.iranpayamak.com/create-new-pattern-13925176e0.md): Create a new pattern with API
- Patterns [Get Pattern Details](https://docs.iranpayamak.com/get-pattern-details-16297027e0.md): This endpoint help to get a pattern by its "code"
- Patterns [Edit Pattern](https://docs.iranpayamak.com/edit-pattern-21747970e0.md): 
- Patterns [Get List of User's Patterns](https://docs.iranpayamak.com/get-list-of-users-patterns-21747971e0.md): 
- Tickets [Download Ticket Attached File](https://docs.iranpayamak.com/download-ticket-attached-file-31200021e0.md): 
- Tickets [Get List of Tickets](https://docs.iranpayamak.com/get-list-of-tickets-31114013e0.md): 
- Tickets [Create New Ticket](https://docs.iranpayamak.com/create-new-ticket-31114014e0.md): 
- Tickets [Show Ticket Conversations](https://docs.iranpayamak.com/show-ticket-conversations-31114015e0.md): 
- Tickets [Replay to Ticket](https://docs.iranpayamak.com/replay-to-ticket-31114016e0.md): 
- Tickets [Close Ticket](https://docs.iranpayamak.com/close-ticket-31114017e0.md): 
- Orders [Pay Created Order](https://docs.iranpayamak.com/pay-created-order-25851395e0.md): 
- Orders [Apply Discount on Order](https://docs.iranpayamak.com/apply-discount-on-order-25851396e0.md): 
- Orders [Cancel an Order](https://docs.iranpayamak.com/cancel-an-order-25851397e0.md): 
- Send Requests [Get Send Requests](https://docs.iranpayamak.com/get-send-requests-27724579e0.md): Get paged list of phonebooks
- Send Requests [Show Send Request Details](https://docs.iranpayamak.com/show-send-request-details-27724809e0.md): Get paged list of phonebooks
- Send Requests [Get Send Request Items](https://docs.iranpayamak.com/get-send-request-items-27724811e0.md): Get paged list of phonebooks
- GEO [Get Provinces List](https://docs.iranpayamak.com/get-provinces-list-31200409e0.md): 
- GEO [Get Cities List of Provinces](https://docs.iranpayamak.com/get-cities-list-of-provinces-31200787e0.md): 
- [Get Paged Inbox Messages](https://docs.iranpayamak.com/get-paged-inbox-messages-13925178e0.md): 

## Schemas
- Schemas [SelfSampleRequestDto](https://docs.iranpayamak.com/selfsamplerequestdto-5179914d0.md): 
- Schemas [SimpleRequestDto](https://docs.iranpayamak.com/simplerequestdto-5179915d0.md): 
- Schemas [ApiResultString](https://docs.iranpayamak.com/apiresultstring-5191104d0.md): 
- Schemas [SimpleFileRequestDto](https://docs.iranpayamak.com/simplefilerequestdto-5179916d0.md): 
- Schemas [ApiResultPagedPhonebook](https://docs.iranpayamak.com/apiresultpagedphonebook-5191105d0.md): 
- Schemas [KeywordRequestDto](https://docs.iranpayamak.com/keywordrequestdto-5179917d0.md): 
- Schemas [ApiResultPagedPhonebookAttribute](https://docs.iranpayamak.com/apiresultpagedphonebookattribute-5191106d0.md): 
- Schemas [KeywordFileRequestDto](https://docs.iranpayamak.com/keywordfilerequestdto-5179918d0.md): 
- Schemas [ApiResultPagedPhonebookData](https://docs.iranpayamak.com/apiresultpagedphonebookdata-5191107d0.md): 
- Schemas [PeerToPeerRequestDto](https://docs.iranpayamak.com/peertopeerrequestdto-5179919d0.md): 
- Schemas [ApiResultPagedInbox](https://docs.iranpayamak.com/apiresultpagedinbox-5191108d0.md): 
- Schemas [PeerToPeerFileRequestDto](https://docs.iranpayamak.com/peertopeerfilerequestdto-5179920d0.md): 
- Schemas [PagedPhonebook](https://docs.iranpayamak.com/pagedphonebook-5191109d0.md): 
- Schemas [ApiResultNumber](https://docs.iranpayamak.com/apiresultnumber-5179921d0.md): 
- Schemas [PagedPhonebookAttribute](https://docs.iranpayamak.com/pagedphonebookattribute-5191110d0.md): 
- Schemas [ApiResultNumberArray](https://docs.iranpayamak.com/apiresultnumberarray-5179922d0.md): 
- Schemas [PagedPhonebookData](https://docs.iranpayamak.com/pagedphonebookdata-5191111d0.md): 
- Schemas [PagedInboxMessages](https://docs.iranpayamak.com/pagedinboxmessages-5191112d0.md): 
- Schemas [PhonebookAttribute](https://docs.iranpayamak.com/phonebookattribute-5191113d0.md): 
- Schemas [Phonebook](https://docs.iranpayamak.com/phonebook-5191114d0.md): 
- Schemas [PhonebookDataAttribute](https://docs.iranpayamak.com/phonebookdataattribute-5191115d0.md): 
- Schemas [PhonebookDataRecord](https://docs.iranpayamak.com/phonebookdatarecord-5191116d0.md): 
- Schemas [PhonebookCreateRequestDto](https://docs.iranpayamak.com/phonebookcreaterequestdto-5191117d0.md): 
- Schemas [PhonebookAttributeCreateRequestDto](https://docs.iranpayamak.com/phonebookattributecreaterequestdto-5191118d0.md): 
- Schemas [InboxMessage](https://docs.iranpayamak.com/inboxmessage-5191119d0.md): 
- Schemas [PatternAttribute](https://docs.iranpayamak.com/patternattribute-5191120d0.md): 
- Schemas [PatternRequestDto](https://docs.iranpayamak.com/patternrequestdto-5191121d0.md): 
- Schemas [PatternSendRequestDto](https://docs.iranpayamak.com/patternsendrequestdto-5191122d0.md): 
- [ApiMessage](https://docs.iranpayamak.com/apimessage-5068593d0.md): 
- [ApiStatus](https://docs.iranpayamak.com/apistatus-5068902d0.md):