Skip to main content
Server path: /freshcaller | Type: Application | PCID required: Yes

Tools

ToolDescription
freshcaller_create_teamCreate a team
freshcaller_create_userCreate a user
freshcaller_delete_recordingDelete a call recording
freshcaller_download_recordingDownload a call recording
freshcaller_get_callGet a call
freshcaller_get_call_metricsGet call metrics for a call
freshcaller_get_teamGet a team
freshcaller_get_userGet a user
freshcaller_list_call_metricsList call metrics
freshcaller_list_callsList all calls
freshcaller_list_teamsList all teams
freshcaller_list_user_statusesList user statuses
freshcaller_list_usersList all users
freshcaller_update_teamUpdate a team
freshcaller_update_userUpdate a user

freshcaller_create_team

Create a team Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringNoDescription of the team.
namestringYesName of the team.
usersobject[]NoArray of user objects to assign to the team.

freshcaller_create_user

Create a user Parameters:
ParameterTypeRequiredDefaultDescription
emailstringYesEmail address of the user.
rolestringYesRole to assign to the user.

freshcaller_delete_recording

Delete a call recording Parameters:
ParameterTypeRequiredDefaultDescription
call_idintegerYesThe ID of the call.
recording_idintegerYesThe ID of the recording to delete.

freshcaller_download_recording

Download a call recording Parameters:
ParameterTypeRequiredDefaultDescription
call_idintegerYesThe ID of the call.
recording_idintegerYesThe ID of the recording.

freshcaller_get_call

Get a call Parameters:
ParameterTypeRequiredDefaultDescription
call_idintegerYesThe ID of the call.

freshcaller_get_call_metrics

Get call metrics for a call Parameters:
ParameterTypeRequiredDefaultDescription
call_idintegerYesThe ID of the call.

freshcaller_get_team

Get a team Parameters:
ParameterTypeRequiredDefaultDescription
team_idintegerYesThe ID of the team.

freshcaller_get_user

Get a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerYesThe ID of the user.

freshcaller_list_call_metrics

List call metrics Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number.
per_pageintegerNoNumber of results per page.
by_time[from]stringNoStart of time range filter (UTC timestamp). Must be used with by_time[to].
by_time[to]stringNoEnd of time range filter (UTC timestamp). Must be used with by_time[from].
includestringNoInclude additional data. Use ‘life_cycle’ to include call life cycle events.

freshcaller_list_calls

List all calls Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number.
per_pageintegerNoNumber of results per page.

freshcaller_list_teams

List all teams Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number.
per_pageintegerNoNumber of results per page.

freshcaller_list_user_statuses

List user statuses Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number.
per_pageintegerNoNumber of results per page.

freshcaller_list_users

List all users Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number (default: 1).
per_pageintegerNoNumber of results per page (default: 10, max: 1000).

freshcaller_update_team

Update a team Parameters:
ParameterTypeRequiredDefaultDescription
team_idintegerYesThe ID of the team to update.
descriptionstringNoDescription of the team.
namestringNoName of the team.
usersobject[]NoArray of user objects to assign to the team.

freshcaller_update_user

Update a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerYesThe ID of the user to update.
deletedbooleanNoSet to true to soft-delete the user.
emailstringNoEmail address of the user.
mobile_app_preferenceintegerNoMobile app status preference ID.
preferenceintegerNoUser status preference ID (from user-statuses endpoint).
rolestringNoRole to assign.