POST api/Receive

برای دریافت پیامک ها از این متد استفاده کنید

Request Information

URI Parameters

None.

Body Parameters

ReceiveSMS
NameDescriptionTypeAdditional information
IsAllMessage

دریافت کامل پیام ها دریافتی در صورت false بودن فقط دریافتهای جدید

 boolean

Required
FromNumber

اگر خالی پاس شود تمام شماره پیامکی ها اورده می شود یا می توان شماره خاصی ارسال نمود مثل : 30007819

 string

None.
FromDate

از تاریخ شمسی فقط تاریخ 01/04/1397(می توان خالی پاس کرد)

 string

None.
ToDate

تا تاریخ شمسی فقط تاریخ 10/04/1397(می توان خالی پاس کرد)

 string

None.
UserName

نام کاربری

 string

None.
Password

پسورد ورود به سامانه

 string

None.
DomainName

نام دامنه

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "IsAllMessage": true,
  "FromNumber": "sample string 2",
  "FromDate": "sample string 3",
  "ToDate": "sample string 4",
  "UserName": "sample string 5",
  "Password": "sample string 6",
  "DomainName": "sample string 7"
}

application/xml, text/xml

Sample: 
<ReceiveModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RESTfulApi.Models">
  <DomainName>sample string 7</DomainName>
  <Password>sample string 6</Password>
  <UserName>sample string 5</UserName>
  <FromDate>sample string 3</FromDate>
  <FromNumber>sample string 2</FromNumber>
  <IsAllMessage>true</IsAllMessage>
  <ToDate>sample string 4</ToDate>
</ReceiveModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Inbox
NameDescriptionTypeAdditional information
ReceiveModel

پیامهای دریافتی

 Collection of ReceiveModel

None.
Messege

متن خطایی که رخ داده

 string

None.
Status

کد خطا. در صورتی که صفر باشد یعنی خطایی رخ نداده

 integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "ReceiveModel": [
    {
      "Mobile": "sample string 1",
      "SenderNumber": "sample string 2",
      "Text": "sample string 3",
      "DateSmsM": "sample string 4",
      "DateSmsF": "sample string 5",
      "MessageId": 6
    },
    {
      "Mobile": "sample string 1",
      "SenderNumber": "sample string 2",
      "Text": "sample string 3",
      "DateSmsM": "sample string 4",
      "DateSmsF": "sample string 5",
      "MessageId": 6
    }
  ],
  "Messege": "sample string 1",
  "Status": 2
}

application/xml, text/xml

Sample: 
<ResponseReceive xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RESTfulApi.Models">
  <Messege>sample string 1</Messege>
  <Status>2</Status>
  <ReceiveModel>
    <ResponseReceiveModel>
      <DateSmsF>sample string 5</DateSmsF>
      <DateSmsM>sample string 4</DateSmsM>
      <MessageId>6</MessageId>
      <Mobile>sample string 1</Mobile>
      <SenderNumber>sample string 2</SenderNumber>
      <Text>sample string 3</Text>
    </ResponseReceiveModel>
    <ResponseReceiveModel>
      <DateSmsF>sample string 5</DateSmsF>
      <DateSmsM>sample string 4</DateSmsM>
      <MessageId>6</MessageId>
      <Mobile>sample string 1</Mobile>
      <SenderNumber>sample string 2</SenderNumber>
      <Text>sample string 3</Text>
    </ResponseReceiveModel>
  </ReceiveModel>
</ResponseReceive>