コール
コールエンゲージメントAPIを使用することで、CRMレコードとコール インデックス ページにコールを記録して管理できます。HubSpotでも、コールエンゲージメントAPIを使用することでも、コールをログに記録できます。この記事では、APIを使用したコールの基本的な管理方法を説明します。利用可能な全てのエンドポイントとそれぞれの要件を確認するには、記事の上部にある[エンドポイント]タブをクリックしてください。
propertiesオブジェクトには、次のフィールドを含めることができます。
フィールド | Description |
---|---|
hs_timestamp
| 必須。このフィールドは、コールの作成時刻を記録し、レコードタイムラインでのそのコールの位置を決定します。ミリ秒単位またはUTC形式のUnixタイムスタンプを使用できます。 |
hs_call_body
| コールの説明。必要に応じてメモを追加できます。 |
hs_call_callee_object_id
| コールに関連付けられているHubSpotレコードのID。 |
hs_call_callee_object_type_id
| コールに関連付けられているレコードが属するオブジェクトのID(例えば、レコードがコンタクトまたは会社であるかを指定します)。 |
hs_call_direction
| HubSpotユーザーの視点から見たコールの方向。ユーザーがコールの受信者である場合、方向は |
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
| コールのステータス。ステータスは、 |
hs_call_title
| コールのタイトル。 |
hs_call_to_number
| コールを受信した電話番号。 |
hubspot_owner_id
| コールに関連付けられている担当者のID。このフィールドにより、レコードタイムラインでコール作成者としてリストされるユーザーが決まります。 |
hs_activity_type
| コールのタイプ。オプションは、HubSpotアカウントで設定されたコールタイプに基づいています。 |
hs_attachment_ids
| コールの添付ファイルのID。複数の添付ファイルIDはそれぞれセミコロンで区切られます。 |
コールを作成して既存のレコードと関連付けるには、リクエストにassociationsオブジェクトを含めます。このオブジェクトには、次のフィールドを含める必要があります。
フィールド | Description |
---|---|
toObjectId
| コールに関連付けるレコードのID。 |
associationType
| コールと他のオブジェクトとの関連付けタイプを示す一意の識別子。このIDは、数値またはスネークケース( |
例えば、コールを作成してコンタクトとチケットに関連付ける場合、リクエスト本文は次のようになります。
コールを一括で作成する方法については、この記事の上部にある[エンドポイント]をクリックしてください。
全てのコールのリストを要求するには、/crm/v3/objects/calls
にGET
リクエストを送信します。リクエストのURLには、次のパラメーターを含めることができます。
Parameter | Description |
---|---|
limit
| ページごとに表示する結果の最大数。 |
properties
| 返されるプロパティーごとにカンマで区切られたリスト。 |
リクエストが正常に完了すると、レスポンスにcallId
が追加されます。このIDを使用して、対応するコールを取得、更新、削除できます。
Identify voicemails vs. recorded calls
録音された通話やボイスメールの場合、録音は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
になり、コースのステータスがmissed以外の場合はnull
になります。
コールを個別に、または一括で更新できます。コールIDを指定して個々のコールを更新するには、/crm/v3/objects/calls/{callId}
にPATCH
リクエストを送信します。
リクエストの本文に、更新するコールプロパティーを含めます。
HubSpotは、読み取り専用プロパティーおよび存在しないプロパティーの値を無視します。プロパティー値をクリアするには、リクエストの本文でプロパティーの空の文字列を渡します。
コールを一括で更新する方法については、この記事の上部にある[エンドポイント]をクリックしてください。
コールをレコード(コンタクトとその関連会社など)に関連付けるには、PUT
リクエストを/crm/v3/objects/calls/{callId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
に送信します。リクエストのURLは次のフィールドからなります。
フィールド | Description |
---|---|
callId
| コールのID。 |
toObjectType
| コールに関連付けるオブジェクトのタイプ(コンタクト、会社など)。 |
toObjectId
| コールに関連付けるレコードのID。 |
associationTypeId
| コールと他のオブジェクトとの関連付けタイプを示す一意の識別子。このIDは、数値またはスネークケース( |
例えば、リクエストのURLは次のようになります。
https://api.hubspot.com/crm/v3/objects/calls/17591596434/associations/contact/104901/194
関連付けを削除する
コールとレコード間の関連付けを削除するには、上記と同じURLに対してDELETE
リクエストを送信します。
/crm/v3/objects/calls/{callId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
コールを個別に、または一括で削除することができます。削除したコールは、HubSpot内のごみ箱に追加されます。そのため、必要に応じて後でレコードタイムラインからコールを復元することも可能です。
コールIDを指定して個々のコールを削除するには、DELETE
リクエストを/crm/v3/objects/calls/{callId}
に送信します。
コールを一括で削除する方法については、この記事の上部にある[エンドポイント]をクリックしてください。
貴重なご意見をありがとうございました。