Callgear

Method	`get.uploaded_calls`
Description	Getting Call Loading Information
Available to	Agent, Client
Necessary components for working with the method	Data API for configuration
Method weight	1 points

Request parameters

method

Name	Type	Required	Valid values	Description
`access_token`	string	yes		Authentication session key
`user_id`	number	no		Unique user identifier of the agent client on behalf of which the request is made Is required for the agent To obtain a list of client users, you must use the method "get.customer_users"
`limit`	number	no		Number of records to return. See "Paging Output"
`offset`	number	no		Shift, determines from which record number to return `"limit"` records. Default is "0". See "Paging Output"
`report_id`	number	yes		User report unique identifier. To get a list of user reports, you must use the "get.reports_list"
`date_from`	iso8601	yes	YYYY-MM-DD hh:mm:ss	Start date of the main selection by `upload_time`
`date_till`	iso8601	yes	YYYY-MM-DD hh:mm:ss	End date of the main selection by `upload_time`
`fields`	array	no		List of custom column identifiers, separated by comma. For the available list of columns, see "Getting Column Nesting" . The order affects the answer.
Filters used in the report
`filter`	object	no	It is permissible to use no more than `2 уровней` nesting. See examples below	Filters applied in the report. The construction logic is similar to "Filtering criteria"
`filters`	array	yes		An expression can contain both simple filters and a filter tree. For an available list of filters for a report with their possible values, see section "Getting a list of possible filtering conditions for a report" .
`field`	string			Field of the entity to which filtering will be applied (the list is predefined for the method)
`operator`	enum			Filtering operator. A list of all operators can be obtained in the section "Filtering operators"
`value`	string			Value for the filtering operator. Optional field; if it is missing, it is considered empty.
Sorting used in the report
`sort`	array	no		The sorting used in the report. The construction logic is similar to "Data sorting"

Response parameters

Name	Type	Valid values	Filtering	Sorting	Default response	Description
`ext_id`	string		yes	yes	yes	A unique call identifier in your system.
`ext_request_id`	string		yes	yes	yes	The unique identifier of the API request in which the calls were loaded.
`upload_time`	iso8601	YYYY-MM-DD hh:mm:ss	no	no	no	Date and time of downloading calls
`direction`	enum	in - incoming call out - outgoing call	yes	yes	yes	Call direction
`calling_phone_number`	string	E164	yes	yes	yes	Caller number
`called_phone_number`	string	E164	yes	yes	yes	The number you called
`start_time`	iso8601	YYYY-MM-DD hh:mm:ss	yes	yes	yes	Date and time when the call session started
`finish_time`	iso8601	YYYY-MM-DD hh:mm:ss	yes	yes	yes	Call session end time
`is_lost`	boolean		yes	yes	yes	Sign that the call is lost or successful
`is_transfer`	boolean		yes	yes	yes	Indicator of whether there was a transfer during the call session.
`wait_duration`	number		yes	yes	yes	The length of time a subscriber waits before the first conversation with an employee. Value in seconds.
`talk_duration`	number		yes	yes	yes	The length of time a subscriber waits before the first conversation with an employee. Value in seconds.
`visitor_session_id`	number		yes	yes	yes	Unique visitor session identifier.
`campaign_id`	number		yes	yes	yes	Unique identifier of the advertising campaign.
`source_id`	number		yes	yes	yes	Unique identifier of the source.
`site_id`	number		yes	yes	yes	Unique site identifier.
`comment`	string		yes	yes	yes	Comment for the call.
`record_type`	enum	`wav` `mp3`	yes	yes	yes	Conversation file type
`status`	enum	`new` - New call `in_process` - Call during loading `cancelled` - Call loading cancelled `processed` - The call is fully processed and the conversation is loaded `error` - An error occurred while loading the call	yes	yes	yes	Call loading status.
`error_code`	enum	`internal_error` - Internal error `download_error` - Unknown error during file upload `connection_download_error` - Error connecting to the server. Network problem. `http_status_download_error` - The server from which we are downloading the file did not respond with 200. `http_content_type_download_error` - Content-Type does not meet the specification. `max_file_size_download_error` - The maximum file size has been exceeded. Currently - 50 MB. `timeout_download_error` - It took a very long time to download the file or it took a very long time to connect to the server. The maximum time is 30 seconds. `decode_error` - Could not open the conversation file, the first bytes are missing in the mp3 - ID3 and wav - RIFF files, or an error occurred during the decoding process. `processing_error` - An unknown error occurred while processing the conversation file. `wav_min_duration_processing_error` - The downloaded wav file is shorter than 16 seconds. `wav_channels_processing_error` - The downloaded wav file does not contain 2 channels.	yes	yes	yes	Error loading call.
`call_session_id`	number		yes	yes	yes	Unique call identifier, only for calls in the `processed` status.
Notification about call processing
`callback`	object		no	no	no	Notification about call processing.
`url`	string		no	no	no	http/https address to which notification of successful call processing will be sent.
`events`	array	`processed` - transferred call processed successfully `in_process` - call in progress `error` - call processing error	no	no	no	What notifications to receive about call processing
Call tags
`tags`	array		no	no	no	Call tags
`tag_id`	number		no	no	no	Unique identifier of the tag in the system
`tag_name`	string		no	no	no	Tag name
Record a conversation
`records`	array		no	no	no	Conversation data for listening in your personal account
`employee_name`	string		no	no	no	Employee name (full name)
`employee_id`	number		no	no	no	Unique identifier of the employee in the system
`employee_channel`	enum	left - left channel right - right channel	no	no	no	Indicates which channel the employee is in
`record_url`	string		no	no	no	Address where you can download the conversation file

JSON request structure```json

{ "jsonrpc":"2.0", "id":"number", "method":"get.uploaded_calls", "params":{ "access_token":"string", "user_id":"number", "offset":"number", "limit":"number", "date_from":"iso8601", "date_till":"iso8601", "filter":{

},
"sort":[
  {
    "field":"string",
    "order":"string"
  }
],
"fields":[
  "string"
]

} }

### JSON response structure```json
{
    "jsonrpc": "2.0",
    "id": "rMiS6Y5qt1OYo2m9S3S3z",
    "result": {
        "data": [
            {
                "tags": [
                    {
                        "tag_name": "Maxim"
                    }
                ],
                "ext_id": "yud2022081125",
                "status": "processed",
                "comment": "yud2022081125",
                "is_lost": false,
                "records": null,
                "site_id": 25187,
                "callback": {
                    "url": "https://webhook.site/dab0fb9d-25e7-48e0-bd2d-a60c9f9f61d9",
                    "events": [
                        "processed",
                        "in_process",
                        "error"
                    ]
                },
                "direction": "in",
                "error_code": null,
                "start_time": "2022-08-11 08:48:43",
                "campaign_id": null,
                "source_id": null,
                "finish_time": "2022-08-11 08:48:44",
                "is_transfer": false,
                "record_type": null,
                "upload_time": "2022-08-11 13:18:19",
                "talk_duration": 13,
                "wait_duration": 12,
                "ext_request_id": "ТЕст",
                "call_session_id": 2427195081,
                "visitor_session_id": 9161005360,
                "called_phone_number": "74950324069",
                "calling_phone_number": "79539693061"
            }
        ]
    }
}

List of returned errors

See the section "List of errors for methods with the verb get"

Request parameters

Response parameters

JSON request structure```json

List of returned errors

CallGear online demo

Thank you, we've got your request!

Choose the number of employees who will use telephony

Choose the industry in which your company operates

Choose your CRM

Thanks!

Choose your region for a better connection

Account recovery