POST api/marketing/SendMessageProcess
Отправка сообщения по заданному каналу коммуникации заданному клиенту или пользователю
Request Information
URI Parameters
None.
Body Parameters
SendMessageProcessRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| PosCode |
Код торговой точки |
string |
None. |
| CommunicationType |
Идентификатор типа коммуникации (1 = смс, 2 = email, 3 = push, 4 = telegram, 5 = whatsapp, 6 = viber, 7 = звонок_код) |
byte |
None. |
| Phone |
Номер телефона клиента или пользователя |
integer |
None. |
|
Email клиента или пользователя |
string |
None. |
|
| Subscriber |
Идентификатор подписчика |
integer |
None. |
| ChatId |
Идентификатор группы/канала для отправки сообщения |
integer |
None. |
| Client |
Идентификатор клиента |
integer |
None. |
| User |
Идентификатор пользователя |
integer |
None. |
| Person |
Идентификатор |
integer |
None. |
| Leads |
Идентификатор лида |
integer |
None. |
| Files |
Список файлов для сообщения |
Collection of SendMessageProcessFile |
None. |
| CardPhoneClientList |
Список карт/телефонов/клиентов для создания маркетингового списка |
Collection of SendMessageProcessCardPhoneClientList |
None. |
| TypeOpen |
Признак, что это регистрационная смс (не используется) |
string |
None. |
| IdTypeOpen |
Признак, что это регистрационная смс (не используется) |
string |
None. |
| MessageTemplate |
Идентификатор шаблона сообщения |
integer |
None. |
| Title |
Заголовок сообщения |
string |
None. |
| TextMessage |
Текст сообщения |
string |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"PosCode": "sample string 1",
"CommunicationType": 64,
"Phone": 1,
"Email": "sample string 2",
"Subscriber": 1,
"ChatId": 1,
"Client": 1,
"User": 1,
"Person": 1,
"Leads": 1,
"Files": [
{
"Id": 1,
"Url": "sample string 1",
"Type": "sample string 2",
"Name": "sample string 3",
"LevelStep": 64
},
{
"Id": 1,
"Url": "sample string 1",
"Type": "sample string 2",
"Name": "sample string 3",
"LevelStep": 64
}
],
"CardPhoneClientList": [
{
"Id": 1,
"Phone": 1,
"Client": 1,
"Card": 1,
"Bonus": 1.0
},
{
"Id": 1,
"Phone": 1,
"Client": 1,
"Card": 1,
"Bonus": 1.0
}
],
"TypeOpen": "sample string 3",
"IdTypeOpen": "sample string 4",
"MessageTemplate": 1,
"Title": "sample string 5",
"TextMessage": "sample string 6",
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 7"
}
application/xml, text/xml
<SendMessageProcessRequest 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 7</SiteCode>
<Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token>
<CardPhoneClientList>
<SendMessageProcessRequest.SendMessageProcessCardPhoneClientList>
<Bonus>1</Bonus>
<Card>1</Card>
<Client>1</Client>
<Id>1</Id>
<Phone>1</Phone>
</SendMessageProcessRequest.SendMessageProcessCardPhoneClientList>
<SendMessageProcessRequest.SendMessageProcessCardPhoneClientList>
<Bonus>1</Bonus>
<Card>1</Card>
<Client>1</Client>
<Id>1</Id>
<Phone>1</Phone>
</SendMessageProcessRequest.SendMessageProcessCardPhoneClientList>
</CardPhoneClientList>
<ChatId>1</ChatId>
<Client>1</Client>
<CommunicationType>64</CommunicationType>
<Email>sample string 2</Email>
<Files>
<SendMessageProcessRequest.SendMessageProcessFile>
<Id>1</Id>
<LevelStep>64</LevelStep>
<Name>sample string 3</Name>
<Type>sample string 2</Type>
<Url>sample string 1</Url>
</SendMessageProcessRequest.SendMessageProcessFile>
<SendMessageProcessRequest.SendMessageProcessFile>
<Id>1</Id>
<LevelStep>64</LevelStep>
<Name>sample string 3</Name>
<Type>sample string 2</Type>
<Url>sample string 1</Url>
</SendMessageProcessRequest.SendMessageProcessFile>
</Files>
<IdTypeOpen>sample string 4</IdTypeOpen>
<Leads>1</Leads>
<MessageTemplate>1</MessageTemplate>
<Person>1</Person>
<Phone>1</Phone>
<PosCode>sample string 1</PosCode>
<Subscriber>1</Subscriber>
<TextMessage>sample string 6</TextMessage>
<Title>sample string 5</Title>
<TypeOpen>sample string 3</TypeOpen>
<User>1</User>
</SendMessageProcessRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
SendMessageProcessResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageId |
Идентификатор отправленного сообщения |
integer |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"MessageId": 1,
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
<SendMessageProcessResponse 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> <MessageId>1</MessageId> </SendMessageProcessResponse>