Web API リファレンス|Tropo Web API

{"session":} オブジェクト

   

セッションは、新しいセッションが到着するとき、HTTP POSTとしてお使いのウェブアプリケーションに送信されるペイロード(データ本体)です。 これにはアプリケーションの起動に関する全データ、アプリケーションに付与するパラメータ(存在する場合)、日付など様々なものが含まれています。

 

  • ユーザーがTropo WebAPIのアプリケーションに発信します。
  • TropoはJSONのセッションを指定のサーバーに送信し、指示を要求します。
  • ウェブサーバーのアプリケーションがTropoに発信者に対して音声ファイルを再生するように要求します。
  • Tropoは音声ファイルを再生し、通話を切断し、JSONのresultを中継し、最終的なリザルトとともにウェブサーバーに返します。
   

フィールド

accountId
データの種類:String型 デフォルト:なし 任意
このセッションを開始するユーザーアカウントIDです。
callId
データの種類:String型 デフォルト:なし 任意
これには、callそのもののIDが含まれます。callerIDでもcalledIDでもありません。これは実際の通話を識別する値です。
from
データの種類:Object型 デフォルト:なし 任意
これにはセッションの発生を特定する要素が含まれています。 これには4つのキーが含まれています。  
  • 「id」 - これはセッションを開始したユーザーの識別子で、一般的にはcallerIDと呼ばれています。
  • 「name」 - セッションを開始したユーザーの名前です。
  • 「network」 - 「PSTN」か「VOIP」です。
headers
データの種類:Object型 デフォルト:なし 任意
これは、現在のセッションのセッション開始プロトコル(SIP)ヘッダを含む高度なネットワーク情報です。
id
データの種類:String型 デフォルト:なし 任意
これは、特定のセッションの識別子を示すGUID(Global Unique Identifier)です。
timestamp
データの種類:String型 デフォルト:なし 任意
これはセッションが開始された時間です。以下の例をご覧ください。 2012-02-21T16:09:33.891Z この最初の部分が日付で「Time」の「T」を示す部分から後に時間が続きます。 この時間は16時、9分、33秒、891ミリ秒、その語の「Zulu」の「Z」を意味する部分はGMTを意味しています。
to
データの種類:Object型 デフォルト:なし 任意
これにはセッションの宛先を識別する要素が含まれています。 このオブジェクト内には4つのキーがあります。
  • 「id」 - セッションを受信するユーザーの識別子で、一般的にはCalled IDと呼ばれています。
  • 「name」 - セッションを受信するユーザーの名前で、SIPにのみ対応しています。
  • 「network」 - 「PSTN」か「VOIP」です。
userType
データの種類:String型 デフォルト:なし 任意
これはセッションの相手方のユーザーの種類を識別します。現在では、 Tropoでは留守番電話装置の検出機能を実装していないため、これは常に「HUMAN」と応答します。

サンプル

 

TTSとオーディオの再生例

{
	"session":{
		"id":"1aa06515183223ec0894039c2af433f2",
		"accountId":"33932",
		"timestamp":"2010-02-18T19:07:36.375Z",
		"userType":"HUMAN",
		"initialText":null,
		"callId":"abcdef743e245c265bc2c699b4112345"
		"to":{
			"id":"9991427645",
			"name":"unknown",
			"channel":"VOICE",
			"network":"PSTN"
		},
		"from":{
			"id":"jsgoecke",
			"name":"unknown",
			"channel":"VOICE",
			"network":"PSTN"
		},
		"headers":{
			"x-sbc-from":"\"jsgoecke\"<sip:0000123456@192.168.34.202>;tag=2a648c6e",
			"x-sbc-allow":"BYE",
			"x-sbc-user-agent":"sipgw-1.0",
			"x-voxeo-sbc-name":"10.6.63.104",
			"x-sbc-contact":"<sip:0000123456@192.168.34.202:16000>",
			"Content-Length":"247",
			"To":"<sip:9991427645@10.6.61.101:5060>",
			"x-voxeo-sbc":"true",
			"Contact":"<sip:jsgoecke@10.6.63.104:5060>",
			"x-voxeo-to":"<sip:990009369991427645@66.193.54.18:5060>",
			"x-sbc-request-uri":"sip:990009369991427645@66.193.54.18:5060",
			"x-sbc-call-id":"OWE0OGFkMTE1ZGY4NTI1MmUzMjc1M2Y3Y2ExMzc2YjE.",
			"x-sid":"39f4688b8896f024f3a3aebd0cfb40b2",
			"x-sbc-cseq":"1 INVITE",
			"x-sbc-max-forwards":"70",
			"x-voxeo-sbc-session-id":"39f4688b8896f024f3a3aebd0cfb40b2",
			"CSeq":"2 INVITE",
			"Via":"SIP/2.0/UDP 66.193.54.18:5060;received=10.6.63.104",
			"x-sbc-record-route":"<sip:195.46.253.237:5061;r2=on;lr;ftag=2a648c6e>",
			"Call-ID":"0-13c4-4b7d8ff7-1c3c1b82-7935-1d10b080",
			"Content-Type":"application/sdp",
			"x-sbc-to":"<sip:990009369991427645@66.193.54.18:5060>",
			"From":"<sip:jsgoecke@10.6.63.104:5060>;tag=0-13c4-4b7d8ff7-1c3c1b82-5d8c"
		}
	}
}