POST api/marketing/CommunicationInfo

Получение информации о ранее созданной рассылке по её идентификатору

Request Information

URI Parameters

None.

Body Parameters

CommunicationInfoRequest
NameDescriptionTypeAdditional information
PosCode

Код торговой точки

string

None.

CommunicationId

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

integer

None.

Operator

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

integer

None.

Token

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

integer

None.

SiteCode

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

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PosCode": "sample string 1",
  "CommunicationId": 1,
  "Operator": 1,
  "Token": 1,
  "SiteCode": "sample string 2"
}

application/xml, text/xml

Sample:
<CommunicationInfoRequest 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 2</SiteCode>
  <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
  <CommunicationId>1</CommunicationId>
  <PosCode>sample string 1</PosCode>
</CommunicationInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommunicationInfoResponse
NameDescriptionTypeAdditional information
OperatorCommunication

Идентификатор оператора, которому принадлежит рассылка

integer

None.

PartnerSender

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

boolean

None.

Name

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

string

None.

CommunicationType

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

byte

None.

CommunicationTypeName

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

string

None.

CommunicationStatus

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

byte

None.

CommunicationStatusName

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

string

None.

BegDate

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

date

None.

EndDate

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

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.

CountSendMessage

Количество отправленных сообщений по рассылки

integer

None.

BonusListRule

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

integer

None.

ErrorCode

Код ошибки

integer

None.

Message

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

string

None.

Response Formats

application/json, text/json

Sample:
{
  "OperatorCommunication": 1,
  "PartnerSender": true,
  "Name": "sample string 1",
  "CommunicationType": 64,
  "CommunicationTypeName": "sample string 2",
  "CommunicationStatus": 64,
  "CommunicationStatusName": "sample string 3",
  "BegDate": "2022-08-16T21:55:01.51981+03:00",
  "EndDate": "2022-08-16T21:55:01.51981+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,
  "CountSendMessage": 1,
  "BonusListRule": 1,
  "ErrorCode": 9,
  "Message": "sample string 10"
}

application/xml, text/xml

Sample:
<CommunicationInfoResponse 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">9</ErrorCode>
  <Message xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">sample string 10</Message>
  <BegDate>2022-08-16T21:55:01.51981+03:00</BegDate>
  <BonusListRule>1</BonusListRule>
  <Campaign>1</Campaign>
  <ClientList>1</ClientList>
  <CommunicationStatus>64</CommunicationStatus>
  <CommunicationStatusName>sample string 3</CommunicationStatusName>
  <CommunicationType>64</CommunicationType>
  <CommunicationTypeName>sample string 2</CommunicationTypeName>
  <CountSendMessage>1</CountSendMessage>
  <EndDate>2022-08-16T21:55:01.51981+03:00</EndDate>
  <IdTypeOpen>sample string 8</IdTypeOpen>
  <Image>sample string 6</Image>
  <MarketList>1</MarketList>
  <MessageTemplate>1</MessageTemplate>
  <Name>sample string 1</Name>
  <OperatorCommunication>1</OperatorCommunication>
  <PartnerSender>true</PartnerSender>
  <Sample>1</Sample>
  <TextMessage>sample string 5</TextMessage>
  <Title>sample string 4</Title>
  <TypeOpen>sample string 7</TypeOpen>
</CommunicationInfoResponse>