Authentication
Parameters:
- string $license [required] License key
Return:
boolean
hangupCall
Description:
Method that allows you to hang up a call. The available options are: - extension [int] => Numintec's extension. - phone [int] => Phone number who's speaking with the extension. - call_id [integer] => Numintec's Identity of call. If you want to hang up by extension is required that you specify the phone and extension. If you want to hang up by call_id you only need to specify this. NOTE: If you don't have the call established, the call can not hang up.
Parameters:
- array $options [required] Options array
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
hangup
Description:
Method that allows you to hang up a call. The available options are: - extension [int] => Numintec's extension. - phone [int] => Phone number who's speaking with the extension. - call_id [integer] => Numintec's Identity of call. If you want to hang up by extension is required that you specify the phone and extension. If you want to hang up by call_id you only need to specify this. NOTE: If you don't have the call established, the call can not hang up.
Parameters:
- array $options [required] Options array
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
call
Description:
Method that allows to make a call through Numintec's extensions. The array of available options are: - service_id [integer] => Service id that applies to this call. - contact_id [integer] => Id from external application. - return_id [boolean] => Return the call id. - custom_data [string] => Parameters that you will receive in your integration. The format value is json string. - autoanswer [integer] => * This parameter indicates that the call will be autoanswered in your agent. NOTE: If your terminal has not been configured with the autoanswer option, the autoanswer will not work.
Parameters:
- string $from [required] Origin extension
- string $to [required] Phone number to call
- array $options [optional] Option array available
Return:
Array ['status' => boolean, 'data_call'] | ['status' => boolean, 'error_code' => integer, 'description' => string]
callbyapp
Description:
Method that allows to make a call through Numintec's applications. The array of available options are: - caller_id --> Number to show the final customer. - app_start --> Application id that starts the call. - app_end --> Application id that starts when the first app has answered. - phone --> Phone number destination ** required
Parameters:
- array $options List of options (see above).
Return:
string The UUID of the request.
getRecording
Description:
Method that return the recording of call.
Parameters:
- string $call_id [required]
- integer $type_recording [optional] The value possible are 1, if you want recording call, and 2, if you want voicemail.
Return:
Array ['status' => boolean, 'url' => string] | ['status' => boolean, 'error_code' => integer, 'description' => string]
getInformation
Description:
Method that return the call information.
Parameters:
- string $call_id [required]
Return:
Array ['status' => boolean, 'data_call' => array] | ['status' => boolean, 'error_code' => integer, 'description' => string]
setEndBusinessByCallId
Description:
Method that set a business end on the call.
Parameters:
- string $call_id [require]
- integer $end_business_id [require]
- array $options [optional]
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
startRecordByCallId
Description:
Method that allows to start recording a call.
Parameters:
- String $call_id
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
stopRecordByCallId
Description:
Method that allows to stop recording a call.
Parameters:
- String $call_id
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
setCustomData
Description:
Method that set a custom data of the call.
Parameters:
- string $call_id [require]
- string $custom_data [require]
- boolean $historical_custom_data [optional]
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
getCustomData
Description:
Method that get a custom data of the call.
Parameters:
- string $call_id [require]
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
setService
Description:
Method that sets the service id for a call.
Parameters:
- string $call_id [require]
- integer $service_id [require]
- integer $agent_id [require]
Return:
array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
listen
Description:
Method that allows to listen a call through Numintec's extensions.
Parameters:
- string $extension [required] The extension of the agent who will listen the call.
- string $call_id [required] The call identifier of the conversation to be listened.
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string]
getTags
Description:
Method that retrieves the tags assigned to a call.
Parameters:
- string $call_id [required] The call identifier of the conversation.
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string] El result of the operation.
setTags
Description:
Method that updates the tags assigned to a call, removes the old and assign the newest.
Parameters:
- string $call_id [required] The call identifier of the conversation.
- string $tags [optional] The json encoded list of id tags to be replaced.
Return:
Array ['status' => boolean] | ['status' => boolean, 'error_code' => integer, 'description' => string] El result of the operation.