Creates a site using CT 3.0.
| Method | create.site |
|---|---|
| Description | Creates a site using CT 3.0. |
| Who has access | Agents and clients |
Request parameters
| Name | Type | Required | Valid values | Description |
|---|---|---|---|---|
access_token |
string | yes | Access token used to authenticate the request. | |
user_id |
number | no | Unique ID of the client user on whose behalf the agent is making the request. Required for agents. To retrieve a list of client users, use get.customer_users.
|
|
domain_name |
string | yes | Site domain name, without the http:// or https:// protocol prefix. | |
name |
string | no | Site name. | |
industry_id |
number | yes | The industry associated with the site: 1 - Automotive and transportation 2 - Business and services 3 - Food and beverages 4 - Animals and pets 5 - Law and government 6 - Internet and telecommunications 7 - Computers and electronics 8 - Beauty and fitness 9 - Healthcare 10 - Real estate 11 - Accommodation and hotels 12 - Industry and manufacturing 13 - Travel and tourism 14 - Sports 15 - Construction and renovation 16 - Education 17 - Finance 18 - Hobbies and entertainment 19 - E-commerce and retail |
|
target_call_min_duration |
number | no | Minimum duration, in seconds, after which a call is considered a target call. Default: 30. | |
site_key |
string | no | Exactly 32 characters. Allowed characters: A-Z, a-z, 0-9, and underscore (_). | Embed code key for the site. If omitted, the key is generated automatically. Replace {site_key} in the following template with this value:<script type="text/javascript"> var __cs = __cs || []; __cs.push(["setCsAccount", "{site_key}"]);</script><script type="text/javascript" async src="//app.callgear.com/static/cs.min.js"></script> |
second_communication_period |
number | no | 1-365 | Repeat communication period, in days. Default: 1. |
is_support_web_directory |
boolean | no | Whether site directory tracking is enabled. | |
child_customer_id |
number | no | Unique ID of the client for whom the site is created. To retrieve a list of clients, use get.customers. |
|
is_block_robot_traffic |
boolean | no | Whether to block bot traffic. When enabled, bot visits and activity are not tracked. |
Response parameters
| Name | Type | Description |
|---|---|---|
id |
number | Unique site ID. |
site_key |
string |
Embed code key for the site. Replace {site_key} in the following template with this value:<script type="text/javascript"> var __cs = __cs || []; __cs.push(["setCsAccount", "{site_key}"]);</script><script type="text/javascript" async src="//app.callgear.com/static/cs.min.js"></script>
|
Example request
{
"jsonrpc": "2.0",
"id": "number",
"method": "create.site",
"params": {
"access_token": "string",
"user_id": "number",
"industry_id": "number",
"target_call_min_duration": "number",
"domain_name": "string",
"site_key": "string",
"second_communication_period": "number",
"is_support_web_directory": "boolean",
"child_customer_id": "number",
"is_block_robot_traffic": "boolean"
}
}
Example response
{
"jsonrpc": "2.0",
"id": "number",
"result": {
"data": {
"id": "number",
"site_key": "string"
},
"metadata": "object"
}
}
Possible errors
See the "Errors for create methods" section.