POST api/client/BotAction
Добавление, обновление, получение информации о связке идентификатора участника программы лояльности и идентификатора пользователя в мессенджере / соц. сети через бота Оператора программы лояльности
Request Information
URI Parameters
None.
Body Parameters
ClientBotActionRequestName | Description | Type | Additional information |
---|---|---|---|
PosCode |
Код торговой точки |
string |
None. |
ActionType |
Тип действия, которое необходимо выполнять (Create, Update, Info) |
string |
None. |
Exit |
Признак, что пользователь удаляет / отписывается от бота |
boolean |
None. |
BotId |
Идентификатор бота оператора |
string |
None. |
CustomerPhone |
Номер телефона пользователя из мессенджера / соц. сети |
integer |
None. |
CustomerBot |
Идентификатор пользователя в мессенджере / соц. сети |
string |
None. |
Operator |
Идентификатор оператора программы лояльности |
integer |
None. |
Token |
Токен пользователя, который инициирует данный запрос |
integer |
None. |
SiteCode |
Уникальный код виджета по продаже подарочных сертификатов, который инициирует запрос |
string |
None. |
Request Formats
application/json, text/json
{ "PosCode": "sample string 1", "ActionType": "sample string 2", "Exit": true, "BotId": "sample string 3", "CustomerPhone": 1, "CustomerBot": "sample string 4", "Operator": 1, "Token": 1, "SiteCode": "sample string 5" }
application/xml, text/xml
<ClientBotActionRequest 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 5</SiteCode> <Token xmlns="http://schemas.datacontract.org/2004/07/LCManagerPartner.Implementation.Abstractions">1</Token> <ActionType>sample string 2</ActionType> <BotId>sample string 3</BotId> <CustomerBot>sample string 4</CustomerBot> <CustomerPhone>1</CustomerPhone> <Exit>true</Exit> <PosCode>sample string 1</PosCode> </ClientBotActionRequest>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
ClientBotActionResponseName | Description | Type | Additional information |
---|---|---|---|
Client |
Идентификатор участника программы лояльности, к которому привязан идентификатор пользователя в мессенджере / соц. сети |
integer |
None. |
Phone |
Номер телефона участника программы лояльности, к которому привязан идентификатор пользователя в мессенджере / соц. сети |
integer |
None. |
ClientOperatorBotId |
Идентификатор созданной связки участника программы лояльности и пользователя мессенджера / соц. сети в БД mloyalty |
integer |
None. |
ErrorCode |
Код ошибки |
integer |
None. |
Message |
Сообщение об ошибке |
string |
None. |
Response Formats
application/json, text/json
{ "Client": 1, "Phone": 1, "ClientOperatorBotId": 1, "ErrorCode": 1, "Message": "sample string 2" }
application/xml, text/xml
<ClientBotActionResponse 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> <Client>1</Client> <ClientOperatorBotId>1</ClientOperatorBotId> <Phone>1</Phone> </ClientBotActionResponse>