POST
/
crm
/
v3
/
extensions
/
calling
/
{appId}
/
settings
コール拡張機能を設定
curl --request POST \
  --url https://api.hubapi.com/crm/v3/extensions/calling/{appId}/settings \
  --header 'Content-Type: application/json' \
  --data '{
  "supportsCustomObjects": true,
  "usesRemote": true,
  "isReady": true,
  "name": "HubPhone",
  "width": 200,
  "usesCallingWindow": true,
  "supportsInboundCalling": true,
  "url": "https://www.example.com/hubspot/iframe",
  "height": 350
}'
{
  "createdAt": "2023-11-07T05:31:56Z",
  "supportsCustomObjects": true,
  "usesRemote": true,
  "isReady": true,
  "name": "<string>",
  "width": 123,
  "usesCallingWindow": true,
  "supportsInboundCalling": true,
  "url": "<string>",
  "height": 123,
  "updatedAt": "2023-11-07T05:31:56Z"
}
サポートされる製品
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub無料ツール
Sales HubSales HubStarter
Service HubService HubStarter
Content HubContent Hub無料ツール

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

アプリのID。

Body

application/json
​
name
string
required

ユーザーに表示されるあなたのコールサービスの名前。

Example:

"HubPhone"

​
url
string
required

電話拡張SDKを使用して作成されたあなたの電話／コールUIのURL。

Example:

"https://www.example.com/hubspot/iframe"

​
supportsCustomObjects
boolean

trueの場合、ユーザーはクリックしてカスタムオブジェクトから電話をかけることができます。

Example:

true

​
usesRemote
boolean

falseの場合、ご使用の通話アプリではHubSpotアプリ内でアンカーが付けられた通話コントローラーが使用されていないことを示します。

Example:

true

​
isReady
boolean

trueの場合、コールアプリが本番で使用できることを示します。ユーザーはコールアプリを電話事業者として選択し、HubSpot内でクリックして電話をかけることができます。

Example:

true

​
width
integer

電話／コールUIが含まれるiframeの幅の目標値。

Example:

200

​
usesCallingWindow
boolean

falseの場合、通話アプリでコールの接続を保持するために個別のコールウィンドウを使用する必要がないことを示します。

Example:

true

​
supportsInboundCalling
boolean

trueの場合、ご使用の通話アプリでHubSpot内のインバウンドコールがサポートされていることを示します。

Example:

true

​
height
integer

電話／コールUIが含まれるiframeの高さの目標値。

Example:

350

Response

successful operation

​
createdAt
string<date-time>
required

このコール拡張機能が作成されたタイミング。

​
supportsCustomObjects
boolean
required

trueの場合、ユーザーはクリックしてカスタムオブジェクトから電話をかけることができます。

​
usesRemote
boolean
required

falseの場合、ご使用の通話アプリではHubSpotアプリ内でアンカーが付けられた通話コントローラーが使用されていないことを示します。

​
isReady
boolean
required

trueの場合、コールアプリが本番で使用できることを示します。ユーザーはコールアプリを電話事業者として選択し、HubSpot内でクリックして電話をかけることができます。

​
name
string
required

ユーザーに表示されるあなたのコールサービスの名前。

​
width
integer
required

電話／コールUIが含まれるiframeの幅の目標値。

​
usesCallingWindow
boolean
required

falseの場合、通話アプリでコールの接続を保持するために個別のコールウィンドウを使用する必要がないことを示します。

​
supportsInboundCalling
boolean
required

trueの場合、ご使用の通話アプリでHubSpot内のインバウンドコールがサポートされていることを示します。

​
url
string
required

電話拡張SDKを使用して作成されたあなたの電話／コールUIのURL。

​
height
integer
required

電話／コールUIが含まれるiframeの高さの目標値。

​
updatedAt
string<date-time>
required

このコール拡張機能の設定が最後に変更された時刻。