GetMessageToken による永続接続トークンの生成と設定 - LIVE

操作説明

使用上の注意

最初にクライアントの UserId、DeviceId、および DeviceType 情報を取得し、それらをサーバーに渡します。サーバーはこのインターフェースを使用して認証トークンを取得し、クライアントに返します。異なるユーザーは異なる UserId を使用する必要があり、異なる端末デバイスは異なる DeviceId を使用する必要があります。

QPS 制限

この API の QPS 制限は、ユーザーごとに 1 秒あたり 100 クエリ/秒（QPS）です。この制限を超えると、API 呼び出しがスロットルされ、ビジネスに影響を与える可能性があります。この API は適切なレートで呼び出すことができます。詳細については、「QPS 制限」をご参照ください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

live:GetMessageToken

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AppId	string	必須	インタラクティブメッセージアプリケーション ID。	a494caec-***-695ef345db77
DeviceId	string	必須	端末デバイス ID。ユーザー端末デバイスを一意に表し、ユーザー定義です。小文字、数字、アンダースコア（_）、およびハイフン（-）で構成され、最大長は 64 文字です。異なる端末デバイスは異なる DeviceId を使用する必要があります。端末デバイスから取得してサーバーに渡すことをお勧めします。	a494caec-***-695ef345db77
DeviceType	string	必須	端末デバイスタイプ。有効な値： ios android web pc	android
UserId	string	必須	ユーザー UserId。ユーザー定義で、AppId 内で一意です。小文字、数字、アンダースコア（_）、およびピリオド（.）で構成され、最大長は 32 文字です。異なるユーザーは異なる UserId を使用する必要があります。	de1**a0

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスのスキーマ
RequestId	string	リクエスト ID。	16A96B9A-****-CB92E68F4CD8
Result	object	戻り値。
AccessToken	string	持続的接続の確立に使用されるトークン。	oauth_cloud_key:***-b0YY5Gy6Q
AccessTokenExpiredTime	integer	ログオントークンの有効期限（ミリ秒）。	86400000
RefreshToken	string	更新トークン。AccessToken の有効期限が切れた場合は、RefreshToken を使用して新しいトークンを取得できます。	oauth_cloud_key:****-Q62xggOTdgk3gw=

例

成功レスポンス

JSONJSON

{
  "RequestId": "16A96B9A-****-CB92E68F4CD8",
  "Result": {
    "AccessToken": "oauth_cloud_key:***-b0YY5Gy6Q",
    "AccessTokenExpiredTime": 86400000,
    "RefreshToken": "oauth_cloud_key:****-Q62xggOTdgk3gw="
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvaildParameter	Invalid Parameter
403	Forbidden	User not authorized to operate on the specified resource.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。