Skip to main content

Guide & Help Session

Helper guide sessions: creating, messaging, inviting, and resolving help requests.

C→S 3338 - RequestGuideAssistance

Nitro: GUIDE_SESSION_CREATE

Source: RequestGuideAssistanceEvent, GuideSessionCreateMessageComposer

Creates a new help request, sending the request type and the user's help message to be matched with an available guide.

Body:
type: int

C→S 1922 - RequestGuideTool

Nitro: GUIDE_SESSION_ON_DUTY_UPDATE

Source: RequestGuideToolEvent, GuideSessionOnDutyUpdateMessageComposer

Updates the guide's on-duty status and the types of requests (tours, help, bully reports) they are willing to handle.

Body:
onDuty: boolean
tourRequests: boolean
helperRequests: boolean

C→S 291 - GuideCancelHelpRequest

Nitro: GUIDE_SESSION_REQUESTER_CANCELS

Source: GuideCancelHelpRequestEvent, GuideSessionRequesterCancelsMessageComposer

Cancels the user's pending help request before a guide has been matched.

Body: (empty)

C→S 887 - GuideCloseHelpRequest

Nitro: GUIDE_SESSION_RESOLVED

Source: GuideCloseHelpRequestEvent, GuideSessionResolvedMessageComposer

Marks the active guide session as resolved from the requester's side.

Body: (empty)

C→S 1424 - GuideHandleHelpRequest

Nitro: GUIDE_SESSION_GUIDE_DECIDES

Source: GuideHandleHelpRequestEvent, GuideSessionGuideDecidesMessageComposer

Sends the guide's decision to accept or decline an incoming help request.

Body: (empty)

C→S 234 - GuideInviteUser

Nitro: GUIDE_SESSION_INVITE_REQUESTER

Source: GuideInviteUserEvent, GuideSessionInviteRequesterMessageComposer

Sends an invitation to the help requester to join the guide's room.

Body: (empty)

C→S 1052 - GuideVisitUser

Nitro: GUIDE_SESSION_GET_REQUESTER_ROOM

Source: GuideVisitUserEvent, GuideSessionGetRequesterRoomMessageComposer

Requests the help requester's current room so the guide can navigate there.

Body: (empty)

C→S 519 - GuideUserTyping

Nitro: GUIDE_SESSION_IS_TYPING

Source: GuideUserTypingEvent, GuideSessionIsTypingMessageComposer

Sends the guide's current typing indicator state to the other session participant.

Body: (empty)

C→S 3899 - GuideUserMessage

Nitro: GUIDE_SESSION_MESSAGE

Source: GuideUserMessageEvent, GuideSessionMessageMessageComposer

Sends a chat message within the active guide help session.

Body: (empty)

C→S 477 - GuideRecommendHelper

Nitro: GUIDE_SESSION_FEEDBACK

Source: GuideRecommendHelperEvent, GuideSessionFeedbackMessageComposer

Submits post-session feedback, indicating whether the user recommends the guide.

Body: (empty)

C→S 3969 - GuideReportHelper

Nitro: GUIDE_SESSION_REPORT

Source: GuideReportHelperEvent, GuideSessionReportMessageComposer

Reports the guide for misconduct during the help session, including a message describing the issue.

Body: (empty)

C→S 1691 - Report

Nitro: CALL_FOR_HELP

Source: ReportEvent, CallForHelpMessageComposer

FieldTypeNotes
(body not confirmed)-General CFH report; body likely includes topic + message

Submits a general Call for Help (CFH) report.

C→S 534 - ReportThread

Nitro: CALL_FOR_HELP_FROM_FORUM_THREAD

Source: ReportThreadEvent, CallForHelpFromForumThreadMessageComposer

FieldTypeNotes
(body not confirmed)-Reports a guild forum thread to CFH

Reports a guild forum thread to CFH.

C→S 1412 - ReportComment

Nitro: CALL_FOR_HELP_FROM_FORUM_MESSAGE

Source: ReportCommentEvent, CallForHelpFromForumMessageMessageComposer

FieldTypeNotes
(body not confirmed)-Reports a guild forum comment to CFH

Reports a guild forum comment to CFH.

C→S 2492 - ReportPhoto

Nitro: CALL_FOR_HELP_FROM_PHOTO

Source: ReportPhotoEvent, CallForHelpFromPhotoMessageComposer

FieldTypeNotes
(body not confirmed)-Reports a room photo to CFH

Reports a user-uploaded room photo to the Call-for-Help moderation system.

C→S 3060 - ReportBully

Nitro: CHAT_REVIEW_SESSION_CREATE

Source: ReportBullyEvent, ChatReviewSessionCreateMessageComposer

FieldTypeNotes
(body not confirmed)-Creates a Guardian/bully-review session

Creates a Guardian anti-bully review session.

C→S 3786 - RequestReportUserBullying

Nitro: GET_GUIDE_REPORTING_STATUS

Source: RequestReportUserBullyingEvent, GetGuideReportingStatusMessageComposer

FieldTypeNotes
(empty)-No body fields read

Notes: Requests the current guide/guardian duty status for the user. Response is GUIDE_REPORTING_STATUS (S→C 3463).

Requests the current guide/guardian duty and reporting status.


C→S 2755 - CallForHelpFromSelfie

Nitro: CALL_FOR_HELP_FROM_SELFIE Note: No Arcturus handler - Nitro only. Source: CallForHelpFromSelfieMessageComposer

FieldTypeNotes
kstringPhoto URL or identifier
_arg_2intUnknown int
_arg_3intUnknown int
_arg_4stringAdditional description or comment
_arg_5intUnknown int

Reports a photo/selfie via CFH. Nitro-only.

C→S 196 - RequestTalenTrack

Nitro: HELPER_TALENT_TRACK

Source: RequestTalentTrackEvent, TalentTrackComposer

FieldTypeNotes
(empty)-No body fields read

Notes: Note the typo in the Arcturus class name: RequestTalenTrackEvent (missing 't'). Requests the user's talent track progress. Response is HELPER_TALENT_TRACK (S→C 3406).

Requests the user's talent track progress data. (Note: typo in Arcturus class name.)

Requests the user's talent track progress data. Note: class name has a typo ('Talen' instead of 'Talent').

S→C 1548 - GuideTools

Nitro: GUIDE_ON_DUTY_STATUS

Source: GuideToolsComposer, GuideOnDutyStatusMessageEvent

FieldTypeNotes
onDutybooleanWhether the user is currently on duty as a guide
guidesOnDutyintAlways 0 in Arcturus
helpersOnDutyintNumber of active helpers/guides
guardiansOnDutyintNumber of active guardians

Delivers the guide duty status (on/off-duty, helper/guardian counts) for the guide tools panel.

S→C 3209 - GuideSessionStarted

Nitro: GUIDE_SESSION_STARTED

Source: GuideSessionStartedComposer, GuideSessionStartedMessageEvent

FieldTypeNotes
noobIdintAccount ID of the help requester
noobNamestringUsername of the requester
noobLookstringFigure string of the requester
helperIdintAccount ID of the guide/helper
helperNamestringUsername of the guide
helperLookstringFigure string of the guide

Notifies both guide and requester that a help session has been matched and started.

S→C 1591 - GuideSessionAttached

Nitro: GUIDE_SESSION_ATTACHED

Source: GuideSessionAttachedComposer, GuideSessionAttachedMessageEvent

FieldTypeNotes
isHelperbooleanTrue if the recipient is the helper (guide); false if requester
tourTypeintAlways 1
helpRequeststringThe help request message
waitTimeintFor helper: 60 seconds; for requester: average wait time

Attaches the client to an active guide session, delivering the help request text and wait time.

S→C 138 - GuideSessionDetached

Nitro: GUIDE_SESSION_DETACHED Source: GuideSessionDetachedComposer, GuideSessionDetachedMessageEvent

(Guide & Help Session - no Arcturus composer)

Sent to both requester and guide when a help session is detached (e.g., guide left, session timed out).

Notifies both the requester and guide that a help session has been detached (ended without completion).

Body: (empty)

S→C 1456 - GuideSessionEnded

Nitro: GUIDE_SESSION_ENDED

Source: GuideSessionEndedComposer, GuideSessionEndedMessageEvent

FieldTypeNotes
errorCodeintEnd reason / error code

Notifies both parties that the guide session has ended, with an end reason code.

S→C 841 - GuideSessionMessage

Nitro: GUIDE_SESSION_MESSAGE

Source: GuideSessionMessageComposer, GuideSessionMessageMessageEvent

FieldTypeNotes
messagestringChat message text
senderIdintAccount ID of the sender

Delivers a chat message sent within the guide session.

S→C 1016 - GuideSessionPartnerIsTyping

Nitro: GUIDE_SESSION_PARTNER_IS_TYPING

Source: GuideSessionPartnerIsTypingComposer, GuideSessionPartnerIsTypingMessageEvent

FieldTypeNotes
isTypingbooleanTrue if the partner is currently typing

Notifies the session participant that their partner is currently typing.

S→C 219 - GuideSessionInvitedToGuideRoom

Nitro: GUIDE_SESSION_INVITED_TO_GUIDE_ROOM

Source: GuideSessionInvitedToGuideRoomComposer, GuideSessionInvitedToGuideRoomMessageEvent

FieldTypeNotes
roomIdintRoom ID of the guide's room (0 if no room)
roomNamestringName of the guide's room (empty if no room)

Notifies the requester that the guide has invited them to their room.

S→C 1847 - GuideSessionRequesterRoom

Nitro: GUIDE_SESSION_REQUESTER_ROOM

Source: GuideSessionRequesterRoomComposer, GuideSessionRequesterRoomMessageEvent

FieldTypeNotes
roomIdintRoom ID of the help requester (0 if not in a room)

Delivers the help requester's current room ID to the guide.

S→C 673 - GuideSessionError

Nitro: GUIDE_SESSION_ERROR

Source: GuideSessionErrorComposer, GuideSessionErrorMessageEvent

FieldTypeNotes
errorCodeintError code for the guide session problem

Notifies a session participant of an error in the guide session.

S→C 3285 - GuideTicketCreationResult

Nitro: GUIDE_TICKET_CREATION_RESULT Note: No Arcturus composer - Nitro only. Source: BullyReportedMessageComposer, GuideTicketCreationResultMessageEvent

FieldTypeNotes
resultint0=ok, 1=unable to report, 2=no chatlog found, 3=bully already reported

Delivers the result of creating a Guardian/bully ticket. Nitro-only.

S→C 2674 - GuideTicketResolution

Nitro: GUIDE_TICKET_RESOLUTION Note: No Arcturus composer - Nitro only. Source: BullyReportClosedComposer, GuideTicketResolutionMessageEvent

FieldTypeNotes
resolutionint0=guardians_took_action, 1=forwarded_to_mods, 2=reporter_is_abusive

Delivers the resolution outcome of a Guardian/bully ticket. Nitro-only.

S→C 3463 - GuideReportingStatus

Nitro: GUIDE_REPORTING_STATUS Note: No Arcturus composer - Nitro only. Source: BullyReportRequestComposer, GuideReportingStatusMessageEvent

FieldTypeNotes
statusCodeint0=ok, 1=pending ticket, 2=abusive, 3=reporting_too_quickly
ticketIssueIdintPending ticket issue ID
reportedUserIdintReported user account ID
isAutobooleanWhether the ticket was auto-created
reportedUserNamestringReported username
reporterUserNamestringReporter username
roomNamestringRoom name where incident occurred
messagestringTicket message

Delivers the current guide/guardian reporting status for the user. Nitro-only.

S→C 2998 - BadgeRequestFulfilled

Nitro: BADGE_REQUEST_FULFILLED Note: No Arcturus composer - Nitro only. Source: HotelViewBadgeButtonConfigComposer, IsBadgeRequestFulfilledEvent

FieldTypeNotes
requestCodestringBadge request code
fulfilledbooleanWhether the badge request was fulfilled

Delivers whether a hotel view badge request has been fulfilled for the user. Nitro-only.

S→C 3796 - CfhReply

Nitro: CFH_REPLY Note: No Arcturus composer - Nitro only. Source: ModToolIssueResponseAlertComposer, CallForHelpReplyMessageEvent

(no Arcturus composer)

CFH reply message. Body is parsed by CallForHelpReplyMessageEvent.

Delivers the moderator's reply to a Call-for-Help report. Nitro-only.

Body: (empty)

S→C 3406 - HelperTalentTrack

Nitro: HELPER_TALENT_TRACK Note: No Arcturus composer - Nitro only. Source: TalentTrackComposer, TalentTrackMessageEvent

(no Arcturus composer)

Full talent track data. Body is parsed by TalentTrackMessageEvent / TalentTrackParser.

Delivers full talent track progress data to the client. Nitro-only.

Body: (empty)

S→C 30 - ChatReviewSessionDetached

Nitro: CHAT_REVIEW_SESSION_DETACHED Note: No Arcturus composer - Nitro only. Source: GuardianVotingTimeEnded, ChatReviewSessionDetachedMessageEvent

(no Arcturus composer)

Sent when the chat review session is detached (guide left or session ended without review).

Notifies the client that the chat review voting session has ended without a review result. Nitro-only.

Body: (empty)

S→C 143 - ChatReviewSessionStarted

Nitro: CHAT_REVIEW_SESSION_STARTED Note: No Arcturus composer - Nitro only. Source: GuardianVotingRequestedComposer, ChatReviewSessionStartedMessageEvent

(no Arcturus composer)

FieldTypeNotes
votingTimeoutintSeconds until the voting window closes
chatRecordstringThe chat message text being reviewed

Notifies a Guardian that a chat review session has been started for a reported message. Nitro-only.

S→C 735 - ChatReviewSessionOfferedToGuide

Nitro: CHAT_REVIEW_SESSION_OFFERED_TO_GUIDE Note: No Arcturus composer - Nitro only. Source: GuardianNewReportReceivedComposer, ChatReviewSessionOfferedToGuideMessageEvent

(no Arcturus composer)

FieldTypeNotes
acceptanceTimeoutintSeconds the guide has to accept the chat review offer

Offers a chat review session to an available Guardian guide. Nitro-only.

S→C 1829 - ChatReviewSessionVotingStatus

Nitro: CHAT_REVIEW_SESSION_VOTING_STATUS Note: No Arcturus composer - Nitro only. Source: GuardianVotingVotesComposer, ChatReviewSessionVotingStatusMessageEvent

(no Arcturus composer)

Delivers the current voting status for all participants in the chat review session.

FieldTypeNotes
countintNumber of participant status entries
[count × status]int0=awaiting, 1=voted_ok, 2=voted_bad, 3=voted_very_bad, 4=no_vote, 5=finding_new_voter

Delivers the current vote tally for an active chat review session. Nitro-only.

S→C 3276 - ChatReviewSessionResults

Nitro: CHAT_REVIEW_SESSION_RESULTS Note: No Arcturus composer - Nitro only. Source: GuardianVotingResultComposer, ChatReviewSessionResultsMessageEvent

FieldTypeNotes
winningVoteCodeintVote code of the winning option
ownVoteCodeintThe current user's vote code
countintNumber of participant status entries
[count × status]intFinal vote status per participant

Delivers the final voting results of a Guardian chat review session, including the winning vote and each participant's vote.