MiiTel API （β版）のはじめに

アクセストークンを取得し、MiiTel API （β版）に最初のリクエストを送るまでの手順を説明します。

📘
はじめる前に
MiiTel API は、テナントで有効化されている必要があります。概要のご利用前の準備をご確認ください。

用意するもの

項目	例
ベース URL	東京：`https://<tenant-code>.tyo101.miitel.com` ジャカルタ：`https://<tenant-code>.jkt101.miitel.com`
テナントコード	MiiTel へのログイン時に使用するテナントコード
MiiTel アカウント	API を実行する MiiTel ユーザーのメールアドレスとパスワード

API のパスはすべて /public-api/v1 から始まります。

API を実行するアカウントの選び方

MiiTel API では API キーは発行しません。既存の MiiTel ユーザーアカウントで認証するため、以下はすべてそのユーザーに紐づきます。

ユーザーに紐づくもの	確認すること
参照できるデータの範囲	API で取得できるのは、そのユーザーが MiiTel 上で閲覧できるデータのみです。必要なデータを閲覧できる権限があるかご確認ください。
レート制限	レート制限はユーザー単位で数えます（制限と注意事項を参照）。
アカウントのライフサイクル	ユーザーの削除・無効化やパスワード変更を行うと、連携が停止します。

既存のユーザーを使うことも、連携専用のユーザーを作成することもできます。長期間運用する連携では、特定の個人のアカウントに依存しないことをおすすめします。

ステップ 1：アクセストークンを取得する

ユーザーのメールアドレスとパスワードで認証エンドポイントを呼び出します。

curl -X POST "https://account.miitel.com/auth/v1/authenticate" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "USER_PASSWORD",
    "params": {"email": "<email>", "password": "<password>"}
  }'

レスポンスの auth_result.access_token をアクセストークンとして使用し、auth_result.refresh_token を保存してください。

アクセストークンの有効期限が切れたら、"flow": "REFRESH_TOKEN" と "params": {"refresh_token": "<refresh-token>"} で新しいトークンを取得します。有効期限は固定値と想定せず、各レスポンスの expires_in を参照してください。

❗️
認証情報の取り扱い
パスワードやトークンを、ブラウザで動くコード、ソースコード管理、ログ、問い合わせ内容に含めないでください。

ステップ 2：最初のリクエストを送る

直近の通話を 5 件取得します。

export PUBLIC_API_URL="https://<tenant-code>.tyo101.miitel.com"
export TENANT_CODE="<tenant-code>"
export ACCESS_TOKEN="<access-token>"

curl -X POST "${PUBLIC_API_URL}/public-api/v1/phone_calls/list" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "X-Tenant-Code: ${TENANT_CODE}" \
  -H "Content-Type: application/json" \
  -d '{"first": 5}'

すべてのリクエストに、次のヘッダーが必要です。

ヘッダー	値
`Authorization`	`Bearer <access-token>`
`X-Tenant-Code`	テナントコード
`Content-Type: application/json`	JSON のリクエストボディがある場合のみ

成功すると、レスポンスに calls と page_info が含まれます。次のページを取得するには、page_info.end_cursor の値を after に指定して送信します。

次のステップ

すべてのエンドポイントは API リファレンスでご確認いただけます。
バッチ処理を設計する前に制限と注意事項をご確認ください。