POST api/system/MessageOperatorAction
Создание, изменение, получение информации о настройках записи отправки коммуникаций
Request Information
URI Parameters
None.
Body Parameters
MessageOperatorActionRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ActionType |
Тип действия: Create, Update, Info |
string |
None. |
| MessageOperatorId |
Идентификатор записи для изменения или получения данных |
integer |
None. |
| MessageProvider |
Идентификатор провайдера |
integer |
None. |
| CommunicationType |
Идентификатор типа коммуникации |
byte |
None. |
| Sender |
Имя отправителя сообщений |
string |
None. |
| ApiUrl |
Адрес апи провайдера |
string |
None. |
| ApiLogin |
Логин в апи провайдера |
string |
None. |
| ApiPassword |
Пароль в апи провайдера |
string |
None. |
| EmailFrom |
Email, от которого отправляются email оператора |
string |
None. |
| AndroidApiKey |
Ключ firebase (android) |
string |
None. |
| IosBundleId |
Идентификатор сборки (ios) |
string |
None. |
| IosTeamId |
Идентификатор команды (ios) |
string |
None. |
| IosAuthKey |
Ключ авторизации (ios) |
string |
None. |
| KeyId |
Идентификатор ключа (ios) |
string |
None. |
| ApiKey |
Апи-ключ |
string |
None. |
| SendFromPos |
Признак, что отправлять коммуникацию нужно от точки, а не от оператора |
boolean |
None. |
| SendBeelineSms |
Признак отправки или не отправки смс на билайн (работает для GreenSms) |
boolean |
None. |
| SendPromoBeelineSms |
Признак отправки или не отправки рекламных смс на билайн (работает для GreenSms) |
boolean |
None. |
| Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
| Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
| SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{
"ActionType": "sample string 1",
"MessageOperatorId": 1,
"MessageProvider": 1,
"CommunicationType": 64,
"Sender": "sample string 2",
"ApiUrl": "sample string 3",
"ApiLogin": "sample string 4",
"ApiPassword": "sample string 5",
"EmailFrom": "sample string 6",
"AndroidApiKey": "sample string 7",
"IosBundleId": "sample string 8",
"IosTeamId": "sample string 9",
"IosAuthKey": "sample string 10",
"KeyId": "sample string 11",
"ApiKey": "sample string 12",
"SendFromPos": true,
"SendBeelineSms": true,
"SendPromoBeelineSms": true,
"Operator": 1,
"Token": 1,
"SiteCode": "sample string 13"
}
application/xml, text/xml
<MessageOperatorActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Request.SystemRequest"> <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 13</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <ActionType>sample string 1</ActionType> <AndroidApiKey>sample string 7</AndroidApiKey> <ApiKey>sample string 12</ApiKey> <ApiLogin>sample string 4</ApiLogin> <ApiPassword>sample string 5</ApiPassword> <ApiUrl>sample string 3</ApiUrl> <CommunicationType>64</CommunicationType> <EmailFrom>sample string 6</EmailFrom> <IosAuthKey>sample string 10</IosAuthKey> <IosBundleId>sample string 8</IosBundleId> <IosTeamId>sample string 9</IosTeamId> <KeyId>sample string 11</KeyId> <MessageOperatorId>1</MessageOperatorId> <MessageProvider>1</MessageProvider> <SendBeelineSms>true</SendBeelineSms> <SendFromPos>true</SendFromPos> <SendPromoBeelineSms>true</SendPromoBeelineSms> <Sender>sample string 2</Sender> </MessageOperatorActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
MessageOperatorActionResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageOperator |
Идентификатор созданной записи |
integer |
None. |
| Data |
Массив данных |
Collection of MessageOperatorActionDataRow |
None. |
| ErrorCode |
Код ошибки |
integer |
None. |
| Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{
"MessageOperator": 1,
"Data": [
{
"MessageOperatorId": 1,
"MessageProvider": 1,
"MessageProviderName": "sample string 1",
"CommunicationType": 64,
"CommunicationTypeName": "sample string 2",
"Sender": "sample string 3",
"ApiUrl": "sample string 4",
"ApiLogin": "sample string 5",
"ApiPassword": "sample string 6",
"EmailFrom": "sample string 7",
"ApiKey": "sample string 8",
"SendFromPos": true,
"SendBeelineSms": true,
"PromoSendBeelineSms": true
},
{
"MessageOperatorId": 1,
"MessageProvider": 1,
"MessageProviderName": "sample string 1",
"CommunicationType": 64,
"CommunicationTypeName": "sample string 2",
"Sender": "sample string 3",
"ApiUrl": "sample string 4",
"ApiLogin": "sample string 5",
"ApiPassword": "sample string 6",
"EmailFrom": "sample string 7",
"ApiKey": "sample string 8",
"SendFromPos": true,
"SendBeelineSms": true,
"PromoSendBeelineSms": true
}
],
"ErrorCode": 1,
"Message": "sample string 2"
}
application/xml, text/xml
<MessageOperatorActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Response.SystemResponse">
<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>
<MessageOperatorActionResponse.MessageOperatorActionDataRow>
<ApiKey>sample string 8</ApiKey>
<ApiLogin>sample string 5</ApiLogin>
<ApiPassword>sample string 6</ApiPassword>
<ApiUrl>sample string 4</ApiUrl>
<CommunicationType>64</CommunicationType>
<CommunicationTypeName>sample string 2</CommunicationTypeName>
<EmailFrom>sample string 7</EmailFrom>
<MessageOperatorId>1</MessageOperatorId>
<MessageProvider>1</MessageProvider>
<MessageProviderName>sample string 1</MessageProviderName>
<PromoSendBeelineSms>true</PromoSendBeelineSms>
<SendBeelineSms>true</SendBeelineSms>
<SendFromPos>true</SendFromPos>
<Sender>sample string 3</Sender>
</MessageOperatorActionResponse.MessageOperatorActionDataRow>
<MessageOperatorActionResponse.MessageOperatorActionDataRow>
<ApiKey>sample string 8</ApiKey>
<ApiLogin>sample string 5</ApiLogin>
<ApiPassword>sample string 6</ApiPassword>
<ApiUrl>sample string 4</ApiUrl>
<CommunicationType>64</CommunicationType>
<CommunicationTypeName>sample string 2</CommunicationTypeName>
<EmailFrom>sample string 7</EmailFrom>
<MessageOperatorId>1</MessageOperatorId>
<MessageProvider>1</MessageProvider>
<MessageProviderName>sample string 1</MessageProviderName>
<PromoSendBeelineSms>true</PromoSendBeelineSms>
<SendBeelineSms>true</SendBeelineSms>
<SendFromPos>true</SendFromPos>
<Sender>sample string 3</Sender>
</MessageOperatorActionResponse.MessageOperatorActionDataRow>
</Data>
<MessageOperator>1</MessageOperator>
</MessageOperatorActionResponse>