GS2-Inbox

メッセージ受信時

メッセージ受信時に呼び出されます。 このイベントが発生した瞬間にはまだメッセージの受信は実行されておらず、スクリプトの結果として「受信を許可しない」というレスポンスを返すことが出来ます。 また、このスクリプトをレスポンスした後、何らかのエラーが発生した場合には、メッセージの受信が失敗する可能性があります。

Request

{
  inboxName=[string] GS2-Inbox の受信ボックス名,
  userId=[string] ユーザID,
  message=[string] メッセージデータ,
  cooperation=[bool] 連携用URLを呼び出すか,
}

Response

{
  permit=[bool] メッセージの受信を許可するか,
  (overrideMessage=[string] 実際に適用するメッセージデータ)
  (overrideCooperation=[bool] 実際に適用する連携用URLを呼び出すか)
}

メッセージ受信完了時

メッセージの受信が完了した時に呼び出されます。 このイベントが発生した瞬間にはメッセージの受信が完了されていることが保証されています。

Request

{
  inboxName=[string] GS2-Inbox の受信ボックス名,
  userId=[string] ユーザID,
  messageId=[string] メッセージID,
  message=[string] メッセージデータ,
  cooperation=[bool] 連携用URLを呼び出すか,
}

メッセージ開封時

メッセージ開封時に呼び出されます。 このイベントが発生した瞬間にはまだメッセージの開封は実行されておらず、スクリプトの結果として「開封を許可しない」というレスポンスを返すことが出来ます。 また、このスクリプトをレスポンスした後、何らかのエラーが発生した場合には、メッセージの開封が失敗する可能性があります。

Request

{
  inboxName=[string] GS2-Inbox の受信ボックス名,
  messages=[{
    userId=[string] ユーザID,
    messageId=[string] メッセージID,
    message=[string] メッセージデータ,
    cooperation=[bool] 連携用URLを呼び出すか,
  }]
  accessToken=[string] アクセストークン,
}

Response

{
  permit=[bool] メッセージの開封を許可するか,
}

メッセージ開封完了時

メッセージの開封が完了した時に呼び出されます。 このイベントが発生した瞬間にはメッセージの開封が完了されていることが保証されています。

Request

{
  inboxName=[string] GS2-Inbox の受信ボックス名,
  messages=[{
    userId=[string] ユーザID,
    messageId=[string] メッセージID,
    message=[string] メッセージデータ,
    cooperation=[bool] 連携用URLを呼び出すか,
  }]
  accessToken=[string] アクセストークン,
}

メッセージ削除時

メッセージ削除時に呼び出されます。 このイベントが発生した瞬間にはまだメッセージの削除は実行されておらず、スクリプトの結果として「削除を許可しない」というレスポンスを返すことが出来ます。 また、このスクリプトをレスポンスした後、何らかのエラーが発生した場合には、メッセージの削除が失敗する可能性があります。

Request

{
  inboxName=[string] GS2-Inbox の受信ボックス名,
  messages=[{
    userId=[string] ユーザID,
    messageId=[string] メッセージID,
    message=[string] メッセージデータ,
    cooperation=[bool] 連携用URLを呼び出すか,
  }]
  accessToken=[string] アクセストークン,
}

Response

{
  permit=[bool] メッセージの削除を許可するか,
}

メッセージ削除完了時

メッセージの削除が完了した時に呼び出されます。 このイベントが発生した瞬間にはメッセージの削除が完了されていることが保証されています。

Request

{
  inboxName=[string] GS2-Inbox の受信ボックス名,
  messages=[{
    userId=[string] ユーザID,
    messageId=[string] メッセージID,
    message=[string] メッセージデータ,
    cooperation=[bool] 連携用URLを呼び出すか,
  }]
  accessToken=[string] アクセストークン,
}