Authentication
Parameters:
- String $license [required] License key
Return:
boolean
skipAdministrativeTime
Description:
Method that skips the administrative time for an agent.
Parameters:
- int $agent_id [required]
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
setScheduleByListDetailID
Description:
Method that schedules a call in the autodialer.
Parameters:
- int $list_detail_id [required] The identified of the entry to be scheduled.
- datetime $schedule_date [required] Schedule date (Format: dd-mm-YYYY HH:mm:ss OR YYYY-mm-dd HH:mm:ss).
- string $time_zone [optional] Schedule date timezone (Default GMT).
- string $phone [optional] The phone number to be called.
- bool $schedule_same_agent [optional] Set to the same agent who attended the entry or not (Default True).
- int $agent_id [optional] The agent identifier if another than the agent who attended the entry.
- bool $force [optional] Force the scheduled if a business outcome has been unsetted (Default False).
- int $service_id [optional] The service identifier if set to other service than the original call.
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
setScheduleByCallId
Description:
Method that schedules a call to be called by the autodialer.
Parameters:
- string $call_id [required] The identified of the call to be scheduled.
- datetime $schedule_date [required] Schedule date (Format: dd-mm-YYYY HH:mm:ss OR YYYY-mm-dd HH:mm:ss).
- string $time_zone [optional] Schedule date timezone (Default GMT).
- string $phone [optional] The phone number to be called.
- bool $schedule_same_agent [optional] Set to the same agent who attended the entry or not (Default True).
- int $agent_id [optional] The agent identifier if another than the agent who attended the entry.
- int $service_id [optional] The service identifier if set to other service than the original call.
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
addListDetail
Description:
Method that allows to add a new recording in your autodialer. The params required are:
- service_id [int] => Service id where you want to put this recording.
- list_phone [array] => List of phones where the autodialer calls it. The format have to be a
list the phones with this informations:
array[][phone] [int] => numeric
array[][priority] [int] => priority of the number in the list,
if you don't want to indicates,
you can put 0 or not indicate.
The params optional are:
- time_zone [string] => indicates the timezone of the dates that you indicate on
the options (from_date, to_date, schedule_date).
- options [array] => The available options are:
- "contact_id" => int
- "from_date" => date_time
- "to_date" => date_time
- "schedule_date" => date_time
- "agent_id" => int
- "priority" => int
- "form_id" => int
Parameters:
- int $service_id [require]
- array $list_phone [require]
- string $time_zone [optional] (Default GMT)
- array $options [optional]
Return:
Array ['status' => boolean, 'id' => int] | ['status' => boolean, 'error_code' => integer, 'description' => string]
addRecordList
Description:
Method that allows to add a list of new recordings in your autodialer. The params required
are a json with this information:
- service_id [int] => Service id where you want to put this recording.
- list_phone [array] => List of phones where the autodialer calls it. The format have
to be a list the phones with this informations:
array[][phone] [int] => numeric
array[][priority] [int] => priority of the number in the list,
if you don't want to indicates,
you can put 0 or not indicate.
The params optional are:
- time_zone [string] => indicates the timezone of the dates that you indicate on the
options (from_date, to_date, schedule_date).
- options [array] => The available options are:
- "contact_id" => int
- "from_date" => date_time
- "to_date" => date_time
- "schedule_date" => date_time
- "agent_id" => int
- "priority" => int
- "form_id" => int
Example:
[
{"service_id":1111,"list_phone":[{"phone":"666", "priority":1}, {"phone":"555"}]},
{"service_id":1111,"list_phone":[{"phone":"666"}],"options":{"contact_id":123}}
]
NOTE: The max number of records are 500.
Parameters:
- string $json_data [require] The url encoded jason string.
Return:
Array ['status' => boolean, 'data' => array result]
deletePhoneByListDetailId
Description:
Method that allows to delete a phone from specific register in your autodialer.
Parameters:
- int $list_detail_id [required]
- int $phone [required]
Return:
Array ['status' => boolean, 'data' => array result]
deleteByListDetailId
Description:
Method that allows to delete a register of your autodialer.
Parameters:
- int $list_detail_id [required]
Return:
Array ['status' => boolean]
getLastCallByListDetailId
Description:
Method that returns the last call by a list detail id
Parameters:
- int $list_detail_id [required]
Return:
Array ['status' => boolean, call data]
unlockContact
Description:
Method that gets an autodialer contact for an agent overriding some lock conditions.
Parameters:
- integer $agent_id [required]
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
lockService
Description:
Method that locks all autodialer contacts from a service.
Parameters:
- integer $service_id [required]
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
unlockService
Description:
Method that unlocks all autodialer contacts from a previously locked service.
Parameters:
- integer $service_id [required]
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
setServiceSchedule
Description:
Method that sets the schedule of a autodialer service.
Parameters:
- integer $service_id [required]
- string $calendar_json [optional] The string JSON of the calendar. By default is none.
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
setNonlinearSchedule
Description:
Method that sets the nonlinear schedule of the lost calls of a autodialer service.
Parameters:
- string $schedule The string JSON of the nonlinear schedule.
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]