PHP Клиент для работы с Bothelp.io API
📖 Документация по API bothelp по ссылке
📑 Навигация
- Установка
- QuickStart
- Методы
php >= 7.4
composer require bothelpio/bothelp-php-sdk
В личном кабинете получаем
client_id
client_secret
Создаем клиента
use BothelpSDK\BothelpClient;
use BothelpSDK\Config\ClientOptions;
// создаем клиента
$options = new ClientOptions(
'***YourClientId***',
'***YourClientSecret***'
);
$client = new new BothelpClient($options);
//отправляем произовольный запрос к апи bothelp
// get
$response = $client->apiRequest('GET', 'subsribers?after=12323');
// patch
$response = $client->apiRequest(
'PATCH',
'subsribers/12',
[
['op' => 'replace', 'path' => '/name', 'value' => 'John Doe']
]
);
//etc...
use BothelpSDK\BothelpClient;
use BothelpSDK\Config\ClientOptions;
use BothelpSDK\Request\Subscriber\SubscriberFilter;
use BothelpSDK\Resource\Subscriber\SubscriberService;
// создаем клиента
$options = new ClientOptions(
'***YourClientId***',
'***YourClientSecret***'
);
$client = new new BothelpClient($options);
// создаем сервис для работы с подписчиками
$subscriberService = new SubscriberService($client);
// ПРИМЕР 1
// получим список всех подписчиков и выведем их имена
$list = $subscriberService->list();
foreach($list as $subscriber) {
echo $subscriber->getName();
}
// ПРИМЕР 2
// получим подписчика по email
$filter = new SubscriberFilter();
$filter->setEmail('johnDhoe@example.com');
$list = $subscriberService->list($filter);
if ($list->count() > 0) {
$subscriber = $list[0];
print_r($subscriber->getRawData());
}
// ПРИМЕР 3
// получим список всех подписчиков после определенной даты
// и пройдемся по постраничке
$filter = new SubscriberFilter();
$filter->setCreatedAfter(1662126165);
$page1list = $subscriberService->list($filter);
if ($page1list->hasNext()) { // есть еще страницы в выдаче?
// заберем вторую страницу...
$page2List = $subscriberService->list($page1list->getNextFilter());
}
use BothelpSDK\BothelpClient;
use BothelpSDK\Config\ClientOptions;
use BothelpSDK\Request\Subscriber\SubscriberId;
use BothelpSDK\Resource\Subscriber\SubscriberService;
// создаем клиента
$options = new ClientOptions(
'***YourClientId***',
'***YourClientSecret***'
);
$client = new new BothelpClient($options);
// создаем сервис для работы с подписчиками
$subscriberService = new SubscriberService($client);
// Определим с каким подписчиком будем работать.
// по ID подписчика
$id = (new SubscriberId())->setId(92);
// или по CUID подписчика
$id = (new SubscriberId())->setCuid('1et0.2k');
// Вызовем нужные методы
// записать телефон
$subscriberService->setPhone($id, '+79941111111');
// записать email
$subscriberService->setEmail($id, 'hello@bothelp.io');
// записать полное имя
$subscriberService->setName($id, 'John Doe');
// записать имя
$subscriberService->setFirstName($id, 'John');
// записать фамилию
$subscriberService->setLastName($id, 'Doe');
// записать заметки
$subscriberService->setNotes($id, 'some notes text... ');
use BothelpSDK\BothelpClient;
use BothelpSDK\Config\ClientOptions;
use BothelpSDK\Request\Subscriber\SubscriberId;
use BothelpSDK\Resource\Subscriber\SubscriberService;
// создаем клиента
$options = new ClientOptions(
'***YourClientId***',
'***YourClientSecret***'
);
$client = new new BothelpClient($options);
// создаем сервис для работы с подписчиками
$subscriberService = new SubscriberService($client);
// Определим с каким подписчиком будем работать.
// по ID подписчика
$id = (new SubscriberId())->setId(92);
// или по CUID подписчика
$id = (new SubscriberId())->setCuid('1et0.2k');
// Вызовем нужные методы
// добавим 3 метки пользователю
$subscriberService->setTags($id, ['awesome', 'bad', 'best']);
// удалить 2 метки у пользователя
$subscriberService->removeTags($id, ['bad', 'best']);
use BothelpSDK\BothelpClient;
use BothelpSDK\Config\ClientOptions;
use BothelpSDK\Request\Subscriber\SubscriberId;
use BothelpSDK\Resource\CustomField\CustomField;
// создаем клиента
$options = new ClientOptions(
'***YourClientId***',
'***YourClientSecret***'
);
$client = new new BothelpClient($options);
// создаем сервис для работы с customField
$customFieldService = new CustomField($client);
// Установим поле favorite_color в значение blue для подписчика с id = 92
$id = (new SubscriberId())->setId(92);
$customFieldService->setField($id, 'favorite_color', 'blue');
// Установим поле Бюджет в значение 7000 для подписчика с cuid = 1et0.2k
$id = (new SubscriberId())->setCuid('1et0.2k');
$customFieldService->setField($id, 'Бюджет', '7000');
use BothelpSDK\BothelpClient;
use BothelpSDK\Config\ClientOptions;
use BothelpSDK\Request\Subscriber\SubscriberId;
use BothelpSDK\Resource\Message\MessageService;
// создаем клиента
$options = new ClientOptions(
'***YourClientId***',
'***YourClientSecret***'
);
$client = new new BothelpClient($options);
// создаем сервис для работы с сообщениями
$messageService = new MessageService($client);
// отправим сообщение для подписчика с id = 92
$id = (new SubscriberId())->setId(92);
$messageService->send($id, 'hello world');
// отправим сообщение в несколько строк для подписчика с cuid = 1et0.2k
$id = (new SubscriberId())->setCuid('1et0.2k');
$content = 'hello' . PHP_EOL;
$content .= 'My name api ' . PHP_EOL;
$content .= '😂';
$messageService->send($id, $content);
👷 Скоро будет
👷 Скоро будет