startCall

新規の電話コールインタラクションを作成します。

リクエスト

構文

startCall(phoneNumber: string, initialObject?: InteractionAssociatedObject): Promise<OperationResult<InitiateResult>>

：

type InteractionAssociatedObject = { id: string type: string displayName: string displayType: string customFields: Record<string, string> } type InitiateResult = { id: string \| null error?: string }

パラメータ

パラメータ	パラメータ値	データ型	オプション／必須	説明
phoneNumber		文字列	必須	発信先の電話番号
initialObject			オプション	初期化時に、このコールに関連付けるオブジェクトを指定できます。たとえば、連絡先からの「クリックして電話」アクションでは、ここでその連絡先に関する情報を送信できます。
	id	文字列		phoneNumberに関連付けるオブジェクトのIDです。
	type	文字列		オブジェクトのタイプ（例：連絡先、ケース、タスクなど）
	displayName	文字列		オブジェクトの表示名
	displayType	文字列		オブジェクトの表示タイプ
	customFields	Record<string, string>		オブジェクトについて提供したい追加情報

   startCallButton.onclick = () => {

       const phone = startCallPhoneNumberInput.value

       let associatedObject: InteractionAssociatedObject | undefined = undefined

       const associatedObjectStr = associatedObjectTextarea.value

       if (associatedObjectStr) {

           try {

               associatedObject = JSON.parse(associatedObjectStr)

           } catch (e) {

               alert('関連オブジェクトの構造に構文エラーがあります。JSONを解析できません。')

               return

       adApi.startCall(phone, associatedObject)

オブジェクト	オブジェクトの値	データ型	オプションですか？（はい／いいえ）	値の説明
InitialResult
	id	文字列	N	作成されたインタラクションのIDを返します。このIDを使用すると、onInteractionStateChange コールバックを通じてインタラクションの更新状況を追跡できます。なお、インタラクションが作成されなかった場合、この値はnullになることがあります。結果がnullであっても、必ずしもエラーを意味するわけではありません。たとえば、「Deferred Dial」機能が有効になっている場合、このAPIメソッドはインタラクションを開始せず、ダイヤルパッドに要求された番号を入力するのみとなります。
	error	文字列		操作中にエラーが発生した場合、エラーメッセージを返します。エラーの種類は以下の通りです：タイムアウトエラー