API クライアント

概要

Client は RPC メソッドを提供する gRPC API クライアントです。

セットアップ

npm

// ESM
import { OAuth2Authenticator, Client, MediaUploadType, LanguageCode } from 'mixi2-js';
// CJS
const { OAuth2Authenticator, Client, MediaUploadType, LanguageCode } = require('mixi2-js');

JSR

import { OAuth2Authenticator, Client, MediaUploadType, LanguageCode } from '@otoneko1102/mixi2-js';

const authenticator = new OAuth2Authenticator({
  clientId: process.env.CLIENT_ID!,
  clientSecret: process.env.CLIENT_SECRET!,
  tokenUrl: process.env.TOKEN_URL!,
});

const client = new Client({
  apiAddress: process.env.API_ADDRESS!,
  authenticator,
});

プロパティ	型	必須	説明
apiAddress	string	○	API サーバーアドレス
authenticator	Authenticator	○	認証インスタンス
authKey	string	-	x-auth-key メタデータに付与する認証キー

RPC メソッド一覧

Bot・Plugin 共通

メソッド	引数	戻り値	説明
getUsers(userIdList)	string[]	Promise<User[]>	ユーザー情報を一括取得
getPosts(postIdList)	string[]	Promise<Post[]>	ポスト情報を一括取得
createPost(request)	CreatePostRequest	Promise<Post>	ポストを作成（返信/引用/コミュニティ/メディア添付対応）
deletePost(postId)	string	Promise<boolean>	ポストを削除
initiatePostMediaUpload(request)	InitiatePostMediaUploadRequest	Promise<InitiatePostMediaUploadResponse>	メディアアップロードを開始
getPostMediaStatus(mediaId)	string	Promise<GetPostMediaStatusResponse>	メディアの処理状況を取得
sendChatMessage(request)	SendChatMessageRequest	Promise<ChatMessage>	チャットメッセージを送信
getStamps(request?)	GetStampsRequest?	Promise<GetStampsResponse>	スタンプ一覧を取得
addStampToPost(postId, stampId)	string, string	Promise<Post>	ポストにスタンプを付与
getAccessToken()	-	Promise<string>	認証インスタンスからアクセストークンを取得
close()	-	void	gRPC 接続を閉じる

Plugin 専用

メソッド	引数	戻り値	説明
getCommunities(communityIdList)	string[]	Promise<Community[]>	コミュニティ情報を一括取得
getCommunityTimeline(request)	GetCommunityTimelineRequest	Promise<Post[]>	コミュニティのタイムラインを取得
getCommunityMemberList(request)	GetCommunityMemberListRequest	Promise<GetCommunityMemberListResponse>	コミュニティのメンバー一覧を取得
restrictCommunityPost(request)	RestrictCommunityPostRequest	Promise<void>	コミュニティのポストを非表示にする
getCommunitiesUsingApplication(request?)	GetCommunitiesUsingApplicationRequest?	Promise<GetCommunitiesUsingApplicationResponse>	Plugin がインストールされているコミュニティ一覧を取得
sendDirectMessageToCommunityMember(request)	SendDirectMessageToCommunityMemberRequest	Promise<ChatMessage>	コミュニティメンバーに DM を送信

ノート

Plugin 専用メソッドを使用するには、対応する Requirement（パーミッション） の設定が必要です。詳しくは コミュニティプラグイン を参照してください。

使用例

ユーザー情報取得

const users = await client.getUsers(["user-id-1", "user-id-2"]);

ポスト作成

const post = await client.createPost({ text: "Hello mixi2!" });

CreatePostRequest

フィールド	型	必須	説明
text	string	○	ポスト本文（最大 149 文字）
inReplyToPostId	string	-	返信先ポスト ID
quotedPostId	string	-	引用対象ポスト ID
communityId	string	-	投稿先コミュニティ ID（Plugin のみ）
mediaIdList	string[]	-	添付メディア ID（最大 4 件）
postMask	PostMask	-	マスク設定（センシティブ/ネタバレ）
publishingType	PostPublishingType	-	配信設定

ノート

inReplyToPostId と quotedPostId は同時に指定できません。

ポスト削除

const deleted = await client.deletePost("post-id");
// deleted === true なら削除成功

メディアアップロード → ポスト添付

const upload = await client.initiatePostMediaUpload({
  contentType: "image/png",
  dataSize: 1024,
  mediaType: MediaUploadType.IMAGE,
});
// upload.uploadUrl に POST でメディアデータを送信
const status = await client.getPostMediaStatus(upload.mediaId);
// status.status === MediaUploadStatus.COMPLETED になったら添付可能
await client.createPost({ text: "画像付き！", mediaIdList: [upload.mediaId] });

InitiatePostMediaUploadRequest

フィールド	型	必須	説明
contentType	string	○	Content-Type（例: image/jpeg）
dataSize	number	○	データサイズ（バイト）
mediaType	MediaUploadType	○	メディア種別（IMAGE / VIDEO）
description	string	-	メディアの説明

チャットメッセージ送信

const message = await client.sendChatMessage({
  roomId: "room-id",
  text: "Hello!",
});

SendChatMessageRequest

フィールド	型	必須	説明
roomId	string	○	送信先ルーム ID
text	string	△	テキスト（text または mediaId のいずれか必須）
mediaId	string	△	添付メディア ID

注意

チャットメッセージはユーザーからの DM 受信後にのみ送信可能です。

スタンプ

// 公式スタンプ一覧取得
const result = await client.getStamps({ officialStampLanguage: LanguageCode.JP });
const officialSets = result.officialStampSets;

// コミュニティスタンプ取得（Plugin のみ）
const result2 = await client.getStamps({ communityIds: ["community-id"] });
const communityStamps = result2.communityStampSets;

// ポストにスタンプを付与
await client.addStampToPost("post-id", "stamp-id");

GetStampsRequest

フィールド	型	必須	説明
officialStampLanguage	LanguageCode	-	公式スタンプの言語（未指定の場合は空のリストが返る）
communityIds	string[]	-	コミュニティスタンプを取得するコミュニティ ID（Plugin のみ）

GetStampsResponse

フィールド	型	説明
officialStampSets	OfficialStampSet[]	公式スタンプセットの一覧
communityStampSets	CommunityStampSet[]	コミュニティスタンプセットの一覧

接続の終了

client.close();

各 RPC メソッドの詳細は 公式 API 仕様 を参照してください。