ミーティングID

ミーティングIDは、PlanetKitを連携したアプリケーションでグループ通話（カンファレンス）を行うために数字で区別するルームの識別子です。

LINE Planetは、SIPターミナルを用いたグループ通話に対応します。SIPターミナルにはいくつかの種類がありますが、SIPフォンやビデオ会議設備が一般的な例です。

アプリケーションでSIPターミナルに対応するには、このページの仕様を参考にしてミーティングIDを取得してください。その上でユーザーは、発行されたミーティングIDを用いてSIPデバイスでグループ通話に参加できます。

通話タイプ
グループ通話

データ構造

ミーティングIDは、次のようなデータ構造を使用します。

ミーティングIDのタイプ

ミーティングIDには、Iタイプ、Sタイプ、Rタイプがあります。アプリケーションが提供するシナリオによって、適切なミーティングIDのタイプをリクエストする必要があります。

ミーティングIDタイプ	名前	有効期限のデフォルト値	説明
I	Instant	1日	ミーティング終了直後または発行24時間後に満了となります。
S	Schedule	30日	デフォルト値が適用された場合、作成30日後に満了となります。30日以内に同じミーティングIDでミーティングを再開すると、有効期限はその日から再び30日延長されます。注：有効期限は、サービスIDごとに設定できます。有効期限が変更された場合、デフォルト値である30日ではなく、その値が適用されます。
R	Schedule for recurring	365日	デフォルト値が適用された場合、作成365日後に満了となります。365日以内に同じミーティングIDでミーティングを再開すると、有効期限はその日から再び365日延長されます。注：有効期限は、サービスIDごとに設定できます。有効期限が変更された場合、デフォルト値である365日ではなく、その値が適用されます。

Note

SタイプまたはRタイプのミーティングIDに対して、有効期限を変更したい場合は、LINE Planetチームにお問い合わせください。

ミーティングIDオブジェクト

ミーティングIDのデータ構造は、以下のようになっています。オブジェクト名は、MeetingObjectです。

プロパティ	データ型	Null許容	説明
`id`	Long	N	ID値。11桁以上の数字
`type`	String	N	ミーティングIDタイプ。I、S、Rのいずれかです。
`passcode`	String	N	パスコード。6桁の数字
`chatSvcId`	String	N	ルームのサービスID
`chatId`	String	N	ルームID
`created`	Timestamp(milliseconds)	N	作成時刻
`expireAt`	Timestamp(milliseconds)	N	満了時刻。発行したミーティングIDは`expireAt`以後無効となります。
`title`	String	Y	ミーティングのタイトル
`data`	String	N	ミーティングのデータ

ミーティングIDの作成

ミーティングIDをリクエストします。

メソッドとエンドポイント

メソッド：POST

エンドポイント

/tas/v2/gcall/{roomServiceId}/{roomId}/mtg

ヘッダー

Authorization:Basic {your credential}
Accept: application/json
Content-Type: application/json

パスパラメーター

パラメーター	説明
`roomServiceId`	ルームのサービスID
`roomId`	ルームID

リクエスト本文

パラメーター	データ型	必須	デフォルト値	説明
`type`	String	Y		ミーティングIDのタイプ。I、S、Rのいずれかです。
`passcode`	String	N	random	パスコード。6桁の数字
`title`	String	N	NULL	ミーティングタイトル。 UTF-16で最大128字まで入力できます。
`data`	String	N	NULL	ミーティングデータ。 UTF-16で最大1024字まで入力できます。

レスポンス

プロパティ	データ型	説明
`mtg`	`MeetingObject`	ミーティングオブジェクト
`sipProxy`	String	グループ通話のプロキシアドレス
`sipProxyPort`	Integer	グループ通話のプロキシポート

例

この例では、以下のような状況を仮定しています。

サービスIDおよびルームのサービスID：ex-service
ルームID：ex-room

curl --location --request POST 'https://vpnx-stn-api.line-apps.com/tas/v2/gcall/ex-service/ex-room/mtg' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic YWxhZGRpbjpvcGVuX3Nlc2FtZQ==' \
--data-raw '{
  "type": "I",
  "passcode": "123456"
}'

{
  "status": "success",
  "data": {
    "mtg": {
      "id": 13698412732,
      "type": "I",
      "passcode": "123456",
      "chatSvcId": "ex-service",
      "chatId": "2048",
      "created": 1656503468722,
      "expireAt": 1656589868722,
      "title": null,
      "data": null
    },
    "sipProxy": "210.1.1.1",
    "sipProxyPort": 5060
  },

  "timestamp": 1656503468730
}

発生し得るアプリケーションエラーコード

発生する可能性のあるアプリケーションエラーコードは、次のとおりです。詳細は、API v2 - エラー処理を参照してください。

400、401、403、405（ミーティングが既に行われている）
500、520

ミーティング一覧

すべてのミーティング一覧を照会します。

メソッドとエンドポイント

メソッド：GET

エンドポイント

/tas/v2/gcall/{roomServiceId}/{roomId}/mtgs

ヘッダー

Authorization:Basic {your credential}
Accept: application/json
Content-Type: application/json

パスパラメーター

パラメーター	説明
`roomServiceId`	ルームのサービスID
`roomId`	ルームID

リクエスト本文

なし

レスポンス

プロパティ	データ型	説明
`mtgs`	`MeetingObject`の配列	現在は、`MeetingObject`1つのみを返します。

例

この例では、以下のような状況を仮定しています。

サービスIDおよびルームのサービスID：ex-service
ルームID：ex-room

curl --location --request GET 'https://vpnx-stn-api.line-apps.com/tas/v2/gcall/ex-service/ex-room/mtgs' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic YWxhZGRpbjpvcGVuX3Nlc2FtZQ=='

{
  "status": "success",
  "data": {
    "mtgs": [
      {
        "id": 73051667563,
        "type": "S",
        "passcode": "123456",
        "chatSvcId": "ex-service",
        "chatId": "ex-room",
        "created": 1656503532981,
        "expireAt": 1659095532981,
        "title": null,
        "data": null
      }
    ]
  },
  "timestamp": 1656503539402
}

発生し得るアプリケーションエラーコード

発生する可能性のあるアプリケーションエラーコードは、次のとおりです。詳しくは、API v2 - エラー処理を参照してください。

400、 401、403
500、520

ミーティングの変更

ミーティングIDのプロパティを上書きします。

メソッドとエンドポイント

メソッド：PUT

エンドポイント

/tas/v2/gcall/{roomServiceId}/{roomId}/mtgs/{mtgId}

ヘッダー

Authorization:Basic {your credential}
Accept: application/json
Content-Type: application/json

パスパラメーター

パラメーター	説明
`roomServiceId`	ルームのサービスID
`roomId`	ルームID
`mtgId`	上書きするミーティングのID

リクエスト本文

パラメーター	データ型	必須	デフォルト値	説明
`type`	String	N		ミーティングIDタイプ。I、S、Rのいずれかです。変更できるタイプは、次のとおりです。 S -> R
`passcode`	String	N	random	パスコード。6桁の数字
`title`	String	N	NULL	ミーティングタイトル。 UTF-16で最大128字まで入力できます。
`data`	String	N	NULL	ミーティングデータ。 UTF-16で最大1024字まで入力できます。

レスポンス

プロパティ	データ型	説明
`mtg`	`MeetingObject`	ミーティングオブジェクト

例1

この例では、以下のような状況を仮定しています。

サービスIDおよびルームのサービスID：ex-service
ルームID：ex-room
ミーティングID：73051667563
現在のミーティングタイプ：S

ミーティングタイプをRに変更する例です。

curl --location --request PUT 'https://vpnx-stn-api.line-apps.com/tas/v2/gcall/ex-service/ex-room/mtg/73051667563' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic YWxhZGRpbjpvcGVuX3Nlc2FtZQ==' \
--data-raw '{
  "type": "R"
}'

{
  "status": "success",
  "data": {
    "id": 73051667563,
    "type": "R",
    "passcode": "123456",
    "chatSvcId": "ex-service",
    "chatId": "ex-room",
    "created": 1656503532981,
    "expireAt": 1688039617461,
    "title": null,
    "data": null
  },
  "timestamp": 1656503617497
}

例2

この例では、以下のような状況を仮定しています。

サービスIDおよびルームのサービスID：ex-service
ルームID：ex-room
ミーティングID：73051667563
現在のミーティングタイプ：R

ミーティングのタイプをSに変更しようとした際に失敗する例です。

curl --location --request PUT 'https://vpnx-stn-api.line-apps.com/tas/v2/gcall/ex-service/ex-room/mtg/73051667563' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic YWxhZGRpbjpvcGVuX3Nlc2FtZQ==' \
--data-raw '{
  "type": "S"
}'

{
  "status": "error",
  "message": "current type cannot be converted to nextType. R -> S",
  "code": "405",
  "data": {},
  "timestamp": 1657108897760
}

発生し得るアプリケーションエラーコード

発生する可能性のあるアプリケーションエラーコードは、次のとおりです。詳しくは、API v2 - エラー処理を参照してください。

400、401、403、404、405、435（現在のミーティングタイプをリクエストしたタイプに変更できない）
500、520

ミーティング削除

ミーティングを削除します。

メソッドとエンドポイント

メソッド：DELETE

エンドポイント

/tas/v2/gcall/{roomServiceId}/{roomId}/mtgs/{mtgId}

ヘッダー

Authorization:Basic {your credential}
Accept: application/json
Content-Type: application/json

パスパラメーター

パラメーター	説明
`roomServiceId`	ルームのサービスID
`roomId`	ルームID
`mtgId`	削除するミーティングID

リクエスト本文

なし

レスポンス

なし

例

この例では、以下のような状況を仮定しています。

サービスIDおよびルームのサービスID：ex-service
ルームID：ex-room
ミーティングID：73051667563

curl --location --request DELETE 'https://vpnx-stn-api.line-apps.com/tas/v2/gcall/ex-service/ex-room/mtg/73051667563' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic YWxhZGRpbjpvcGVuX3Nlc2FtZQ=='

{
  "status": "success",
  "data": null,
  "timestamp": 1656503704119
}

発生し得るアプリケーションエラーコード

発生する可能性のあるアプリケーションエラーコードは、次のとおりです。詳細は、API v2 - エラー処理を参照してください。

400、401、403、404
500、520

データ構造​

ミーティングIDのタイプ​

ミーティングIDオブジェクト​

ミーティングIDの作成​

メソッドとエンドポイント​

ヘッダー​

パスパラメーター​

リクエスト本文​

レスポンス​

例​

発生し得るアプリケーションエラーコード​

ミーティング一覧​

メソッドとエンドポイント​

ヘッダー​

パスパラメーター​

リクエスト本文​

レスポンス​

例​

発生し得るアプリケーションエラーコード​

ミーティングの変更​

メソッドとエンドポイント​

ヘッダー​

パスパラメーター​

リクエスト本文​

レスポンス​

例1​

例2​

発生し得るアプリケーションエラーコード​

ミーティング削除​

メソッドとエンドポイント​

ヘッダー​

パスパラメーター​

リクエスト本文​

レスポンス​

例​

発生し得るアプリケーションエラーコード​

データ構造

ミーティングIDのタイプ

ミーティングIDオブジェクト

ミーティングIDの作成

メソッドとエンドポイント

ヘッダー

パスパラメーター

リクエスト本文

レスポンス

例

発生し得るアプリケーションエラーコード

ミーティング一覧

メソッドとエンドポイント

ヘッダー

パスパラメーター

リクエスト本文

レスポンス

例

発生し得るアプリケーションエラーコード

ミーティングの変更

メソッドとエンドポイント

ヘッダー

パスパラメーター

リクエスト本文

レスポンス

例1

例2

発生し得るアプリケーションエラーコード

ミーティング削除

メソッドとエンドポイント

ヘッダー

パスパラメーター

リクエスト本文

レスポンス

例

発生し得るアプリケーションエラーコード