Obtaining information on offline applications
| Method | get.offline_messages_report |
|---|---|
| Description | Obtaining information on offline applications |
| Available to | Partner, Client |
Request parameters
| Title | 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 agentTo obtain a list of client users, you must use the method "get.customer_users" |
|
limit |
number | no | Number of records returned. See section "Paging" | |
offset |
number | no | Shift determines from which record number to return "limit" records. Default is "0". See section "Paging" |
|
filter |
object | no | See section "Filtering Criteria" | |
sort |
array | no | See section "Sorting data" | |
date_from |
iso8601 | yes | YYYY-MM-DD hh:mm:ss | Sample start date |
date_till |
iso8601 | yes | YYYY-MM-DD hh:mm:ss | Sampling end date |
include_tech_offline_messages |
boolean | no | Include technical requests that are not customer communications |
Response parameters
| Name | Type | Valid values | Filtering | Sorting | Default response | Description |
|---|---|---|---|---|---|---|
id |
number | yes | yes | Unique identifier offline applications | ||
date_time |
iso8601 | YYYY-MM-DD hh:mm:ss | Date and time of receipt of the application | |||
text |
string | yes | Application text | |||
communication_number |
number | yes | yes | Call number. Calculated within persons. | ||
communication_page_url |
string | no | no | no | The URL of the page the visitor was on at the time of the call or the page of the visitor’s last interaction before the call. | |
communication_type |
enum | offline_message |
Treatment type | |||
communication_id |
number | yes | yes | Unique identifier appeals | ||
is_agree_to_process_personal_data |
boolean | yes | Denotes the client’s consent to the processing of his personal data | |||
is_agree_to_mailing |
boolean | yes | Denotes the client’s consent to advertising and information mailings | |||
ua_client_id |
string | Unique identifier in Universal Analytics | ||||
ym_client_id |
string | Unique Yandex.Metrica user identifier | ||||
sale_date |
iso8601 | YYY-MM-DD hh:mm:ss | yes | yes | Trade date | |
sale_cost |
number | yes | yes | Transaction amount | ||
status |
enum |
|
yes | yes | yes | Application status |
process_time |
iso8601 | YYYY-MM-DD hh:mm:ss | Date and time when the application was submitted
transferred to the status "Processed"
(see parameter "status") |
|||
form_type |
enum | Custom,
Standard, DataAPI |
yes | yes | yes | Type of form with which it was offline application sent |
form_name |
string | yes | yes | Name of the application form, if the form_name parameter is filled in when submitting the application to our service: https://www.callgear.com/support/api/javascript-api/ | ||
search_query |
string | yes | Search query | |||
search_engine |
string | yes | Search engine name | |||
referrer_domain |
string | yes | Referrer domain | |||
referrer |
string | yes | Transition source | |||
entrance_page |
string | yes | Login page | |||
gclid |
string | yes | Google Click Identifier | |||
yclid |
string | yes | Yandex Click Identifier | |||
ymclid |
string | yes | Yandex Market Click Identifier | |||
ef_id |
string | yes | Used for markup links in the control system contextual advertising AdLense | |||
channel |
enum |
|
yes | Channel. | ||
properties |
string | yes | Callback forms may have a field with a comment (text). If the user leaves a comment (text) when generating a call back, it will be displayed in this field. | |||
| Group selected by the visitor | ||||||
group_id |
number | yes | yes | Unique identifier group selected by the visitor | ||
group_name |
string | yes | yes | Name of the selected group visitor | ||
| Employee | ||||||
employee_id |
number | yes | yes | yes | Unique identifier employee who processed application | |
employee_full_name |
string | yes | yes | Last name First name of the Employee, who processed the application | ||
employee_answer_message |
string | Answer from the employee who was sent to email address visitor email | ||||
employee_comment |
string | Employee's comment when
transferring the application to status
"Processed" (see field "status") |
||||
| Added tags | ||||||
tags |
array | yes | Tags, see method "get.tags" |
|||
tag_id |
number | Unique tag identifier | ||||
tag_name |
string | Tag name | ||||
tag_change_time |
iso8601 | YYYY-MM-DD hh:mm:ss | Tag insertion time | |||
tag_type |
enum | auto, manual |
Tag type | |||
tag_user_id |
number | Unique identifier the user who entered tag | ||||
tag_user_login |
string | Login of the user who added tag | ||||
tag_employee_id |
number | Unique identifier employee who entered tag | ||||
tag_employee_full_name |
string | F.I.O. employee who added tag | ||||
| Website | ||||||
site_id |
number | yes | yes | yes | Unique site identifier | |
site_domain_name |
string | yes |
Internet site address. Without
protocol instructions - "http://" or
"https://"
|
|||
| Advertising campaign | ||||||
campaign_id |
number | yes | yes | yes | Unique identifier advertising campaign | |
campaign_name |
string | yes | Advertising campaign name | |||
visit_other_campaign |
boolean | The flag shows whether you have visited visitor (within person) for other advertising campaigns | ||||
| Visitor information | ||||||
visitor_phone_number |
number | yes | yes | Visitor phone number left in the application | ||
visitor_email |
string | yes | yes | Email address left by the visitor | ||
visitor_name |
string | yes | yes | Name left by the visitor when submitting an application | ||
visitor_id |
number | yes | yes | yes | Unique visitor identifier | |
person_id |
number | yes | yes | Unique identifier persons | ||
visitor_type |
enum | New, Returned, Not filled | yes | yes | Visitor type | |
visitor_session_id |
number | yes | yes | Unique identifier
visitor sessions, see "get.visitor_sessions_report" |
||
visits_count |
number | yes | Total number of visits visitor | |||
visitor_first_campaign_id |
number | yes | Unique identifier first advertising campaign. | |||
visitor_first_campaign_name |
string | yes | Name of the first advertisement campaigns | |||
visitor_city |
string | yes | Visitor city | |||
visitor_country |
string | yes | Visitor country | |||
visitor_region |
string | yes | Visitor region | |||
visitor_device |
enum |
desktop
mobile
tablet
other
|
yes | yes | Visitor device | |
| Visitor properties | ||||||
visitor_custom_properties |
array | yes |
Visitor properties that
can be asked via personal
office or using JavaScript
API [method
Comagic.setProperty(name, value);]
|
|||
property_name |
string | The name of the property that should be assigned to the visitor | ||||
property_value |
string | Property value | ||||
| Segments | ||||||
segments |
array | yes | Segments | |||
segment_id |
number | Unique identifier segment | ||||
segment_name |
string | Segment name | ||||
| UTM tags | ||||||
utm_source |
string | yes | Campaign source | |||
utm_medium |
string | yes | Campaign Channel | |||
utm_term |
string | yes | Campaign keyword | |||
utm_content |
string | yes | Campaign content | |||
utm_campaign |
string | yes | Campaign name | |||
| OS tags | ||||||
openstat_ad |
string | yes | Advertising ID announcements | |||
openstat_campaign |
string | yes | Advertising ID campaigns | |||
openstat_service |
string | yes | Service ID, service provider | |||
openstat_source |
string | yes | Site ID, section, page, place on the page on which it was shown corresponding advertisement | |||
| Hit attributes | ||||||
attributes |
array |
|
yes | Case attributes | ||
| Extended UTM tags | ||||||
eq_utm_source |
string | yes | Extended utm_source | |||
eq_utm_medium |
string | yes | Extended utm_medium | |||
eq_utm_term |
string | yes | Extended utm_term | |||
eq_utm_content |
string | yes | Extended utm_content | |||
eq_utm_campaign |
string | yes | Extended utm_campaign | |||
eq_utm_referrer |
string | yes | Extended utm_referrer | |||
eq_utm_expid |
string | yes | Extended utm_expid | |||
| Source information | ||||||
source_id |
number | yes | yes | Source ID | ||
source_name |
string | yes | yes | Source. Source name | ||
source_new |
string | yes | yes | Source group | ||
channel_new |
string | yes | yes | Channel(new). Source channel name | ||
channel_code |
string | yes | yes | Channel mnemonic | Parameters from external systems | |
ext_id |
string | yes | yes | Unique identifier of the request in your system. | ||
JSON request structure```json
{ "jsonrpc":"2.0", "id":"number", "method":"get.offline_messages_report", "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":"number",
"result":{
"metadata":{
},
"data":[
{
"id":"number",
"date_time":"iso8601",
"text":"string",
"communication_number":"number",
"communication_page_url": "string",
"communication_type":"enum",
"communication_id":"number",
"is_agree_to_process_personal_data":"boolean",
"is_agree_to_mailing":"boolean",
"ua_client_id":"string",
"ym_client_id": "string",
"sale_date":"iso8601",
"sale_cost":"number",
"status":"enum",
"process_time":"iso8601",
"form_type":"enum",
"form_name":"string",
"search_query":"string",
"search_engine":"string",
"referrer_domain":"string",
"referrer":"string",
"entrance_page":"string",
"gclid":"string",
"yclid":"string",
"ymclid":"string",
"ef_id":"string",
"channel":"enum",
"employee_id":"number",
"employee_full_name":"string",
"employee_answer_message":"string",
"employee_comment":"string",
"tags":[
{
"tag_id":"number",
"tag_name":"string",
"tag_type":"enum",
"tag_change_time":"iso8601",
"tag_user_id":"number",
"tag_user_login":"string",
"tag_employee_id":"number",
"tag_employee_full_name":"string"
}
],
"site_id":"number",
"site_domain_name":"string",
"group_id":"number",
"group_name":"string",
"campaign_id":"number",
"campaign_name":"string",
"visit_other_campaign":"boolean",
"visitor_id":"number",
"visitor_name":"string",
"visitor_phone_number":"number",
"visitor_email":"string",
"person_id":"number",
"visitor_type":"enum",
"visitor_session_id":"number",
"visits_count":"number",
"visitor_first_campaign_id":"number",
"visitor_first_campaign_name":"string",
"visitor_city":"string",
"visitor_region":"string",
"visitor_country":"string",
"visitor_device":"enum",
"visitor_custom_properties":[
{
"property_name":"string",
"property_value":"string"
}
],
"segments":[
{
"segment_id":"number",
"segment_name":"string"
}
],
"utm_source":"string",
"utm_medium":"string",
"utm_term":"string",
"utm_content":"string",
"utm_campaign":"string",
"openstat_ad":"string",
"openstat_campaign":"string",
"openstat_service":"string",
"openstat_source":"string",
"eq_utm_source": "string",
"eq_utm_medium": "string",
"eq_utm_term": "string",
"eq_utm_content": "string",
"eq_utm_campaign": "string",
"eq_utm_referrer": "string",
"eq_utm_expid": "string",
"attributes":[
],
"source_id": "number",
"source_name": "string",
"source_new": "string",
"channel_new": "string",
"channel_code": "string",
"ext_id": "string",
"properties": "string"
}
]
}
}
List of returned errors
See the section "List of errors for methods with the verb get"