HubSpot API Data Model
CallingsByAppIdSettings |
Get calling settingsReturns the calling extension settings configured for your app.
Catalog: CallingExtensions3
Schema: Settings
Label: {res:itgen_hubspot_callingsbyappidsettings_plural}
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function CallingsByAppIdSettings. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
appId |
int32 |
☑ |
|
The ID of the app. |
Columns of Table Function
The columns of the table function CallingsByAppIdSettings are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
createdAt |
datetime |
Created at |
☐ |
When this calling extension was created. |
height |
int32 |
Height |
☐ |
The target height of the iframe that will contain your phone/calling UI. |
isReady |
boolean |
Is Ready |
☐ |
When true, this indicates that your calling app is ready for production. Users will be able to select your calling app as their provider and can then click to dial within HubSpot. |
name |
string |
Name |
☐ |
The name of your calling service to display to users. |
supportsCustomObjects |
boolean |
Supports Custom Objects |
☐ |
When true, users will be able to click to dial from custom objects. |
supportsInboundCalling |
boolean |
{res:itgen_hubspot_supportsinboundcalling} |
☐ |
When true, this indicates that your calling app supports inbound calling within HubSpot. |
updatedAt |
datetime |
Updated at |
☐ |
The last time the settings for this calling extension were modified. |
url |
string |
URL |
☐ |
The URL to your phone/calling UI, built with the [Calling SDK](#). |
usesCallingWindow |
boolean |
{res:itgen_hubspot_usescallingwindow} |
☐ |
When false, this indicates that your calling app does not require the use of the separate calling window to hold the call connection. |
width |
int32 |
Width |
☐ |
The target width of the iframe that will contain your phone/calling UI. |
18-12-2024 20:09 Version 24.1.33-BETA+5180
