# Выплаты Agents Telegram
## Описание
Модуль позволяет настроить выплату валюты через операторов, которые будут получать в отдельной телеграм группе сообщения с возможными заявками. В группе будет возможность видеть детали заявки, закрепляться за ними и изменять их статус после успешной/неуспешной выплаты. \
Администратор сможет мониторить в группе статусы заявки, операторов, а также время затраченное на выплату.
## Установка
Используя параметры ниже, установите модуль через функционал "**Install plugin**" по инструкции [install-plugin](https://manual.boxexchanger.net/dopolnitelnye-sistemy/install-plugin "mention").
Параметры для Install Plugin
**Plugin type**: **`Payout module`**
**Plugin URL**: **`@boxexchanger-plugins/payout-agents-telegram`**
**Directory path**: **`agents-telegram`**
**Auth: (Deploy token)**: оставляем пустым
**Package tag**: **`latest`**
## Конфигурация
1. Создайте в Telegram новую группу и добавьте в нее бота .
2. В чате созданной группы, отправьте команду **`/start@payout_agents_bot`**для генерации API URL и ключей -> [**сохраните**](#user-content-fn-1)[^1] значения **API URL**, **API Key**, **Secret Key** в надежное место -> **удалите сообщение из чата в целях безопасности**.
{% hint style="info" %}
Для перегенерации ключей вы можете использовать команду **`/regenerate@payout_agents_bot`**
{% endhint %}
{% hint style="info" %}
Команды **`/start@payout_agents_bot`** и **`/regenerate@payout_agents_bot`** могут быть вызваны любым участником группы, однако бот отправит **API URL**, **API Key**, **Secret Key** либо перегенерирует ключи только если команды выше вызовет администратор группы.
{% endhint %}
3. Зайдите в админ панель скрипта -> страница "**Мерчант и API**" - раздел "**PAYOUT SYSTEM**" -> нажмите на [**значок настроек**](#user-content-fn-2)[^2] в блоке с модулем выплаты "**Payout Agents**".
4. На странице настроек модуля укажите значения **API URL**, **API Key**, **Secret Key** в соответствующие поля -> нажмите "[**Save**](#user-content-fn-3)[^3]" напротив каждого поля.
5. Для поля "**Send route fields (from order)**" выберите подходящий параметр по таблице ниже -> нажмите "**Save**".
| Yes | No |
| :--------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------: |
| При параметре "**Yes**", в сообщении с деталями заявки будут отображаться и данные из полей валюты вывода и данные из полей направления. | При параметре "**No**", в сообщении с деталями заявки будут отображаться только данные из полей валюты выплаты. |
6. В настройках валюты/направления установите "**Payout Agents**" в качестве модуля выплаты.
{% hint style="info" %}
Обратите внимание, одна группа в телеграм = один модуль выплаты "**Payout Agents**". В случае, если вам необходимо разделить выплаты разных валют по группам, к примеру, "**Выплата UAH**", "**Выплата USD**" и т.д, то вы можете дублировать данный модуль выплаты через функционал [install-plugin](https://manual.boxexchanger.net/dopolnitelnye-sistemy/install-plugin "mention"), при этом указывая уникальный "**Directory path**" для каждого последующего модуля. \
Также учтите, что для каждого нового модуля необходимо указывать уникальный **API URL**, **API Key**, **Secret Key**, которые возможно получить в новой созданной Telegram группе по инструкции выше.
{% endhint %}
## Взаимодействие с заявкой
1. В ранее созданную Telegram группу добавьте операторов, которые будут обрабатывать заявки.
2. Дождитесь пока бот отправит в группу сообщение с деталями по заявке. Пример такого сообщения на [**скриншоте**](#user-content-fn-4)[^4].
{% hint style="info" %}
Обратите внимание, что бот отправляет в чат новую заявку через несколько секунд после того как для заявки был выставлен статус [#na-vyplatu](https://manual.boxexchanger.net/zayavki/zayavki/statusy-zayavki#na-vyplatu "mention") (то есть был запущен модуль выплаты "**Payout Agents**" для валюты OUT).
{% endhint %}
{% hint style="info" %}
До момента пока заявка не была принята одним из операторов - данные из полей заявки будут частично скрыты для всех участников группы.
{% endhint %}
3. Как только один из операторов будет готов обработать заявку -> оператору необходимо нажать на кнопку "[**Accept**](#user-content-fn-5)[^5]" в сообщении с необходимой заявкой. После нажатия на кнопку оператор будет закреплён за заявкой и для всех участников группы станут видны данные из полей заявки. Пример на [**скриншоте**](#user-content-fn-6)[^6].
4. После того как оператор закрепился за заявкой, появляется возможность обозначить выплату завершенной (кнопка "**Done**") либо открепиться от заявки (кнопка "**Cancel**"). Подробнее о каждой кнопке в таблице ниже.
| Done | Cancel |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| При нажатии на кнопку "**Done**", статус заявки изменяется на [#zavershena](https://manual.boxexchanger.net/zayavki/zayavki/statusy-zayavki#zavershena "mention"), а в сообщении от бота добавляется строка с временем завершения обработки заявки. Пример на [**скриншоте**](#user-content-fn-7)[^7]. | При нажатии на кнопку "**Cancel**", статус заявки изменяется на [#oshibka-pri-vyplate](https://manual.boxexchanger.net/zayavki/zayavki/statusy-zayavki#oshibka-pri-vyplate "mention"), а в сообщении от бота добавляется строка с временем, в которое оператор открепился от заявки. Пример на [**скриншоте**](#user-content-fn-8)[^8]. |
{% hint style="info" %}
Заявку, для которой был установлен статус [#oshibka-pri-vyplate](https://manual.boxexchanger.net/zayavki/zayavki/statusy-zayavki#oshibka-pri-vyplate "mention") (после нажатия на кнопку "**Cancel**"), возможно еще раз отправить в бот чтобы ее обработал другой оператор. Для этого достаточно в админ панели скрипта, в деталях заявки изменить ее статус на [#na-vyplatu](https://manual.boxexchanger.net/zayavki/zayavki/statusy-zayavki#na-vyplatu "mention"). \
Подробнее об изменении статуса заявки в инструкции [#izmenenie-statusa](https://manual.boxexchanger.net/zayavki/zayavki#izmenenie-statusa "mention").
{% endhint %}
{% hint style="info" %}
Кнопки "**Done**" и "**Cancel**" будут отображаться для все участников группы, однако изменение статуса заявки, при нажатии на одну из кнопок, произойдет только если такое действие совершит оператор, который закрепился за заявкой. \
В противном случае, будет отображаться ошибка, которая сообщает о том, что заявка закреплена за другим оператором.
{% endhint %}
### Структура деталей заявки
* Значения номера заявки, данных из полей, а также суммы возможно скопировать нажатием на такое значение. Пример на [**скриншоте**](#user-content-fn-9)[^9].
* В случае, если у оператора установлен username в Telegram, то после нажатия на кнопку "**Accept**", в поле "**Accepted By**" будет установлен username оператора, который принял заявку. Пример на [**скриншоте**](#user-content-fn-10)[^10].
* В случае, если у оператора отсутствует username в Telegram, то после нажатия на кнопку "**Accept**", в поле "**Accepted By**" будет установлены имя и фамилия оператора, который принял заявку. Пример на [**скриншоте**](#user-content-fn-11)[^11].
* В поле "**Currency**" отображается XML валюты вывода и тип валюты вывода. Пример на [**скриншоте**](#user-content-fn-12)[^12].
[^1]: 
[^2]: 
[^3]: 
[^4]: 
[^5]: 
[^6]: 
[^7]: 
[^8]: 
[^9]: 
[^10]: 
[^11]: 
[^12]: 