フォローする

TRANSREC APIとは

TRANSREC APIを利用すると、外部サービスから以下の動作を実行することができます。

  • 変換された留守番電話メッセージを取得。
  • 発信者番号と着信番号を取得。
  • 音声データ(mp3)を取得。
  • 留守番電話メッセージの削除。

TRANSREC APIを構成するのは、以下の2つです。

  • Ping通知
    留守電が保存されると、あらかじめ登録しておいたURLに対して、TRANSREC側からPingと呼ばれる短いメッセージが送信されます。
  • RESTful API
    伝言メッセージや音声データを受信するためのAPIです。RESTfulなAPIですので、言語に依存することなくHTTPベースでデータの受信などが行えます。
    ※RESTとは

API利用手順

  1. ユーザサイトにログインし、ダッシュボードページにある「API設定情報」ボタンを押します。
  2. 初回はAPIの利用規約が表示されるので、内容をよく読んで同意します。
  3. API認証情報として、ご契約者様用のSIDとTokenが表示されますので、安全な場所に保存します。
  4. 同じ画面内のPing通知設定欄にて、Pingの通知先を指定してください。
    ※以上で準備作業は終了です。
  5. 留守番電話メッセージが登録されると、4.で指定した通知先にPingデータが送られます。
  6. ご契約者様に割り当てられたSIDとToken、さらにPingデータ内に記載されているrecordidを利用して、保存された伝言メッセージの内容を取得したり、削除します。
    ※RESTful APIの仕様については、こちらを御覧ください。

用語解説

  • SID
    契約者を識別するためのIDです。TRANSRECに契約された方に対して、個別に払い出しされます。RESTful APIの呼び出し時の認証に利用されます。
  • Token
    SIDとセットで利用されるパスワードです。SIDと同様、TRANSRECに契約された方に対して、個別に払出されます。RESTful APIの呼び出し時の認証に利用されます。
  •  recordid
    伝言メッセージに割り当てられたIDで、RESTful APIを使って、個別のメッセージを取得したり削除する際に利用します。recordidは、Ping通知データの中に記載されます。

0 コメント

ログインしてコメントを残してください。
Powered by Zendesk