APIChannels APIpostchannelの作成getchannel情報の取得putchannelの更新delchannelの削除Users APIputchannelへのUserの登録deluserをchannelから削除Messages APIpostmessageの投稿get指定したmessageの取得put指定したmessageの更新del指定したmessageの削除スキーマChannelUserMessageAPI docs by RedoclyRICOH Live Streaming REST API: Messaging Application Server API (v1)Download OpenAPI specification:DownloadRICOH Live Streaming REST API は Live Streaming サービスの REST API です。本ページは そのうちのMessaging の アプリサーバー用 REST API の仕様について記載します。Messaging REST API についてMessaging REST API は、現在 β 版として提供しております。そのため、商用サービスでの利用をご検討される際には、必ず事前にお問い合わせください。本 β 版の利用料金は無料です。正式版は有償での提供を検討しておりますので、あらかじめご了承ください。正式版を公開せずに β 版の公開を終了する、もしくは、正式版では β 版から機能や仕様が変更される可能性がありますので、あらかじめご了承ください。共通仕様HTTP レスポンスについてAPI の認証/認可に失敗した場合、ステータスコード 401 のレスポンスが返却されますPathとMethodがマッチしていない場合、ステータスコード 405 のレスポンスが返却されますサーバ内部での未知のエラーが発生した場合、ステータスコード 500 のレスポンスが返却されますイベントに対する通知についてuserがchannelに追加された時、invited_channelが送信されますuserがchannelから削除された時、banned_channelが送信されます参加しているchannelが更新された時、channel_updatedが送信されますchannel 削除、更新などにより、今までチャンネル経由でのつながりがなかったuserとの繋がりがなくなった場合には、そのユーザについてのupdate_presenceが送信されるます(banned_channelで分かる場合を除く)。Channels APIchannelの作成 channelを新規に作成しますAuthorizations:ClientBasicRequest Body schema: application/jsonnamerequiredstring <= 255 characters チャンネルの表示名user_idsrequiredArray of strings[ items <= 255 characters /^[a-zA-Z0-9.%+^_"`{|}~<>\-]{1,255}$/ ] Responses201 Channelの作成に成功400 文字数オーバーや使用できない文字が使用されているなど、リクエストの指定不備post/channelsMessaging Endpointhttps://messaging.livestreaming.mw.smart-integration.ricoh.com/channels Request samples PayloadContent typeapplication/jsonCopy Expand all Collapse all {"name": "string","user_ids": ["string"]} Response samples 201400Content typeapplication/jsonCopy Expand all Collapse all {"name": "string","channel_id": "string","user_ids": ["string"]}channel情報の取得 パラメータで指定したchannel_idに該当するchannelの情報を返しますAuthorizations:ClientBasicpath Parameterschannel_idrequiredstring Channel IDResponses200 Channel情報404 指定したchannel_idに対応するchannelが存在しませんget/channels/{channel_id}Messaging Endpointhttps://messaging.livestreaming.mw.smart-integration.ricoh.com/channels/{channel_id} Response samples 200404Content typeapplication/jsonCopy Expand all Collapse all {"name": "string","channel_id": "string","user_ids": ["string"]}channelの更新 channel_idで指定したchannelの情報を指定値で更新しますAuthorizations:ClientBasicpath Parameterschannel_idrequiredstring Channel IDRequest Body schema: application/jsonnamerequiredstring <= 255 characters チャンネルの表示名user_idsrequiredArray of strings[ items <= 255 characters /^[a-zA-Z0-9.%+^_"`{|}~<>\-]{1,255}$/ ] Responses200 Channelの更新に成功400 文字数オーバーや使用できない文字が使用されているなど、リクエストの指定不備404 指定された channel_id の Channel が存在しませんput/channels/{channel_id}Messaging Endpointhttps://messaging.livestreaming.mw.smart-integration.ricoh.com/channels/{channel_id} Request samples PayloadContent typeapplication/jsonCopy Expand all Collapse all {"name": "string","user_ids": ["string"]} Response samples 200400404Content typeapplication/jsonCopy Expand all Collapse all {"name": "string","channel_id": "string","user_ids": ["string"]}channelの削除 channel_idで指定したchannelを削除しますAuthorizations:ClientBasicpath Parameterschannel_idrequiredstring Channel IDResponses204 channel削除の受付け成功ボディは空です404 指定したchannel_idに対応するchannelが存在しませんdelete/channels/{channel_id}Messaging Endpointhttps://messaging.livestreaming.mw.smart-integration.ricoh.com/channels/{channel_id} Response samples 404Content typeapplication/jsonCopy{"error_id": "not_found","message": "string"}Users APIchannelへのUserの登録 指定したchannel_idに対応するChannelのメンバーに、user_idで指定されるユーザーを追加しますAuthorizations:ClientBasicpath Parameterschannel_idrequiredstring Channel IDuser_idrequiredstring <= 255 characters /^[a-zA-Z0-9.%+^_"`{|}~<>\-]{1,255}$/ User IDResponses200 Channelへのユーザー追加に成功400 user_id が最大文字数を超えている、または文字列ではない場合put/channels/{channel_id}/users/{user_id}Messaging Endpointhttps://messaging.livestreaming.mw.smart-integration.ricoh.com/channels/{channel_id}/users/{user_id} Response samples 200400Content typeapplication/jsonCopy{"user_id": "string"}userをchannelから削除 パラメータで指定したuser_idで表されるユーザーを、channel_idで表されるChannelから削除しますAuthorizations:ClientBasicpath Parameterschannel_idrequiredstring Channel IDuser_idrequiredstring <= 255 characters /^[a-zA-Z0-9.%+^_"`{|}~<>\-]{1,255}$/ User IDResponses204 User削除の受付け成功ボディは空です404 指定したchannel_idに対応するchannel、またはuser_idに対応するユーザーが存在しませんdelete/channels/{channel_id}/users/{user_id}Messaging Endpointhttps://messaging.livestreaming.mw.smart-integration.ricoh.com/channels/{channel_id}/users/{user_id} Response samples 404Content typeapplication/jsonCopy{"error_id": "not_found","message": "string"}Messages APImessageの投稿 パラメータで指定したchannel_idに一致するchannel内にmessageを投稿します投稿に成功すると、message_createdメッセージが、該当チャンネルに所属し接続中の全てのユーザーに送信されますuser_idで指定したユーザーが作成したという扱いになりますAuthorizations:ClientBasicpath Parameterschannel_idrequiredstring Channel IDuser_idrequiredstring <= 255 characters /^[a-zA-Z0-9.%+^_"`{|}~<>\-]{1,255}$/ User IDRequest Body schema: application/jsontyperequiredstring 実テキストか画像 URL か Markdown かなどの分類文字列bodyrequiredobject or string 投稿するmessage。文字列もしくは任意の JSON object を指定可能。object の場合、サイズの上限は文字列にエンコードして 300 万文字までResponses201 messageの受付け成功400 文字数オーバーや使用できない文字が使用されているなど、リクエストの指定不備404 指定したchannel_idに対応するchannelが存在しませんuser_idで指定したユーザがchannelのメンバーではありませんpost/channels/{channel_id}/users/{user_id}/messagesMessaging Endpointhttps://messaging.livestreaming.mw.smart-integration.ricoh.com/channels/{channel_id}/users/{user_id}/messages Request samples PayloadContent typeapplication/jsonCopy Expand all Collapse all {"type": "string","body": { }} Response samples 201400404Content typeapplication/jsonCopy Expand all Collapse all {"seq": 1,"author_id": "string","body": { },"type": "string","revision": 1,"created_at": 0,"updated_at": 0}指定したmessageの取得 指定されたchannel_idに該当するchannelがらmessageを取得しますAuthorizations:ClientBasicpath Parameterschannel_idrequiredstring Channel IDquery Parametersfromnumber messageの検索時に、検索対象とするseqの終点を指定します。つまり、fromで指定したseqから遡ってcount件のmessageが検索対象となります - 省略された場合、1が指定されたものとして動作しますcountnumber messageの検索時に、最大何件までの結果を返すかを指定します - 省略された場合、500が指定されたものとして扱われますResponses200 messageの受付け成功該当するmessageが存在しない場合でも、レスポンスコードは200が返り、空のListがレスポンスボディに格納されます400 fromやcountに負値を指定するなどのリクエストの指定不備404 指定したchannel_idが存在しませんchannel_idが存在していて、fromなどの条件で該当するmessageが存在しない場合は、レスポンスコードは200で空のListが返りますget/channels/{channel_id}/messagesMessaging Endpointhttps://messaging.livestreaming.mw.smart-integration.ricoh.com/channels/{channel_id}/messages Response samples 200400404Content typeapplication/jsonCopy Expand all Collapse all [{"seq": 1,"author_id": "string","body": { },"type": "string","revision": 1,"created_at": 0,"updated_at": 0}]指定したmessageの更新 seqで指定されたmessageを更新します更新に成功すると、message_updatedメッセージが、該当チャンネルに所属し接続中の全てのユーザーに送信されますwebsocketののupdate_messageリクエストとは異なり、どのuser_idのユーザーが作成したmessageであっても更新可能ですAuthorizations:ClientBasicpath Parameterschannel_idrequiredstring Channel IDseqrequirednumber Messageの生成時に割り振られたseq番号Request Body schema: application/jsontyperequiredstring 実テキストか画像 URL か Markdown かなどの分類文字列bodyrequiredobject or string 投稿するmessage。文字列もしくは任意の JSON object を指定可能。object の場合、サイズの上限は文字列にエンコードして 300 万文字までResponses200 messageの更新受付け成功400 サイズが大きすぎる、使用できない文字が使用されているなど、指定したmessage本文が不適切。404 指定したchannel_id、seqに対応するmessageが存在しませんput/channels/{channel_id}/messages/{seq}Messaging Endpointhttps://messaging.livestreaming.mw.smart-integration.ricoh.com/channels/{channel_id}/messages/{seq} Request samples PayloadContent typeapplication/jsonCopy Expand all Collapse all {"type": "string","body": { }} Response samples 200400404Content typeapplication/jsonCopy Expand all Collapse all {"seq": 1,"author_id": "string","body": { },"type": "string","revision": 1,"created_at": 0,"updated_at": 0}指定したmessageの削除 seqで指定されたmessageを削除します削除に成功すると、message_deletedメッセージが、該当チャンネルに所属し接続中の全てのユーザーに送信されますwebsocketののdelete_messageリクエストとは異なり、どのuser_idのユーザーが作成したmessageであっても削除可能ですAuthorizations:ClientBasicpath Parameterschannel_idrequiredstring Channel IDseqrequirednumber Messageの生成時に割り振られたseq番号Responses204 messageの削除受付け成功レスポンスボディはありません404 指定したchannel_id、seqに対応するmessageが存在しませんdelete/channels/{channel_id}/messages/{seq}Messaging Endpointhttps://messaging.livestreaming.mw.smart-integration.ricoh.com/channels/{channel_id}/messages/{seq} Response samples 404Content typeapplication/jsonCopy{"error_id": "not_found","message": "string"}Channelnamestring <= 255 characters チャンネルの表示名channel_idstring チャンネル作成時に決まる不変IDuser_idsArray of strings[ items <= 255 characters /^[a-zA-Z0-9.%+^_"`{|}~<>\-]{1,255}$/ ] Copy Expand all Collapse all {"name": "string","channel_id": "string","user_ids": ["string"]}Useruser_idstring <= 255 characters UserのIDCopy{"user_id": "string"}Messageseqinteger >= 1 channel 内で振られた連番author_idstring messageを書き込んだユーザのuser_idbodyobject or string 書き込まれた中身typestring 実テキストか画像URLか Markdownかなどの分類文字列revisioninteger >= 1 何回改訂されたか。初期値は 1created_atinteger 投稿時間(unixtime)。サーバでseqが振られた時間でありクライアントが送信した時間ではありませんupdated_atinteger 最終更新時間(unixtime)。サーバで更新が確定した時間が記録されますCopy Expand all Collapse all {"seq": 1,"author_id": "string","body": { },"type": "string","revision": 1,"created_at": 0,"updated_at": 0} const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.2","info":{"title":"RICOH Live Streaming REST API: Messaging Application Server API","version":"v1","description":"RICOH Live Streaming REST API は Live Streaming サービスの REST API です。 \n本ページは そのうちのMessaging の アプリサーバー用 REST API の仕様について記載します。\n\n### Messaging REST API について\n\n**Messaging REST API は、現在 β 版として提供しております。**
\n**そのため、商用サービスでの利用をご検討される際には、必ず事前にお問い合わせください。**
\n**本 β 版の利用料金は無料です。正式版は有償での提供を検討しておりますので、あらかじめご了承ください。**
\n**正式版を公開せずに β 版の公開を終了する、もしくは、正式版では β 版から機能や仕様が変更される可能性がありますので、あらかじめご了承ください。**
\n\n### 共通仕様\n\n- HTTP レスポンスについて\n - API の認証/認可に失敗した場合、ステータスコード 401 のレスポンスが返却されます\n - PathとMethodがマッチしていない場合、ステータスコード 405 のレスポンスが返却されます\n - サーバ内部での未知のエラーが発生した場合、ステータスコード 500 のレスポンスが返却されます\n- イベントに対する通知について\n - userがchannelに追加された時、invited_channelが送信されます\n - userがchannelから削除された時、banned_channelが送信されます\n - 参加しているchannelが更新された時、channel_updatedが送信されます\n - channel 削除、更新などにより、今までチャンネル経由でのつながりがなかったuserとの繋がりがなくなった場合には、そのユーザについてのupdate_presenceが送信されるます(banned_channelで分かる場合を除く)。\n"},"servers":[{"url":"https://messaging.livestreaming.mw.smart-integration.ricoh.com/","description":"Messaging Endpoint"}],"x-tagGroups":[{"name":"API","tags":["api_channels","api_users","api_messages"]},{"name":"スキーマ","tags":["Channel","User","Message"]}],"tags":[{"name":"api_channels","x-displayName":"Channels API"},{"name":"api_users","x-displayName":"Users API"},{"name":"api_messages","x-displayName":"Messages API"},{"name":"Channel","x-displayName":"Channel","description":""},{"name":"User","x-displayName":"User","description":""},{"name":"Message","x-displayName":"Message","description":""}],"security":[{"ClientBasic":[]}],"paths":{"/channels":{"get":{"summary":"channel一覧の取得","description":"- channelの一覧を返します\n","tags":["Channel API"],"responses":{"200":{"description":"- channelのListが返ります\n- channelが1つも存在していない場合、空のListが返ります\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}}}}},"post":{"summary":"channelの作成","description":"- channelを新規に作成します\n","tags":["api_channels"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","user_ids"],"properties":{"name":{"type":"string","maxLength":255,"description":"チャンネルの表示名"},"user_ids":{"type":"array","items":{"type":"string","pattern":"/^[a-zA-Z0-9.%+^_\"`{|}~<>\\-]{1,255}$/","maxLength":255,"description":"チャンネルに入室できる User の ID"}}}}}}},"responses":{"201":{"description":"Channelの作成に成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"400":{"description":"- 文字数オーバーや使用できない文字が使用されているなど、リクエストの指定不備\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["invalid_channel","invalid_request","invalid_name","invalid_user_ids","invalid_classification_label"]}}}]}}}}}}},"/channels/{channel_id}":{"get":{"summary":"channel情報の取得","description":"- パラメータで指定したchannel_idに該当するchannelの情報を返します\n","tags":["api_channels"],"parameters":[{"$ref":"#/components/parameters/channel_id"}],"responses":{"200":{"description":"Channel情報","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"404":{"description":"- 指定したchannel_idに対応するchannelが存在しません\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}},"put":{"summary":"channelの更新","description":"- channel_idで指定したchannelの情報を指定値で更新します\n","tags":["api_channels"],"parameters":[{"$ref":"#/components/parameters/channel_id"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["name","user_ids"],"properties":{"name":{"type":"string","maxLength":255,"description":"チャンネルの表示名"},"user_ids":{"type":"array","items":{"type":"string","pattern":"/^[a-zA-Z0-9.%+^_\"`{|}~<>\\-]{1,255}$/","maxLength":255,"description":"チャンネルに入室できる User の ID"}}}}}}},"responses":{"200":{"description":"Channelの更新に成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Channel"}}}},"400":{"description":"- 文字数オーバーや使用できない文字が使用されているなど、リクエストの指定不備\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["invalid_request","invalid_name","invalid_user_ids"]}}}]}}}},"404":{"description":"- 指定された channel_id の Channel が存在しません\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}},"delete":{"summary":"channelの削除","description":"- channel_idで指定したchannelを削除します\n","tags":["api_channels"],"parameters":[{"$ref":"#/components/parameters/channel_id"}],"responses":{"204":{"description":"- channel削除の受付け成功\n- ボディは空です\n"},"404":{"description":"- 指定したchannel_idに対応するchannelが存在しません\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}}},"/channels/{channel_id}/users/{user_id}":{"put":{"summary":"channelへのUserの登録","description":"- 指定したchannel_idに対応するChannelのメンバーに、user_idで指定されるユーザーを追加します\n","tags":["api_users"],"parameters":[{"$ref":"#/components/parameters/channel_id"},{"$ref":"#/components/parameters/user_id"}],"responses":{"200":{"description":"Channelへのユーザー追加に成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"- user_id が最大文字数を超えている、または文字列ではない場合\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["invalid_user_id"]}}}]}}}}}},"delete":{"summary":"userをchannelから削除","description":"- パラメータで指定したuser_idで表されるユーザーを、channel_idで表されるChannelから削除します\n","tags":["api_users"],"parameters":[{"$ref":"#/components/parameters/channel_id"},{"$ref":"#/components/parameters/user_id"}],"responses":{"204":{"description":"User削除の受付け成功\n- ボディは空です\n"},"404":{"description":"- 指定したchannel_idに対応するchannel、またはuser_idに対応するユーザーが存在しません\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}}},"/channels/{channel_id}/users/{user_id}/messages":{"post":{"summary":"messageの投稿","description":"- パラメータで指定したchannel_idに一致するchannel内にmessageを投稿します\n- 投稿に成功すると、message_createdメッセージが、該当チャンネルに所属し接続中の全てのユーザーに送信されます\n- user_idで指定したユーザーが作成したという扱いになります\n","tags":["api_messages"],"parameters":[{"$ref":"#/components/parameters/channel_id"},{"$ref":"#/components/parameters/user_id"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","body"],"properties":{"type":{"type":"string","description":"実テキストか画像 URL か Markdown かなどの分類文字列"},"body":{"anyOf":[{"type":"object"},{"type":"string","maxLength":4096}],"description":"- 投稿するmessage。文字列もしくは任意の JSON object を指定可能。\n- object の場合、サイズの上限は文字列にエンコードして 300 万文字まで\n"}}}}}},"responses":{"201":{"description":"messageの受付け成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"400":{"description":"- 文字数オーバーや使用できない文字が使用されているなど、リクエストの指定不備\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["invalid_message"]}}}]}}}},"404":{"description":"- 指定したchannel_idに対応するchannelが存在しません\n- user_idで指定したユーザがchannelのメンバーではありません\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}}},"/channels/{channel_id}/messages":{"get":{"summary":"指定したmessageの取得","description":"指定されたchannel_idに該当するchannelがらmessageを取得します","tags":["api_messages"],"parameters":[{"$ref":"#/components/parameters/channel_id"},{"$ref":"#/components/parameters/from"},{"$ref":"#/components/parameters/count"}],"responses":{"200":{"description":"- messageの受付け成功\n- 該当するmessageが存在しない場合でも、レスポンスコードは200が返り、空のListがレスポンスボディに格納されます\n","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}}}},"400":{"description":"- fromやcountに負値を指定するなどのリクエストの指定不備\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["invalid_message"]}}}]}}}},"404":{"description":"- 指定したchannel_idが存在しません\n - channel_idが存在していて、fromなどの条件で該当するmessageが存在しない場合は、レスポンスコードは200で空のListが返ります\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}}},"/channels/{channel_id}/messages/{seq}":{"put":{"summary":"指定したmessageの更新","description":"- seqで指定されたmessageを更新します\n- 更新に成功すると、message_updatedメッセージが、該当チャンネルに所属し接続中の全てのユーザーに送信されます\n- websocketののupdate_messageリクエストとは異なり、どのuser_idのユーザーが作成したmessageであっても更新可能です\n","tags":["api_messages"],"parameters":[{"$ref":"#/components/parameters/channel_id"},{"$ref":"#/components/parameters/seq"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["type","body"],"properties":{"type":{"type":"string","description":"実テキストか画像 URL か Markdown かなどの分類文字列"},"body":{"anyOf":[{"type":"object"},{"type":"string","maxLength":4096}],"description":"- 投稿するmessage。文字列もしくは任意の JSON object を指定可能。\n- object の場合、サイズの上限は文字列にエンコードして 300 万文字まで\n"}}}}}},"responses":{"200":{"description":"messageの更新受付け成功","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Message"}}}},"400":{"description":"- サイズが大きすぎる、使用できない文字が使用されているなど、指定したmessage本文が不適切。\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["invalid_message"]}}}]}}}},"404":{"description":"- 指定したchannel_id、seqに対応するmessageが存在しません\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}},"delete":{"summary":"指定したmessageの削除","description":"- seqで指定されたmessageを削除します\n- 削除に成功すると、message_deletedメッセージが、該当チャンネルに所属し接続中の全てのユーザーに送信されます\n- websocketののdelete_messageリクエストとは異なり、どのuser_idのユーザーが作成したmessageであっても削除可能です\n","tags":["api_messages"],"parameters":[{"$ref":"#/components/parameters/channel_id"},{"$ref":"#/components/parameters/seq"}],"responses":{"204":{"description":"- messageの削除受付け成功\n- レスポンスボディはありません\n"},"404":{"description":"- 指定したchannel_id、seqに対応するmessageが存在しません\n","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Error"},{"type":"object","properties":{"error_id":{"type":"string","enum":["not_found"]}}}]}}}}}}}},"components":{"schemas":{"Channel":{"type":"object","properties":{"name":{"type":"string","maxLength":255,"description":"チャンネルの表示名"},"channel_id":{"type":"string","description":"チャンネル作成時に決まる不変ID"},"user_ids":{"type":"array","items":{"type":"string","pattern":"/^[a-zA-Z0-9.%+^_\"`{|}~<>\\-]{1,255}$/","maxLength":255,"description":"チャンネルに入室できるUserのID"}}}},"User":{"type":"object","properties":{"user_id":{"type":"string","maxLength":255,"description":"UserのID"}}},"Message":{"type":"object","properties":{"seq":{"type":"integer","minimum":1,"description":"channel 内で振られた連番"},"author_id":{"type":"string","description":"messageを書き込んだユーザのuser_id"},"body":{"anyOf":[{"type":"object"},{"type":"string","maxLength":4096}],"description":"書き込まれた中身"},"type":{"type":"string","description":"実テキストか画像URLか Markdownかなどの分類文字列"},"revision":{"type":"integer","minimum":1,"description":"何回改訂されたか。初期値は 1"},"created_at":{"type":"integer","description":"投稿時間(unixtime)。サーバでseqが振られた時間でありクライアントが送信した時間ではありません"},"updated_at":{"type":"integer","description":"最終更新時間(unixtime)。サーバで更新が確定した時間が記録されます"}}},"Error":{"type":"object","required":["error_id"],"properties":{"error_id":{"type":"string","description":"- API を利用するプログラムが機械的に分岐することを意図したエラー内容のID\n"},"message":{"type":"string","description":"- API を利用するプログラムの開発者のデバッグ補助になるエラーメッセージ\n"}}}},"parameters":{"channel_id":{"in":"path","name":"channel_id","schema":{"type":"string"},"required":true,"description":"- Channel ID\n"},"user_id":{"in":"path","name":"user_id","schema":{"type":"string","pattern":"/^[a-zA-Z0-9.%+^_\"`{|}~<>\\-]{1,255}$/","maxLength":255},"required":true,"description":"- User ID\n"},"seq":{"in":"path","name":"seq","schema":{"type":"number"},"required":true,"description":"- Messageの生成時に割り振られたseq番号\n"},"from":{"in":"query","name":"from","schema":{"type":"number"},"required":false,"description":"- messageの検索時に、検索対象とするseqの終点を指定します。つまり、fromで指定したseqから遡ってcount件のmessageが検索対象となります - 省略された場合、1が指定されたものとして動作します\n"},"count":{"in":"query","name":"count","schema":{"type":"number"},"required":false,"description":"- messageの検索時に、最大何件までの結果を返すかを指定します - 省略された場合、500が指定されたものとして扱われます\n"}},"securitySchemes":{"ClientBasic":{"type":"http","scheme":"basic","description":"Client ID を username、Client Secretを password にした Basic 認証"}}}}},"searchIndex":{"store":["tag/api_channels","tag/api_channels/paths/~1channels/post","tag/api_channels/paths/~1channels~1{channel_id}/get","tag/api_channels/paths/~1channels~1{channel_id}/put","tag/api_channels/paths/~1channels~1{channel_id}/delete","tag/api_users","tag/api_users/paths/~1channels~1{channel_id}~1users~1{user_id}/put","tag/api_users/paths/~1channels~1{channel_id}~1users~1{user_id}/delete","tag/api_messages","tag/api_messages/paths/~1channels~1{channel_id}~1users~1{user_id}~1messages/post","tag/api_messages/paths/~1channels~1{channel_id}~1messages/get","tag/api_messages/paths/~1channels~1{channel_id}~1messages~1{seq}/put","tag/api_messages/paths/~1channels~1{channel_id}~1messages~1{seq}/delete","tag/Channel","tag/User","tag/Message"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.639,1,1.235]],["description/0",[]],["title/1",[0,0.875]],["description/1",[0,1.156,2,0.32]],["title/2",[0,0.875]],["description/2",[2,0.32,3,2.525,4,1.644]],["title/3",[0,0.875]],["description/3",[2,0.32,4,1.644,5,1.994]],["title/4",[0,0.875]],["description/4",[2,0.32,4,1.644,5,1.994]],["title/5",[1,1.235,6,1.498]],["description/5",[]],["title/6",[7,2.595]],["description/6",[2,0.32,8,2.525,9,1.994]],["title/7",[10,2.595]],["description/7",[2,0.32,9,1.994,11,2.525]],["title/8",[1,1.235,12,0.751]],["description/8",[]],["title/9",[12,1.028]],["description/9",[2,0.371,13,1.538,14,1.538,15,1.538,16,1.538,17,1.538]],["title/10",[12,1.028]],["description/10",[18,2.897,19,2.897]],["title/11",[12,1.028]],["description/11",[2,0.371,20,1.214,21,1.538,22,1.538,23,1.538,24,1.214]],["title/12",[12,1.028]],["description/12",[2,0.371,20,1.214,24,1.214,25,1.538,26,1.538,27,1.538]],["title/13",[0,0.875]],["description/13",[2,0.32,28,1.644,29,2.525]],["title/14",[6,2.049]],["description/14",[2,0.32,28,1.644,30,2.525]],["title/15",[12,1.028]],["description/15",[2,0.32,28,1.644,31,2.525]]],"invertedIndex":[["",{"_index":2,"title":{},"description":{"1":{},"2":{},"3":{},"4":{},"6":{},"7":{},"9":{},"11":{},"12":{},"13":{},"14":{},"15":{}}}],["api",{"_index":1,"title":{"0":{},"5":{},"8":{}},"description":{}}],["channel",{"_index":0,"title":{"0":{},"1":{},"2":{},"3":{},"4":{},"13":{}},"description":{"1":{}}}],["channel_idで指定したchannel",{"_index":5,"title":{},"description":{"3":{},"4":{}}}],["channel_idに一致するchannel内にmessag",{"_index":13,"title":{},"description":{"9":{}}}],["channel_idに対応するchannelのメンバーに、user_id",{"_index":8,"title":{},"description":{"6":{}}}],["channel_idに該当するchannel",{"_index":3,"title":{},"description":{"2":{}}}],["channel_idに該当するchannelがらmessag",{"_index":18,"title":{},"description":{"10":{}}}],["channels/{channel_id",{"_index":4,"title":{},"description":{"2":{},"3":{},"4":{}}}],["channels/{channel_id}/messag",{"_index":19,"title":{},"description":{"10":{}}}],["channels/{channel_id}/messages/{seq",{"_index":24,"title":{},"description":{"11":{},"12":{}}}],["channels/{channel_id}/users/{user_id",{"_index":9,"title":{},"description":{"6":{},"7":{}}}],["channels/{channel_id}/users/{user_id}/messag",{"_index":17,"title":{},"description":{"9":{}}}],["channelへのus",{"_index":7,"title":{"6":{}},"description":{}}],["href='https://livestreaming.ricoh/docs/messaging-app-client/#%e3%83%a1%e3%83%83%e3%82%bb%e3%83%bc%e3%82%b8%e3%81%ae%e4%bd%9c%e6%88%90%e9%80%9a%e7%9f%a5",{"_index":14,"title":{},"description":{"9":{}}}],["href='https://livestreaming.ricoh/docs/messaging-app-client/#%e3%83%a1%e3%83%83%e3%82%bb%e3%83%bc%e3%82%b8%e3%81%ae%e5%89%8a%e9%99%a4%e9%80%9a%e7%9f%a5",{"_index":25,"title":{},"description":{"12":{}}}],["href='https://livestreaming.ricoh/docs/messaging-app-client/#%e3%83%a1%e3%83%83%e3%82%bb%e3%83%bc%e3%82%b8%e3%81%ae%e6%9b%b4%e6%96%b0%e9%80%9a%e7%9f%a5",{"_index":21,"title":{},"description":{"11":{}}}],["messag",{"_index":12,"title":{"8":{},"9":{},"10":{},"11":{},"12":{},"15":{}},"description":{}}],["schemadefinit",{"_index":28,"title":{},"description":{"13":{},"14":{},"15":{}}}],["schemaref=\"#/components/schemas/channel",{"_index":29,"title":{},"description":{"13":{}}}],["schemaref=\"#/components/schemas/messag",{"_index":31,"title":{},"description":{"15":{}}}],["schemaref=\"#/components/schemas/us",{"_index":30,"title":{},"description":{"14":{}}}],["seqで指定されたmessag",{"_index":20,"title":{},"description":{"11":{},"12":{}}}],["target='_parent'>message_createdメッセージmessage_deletedメッセージmessage_updatedメッセージ