POST api/marketing/CommunicationAction

Создание / изменение / получение информации о рассылке

Request Information

URI Parameters

None.

Body Parameters

CommunicationActionRequest
NameDescriptionTypeAdditional information
PosCode

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

string

None.

ActionType

Тип действия, которое нужно совершить

string

None.

CommunicationId

Идентификатор рассылки, которую нужно изменить или по которой нужно получить данные

integer

None.

PartnerSender

Признак, что отправка должна идти от имени отправителя партнера, а не оператора

boolean

None.

Name

Наименование рассылки

string

None.

CommunicationStatus

Статус рассылки

byte

None.

CommunicationType

Тип рассылки (1 = sms; 2 = email; 3 = push)

byte

None.

BegDate

Дата и время отправки рассылки

date

None.

Title

Заголовок сообщения

string

None.

TextMessage

Текст сообщения

string

None.

Image

Адрес изображения, посылаемого в сообщении

string

None.

TypeOpen

Тип экрана, который нужно открывать при нажатии на пуш (1 = акции, 2 = партнеры, 3 = уведомления, 4 = история бонусов)

string

None.

IdTypeOpen

Идентификатор партнера или акции, карточку которого нужно открыть при нажатии на пуш

string

None.

MessageTemplate

Идентификатор ранее созданного шаблона сообщения

integer

None.

MarketList

Идентификатор ранее созданного списка карт, по которым будет отправка рассылки

integer

None.

ClientList

Идентификатор ранее созданного списка клиентов, по которым будет отправка рассылки

integer

None.

Campaign

Идентификатор акции, по которой будет рассылка

integer

None.

Sample

Идентификатор выборки, на основании критериев которой необходимо создать список карт, по которым будет отправка рассылки

integer

None.

BonusmarketList

Идентификатор правила начисления бонусов на список клиентов

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "ActionType": "sample string 2",
  "CommunicationId": 1,
  "PartnerSender": true,
  "Name": "sample string 3",
  "CommunicationStatus": 64,
  "CommunicationType": 64,
  "BegDate": "2024-06-20T05:06:03.6744479+03:00",
  "Title": "sample string 4",
  "TextMessage": "sample string 5",
  "Image": "sample string 6",
  "TypeOpen": "sample string 7",
  "IdTypeOpen": "sample string 8",
  "MessageTemplate": 1,
  "MarketList": 1,
  "ClientList": 1,
  "Campaign": 1,
  "Sample": 1,
  "BonusmarketList": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 9"
}

application/xml, text/xml

Sample:
<CommunicationActionRequest 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 9</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <ActionType>sample string 2</ActionType>
  <BegDate>2024-06-20T05:06:03.6744479+03:00</BegDate>
  <BonusmarketList>1</BonusmarketList>
  <Campaign>1</Campaign>
  <ClientList>1</ClientList>
  <CommunicationId>1</CommunicationId>
  <CommunicationStatus>64</CommunicationStatus>
  <CommunicationType>64</CommunicationType>
  <IdTypeOpen>sample string 8</IdTypeOpen>
  <Image>sample string 6</Image>
  <MarketList>1</MarketList>
  <MessageTemplate>1</MessageTemplate>
  <Name>sample string 3</Name>
  <PartnerSender>true</PartnerSender>
  <PosCode>sample string 1</PosCode>
  <Sample>1</Sample>
  <TextMessage>sample string 5</TextMessage>
  <Title>sample string 4</Title>
  <TypeOpen>sample string 7</TypeOpen>
</CommunicationActionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommunicationActionResponse
NameDescriptionTypeAdditional information
Communication

Идентификатор созданной рассылки

integer

None.

CommunicationList

Рассылки

Collection of CommunicationActionCommunicationList

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Communication": 1,
  "CommunicationList": [
    {
      "Id": 1,
      "Operator": 1,
      "Name": "sample string 1",
      "CommunicationType": 64,
      "CommunicationTypeName": "sample string 2",
      "CommunicationStatus": 64,
      "CommunicationStatusName": "sample string 3",
      "BegDate": "2024-06-20T05:06:03.8931995+03:00",
      "EndDate": "2024-06-20T05:06:03.8931995+03:00",
      "Title": "sample string 4",
      "TextMessage": "sample string 5",
      "Image": "sample string 6",
      "TypeOpen": "sample string 7",
      "IdTypeOpen": "sample string 8",
      "MessageTemplate": 1,
      "MarketList": 1,
      "BonusMarketList": 1,
      "PersonList": 1,
      "Campaign": 1,
      "CountSendMessage": 1,
      "MarketListName": "sample string 9",
      "BonusMarketListName": "sample string 10",
      "CommunicationCost": 1.0,
      "CountCard": 1
    },
    {
      "Id": 1,
      "Operator": 1,
      "Name": "sample string 1",
      "CommunicationType": 64,
      "CommunicationTypeName": "sample string 2",
      "CommunicationStatus": 64,
      "CommunicationStatusName": "sample string 3",
      "BegDate": "2024-06-20T05:06:03.8931995+03:00",
      "EndDate": "2024-06-20T05:06:03.8931995+03:00",
      "Title": "sample string 4",
      "TextMessage": "sample string 5",
      "Image": "sample string 6",
      "TypeOpen": "sample string 7",
      "IdTypeOpen": "sample string 8",
      "MessageTemplate": 1,
      "MarketList": 1,
      "BonusMarketList": 1,
      "PersonList": 1,
      "Campaign": 1,
      "CountSendMessage": 1,
      "MarketListName": "sample string 9",
      "BonusMarketListName": "sample string 10",
      "CommunicationCost": 1.0,
      "CountCard": 1
    }
  ],
  "ErrorCode": 1,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<CommunicationActionResponse 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>
  <Communication>1</Communication>
  <CommunicationList>
    <CommunicationActionResponse.CommunicationActionCommunicationList>
      <BegDate>2024-06-20T05:06:03.8931995+03:00</BegDate>
      <BonusMarketList>1</BonusMarketList>
      <BonusMarketListName>sample string 10</BonusMarketListName>
      <Campaign>1</Campaign>
      <CommunicationCost>1</CommunicationCost>
      <CommunicationStatus>64</CommunicationStatus>
      <CommunicationStatusName>sample string 3</CommunicationStatusName>
      <CommunicationType>64</CommunicationType>
      <CommunicationTypeName>sample string 2</CommunicationTypeName>
      <CountCard>1</CountCard>
      <CountSendMessage>1</CountSendMessage>
      <EndDate>2024-06-20T05:06:03.8931995+03:00</EndDate>
      <Id>1</Id>
      <IdTypeOpen>sample string 8</IdTypeOpen>
      <Image>sample string 6</Image>
      <MarketList>1</MarketList>
      <MarketListName>sample string 9</MarketListName>
      <MessageTemplate>1</MessageTemplate>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <PersonList>1</PersonList>
      <TextMessage>sample string 5</TextMessage>
      <Title>sample string 4</Title>
      <TypeOpen>sample string 7</TypeOpen>
    </CommunicationActionResponse.CommunicationActionCommunicationList>
    <CommunicationActionResponse.CommunicationActionCommunicationList>
      <BegDate>2024-06-20T05:06:03.8931995+03:00</BegDate>
      <BonusMarketList>1</BonusMarketList>
      <BonusMarketListName>sample string 10</BonusMarketListName>
      <Campaign>1</Campaign>
      <CommunicationCost>1</CommunicationCost>
      <CommunicationStatus>64</CommunicationStatus>
      <CommunicationStatusName>sample string 3</CommunicationStatusName>
      <CommunicationType>64</CommunicationType>
      <CommunicationTypeName>sample string 2</CommunicationTypeName>
      <CountCard>1</CountCard>
      <CountSendMessage>1</CountSendMessage>
      <EndDate>2024-06-20T05:06:03.8931995+03:00</EndDate>
      <Id>1</Id>
      <IdTypeOpen>sample string 8</IdTypeOpen>
      <Image>sample string 6</Image>
      <MarketList>1</MarketList>
      <MarketListName>sample string 9</MarketListName>
      <MessageTemplate>1</MessageTemplate>
      <Name>sample string 1</Name>
      <Operator>1</Operator>
      <PersonList>1</PersonList>
      <TextMessage>sample string 5</TextMessage>
      <Title>sample string 4</Title>
      <TypeOpen>sample string 7</TypeOpen>
    </CommunicationActionResponse.CommunicationActionCommunicationList>
  </CommunicationList>
</CommunicationActionResponse>