README
Documentation
Daktela API
Installation
composer require mfajfr/daktela-api
Using
Connection
define('API_KEY', 'xxxxx'); // API section in Daktela
\Daktela\Connection::setSubDomain('example'); // Name of subdomain example.daktela.com
\Daktela\Connection::setAccessToken(API_KEY);
Fetch
Loading group of records.
$rows = \Daktela\Models\ActivityCall\ActivityCall::fetch([
// paginating, sorting, filtering ...
]);
Read
Loading specific record
$call = \Daktela\Models\ActivityCall\ActivityCall::read('nameOfActivityCall');
Relations (HasMany)
Loading records related to one record
$activity = \Daktela\Models\ActivityCall\Activity::read('nameOfActivity');
$activity->statuses($force = true|false) // If $false == true then reload data
Legend
✅ ... Implemented
❌ ... Not implemented
🚫 ... Not available
Models
Basic methods
Namespace |
Model |
Fetch |
Create |
Read |
Update |
Delete |
Account |
Account |
✅ |
❌ |
❌ |
❌ |
❌ |
" |
AccountSnapshot |
✅ |
🚫 |
❌ |
🚫 |
🚫 |
Activity |
Activity |
✅ |
❌ |
✅ |
❌ |
🚫 |
ActivityCall |
ActivityCall |
✅ |
❌ |
✅ |
🚫 |
🚫 |
" |
ActivityCallChannel |
✅ |
🚫 |
✅ |
🚫 |
🚫 |
" |
ActivityCallRecording |
❌ |
❌ |
❌ |
❌ |
❌ |
ActivityChat |
ActivityChat |
✅ |
❌ |
❌ |
❌ |
🚫 |
" |
ActivityChatMessage |
✅ |
❌ |
❌ |
🚫 |
🚫 |
ActivityEmail |
ActivityEmail |
✅ |
🚫 |
✅ |
❌ |
🚫 |
" |
ActivityEmailFile |
❌ |
❌ |
❌ |
❌ |
❌ |
ActivityFbm |
ActivityFbm |
❌ |
❌ |
❌ |
❌ |
❌ |
ActivitySms |
ActivitySms |
✅ |
🚫 |
❌ |
❌ |
🚫 |
Blacklist |
BlacklistDatabase |
✅ |
❌ |
✅ |
❌ |
❌ |
" |
BlacklistNumber |
❌ |
❌ |
❌ |
❌ |
❌ |
CampaignRecord |
CampaignRecord |
✅ |
❌ |
❌ |
❌ |
❌ |
" |
CustomField |
❌ |
❌ |
❌ |
🚫 |
❌ |
" |
CustomFieldScheme |
❌ |
❌ |
❌ |
❌ |
❌ |
" |
Snapshot |
✅ |
❌ |
❌ |
❌ |
❌ |
Contact |
Contact |
✅ |
❌ |
❌ |
❌ |
❌ |
" |
ContactSnapshot |
✅ |
🚫 |
❌ |
🚫 |
🚫 |
CrmRecod |
CrmRecord |
✅ |
❌ |
❌ |
❌ |
❌ |
Database |
Database |
✅ |
❌ |
✅ |
❌ |
❌ |
Event |
Event |
✅ |
❌ |
❌ |
❌ |
❌ |
Group |
Group |
✅ |
❌ |
✅ |
❌ |
❌ |
Music |
Music |
❌ |
❌ |
❌ |
❌ |
❌ |
Pause |
Pause |
✅ |
❌ |
✅ |
❌ |
❌ |
Profile |
Profile |
✅ |
❌ |
✅ |
❌ |
❌ |
QAForm |
QAForm |
✅ |
❌ |
❌ |
❌ |
❌ |
Queue |
Queue |
✅ |
❌ |
✅ |
❌ |
❌ |
" |
QueueProfile |
❌ |
❌ |
❌ |
❌ |
❌ |
Recording |
Recording |
✅ |
❌ |
✅ |
❌ |
❌ |
Role |
Role |
✅ |
❌ |
✅ |
❌ |
❌ |
Status |
Status |
✅ |
❌ |
✅ |
❌ |
❌ |
Template |
Template |
✅ |
❌ |
✅ |
❌ |
❌ |
" |
File |
❌ |
❌ |
❌ |
❌ |
❌ |
Ticket |
Ticket |
✅ |
❌ |
❌ |
❌ |
❌ |
TicketCategory |
TicketCategory |
✅ |
❌ |
✅ |
❌ |
❌ |
TicketSla |
TicketSla |
✅ |
❌ |
✅ |
❌ |
❌ |
Timegroup |
Timegroup |
❌ |
❌ |
❌ |
❌ |
❌ |
Transcript |
Transcript |
✅ |
🚫 |
❌ |
❌ |
🚫 |
User |
User |
✅ |
❌ |
✅ |
❌ |
❌ |
" |
UserOptionsFields |
❌ |
❌ |
❌ |
❌ |
❌ |
Wallboard |
Wallboard |
✅ |
❌ |
❌ |
❌ |
❌ |
Account/Account
HasMany |
|
HasOne |
|
Activity |
❌ |
TicketSla |
❌ |
Ticket |
✅ |
User |
❌ |
Record |
✅ |
CustomField |
❌ |
Contact |
✅ |
|
|
Snapshot |
✅ |
|
|
Attachment |
❌ |
|
|
Synchronization |
❌ |
|
|
Account/AccountSnapshot
HasMany |
|
HasOne |
|
|
|
Account (account) |
❌ |
|
|
User (user) |
❌ |
|
|
TicketSla (sla) |
❌ |
|
|
CustomField (customFields) |
❌ |
|
|
User (created_by) |
❌ |
Activity/Activity
HasMany |
|
HasOne |
|
Status |
✅ |
Ticket (ticket) |
❌ |
RT User |
❌ |
Queue (queue) |
✅ |
Attachment |
❌ |
User (user) |
✅ |
Channel |
❌ |
Contact (contact) |
✅ |
Recording |
❌ |
NpsSurvey (survey) |
❌ |
Statuses |
✅ |
CampaignRecord (record) |
❌ |
|
|
User (created_by) |
❌ |
ActivityCall/ActivityCall
HasMany |
|
HasOne |
|
Activity |
✅ |
Queue (id_queue) |
✅ |
Transcript |
✅ |
User (id_agent |
✅ |
ActivityCallChannel |
✅ |
Contact (contact) |
✅ |
ActivityCall/ActivityCallChannel
HasMany |
|
HasOne |
|
|
|
ActivityCall (call) |
✅ |
|
|
User (user) |
❌ |
|
|
Extension (endpoint) |
❌ |
|
|
Activity (activity) |
✅ |
ActivityCall/ActivityCallRecording
ActivityChat/ActivityChat
HasMany |
|
HasOne |
|
Message |
✅ |
Queue (queue) |
✅ |
Flow |
❌ |
User (user) |
✅ |
Activity (activities) |
✅ |
Contact (contact) |
✅ |
ActivityChat/ActivityChatMessage
ActivityEmail/ActivityEmail
HasMany |
|
HasOne |
|
Attachment |
✅ |
Queue (queue) |
✅ |
Activity |
✅ |
User (user) |
✅ |
|
|
Contact (contact) |
✅ |
ActivityEmail/ActivityEmailFile
HasMany |
|
HasOne |
|
|
|
ActivityEmail (email) |
❌ |
ActivityFbm/ActivityFbm
HasMany |
|
HasOne |
|
Message |
❌ |
Queue (queue) |
❌ |
Activity |
❌ |
User (user) |
❌ |
Flow |
❌ |
Contact (contact) |
❌ |
|
|
FlowContact (fbm_contact) |
❌ |
ActivitySms/ActivitySms
HasMany |
|
HasOne |
|
Message |
❌ |
Queue (queue) |
✅ |
Activity |
✅ |
User (user) |
✅ |
Flow |
❌ |
Contact (contact) |
✅ |
Blacklist/BlacklistDatabase
HasMany |
|
HasOne |
|
Queue |
✅ |
|
|
Number |
✅ |
|
|
Blacklist/BlacklistNumber
HasMany |
|
HasOne |
|
|
|
BlacklistDatabase |
❌ |
|
|
User |
✅ |
CampaignRecord/CampaignRecord
HasMany |
|
HasOne |
|
Status |
✅ |
User (user) |
✅ |
Snapshot |
✅ |
Queue (queue) |
✅ |
Activity |
✅ |
Database (database) |
✅ |
CustomField (customFields) |
❌ |
Database (database) |
✅ |
|
|
|
|
CampaignRecord/CustomField
CampaignRecord/CustomFieldScheme
CampaignRecord/Snapshot
HasMany |
|
HasOne |
|
Status |
✅ |
CampaignRecord (record) |
✅ |
CustomField (customFields) |
❌ |
User (user) |
✅ |
|
|
Queue (queue) |
✅ |
|
|
User (created_by) |
✅ |
Contact/Contact
HasMany |
|
HasOne |
|
Activity |
❌ |
|
|
Ticket |
✅ |
|
|
Record |
✅ |
|
|
Snapshot |
✅ |
|
|
Attachment |
❌ |
|
|
Facebook contact |
❌ |
|
|
Synchronization |
❌ |
|
|
Contact/ContactSnapshot
HasMany |
|
HasOne |
|
|
|
Contact |
❌ |
|
|
Account |
❌ |
|
|
User (user) |
❌ |
|
|
CustomField |
❌ |
|
|
User (created_by) |
❌ |
CrmRecord/CrmRecord
HasMany |
|
HasOne |
|
Snapshot |
❌ |
Type |
❌ |
Attachment |
❌ |
Contact |
❌ |
|
|
User |
❌ |
|
|
Account |
❌ |
|
|
Ticket |
❌ |
|
|
Status |
❌ |
|
|
CustomField |
❌ |
Database/Database
HasMany |
|
HasOne |
|
|
|
Queue (queue) |
✅ |
Event/Event
HasMany |
|
HasOne |
|
Profile |
✅ |
Event (event) |
❌ |
Handler |
❌ |
|
|
Group/Group
HasMany |
|
HasOne |
|
Profile |
✅ |
|
|
Member |
✅ |
|
|
Pause/Pause
Profile/Profile
HasMany |
|
HasOne |
|
Queue |
✅ |
|
|
User (assigned) |
✅ |
|
|
User |
✅ |
|
|
TicketCategory |
✅ |
|
|
Profile |
✅ |
|
|
Role |
✅ |
|
|
QAForm/QAForm
HasMany |
|
HasOne |
|
Queue |
❌ |
|
|
Question |
❌ |
|
|
Queue/Queue
HasMany |
|
HasOne |
|
Profile |
✅ |
Recording (recording_user(options)) |
✅ |
Status |
✅ |
Recording (target_before(options)) |
✅ |
Template |
✅ |
Recording (target_join(options)) |
✅ |
QAForm |
❌ |
Timegroup (timecondition(options)) |
❌ |
BlacklistDatabase |
✅ |
Music (music(options)) |
✅ |
CustomField |
❌ |
Ivr (ivr_jump(options)) |
❌ |
CampaignRecord |
❌ |
Status (missed_record_status(options)) |
✅ |
Database |
❌ |
TicketCategory (crm_ticket_category(options)) |
✅ |
Group |
✅ |
Template (signtemplate(options)) |
❌ |
Greeting |
❌ |
Template (npstemplate(options)) |
❌ |
RT User |
❌ |
Template (respond(options)) |
❌ |
|
|
Template (respond_outside_timecondition(options)) |
❌ |
|
|
Status (status_answer(options)) |
✅ |
|
|
Status (status_busy(options)) |
✅ |
|
|
Status (status_hangup_dialer(options)) |
✅ |
|
|
Status (status_hangup_customer(options)) |
✅ |
|
|
Template (closed_hours_template(options)) |
❌ |
Queue/QueueProfile
Role/Role
HasMany |
|
HasOne |
|
User |
✅ |
|
|
Profile |
✅ |
|
|
Status/Status
HasMany |
|
HasOne |
|
TicketCategory |
✅ |
BlacklistDatabase |
✅ |
Queue |
✅ |
|
|
Type |
❌ |
|
|
Template/Template
HasMany |
|
HasOne |
|
Profile |
✅ |
Template (id_template) |
❌ |
Queue |
✅ |
|
|
Attachment |
✅ |
|
|
Template/File
HasMany |
|
HasOne |
|
Template |
❌ |
|
|
Ticket/Ticket
HasMany |
|
HasOne |
|
Bookmarked |
❌ |
Ticket (id_merger) |
❌ |
Status |
✅ |
TicketCategory (category) |
✅ |
MergeTicket |
❌ |
User (user) |
❌ |
Activity |
❌ |
Contact |
❌ |
Record |
✅ |
Ticket (parentTicket) |
❌ |
Snapshot |
❌ |
User (created_by) |
❌ |
Status |
❌ |
User (created_by) |
❌ |
CustomField |
❌ |
|
|
TicketCategory/TicketCategory
HasMany |
|
HasOne |
|
Profile |
✅ |
TicketSla |
✅ |
Status |
✅ |
Timegroup |
❌ |
Ticket |
✅ |
Queue (email) |
❌ |
Notify |
❌ |
Queue (call) |
❌ |
Group |
✅ |
Queue (sms) |
✅ |
User |
✅ |
|
: |
Timegroup/Timegroup
HasMany |
|
HasOne |
|
|
|
TimegroupCron |
❌ |
|
|
TimegroupGroup |
❌ |
Transcript/Transcript
HasMany |
|
HasOne |
|
|
|
ActivityCall (call) |
❌ |
|
|
RoutingCallActivityCallSteering (call_steering) |
❌ |
User/User
HasMany |
|
HasOne |
|
Activity |
❌ |
Role |
✅ |
Ticket |
✅ |
Profile |
✅ |
Record |
✅ |
IntegrationConfig |
❌ |
Contact |
✅ |
Announcement (target_announcement(options)) |
❌ |
Account |
✅ |
User (target_user(options)) |
❌ |
Queue |
✅ |
CallSteering (target_callsteering(options)) |
❌ |
User |
✅ |
TimeCondition (target_condition(options)) |
❌ |
TicketCategory |
✅ |
Customcontext (target_context(options)) |
❌ |
Profile |
✅ |
Language (target_language(options)) |
❌ |
Role |
✅ |
Ivr (target_ivr_menu(options)) |
❌ |
Wallboard |
✅ |
RingGroup (target_ringgroup(options)) |
❌ |
Template |
✅ |
Queue (target_queue(options)) |
❌ |
Event |
✅ |
|
|
Group |
✅ |
|
|
Pause |
❌ |
|
|
RT Queue |
❌ |
|
|
RT Activity |
❌ |
|
|
Device |
❌ |
|
|
Notify |
❌ |
|
|
Macro |
❌ |
|
|
Group member |
❌ |
|
|
Announcement |
❌ |
|
|
Saved filter |
❌ |
|
|
User/UserOptionsFields
Wallboard/Wallboard