POST api/lead/LeadMessageInfo

Получение сообщений отправленных лиду

Request Information

URI Parameters

None.

Body Parameters

LeadMessageInfoRequest
NameDescriptionTypeAdditional information
Leads

Фильтр: идентификатор лида

integer

None.

Client

Фильтр: идентификатор клиента из таблицы client

integer

None.

Subject

Фильтр: тема сообщения

string

None.

Leadmessage

Фильтр: идентификатор сообщения лида

integer

None.

Start

Фильтр: с какой позиции вернуть записи

integer

None.

Length

Фильтр: какое количество записей вернуть

integer

None.

TextAuthor

Фильтр: автор сообщения (Client или User)

string

None.

ReadMessageStatus

Фильтр: статус прочитанности сообщения ('Прочитано' или 'Не прочитано')

string

None.

Operator

Идентификатор оператора программы лояльности

integer

None.

Token

Токен пользователя, который инициирует данный запрос

integer

None.

SiteCode

Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Leads": 1,
  "Client": 1,
  "Subject": "sample string 1",
  "Leadmessage": 1,
  "Start": 1,
  "Length": 1,
  "TextAuthor": "sample string 2",
  "ReadMessageStatus": "sample string 3",
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 4"
}

application/xml, text/xml

Sample:
<LeadMessageInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request">
  <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>
  <Client>1</Client>
  <Leadmessage>1</Leadmessage>
  <Leads>1</Leads>
  <Length>1</Length>
  <ReadMessageStatus>sample string 3</ReadMessageStatus>
  <Start>1</Start>
  <Subject>sample string 1</Subject>
  <TextAuthor>sample string 2</TextAuthor>
</LeadMessageInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LeadMessageInfoResponse
NameDescriptionTypeAdditional information
TotalRows

Общее количество записей, которые можно вернуть после применения всех фильтров

integer

None.

TotalRowsSelect

Общее количество записей, которые вернулись в конкретном запросе с пагинацией

integer

None.

Leadmessagedata

Данные о сообщениях

Collection of LeadMessageData

None.

ErrorCode

Код ошибки

integer

None.

Message

Сообщение об ошибке

string

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalRows": 1,
  "TotalRowsSelect": 1,
  "Leadmessagedata": [
    {
      "Id": 1,
      "Subject": "sample string 1",
      "Parent": 1,
      "Leadtext": "sample string 2",
      "Usertext": "sample string 3",
      "Status": "sample string 4",
      "Date": "2024-06-20T05:58:14.0205274+03:00",
      "LeadId": 1,
      "TextAuthor": "sample string 5",
      "ParentText": "sample string 6",
      "MessageData": [
        {
          "Id": 1,
          "Field": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "TypeId": "sample string 4"
        },
        {
          "Id": 1,
          "Field": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "TypeId": "sample string 4"
        }
      ]
    },
    {
      "Id": 1,
      "Subject": "sample string 1",
      "Parent": 1,
      "Leadtext": "sample string 2",
      "Usertext": "sample string 3",
      "Status": "sample string 4",
      "Date": "2024-06-20T05:58:14.0205274+03:00",
      "LeadId": 1,
      "TextAuthor": "sample string 5",
      "ParentText": "sample string 6",
      "MessageData": [
        {
          "Id": 1,
          "Field": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "TypeId": "sample string 4"
        },
        {
          "Id": 1,
          "Field": "sample string 1",
          "Value": "sample string 2",
          "Type": "sample string 3",
          "TypeId": "sample string 4"
        }
      ]
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<LeadMessageInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response">
  <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>
  <Leadmessagedata xmlns:d2p1="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Data">
    <d2p1:LeadMessageData>
      <d2p1:Date>2024-06-20T05:58:14.0205274+03:00</d2p1:Date>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LeadId>1</d2p1:LeadId>
      <d2p1:Leadtext>sample string 2</d2p1:Leadtext>
      <d2p1:MessageData>
        <d2p1:LeadDataActionStr>
          <d2p1:Field>sample string 1</d2p1:Field>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:TypeId>sample string 4</d2p1:TypeId>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:LeadDataActionStr>
        <d2p1:LeadDataActionStr>
          <d2p1:Field>sample string 1</d2p1:Field>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:TypeId>sample string 4</d2p1:TypeId>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:LeadDataActionStr>
      </d2p1:MessageData>
      <d2p1:Parent>1</d2p1:Parent>
      <d2p1:ParentText>sample string 6</d2p1:ParentText>
      <d2p1:Status>sample string 4</d2p1:Status>
      <d2p1:Subject>sample string 1</d2p1:Subject>
      <d2p1:TextAuthor>sample string 5</d2p1:TextAuthor>
      <d2p1:Usertext>sample string 3</d2p1:Usertext>
    </d2p1:LeadMessageData>
    <d2p1:LeadMessageData>
      <d2p1:Date>2024-06-20T05:58:14.0205274+03:00</d2p1:Date>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:LeadId>1</d2p1:LeadId>
      <d2p1:Leadtext>sample string 2</d2p1:Leadtext>
      <d2p1:MessageData>
        <d2p1:LeadDataActionStr>
          <d2p1:Field>sample string 1</d2p1:Field>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:TypeId>sample string 4</d2p1:TypeId>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:LeadDataActionStr>
        <d2p1:LeadDataActionStr>
          <d2p1:Field>sample string 1</d2p1:Field>
          <d2p1:Id>1</d2p1:Id>
          <d2p1:Type>sample string 3</d2p1:Type>
          <d2p1:TypeId>sample string 4</d2p1:TypeId>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:LeadDataActionStr>
      </d2p1:MessageData>
      <d2p1:Parent>1</d2p1:Parent>
      <d2p1:ParentText>sample string 6</d2p1:ParentText>
      <d2p1:Status>sample string 4</d2p1:Status>
      <d2p1:Subject>sample string 1</d2p1:Subject>
      <d2p1:TextAuthor>sample string 5</d2p1:TextAuthor>
      <d2p1:Usertext>sample string 3</d2p1:Usertext>
    </d2p1:LeadMessageData>
  </Leadmessagedata>
  <TotalRows>1</TotalRows>
  <TotalRowsSelect>1</TotalRowsSelect>
</LeadMessageInfoResponse>