laravel-webex.md

meta	gitName
name content description A simple Laravel integration with Webex.	laravel-webex

laravel-webex

A simple Laravel integration with Webex.

Installation

Install the package through Composer.

Run the Composer require command from the Terminal:

composer require offline-agency/laravel-webex

You should publish config file with:

php artisan vendor:publish --tag="webex-config"

Usage

Each callback accept a number of parameters equals to the sum of the required parameters +1 that is $additional_data that accept all optional parameters.

Package provide two events to intercept the start and the end of the authentication flow.

Examples

Meetings

// all 
$laravel_webex = new LaravelWebex($bearer);
$meetings_list = $laravel_webex->meeting()->list();

// all filtered by state
$laravel_webex = new LaravelWebex($bearer);
$meetings_list = $laravel_webex->meeting()->list([
    'state' => $state
]);

// detail
$laravel_webex = new LaravelWebex($bearer);
$meeting_detail = $laravel_webex->meeting()->detail($meeting_id);

// detail filtered by current 
$laravel_webex = new LaravelWebex($bearer);
$meeting_detail = $laravel_webex->meeting()->detail($meeting_id, [
    'current' => $current
]);

// create
$laravel_webex = new LaravelWebex($bearer);
$new_meeting = $laravel_webex->meeting()->create($title, $start, $end, [
    'agenda' => $agenda,
    'enabledAutoRecordMeeting' => $enabledAutoRecordMeeting
]);

// update
$laravel_webex = new LaravelWebex($bearer);
$updated_meeting = $laravel_webex->meeting()->update($id, $title, $pasword, $start, $end, [
    'agenda' => $agenda,
    'enabledAutoRecordMeeting' => $enabledAutoRecordMeeting
]);

// delete 
$laravel_webex = new LaravelWebex($bearer);
$delete_response = $laravel_webex->meeting()->destroy('fake_id');

Meetings participants

$laravel_webex = new LaravelWebex($bearer);
$meeting_participants_list = $laravel_webex->meeting_participants()->list($meeting_id);

Api coverage

Admin

Admin Audit Events

• List Admin Audit Events

Events

• List Events
• Get Event Details

Historical Analytics

• Historical Data related to Messaging
• Historical Data related to Room Devices
• Historical Data related to Meetings

Hybrid Clusters

• List Hybrid Clusters
• Get Hybrid Cluster Details

Hybrid Connectors

• List Hybrid Connectors
• Get Hybrid Connector Details

Licenses

• List Licenses
• Get License Details

Locations

• List Locations
• Get Location Details

Meeting Qualities

• Get Meeting Qualities

Memberships

• List Memberships
• Create Membership
• Get Membership Details
• Update a Membership
• Delete a Membership

Organizations

• List Organizations
• Get Organization Details
• Delete Organization

People

• List People
• Create a Person
• Get Person Details
• Update a Person
• Delete a Person
• Get My Own Details

Recording Report

• List of Recording Audit Report Summaries
• Get Recording Audit Report Details

Recordings

• List Recordings
• Get Recording Details
• Delete a Recording

Report Templates

• List Report Templates

Reports

• List Reports
• Create a Report
• Get Report Details
• Delete a Report

Resource Group Memberships

• List Resource Group Memberships
• Get Resource Group Membership Details
• Update a Resource Group Membership

Resource Group

• List Resource Groups
• Get Resource Group Details

Roles

• List Roles
• Get Role Details

Space Classifications

• List classifications

Webex Calling Organization Settings

• Read the List of Call Pickups
• Create a Call Pickup
• Delete a Call Pickup
• Get Details for a Call Pickup
• Update a Call Pickup
• Get available agents from Call Pickups
• Read the List of Call Queues
• Create a Call Queue
• Delete a Call Queue
• Get Details for a Call Queue
• Update a Call Queue
• Read the List of Call Queue Announcement Files
• Delete a Call Queue Announcement File
• Get Call Forwarding Settings for a Call Queue
• Update Call Forwarding Settings for a Call Queue
• Create a Selective Call Forwarding Rule for a Call Queue
• Get Call Forwarding Rule Settings for a Call Queue
• Update Call Forwarding Rule Settings for a Call Queue
• Delete a Selective Call Forwarding Rule for a Call Queue
• Read the List of Hunt Groups
• Create a Hunt Group
• Delete a Hunt Group
• Get Details for a Hunt Group
• Update a Hunt Group
• Get Call Forwarding Settings for a Hunt Group
• Update Call Forwarding Settings for a Hunt Group
• Create a Selective Call Forwarding Rule for a Hunt Group
• Get Call Forwarding Rule Settings for a Hunt Group
• Update Call Forwarding Rule Settings for a Hunt Group
• Delete a Selective Call Forwarding Rule for a Hunt Group
• Read the List of UC Manager Profiles

Webex Calling Person Settings

• Read Person's UC Profile
• Configure a Person's UC Profile
• Read Barge In Settings for a Person
• Configure Barge In Settings for a Person
• Read Forwarding Settings for a Person
• Configure Call Forwarding Settings for a Person
• Read Call Intercept Settings for a Person
• Configure Call Intercept Settings for a Person
• Configure Call Intercept Greeting for a Person
• Read Call Recording Settings for a Person
• Configure Call Recording Settings for a Person
• Read Caller ID Settings for a Person
• Configure Caller ID Settings for a Person
• Read Do Not Disturb Settings for a Person
• Configure Do Not Disturb Settings for a Person
• Read Voicemail Settings for a Person
• Configure Voicemail Settings for a Person
• Configure Busy Voicemail Greeting for a Person
• Configure No Answer Voicemail Greeting for a Person

Workspace Locations

• List Workspace Locations
• Create a Workspace Location
• Get a Workspace Location Details
• Update a Workspace Location
• Delete a Workspace Location
• List Workspace Location Floors
• Create a Workspace Location Floor
• Get a Workspace Location Floor Details
• Update a Workspace Location Floor
• Delete a Workspace Location Floor

Workspace Metrics

• Workspace Metrics
• Workspace Duration Metrics

Workspaces

• List Workspaces
• Create a Workspaces
• Get Workspace Details
• Update a Workspace
• Delete a Workspace

Calling

BroadWorks Enterprises

• List BroadWorks Enterprises
• Update Directory Sync for a BroadWorks Enterprise
• Trigger Directory Sync for an Enterprise
• Get Directory Sync Status for an Enterprise

BroadWorks Subscribers

• List BroadWorks Subscribers
• Provision a BroadWorks Subscriber
• Get a BroadWorks Subscriber
• Update a BroadWorks Subscriber
• Remove a BroadWorks Subscriber

Call Controls

• Dial
• Answer
• Reject
• Hangup
• Hold
• Resume
• Divert
• Transfer
• Park
• Retrieve
• Start Recording
• Stop Recording
• Pause Recording
• Resume Recording
• Transmit DTMF
• Push
• Pickup
• Barge In
• List Calls
• Get Call Details
• List Call History

Locations

• List Locations
• Get Location Details

People

• List People
• Create a Person
• Get Person Details
• Update a Person
• Delete a Person
• Get My Own Details

Recording Report

• List of Recording Audit Report Summaries
• Get Recording Audit Report Details

Webex Calling Organization Settings

• Read the List of Call Pickups
• Create a Call Pickup
• Delete a Call Pickup
• Get Details for a Call Pickup
• Update a Call Pickup
• Get available agents from Call Pickups
• Read the List of Call Queues
• Create a Call Queue
• Delete a Call Queue
• Get Details for a Call Queue
• Update a Call Queue
• Read the List of Call Queue Announcement Files
• Delete a Call Queue Announcement File
• Get Call Forwarding Settings for a Call Queue
• Update Call Forwarding Settings for a Call Queue
• Create a Selective Call Forwarding Rule for a Call Queue
• Get Call Forwarding Rule Settings for a Call Queue
• Update Call Forwarding Rule Settings for a Call Queue
• Delete a Selective Call Forwarding Rule for a Call Queue
• Read the List of Hunt Groups
• Create a Hunt Group
• Delete a Hunt Group
• Get Details for a Hunt Group
• Update a Hunt Group
• Get Call Forwarding Settings for a Hunt Group
• Update Call Forwarding Settings for a Hunt Group
• Create a Selective Call Forwarding Rule for a Hunt Group
• Get Call Forwarding Rule Settings for a Hunt Group
• Update Call Forwarding Rule Settings for a Hunt Group
• Delete a Selective Call Forwarding Rule for a Hunt Group
• Read the List of UC Manager Profiles

Webex Calling Person Settings

• Read Person's UC Profile
• Configure a Person's UC Profile
• Read Barge In Settings for a Person
• Configure Barge In Settings for a Person
• Read Forwarding Settings for a Person
• Configure Call Forwarding Settings for a Person
• Read Call Intercept Settings for a Person
• Configure Call Intercept Settings for a Person
• Configure Call Intercept Greeting for a Person
• Read Call Recording Settings for a Person
• Configure Call Recording Settings for a Person
• Read Caller ID Settings for a Person
• Configure Caller ID Settings for a Person
• Read Do Not Disturb Settings for a Person
• Configure Do Not Disturb Settings for a Person
• Read Voicemail Settings for a Person
• Configure Voicemail Settings for a Person
• Configure Busy Voicemail Greeting for a Person
• Configure No Answer Voicemail Greeting for a Person

Webex Calling Voice Messaging

• Get Message Summary
• List Messages
• Delete Messages
• Mark As Read
• Mark As Unread

Devices

Device Configurations

• List Device Configurations for device
• PATCH - Update Device Configurations

Devices

• List Devices
• Get Device Details
• Delete a Device
• PATCH - Modify Device Tags
• Create a Device Activation Code

Places

• List Places
• Create a Place
• Get Place Details
• Update a Place
• Delete a Place

Workspace Locations

• List Workspace Locations
• Create a Workspace Location
• Get a Workspace Location Details
• Update a Workspace Location
• Delete a Workspace Location
• List Workspace Location Floors
• Create a Workspace Location Floor
• Get a Workspace Location Floor Details
• Update a Workspace Location Floor
• Delete a Workspace Location Floor

Workspace Metrics

• Workspace Metrics
• Workspace Duration Metrics

Workspace Personalization

• Personalize a Workspace
• Get Personalization Task

Workspaces

• List Workspaces
• Create a Workspace
• Get Workspace Details
• Update a Workspace
• Delete a Workspace

xAPI

• Query Status
• Execute Command

Meetings

Meeting Invitees

• List Meeting Invitees
• Create a Meeting Invitee
• Create Meeting Invitees
• Get a Meeting Invitee
• Update a Meeting Invitee
• Delete a Meeting Invitee

Meeting Participants

• List Meeting Participants
• Get Meeting Participant Details
• Update a Participant
• Admit Participants

Meeting Preferences

• Get Meeting Preference Details
• Get Personal Meeting Room Options
• Update Personal Meeting Room Options
• Get Audio Options
• Update Audio Options
• Get Video Options
• Update Video Options
• Get Scheduling Options
• Update Scheduling Options
• Get Site List
• Update Default Site

Meeting Qualities

• Get Meeting Qualities

Meeting Transcripts

• List Meeting Transcripts
• Download a meeting transcript
• List Snippets of a Meeting Transcript
• Get a Transcript Snippet
• Update a Transcript Snippet

Meetings

• List Meetings of a Meeting Series
• Create a Meeting
• Get a Meeting
• List Meetings
• Update a Meeting
• Delete a Meeting
• Get Meeting Control Status
• Update Meeting Control Status
• List Meeting Session Types
• Get a Meeting Session Type
• Get registration form for a meeting
• Register a Meeting Registrant
• Get a meeting registrant's detail information
• List Meeting Registrant
• Batch Update Meeting Registrants status
• Delete a Meeting Registrant

People

• List People
• Create a Person
• Get Person Details
• Update a Person
• Delete a Person
• Get My Own Details

Recording Report

• List of Recording Audit Report Summaries
• Get Recording Audit Report Details

Recordings

• List Recordings
• Get Recording Details
• Delete a Recording

Webhooks

• List Webhooks
• Create a Webhook
• Get Webhook Details
• Update a Webhook
• Delete a Webhook

Messaging

Attachment Actions

• Create an Attachment Action
• Get Attachment Action Details

Events

• List Events
• Get Event Details

Memberships

• List Memberships
• Create Membership
• Get Membership Details
• Update a Membership
• Delete a Membership

Messages

• List Messages
• List Direct Messages
• Create a Message
• Edit a Message
• Get Message Details
• Delete a Message

Messages with Edit

• List Messages
• List Direct Messages
• Create a Message
• Edit a Message
• Get Message Details
• Delete a Message

People

• List People
• Create a Person
• Get Person Details
• Update a Person
• Delete a Person
• Get My Own Details

Room Tabs

• List Room Tabs
• Create a Room Tab
• Get Room Tab Details
• Update a Room Tab
• Delete a Room Tab

Rooms

• List Rooms
• Create a Room
• Get Room Details
• Get Room Meeting Details
• Update a Room
• Delete a Room

Team Memberships

• List Team Memberships
• Create a Team Membership
• Get Team Membership Details
• Update a Team Membership
• Delete a Team Membership

Teams

• List Teams
• Create a Team
• Get Team Details
• Update a Team
• Delete a Team

Webhooks

• List Webhooks
• Create a Webhook
• Get Webhook Details
• Update a Webhook
• Delete a Webhook

Testing

composer test

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Credits

• Offline Agency
• Giacomo Fabbian
• Nicolas Sanavia
• All Contributors

About us

Offline Agency is a web design agency based in Padua, Italy. You'll find an overview of our projects on our website.

License

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