Zum Hauptinhalt springen
POST
/
crm
/
v3
/
extensions
/
calling
/
{appId}
/
settings
Configurer une extension d'appel
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"
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubStarter
Service HubService HubStarter
Content HubContent HubGratuit

Authorizations

​
hapikey
string
query
required

Path Parameters

​
appId
integer
required

L'ID de l'application.

Body

application/json
​
name
string
required

Le nom de votre service d'appel à afficher aux utilisateurs.

Example:

"HubPhone"

​
url
string
required

L'URL vers votre interface utilisateur de téléphone/appel, construite avec le Kit de développement d'appel.

Example:

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

​
supportsCustomObjects
boolean

Lorsqu'indiqué comme vrai, les utilisateurs pourront cliquer pour composer un numéro à partir d'objets personnalisés.

Example:

true

​
usesRemote
boolean

Lorsque la valeur est définie sur faux, cela indique que votre application d'appel n'utilise pas la télécommande d'appel intégrée à l'application HubSpot.

Example:

true

​
isReady
boolean

Lorsqu'indiqué comme vrai, cela indique que votre application d'appels HubSpot est prête pour la production. Les utilisateurs pourront sélectionner votre application d'appels HubSpot comme fournisseur et pourront ensuite cliquer pour composer un numéro dans HubSpot.

Example:

true

​
width
integer

La largeur cible de l'iframe qui contiendra votre interface utilisateur de téléphone/appel.

Example:

200

​
usesCallingWindow
boolean

Si la valeur est définie sur « false », cela signifie que votre application d'appel ne nécessite pas l'utilisation d'une fenêtre d'appel distincte pour maintenir la connexion d'appel.

Example:

true

​
supportsInboundCalling
boolean

Lorsque la valeur est définie sur vrai, cela indique que votre application d'appel prend en charge les appels entrants dans HubSpot.

Example:

true

​
height
integer

La hauteur cible de l'iframe qui contiendra votre interface utilisateur de téléphone/appel.

Example:

350

Response

successful operation

​
createdAt
string<date-time>
required

Lorsque cette extension d'appel a été créée.

​
supportsCustomObjects
boolean
required

Lorsqu'indiqué comme vrai, les utilisateurs pourront cliquer pour composer un numéro à partir d'objets personnalisés.

​
usesRemote
boolean
required

Lorsque la valeur est définie sur faux, cela indique que votre application d'appel n'utilise pas la télécommande d'appel intégrée à l'application HubSpot.

​
isReady
boolean
required

Lorsqu'indiqué comme vrai, cela indique que votre application d'appels HubSpot est prête pour la production. Les utilisateurs pourront sélectionner votre application d'appels HubSpot comme fournisseur et pourront ensuite cliquer pour composer un numéro dans HubSpot.

​
name
string
required

Le nom de votre service d'appel à afficher aux utilisateurs.

​
width
integer
required

La largeur cible de l'iframe qui contiendra votre interface utilisateur de téléphone/appel.

​
usesCallingWindow
boolean
required

Si la valeur est définie sur « false », cela signifie que votre application d'appel ne nécessite pas l'utilisation d'une fenêtre d'appel distincte pour maintenir la connexion d'appel.

​
supportsInboundCalling
boolean
required

Lorsque la valeur est définie sur vrai, cela indique que votre application d'appel prend en charge les appels entrants dans HubSpot.

​
url
string
required

L'URL vers votre interface utilisateur de téléphone/appel, construite avec le Kit de développement d'appel.

​
height
integer
required

La hauteur cible de l'iframe qui contiendra votre interface utilisateur de téléphone/appel.

​
updatedAt
string<date-time>
required

La dernière fois que les paramètres de cette extension d'appel ont été modifiés.

⌘I