Skip to content

Latest commit

 

History

History
109 lines (81 loc) · 3.52 KB

README_EN.md

File metadata and controls

109 lines (81 loc) · 3.52 KB

php-byrobot

ENGLISH | 中文

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

php byrobot openapi

Structure

src/
tests/

Install

Via Composer

$ composer require yiranzai/byrobot

Usage

Init

$robot = Yiranzai\Byrobot\Byrobot::init(
    [
        'appKey' => 'YOU_APP_KEY',
        'appSecret' => 'YOU_APP_SECRET'
    ]);

or

$robot = Yiranzai\Byrobot\Byrobot::init();
$robot->key(YOU_APP_KEY)->secret(YOU_APP_SECRET);

API

  • $robot->getCompanys() // Get the binding company list interface
  • $robot->getPhones() // Get the company's calling list interface
  • $robot->getRobots() // Get the company's robotic speech list interface
  • $robot->addBlackList() // Add a single blacklist to the company default blacklist group interface
  • $robot->statistics() // Get the company AI agent profile interface
  • $robot->createTask() // Create a task interface
  • $robot->start() // Start the task interface
  • $robot->pause() // Pause task interface
  • $robot->stop() // Stop the task interface
  • $robot->delete() // delete the task
  • $robot->importTaskCustomer() // Import the client interface into the task
  • $robot->update() // modify the task
  • $robot->call() // Single call outside call
  • $robot->singleCallByMobile() // Make a single call based on the phone number
  • $robot->getTasks() // Get the task list interface
  • $robot->getTaskDetail() // Get the task details interface
  • $robot->queryDoneTaskPhones() // Get the completed phone number interface
  • $robot->notDialedCustomerList() // Get a list of calls that the task has not started
  • $robot->phoneLogInfo() // Get a call details interface

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email wuqingdzx@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.