API リファレンス

サポート API

サポート

HTTP リファレンス。 バックエンド契約から生成。以下のエンドポイントを参照するか、OpenAPI をダウンロードしてください。

このグループには 9 件のオペレーションがあり、api/openapi.yaml から生成されています。パス、アクション、認証で絞り込めます。各エンドポイントには入力が一覧され、展開するとリクエストテンプレートとレスポンスコードを確認できます。テンプレートには、ご自身の値とスキーマに適合する本文が必要です。

大文字のプレースホルダーをあなたの値に置き換えます。JSONリクエストの場合、request.jsonのスキーマに合うボディを保存します。Cookie例は認証済みセッションのローカルCookieジャーを使用します。

サポート

POST/website/support-messages

ウェブサイトからお問い合わせを送信する

ウェブサイトのお問い合わせフォーム用の、同一オリジンからの匿名JSON受付です。サイトのOriginヘッダーと、英字・数字・ハイフン・アンダースコアで構成される20~128文字のIdempotency-Keyが必要です。アカウントやセッションは作成しません。受領を通知する前にメッセージと返信先メールアドレスを保存し、サポート処理が設定済みのSlackサポートチャンネルへ送信します。

訪問者が入力したメールアドレスは連絡先情報であり、本人確認の証明にはなりません。同一内容の再試行には再配信せず同じ受領確認を返します。同じキーで本文を変更するとidempotency_mismatchになります。

新規メッセージはクライアントIPごとに毎時10件(IPv6は/64単位)、メールアドレスごとに1日3件、全体で毎時200件までです。すべてのリクエストにはIPごとに毎分120件の共通上限があります。Retry-Afterに従ってください。配信に失敗したメッセージは待機列に残り、配信済みレコードは30日後に期限切れになります。

認証
なし
リクエスト本文
object
操作ID
submitWebsiteSupportMessage

パラメーター

名前送信する必須?説明
オリジンヘッダー必須
Idempotency-Keyヘッダー必須

リクエスト本文フィールド

フィールド説明
email(必須、文字列)maxLength:254 フォーマット:「email」
message(必須、文字列)段落とインデントを保持する原文のメッセージ。空白文字のみのテキストは拒否されます。minLength: 1 maxLength: 4000
website(任意、文字列)スパム対策フィールド。空のままにしてください。maxLength: 200
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Origin: https://screenrig.ai' --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/website/support-messages'

レスポンス

ステータス意味本文とヘッダー
202配信用にメッセージを保存、または同一内容の再試行を確認しました。連絡先データは含まれません。オブジェクト (application/json); ヘッダー: Cache-Control
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/support/status

サポート状況

アクティブなすべてのプロジェクトの可用性と時間。chat_allowed は Standard を含むすべてのアクティブなプロジェクトで true です。human_available は、リクエストに応じて担当者がチャットに参加できる場合に true です(Education、Premium、Enterprise)。Standard と Plus にはドキュメントと AI サポートがあります。staffed は、スタッフが現在対応時間内かどうかを示します。Luna はすべてのプランですぐに回答します。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
supportStatus

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/support/status'

レスポンス

ステータス意味本文とヘッダー
200サポート結果。SupportStatus(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/support/conversations

サポート会話一覧

プロジェクトの会話は最新順で最大100件です。スタッフの未読数は認証されたユーザーまたはエージェントごとにカウントされます。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listSupportConversations

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
beforeクエリオプション前のページの次のカーソルからの会話 ID。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/support/conversations'

レスポンス

ステータス意味本文とヘッダー
200サポート結果。SupportConversationList(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/support/conversations

サポート会話を作成

すべてのプランで利用可能。Luna が最初にすぐ回答します。担当者が参加できる場合(サポートステータスの human_available)は、リクエストすると Luna が一時停止してスタッフが対応します。Standard と Plus では無視され、Luna が回答します。保存または Slack 送信前にスクリーニングされます。

8文字未満または3語未満の開始メッセージは submission_too_short を返します。質問や問題でないものは submission_unclear を返します。スパム、リンク過多のテキスト、プロンプトインジェクション、安全でないテキストは submission_rejected を返します。拒否されたテキストは保持されず Luna に送信されません。問題の詳細は繰り返し表示されません。

ScreenRig 資格情報以外の資格情報形式のテキスト(ベアラートークン、クラウドおよび API キー、秘密鍵)は保存前に [redacted] に置き換えられます。ScreenRig 資格情報は invalid_request を返します。新しい会話は1つの Slack スレッドで開始され、フォローアップはその中に残ります。同じキーのリクエストは24時間リプレイされます。拒否も含みます。

認証
projectBearer または dashboardSession
リクエスト本文
SupportWrite
操作ID
createSupportConversation

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
Idempotency-Keyヘッダー必須

リクエスト本文フィールド

フィールド説明
body(必須、文字列)minLength: 1 maxLength: 4000
human_requested(任意、真偽値)

担当者を呼び出し、Luna を一時停止してスタッフを待ちます。担当者が参加できる場合にのみ有効です(human_available:Education、Premium、Enterprise)。Standard と Plus では無視され、Luna が回答します。デフォルト:false

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/support/conversations'

レスポンス

ステータス意味本文とヘッダー
201サポート結果。SupportSubmission(application/json)
422メッセージはスクリーニングで拒否されました:submission_too_shortまたはsubmission_unclear(最初のメッセージのみ)、またはsubmission_rejected。詳細はテキストを繰り返しません。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/api/support/conversations/{id}/messages

サポートメッセージ一覧

プロジェクト会話のメッセージ、昇順シーケンス、最大100件。古い会話のページネーションは最後のメッセージシーケンスの後に続きます。読み取りはスタッフの未読状態を認識しません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
listSupportMessages

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
以降クエリオプションプロジェクトサポートメッセージのシーケンス;この位置の後に厳密に再開します。
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/messages'

レスポンス

ステータス意味本文とヘッダー
200サポート結果。SupportMessageList(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/support/conversations/{id}/messages

サポート会話に返信

オープンな会話に顧客メッセージを追加します。フォローアップは最小長がなく、単独で不明瞭として拒否されません(「ありがとう」「はい」)。安全性、プロンプトインジェクション、リンクスパムを検査し、submission_rejectedで拒否し、資格情報形テキストは新しい会話と同様に処理されます。

拒否されたテキストは保持されず、拒否は同じキーで24時間再生されます。

認証
projectBearer または dashboardSession
リクエスト本文
SupportWrite
操作ID
replySupportConversation

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
Idempotency-Keyヘッダー必須

リクエスト本文フィールド

フィールド説明
body(必須、文字列)minLength: 1 maxLength: 4000
human_requested(任意、真偽値)

担当者を呼び出し、Luna を一時停止してスタッフを待ちます。担当者が参加できる場合にのみ有効です(human_available:Education、Premium、Enterprise)。Standard と Plus では無視され、Luna が回答します。デフォルト:false

リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/messages'

レスポンス

ステータス意味本文とヘッダー
201サポート結果。SupportSubmission(application/json)
422メッセージはスクリーニングで拒否されました:submission_too_shortまたはsubmission_unclear(最初のメッセージのみ)、またはsubmission_rejected。詳細はテキストを繰り返しません。問題 (application/problem+json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
PUT/api/support/conversations/{id}/read

サポート会話を読む

このリーダーのためにシーケンスを通じて単調にメッセージを承認します。会話の last_sequence を超えて承認できません。

認証
projectBearer または dashboardSession
リクエスト本文
SupportRead
操作ID
readSupportConversation

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須

リクエスト本文フィールド

フィールド説明
sequence(必須、整数)最小値: 0
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/read'

レスポンス

ステータス意味本文とヘッダー
200サポート結果。SupportRead(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
POST/api/support/conversations/{id}/close

サポート会話を閉じる

このプロジェクトの会話を終了し、保留中のAI返信をキャンセルします。繰り返し可能で履歴を保持します。スタッフはSlackで再開できます。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
closeSupportConversation

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
IDパス必須
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/support/conversations/RESOURCE_ID/close'

レスポンス

ステータス意味本文とヘッダー
200会話を閉じました。SupportConversation(application/json)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)
GET/stream/support

ストリームサポートメッセージ

すべてのプランでのプロジェクトサポートメッセージは再開可能なSSEです。eventはsupport.message、idはプロジェクトサポートシーケンス、dataはSupportMessageです。afterはLast-Event-IDより優先されます。カーソル0は履歴を再生します。スタッフ、顧客、AIメッセージは役割で区別されます。ストリームは資格情報とアクティブなプロジェクトアクセスを再検証します。

スクリーンショットや認証情報は送信されません。

認証
projectBearer または dashboardSession
リクエスト本文
なし
操作ID
streamSupportMessages

パラメーター

名前送信する必須?説明
ScreenRig-Projectヘッダーオプション1リリースの間非推奨。JWTプロジェクトの権限と整合性が必要。Deprecation と Warning ヘッダーを追加。トークン交換なし。
以降クエリオプションプロジェクトサポートメッセージのシーケンス;この位置の後に厳密に再開します。
Last-Event-IDヘッダーオプション
リクエストテンプレートとレスポンス
シェル・リクエストテンプレート
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/stream/support'

レスポンス

ステータス意味本文とヘッダー
200サポートメッセージSSE。string (text/event-stream)
デフォルト

安定した RFC 9457 問題応答。421 server_draining は Retry-After 1秒、500 not_ready または dependency_unavailable は 5秒、500 manifest_degraded は 60秒を持ちます。ハンドラーがより具体的な値を設定していない場合。

問題 (application/problem+json)