POST api/Client/SMS/GetSMS

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AccountId	integer	None.
CustomerId	integer	None.
SmsType	integer	None.
ErrorCode	string	None.
CompanyId	integer	None.
StartDate	date	None.
EndDate	date	None.
Id	integer	None.
CreatedOn	date	None.
ModifiedOn	date	None.
Status	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "AccountId": 1,
  "CustomerId": 2,
  "SmsType": 3,
  "ErrorCode": "sample string 4",
  "CompanyId": 5,
  "StartDate": "2025-10-25T21:04:34.6770535+03:00",
  "EndDate": "2025-10-25T21:04:34.6770535+03:00",
  "Id": 6,
  "CreatedOn": "2025-10-25T21:04:34.6770535+03:00",
  "ModifiedOn": "2025-10-25T21:04:34.6770535+03:00",
  "Status": 7
}

application/xml, text/xml

Sample:

<SmsSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Entities.Models.Client.Definition">
  <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/Entities.Models">2025-10-25T21:04:34.6770535+03:00</CreatedOn>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Entities.Models">6</Id>
  <ModifiedOn xmlns="http://schemas.datacontract.org/2004/07/Entities.Models">2025-10-25T21:04:34.6770535+03:00</ModifiedOn>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Entities.Models">7</Status>
  <AccountId>1</AccountId>
  <CompanyId>5</CompanyId>
  <CustomerId>2</CustomerId>
  <EndDate>2025-10-25T21:04:34.6770535+03:00</EndDate>
  <ErrorCode>sample string 4</ErrorCode>
  <SmsType>3</SmsType>
  <StartDate>2025-10-25T21:04:34.6770535+03:00</StartDate>
</SmsSearchModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SmsSearchModel'.

Response Information

Resource Description

ResultModelOfListOfSmsResponseModel

Name	Type	Additional information
Response	boolean	None.
Message	string	None.
Exception	string	None.
Data	Collection of SmsResponseModel	None.

Response Formats

application/json, text/json

Sample:

{
  "Response": true,
  "Message": "sample string 2",
  "Exception": "sample string 3",
  "Data": [
    {
      "AccountId": 1,
      "CustomerId": 2,
      "CustomerFullName": "sample string 3",
      "EntegratorId": 4,
      "MobilePhone": "sample string 5",
      "SmsType": 6,
      "RegardingObjectId": 7,
      "SmsBody": "sample string 8",
      "SmsReturnMessage": "sample string 9",
      "TransactionID": "sample string 10",
      "ErrorCode": "sample string 11",
      "MessageCount": 12,
      "Id": 13,
      "CreatedOn": "2025-10-25T21:04:34.6927066+03:00",
      "ModifiedOn": "2025-10-25T21:04:34.6927066+03:00",
      "Status": 14
    },
    {
      "AccountId": 1,
      "CustomerId": 2,
      "CustomerFullName": "sample string 3",
      "EntegratorId": 4,
      "MobilePhone": "sample string 5",
      "SmsType": 6,
      "RegardingObjectId": 7,
      "SmsBody": "sample string 8",
      "SmsReturnMessage": "sample string 9",
      "TransactionID": "sample string 10",
      "ErrorCode": "sample string 11",
      "MessageCount": 12,
      "Id": 13,
      "CreatedOn": "2025-10-25T21:04:34.6927066+03:00",
      "ModifiedOn": "2025-10-25T21:04:34.6927066+03:00",
      "Status": 14
    }
  ]
}

application/xml, text/xml

Sample:

<ResultModelOfArrayOfSmsResponseModelIjrq4xa9 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Entities.Models">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Entities.Models.Client.Definition">
    <d2p1:SmsResponseModel>
      <CreatedOn>2025-10-25T21:04:34.6927066+03:00</CreatedOn>
      <Id>13</Id>
      <ModifiedOn>2025-10-25T21:04:34.6927066+03:00</ModifiedOn>
      <Status>14</Status>
      <d2p1:AccountId>1</d2p1:AccountId>
      <d2p1:CustomerFullName>sample string 3</d2p1:CustomerFullName>
      <d2p1:CustomerId>2</d2p1:CustomerId>
      <d2p1:EntegratorId>4</d2p1:EntegratorId>
      <d2p1:ErrorCode>sample string 11</d2p1:ErrorCode>
      <d2p1:MessageCount>12</d2p1:MessageCount>
      <d2p1:MobilePhone>sample string 5</d2p1:MobilePhone>
      <d2p1:RegardingObjectId>7</d2p1:RegardingObjectId>
      <d2p1:SmsBody>sample string 8</d2p1:SmsBody>
      <d2p1:SmsReturnMessage>sample string 9</d2p1:SmsReturnMessage>
      <d2p1:SmsType>6</d2p1:SmsType>
      <d2p1:TransactionID>sample string 10</d2p1:TransactionID>
    </d2p1:SmsResponseModel>
    <d2p1:SmsResponseModel>
      <CreatedOn>2025-10-25T21:04:34.6927066+03:00</CreatedOn>
      <Id>13</Id>
      <ModifiedOn>2025-10-25T21:04:34.6927066+03:00</ModifiedOn>
      <Status>14</Status>
      <d2p1:AccountId>1</d2p1:AccountId>
      <d2p1:CustomerFullName>sample string 3</d2p1:CustomerFullName>
      <d2p1:CustomerId>2</d2p1:CustomerId>
      <d2p1:EntegratorId>4</d2p1:EntegratorId>
      <d2p1:ErrorCode>sample string 11</d2p1:ErrorCode>
      <d2p1:MessageCount>12</d2p1:MessageCount>
      <d2p1:MobilePhone>sample string 5</d2p1:MobilePhone>
      <d2p1:RegardingObjectId>7</d2p1:RegardingObjectId>
      <d2p1:SmsBody>sample string 8</d2p1:SmsBody>
      <d2p1:SmsReturnMessage>sample string 9</d2p1:SmsReturnMessage>
      <d2p1:SmsType>6</d2p1:SmsType>
      <d2p1:TransactionID>sample string 10</d2p1:TransactionID>
    </d2p1:SmsResponseModel>
  </Data>
  <Exception>sample string 3</Exception>
  <Message>sample string 2</Message>
  <Response>true</Response>
</ResultModelOfArrayOfSmsResponseModelIjrq4xa9>