Dialpad コールログ エンドポイント

この API は コールログ エンドポイントを企業に提供します。このエンドポイントへアクセスすることにより、Webhook として call logging events により送られる特定の URL を指定することができます。

原文（英語）はこちらをご覧ください。

必要なこと

• イベントの送付先 URL を特定してください 

• JSON オブジェクトをデコードするシークレットオブジェクトを特定してください

Dialpad から受け取るオブジェクト

 

イベント ループ

Dialpad コールログ エンドポイントワークフローは、次のイベント ドリブン シークエンスに従います:

1. ユーザーはあなたのアプリケーションに event subscription をトリガーとする状況を作成する（A user creates a circumstance that triggers an event subscription to your application）
2. あなたのサーバーがシークレットとして .jwt でエンコードされたJSON オブジェクトを受け取る（Your server receives a JSON object, encoded with jwt  with the secret you gave us）
3. あなたのサーバーがイベントの受領を認識する（Your server acknowledges receipt of the event）
4. あなたのビジネスロジックがそのイベントに対して何をするか決める（Your business logic decides what to do about that event）
5. あなたのサーバーが決定を実行する（Your server carries out that decision）

Dialpad コールログ エンドポイント |  URLs リクエスト

URLs リクエストはこのように動作します:

• アクティビティに応えて HTTP POST が含まれるデータを全て受領する（They all receive an HTTP POST containing data in response to activity.）
• コールログ エンドポイントでは、あなたのリクエスト URL はあなたのアプリケーションが subscribe する全てのイベントが送られるターゲットロケーションです（In the call logging endpoint, your Request URL is the target location where all the events your application is subscribed to will be delivered）
• あなたのアプリケーションは１つのリクエスト URL しか持っていないため、イベントデータを受領後、追加の dispatch またはサーバー側にルーティングする必要はありません（Since your application will have only one Request URL, you won’t need to do any additional dispatch or routing server-side after receiving event data.）
• あなたのリクエスト URL はイベントタイプを含む JSON に基づくペイロードを受領します（Your Request URL will receive JSON-based payloads containing wrapped event types.)

Events Dispatched as JSON

認証されたユーザーのアカウントでサブスクリプションイベントが起こると、Dialpad はあなたのリクエスト URL に HTTP POST リクエストを送信します。イベントを受け取ると、サクセスを示すために200 シリーズ HTTP ステータスコードが使われます。200 で反応がない場合はもう一度リトライされます。

call logging endpoint からの JSON response デコード例:

{  
  "internal_number":"14155551001",
  "target":{  
     "phone":"+14155551001",
     "type":"user",
     "id":2,
     "email":"bot@fuzz-ball.com"
  },
  "date_ended":1494624100265,
  "proxy_target":{  

  },
  "date_connected":1494624100265,
  "direction":"inbound",
  "call_id":7,
  "state":"hangup",
  "external_number":"14155556666",
  "was_recorded":false,
  "entry_point_target":{  

  },
  "date_rang":1494624100265,
  "date_started":1494624097927
}

FAQs

コールログ エンドポイントを試みる際に、events や errors がお客様に送信されますか？

いいえ。コールが発生した時にお客様が情報を受け取っていないといった、うまく動作していない兆候を示すだけです。（The only indication that something is not working is if the customer does not receive any information when a call happens.）

カンパニーごとに複数のエンドポイントをサポートしていますか？

いいえ。１カンパニーにつき１エンドポイントをサポートしています。

1日あたりの速度制限はありますか？

ありません。