コールエンゲージメントAPIを使用すると、CRMレコードにコールを記録して管理できます。
/crm/v3/objects/calls
にPOST
リクエストを送信します。
リクエストの本文で、プロパティーオブジェクト内にコールの詳細を追加します。また、関連付けオブジェクトを追加して、新しいコールを既存のレコード(コンタクト、会社など)に関連付けることもできます。
フィールド | 説明 |
---|---|
hs_timestamp | 必須。このフィールドは、コールの作成時刻を記録し、レコードタイムラインでのそのコールの位置を決定します。ミリ秒単位またはUTC形式のUnixタイムスタンプを使用できます。 |
hs_call_body | コールの説明。必要に応じてメモを追加できます。 |
hs_call_callee_object_id | コールに関連付けられているHubSpotレコードのID。OUTBOUND コールの場合はコールの受信者、INBOUND コールの場合はコールの発信者になります。 |
hs_call_callee_object_type | コールに関連付けられているレコードが属するオブジェクトのタイプ(例えば、レコードがコンタクトまたは会社のどちらであるかを指定します)。OUTBOUND コールの場合は受信者のオブジェクト、INBOUND コールの場合は発信者のオブジェクトになります。 |
hs_call_direction | HubSpotユーザー側から見たコールの方向。ユーザーがコールの受信者である場合、方向はINBOUND に設定されます。ユーザーがコールを開始した場合、方向はOUTBOUND に設定されます。 |
hs_call_disposition | コールの成果。コールの通話結果を設定するには、内部GUID値を使用する必要があります。アカウントでカスタムコールの成果が設定されている場合、このAPIを使用してカスタムコール成果に対応する通話結果GUIDを検索できます。既定のHubSpot成果ラベルとそれぞれの内部値は次の通りです。
|
hs_call_duration | 通話時間(ミリ秒)。 |
hs_call_from_number | 発信元の電話番号。 |
hs_call_recording_url | 通話録音を保存するURL。.mp3ファイルまたは.wavファイルへのURLの場合、CRMレコードで再生できます。HTTPSを使用した安全なURLのみが受け入れられます。 |
hs_call_status | コールのステータス。ステータスはBUSY 、CALLING_CRM_USER 、CANCELED 、COMPLETED 、CONNECTING 、FAILED 、IN_PROGRESS 、NO_ANSWER 、QUEUED 、およびRINGING です。 |
hs_call_title | 通話のタイトル。 |
hs_call_source | 通話のソース。これは必須ではありませんが、録音と文字起こしのパイプラインを活用する必要があります。プロパティーが設定されている場合は、INTEGRATIONS_PLATFORM に設定する必要があります。 |
hs_call_to_number | コールを受信した電話番号。 |
hubspot_owner_id | コールに関連付けられている担当者のID。このフィールドにより、レコードタイムラインでコール作成者としてリストされるユーザーが決まります。 |
hs_activity_type | コールのタイプ。利用可能なオプションは、HubSpotアカウントで設定されたコールタイプに基づきます。 |
hs_attachment_ids | コールの添付ファイルのID。複数の添付ファイルIDはそれぞれセミコロンで区切られます。 |
フィールド | 説明 |
---|---|
to | コールに関連付けるレコード。一意のid 値で指定します。 |
types | コールとレコード間の関連付けのタイプ。associationCategory およびassociationTypeId を含めます。既定の関連付けタイプIDはこのページに記載されています。または、関連付けAPIを使用して、カスタム関連付けタイプ(ラベル)の値を取得することもできます。 |
/crm/v3/objects/calls/{callId}
にGET
リクエストを送信します。リクエストのURLには、次のパラメーターを含めることができます。
パラメーター | 説明 |
---|---|
properties | 返されるプロパティーのカンマ区切りリスト。 |
associations | 関連するIDの取得対象となるオブジェクトタイプからなるカンマ区切りリスト。存在しない関連付けを指定した場合、その関連付けはレスポンスで返されません。詳しくは関連付けAPIをご参照ください。 |
/crm/v3/objects/calls
にGET
リクエストを送信します。リクエストのURLには、次のパラメーターを含めることができます。
パラメーター | 説明 |
---|---|
limit | ページごとに表示する結果の最大数。 |
properties | 返されるプロパティーのカンマ区切りリスト。 |
callId
が追加されます。このIDを使用してコールを取得、更新、削除できます。
hs_call_recording_url
プロパティーに保存されます。ご使用のアカウントでインバウンドコールを利用できる場合、完了して録音されたコールと、ボイスメール付きインバウンドコールを区別するには、リクエストにhs_call_status
およびhs_call_has_voicemail
プロパティーを含めます。
コールでボイスメールが残されている場合、hs_call_status
の値はmissed
、hs_call_has_voicemail
の値はtrue
になります。hs_call_has_voicemail
の値は、ボイスメールが残されていないインバウンドコールの場合はfalse
に、コールのステータスが不在着信以外の場合はnull
になります。
/crm/v3/objects/calls/{callId}
にPATCH
リクエストを送信します。
リクエストの本文に、更新するコールプロパティーを含めます。
PUT
リクエストを/crm/v3/objects/calls/{callId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
に送信します。リクエストのURLは次のフィールドからなります。
フィールド | 説明 |
---|---|
callId | コールのID。 |
toObjectType | コールに関連付けるオブジェクトのタイプ(コンタクト、会社など)。 |
toObjectId | コールに関連付けるレコードのID。 |
associationTypeId | コールと他のオブジェクト間の関連付けタイプを示す一意の識別子。このIDは、数値またはスネークケース(例:call_to_contact )で表すことができます。関連付けAPIを介して値を取得できます。 |
https://api.hubspot.com/crm/v3/objects/calls/17591596434/associations/contact/104901/194
DELETE
リクエストを送信します。
/crm/v3/objects/calls/{callId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
hs_pinned_engagement_id
フィールドにコールのid
を含めます。会社、コンタクト、取引、チケット、およびカスタムオブジェクトAPIの使用の詳細については、こちらをご覧ください。
DELETE
リクエストを/crm/v3/objects/calls/{callId}
に送信します。
コールを削除する方法の詳細については、 リファレンスドキュメントでご覧いただけます。