POST api/marketing/MessagePagingInfo

Получение информации об отправленных сообщениях, с пагинацией и входными фильтрами

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Poscode	Код торговой точки пользователя, который делает запрос	string	None.
Month	Фильтр: месяц отправки сообщений	byte	None.
Year	Фильтр: год отправки сообщений	integer	None.
Phone	Фильтр: телефон клиента	integer	None.
Client	Фильтр: идентификатор клиента	integer	None.
Email	Фильтр: email клиента	string	None.
Communication_id	Фильтр: идентификатор рассылки	integer	None.
Communicationtype	Фильтр: идентификатор типа рассылки	byte	None.
Messagestatus	Фильтр: идентификатор статуса сообщения	byte	None.
BegDate	Фильтр: дата начала анализируемого периода	date	None.
EndDate	Фильтр: дата окончания анализируемого периода	date	None.
Textmessage	Фильтр: текст сообщения	string	None.
Messagetemplate	Фильтр: идентификатор ранее созданного шаблона сообщения	integer	None.
Message_eventtype	Фильтр: тип события, по которому отправлено сообщение	byte	None.
Quantity	Фильтр: количество смс в одном сообщении	decimal number	None.
Start	Пагинация: последовательный номер записи от которой нужно возвращать данные (1, 10, 20, 30 и т.д.)	integer	None.
Length	Пагинация: количество записей, которые нужно вернуть	integer	None.
Report	Признак, что запрос идёт для скачивания отчёта	boolean	None.
Operator	Идентификатор оператора программы лояльности	integer	None.
Token	Токен пользователя, который инициирует данный запрос	integer	None.
SiteCode	Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Poscode": "sample string 1",
  "Month": 64,
  "Year": 1,
  "Phone": 1,
  "Client": 1,
  "Email": "sample string 2",
  "Communication_id": 1,
  "Communicationtype": 64,
  "Messagestatus": 64,
  "BegDate": "2024-04-29T17:36:40.3800965+03:00",
  "EndDate": "2024-04-29T17:36:40.3800965+03:00",
  "Textmessage": "sample string 3",
  "Messagetemplate": 1,
  "Message_eventtype": 64,
  "Quantity": 1.0,
  "Start": 1,
  "Length": 1,
  "Report": true,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 4"
}

application/xml, text/xml

Sample:

<MessagePagingInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.MarketingRequest">
  <Operator xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Operator>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 4</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <BegDate>2024-04-29T17:36:40.3800965+03:00</BegDate>
  <Client>1</Client>
  <Communication_id>1</Communication_id>
  <Communicationtype>64</Communicationtype>
  <Email>sample string 2</Email>
  <EndDate>2024-04-29T17:36:40.3800965+03:00</EndDate>
  <Length>1</Length>
  <Message_eventtype>64</Message_eventtype>
  <Messagestatus>64</Messagestatus>
  <Messagetemplate>1</Messagetemplate>
  <Month>64</Month>
  <Phone>1</Phone>
  <Poscode>sample string 1</Poscode>
  <Quantity>1</Quantity>
  <Report>true</Report>
  <Start>1</Start>
  <Textmessage>sample string 3</Textmessage>
  <Year>1</Year>
</MessagePagingInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MessagePagingInfoResponse

Name	Description	Type	Additional information
TotalRows	Количество записей, которые попали в выборку	integer	None.
TotalRowsSelect	Количество записей, которые вернулись в массиве ответа на запрос	integer	None.
Data	Полученные данные	Collection of MessagePagingInfoData	None.
ErrorCode	Код ошибки	integer	None.
Message	Сообщение об ошибке	string	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Data": [
    {
      "Id": 1,
      "MessageId": 1,
      "ProcTime": "2024-04-29T17:36:40.5988432+03:00",
      "Pos": 1,
      "PosName": "sample string 1",
      "Phone": 1,
      "Client": 1,
      "Email": "sample string 2",
      "TextMessage": "sample string 3",
      "Subject": "sample string 4",
      "CommunicationType": 64,
      "CommunicationTypeName": "sample string 5",
      "MessageEventType": 64,
      "MessageEventTypeName": "sample string 6",
      "MessageStatus": 64,
      "MessageStatusName": "sample string 7",
      "Communication": 1,
      "CommunicationName": "sample string 8",
      "Image": "sample string 9",
      "TypeOpen": "sample string 10",
      "IdTypeOpen": "sample string 11",
      "Price": 1.0,
      "Quantity": 1.0,
      "SmsrequestId": "sample string 12",
      "EmailRequestId": "sample string 13",
      "Provider": "sample string 14"
    },
    {
      "Id": 1,
      "MessageId": 1,
      "ProcTime": "2024-04-29T17:36:40.5988432+03:00",
      "Pos": 1,
      "PosName": "sample string 1",
      "Phone": 1,
      "Client": 1,
      "Email": "sample string 2",
      "TextMessage": "sample string 3",
      "Subject": "sample string 4",
      "CommunicationType": 64,
      "CommunicationTypeName": "sample string 5",
      "MessageEventType": 64,
      "MessageEventTypeName": "sample string 6",
      "MessageStatus": 64,
      "MessageStatusName": "sample string 7",
      "Communication": 1,
      "CommunicationName": "sample string 8",
      "Image": "sample string 9",
      "TypeOpen": "sample string 10",
      "IdTypeOpen": "sample string 11",
      "Price": 1.0,
      "Quantity": 1.0,
      "SmsrequestId": "sample string 12",
      "EmailRequestId": "sample string 13",
      "Provider": "sample string 14"
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<MessagePagingInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.MarketingResponse">
  <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 2</Message>
  <Data>
    <MessagePagingInfoResponse.MessagePagingInfoData>
      <Client>1</Client>
      <Communication>1</Communication>
      <CommunicationName>sample string 8</CommunicationName>
      <CommunicationType>64</CommunicationType>
      <CommunicationTypeName>sample string 5</CommunicationTypeName>
      <Email>sample string 2</Email>
      <EmailRequestId>sample string 13</EmailRequestId>
      <Id>1</Id>
      <IdTypeOpen>sample string 11</IdTypeOpen>
      <Image>sample string 9</Image>
      <MessageEventType>64</MessageEventType>
      <MessageEventTypeName>sample string 6</MessageEventTypeName>
      <MessageId>1</MessageId>
      <MessageStatus>64</MessageStatus>
      <MessageStatusName>sample string 7</MessageStatusName>
      <Phone>1</Phone>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
      <Price>1</Price>
      <ProcTime>2024-04-29T17:36:40.5988432+03:00</ProcTime>
      <Provider>sample string 14</Provider>
      <Quantity>1</Quantity>
      <SmsrequestId>sample string 12</SmsrequestId>
      <Subject>sample string 4</Subject>
      <TextMessage>sample string 3</TextMessage>
      <TypeOpen>sample string 10</TypeOpen>
    </MessagePagingInfoResponse.MessagePagingInfoData>
    <MessagePagingInfoResponse.MessagePagingInfoData>
      <Client>1</Client>
      <Communication>1</Communication>
      <CommunicationName>sample string 8</CommunicationName>
      <CommunicationType>64</CommunicationType>
      <CommunicationTypeName>sample string 5</CommunicationTypeName>
      <Email>sample string 2</Email>
      <EmailRequestId>sample string 13</EmailRequestId>
      <Id>1</Id>
      <IdTypeOpen>sample string 11</IdTypeOpen>
      <Image>sample string 9</Image>
      <MessageEventType>64</MessageEventType>
      <MessageEventTypeName>sample string 6</MessageEventTypeName>
      <MessageId>1</MessageId>
      <MessageStatus>64</MessageStatus>
      <MessageStatusName>sample string 7</MessageStatusName>
      <Phone>1</Phone>
      <Pos>1</Pos>
      <PosName>sample string 1</PosName>
      <Price>1</Price>
      <ProcTime>2024-04-29T17:36:40.5988432+03:00</ProcTime>
      <Provider>sample string 14</Provider>
      <Quantity>1</Quantity>
      <SmsrequestId>sample string 12</SmsrequestId>
      <Subject>sample string 4</Subject>
      <TextMessage>sample string 3</TextMessage>
      <TypeOpen>sample string 10</TypeOpen>
    </MessagePagingInfoResponse.MessagePagingInfoData>
  </Data>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</MessagePagingInfoResponse>