1. Schemas
FarazSMS Public APIs
  • Auth
    • Login
    • Register
    • Verify 2fa
    • Show Register Form
    • Logout
  • Account
    • Profile
    • Account Balance
    • update
    • Charge wallet
    • Register
    • Lines
  • 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
      • Send Peer-to-Peer SMS from Excel
    • 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
    • Send Sample SMS
    • Send Pattern-Based SMS
    • Calculate Send SMS Cost
  • Phonebook
    • Get Phonebooks
    • Create New Phonebook
    • Update Phonebook
    • Get Phonebook Attributes
    • Create New Phonebook Attribute
    • Get Phonebook Contacts
    • Add New Contact
    • Delete Contact
  • 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. Schemas

KeywordRequestDto

{
    "text": "string",
    "attributes": [
        "additionalProp1",
        "additionalProp2",
        "additionalProp3"
    ],
    "from": "500012345",
    "recipients": [
        {
            "type": "plain",
            "number": "string",
            "attributes": {
                "additionalProp1": "Ahmad",
                "additionalProp2": "12345",
                "additionalProp3": "Mr."
            }
        }
    ],
    "numberFormat": "en",
    "schedule": "2019-08-24T14:15:22.123Z"
}
Built with