package mobile.matching.v1

Get desktop application:
View/edit binary Protocol Buffers messages

These endpoints facilitate clients starting, ending and voting on anonymous chat sessions

• rpc FindChatPartner (FindChatPartnerRequest, FindChatPartnerResponse)

  anon_matching_service.proto:18

  Finds a chat partner, starting a new chat session request or updates an existing request if there's already something in the queue

  message FindChatPartnerRequest

  anon_matching_service.proto:46

  If the user already has an ongoing search in the queue, it will be updated by sending another FindChatPartnerRequest. It is considered normal behaviour and no exception or warning or special status code is returned

  • repeated ChatInterest interests = 1

    If no interests are included in this request, this is considered a "quick chat", and users will be matched with anyone.

  • string matching_variant = 2

    Matching Variant defines the queue to search a partner. If a value is not provided, the default queue will be used. For certain whitelisted accounts (QA accounts), a different queue is used. Providing a value for matching_variant will override any other default queue setting.

  message FindChatPartnerResponse

  anon_matching_service.proto:63

  • FindChatPartnerResponse.Result result = 1

  • optional common.XiUuid find_chat_request_id = 2

    The optional id of the request, can be used to cancel this request if in queue Will not be present unless result = (PARTNER_FOUND or IN_QUEUE)

  • optional SessionDetails session_details = 3

    optional, will only be present if result = PARTNER_FOUND

  • optional google.protobuf.Timestamp rejected_expiry_time = 4

    In case of a rejection, this is the (UTC) timestamp of when the user will be allowed to return and request a new anon-chat. Will only be present if the rejection is for any reason that can expire such as REJECTED_NO_REMAINING_SESSIONS or REJECTED_TEMPORARILY_BANNED

• rpc CancelFindChatPartner (CancelFindChatPartnerRequest, CancelFindChatPartnerResponse)

  anon_matching_service.proto:22

  Cancels a find chat partner request. If a session has already been created, it will not be cancelled, and the session details will still be returned to clients as normal

  message CancelFindChatPartnerRequest

  anon_matching_service.proto:100

  • optional common.XiUuid find_chat_request_id = 1

    The id that was returned by the FindChatPartnerResponse should be used here to cancel the request

  message CancelFindChatPartnerResponse

  anon_matching_service.proto:105

  • CancelFindChatPartnerResponse.Result result = 1

• rpc EndChatSession (EndChatSessionRequest, EndChatSessionResponse)

  anon_matching_service.proto:27

  Ends a chat session before the chat expiry duration. The other chat partner will be notified that the chat has ended prematurely, and the chat session will be marked for eventual cleanup

  message EndChatSessionRequest

  anon_matching_service.proto:160

  • optional common.matching.v1.AnonMatchingSessionKey session_key = 1

  message EndChatSessionResponse

  anon_matching_service.proto:166

  • EndChatSessionResponse.Result result = 1

• rpc GetChatSession (GetChatSessionRequest, GetChatSessionResponse)

  anon_matching_service.proto:30

  Returns session details

  message GetChatSessionRequest

  anon_matching_service.proto:118

  • optional common.matching.v1.AnonMatchingSessionKey session_key = 1

  message GetChatSessionResponse

  anon_matching_service.proto:124

  • GetChatSessionResponse.Result result = 1

  • optional SessionDetails session_details = 2

    Will only be present if Result = OK

• rpc GetRemainingAnonChats (GetRemainingAnonChatsRequest, GetRemainingAnonChatsResponse)

  anon_matching_service.proto:40

  Used by clients to query the number of chats the server will allow a user before they are rate limited

  message GetRemainingAnonChatsRequest

  anon_matching_service.proto:173

  empty placeholder. Currently we get user jid from the request header

  (message has no fields)

  message GetRemainingAnonChatsResponse

  anon_matching_service.proto:177

  • GetRemainingAnonChatsResponse.Result result = 1

  • int32 remaining_chats = 2

    The number of chats remaining in a (configurable) time period.

Used in: CancelFindChatPartnerResponse

• OK = 0

  Find chat session request successfully cancelled

• SESSION_ALREADY_CREATED = 1

  Chat session has already been created, the session will not be cancelled, details will be included in the same way that clients waiting after a FindChatSessionResponse.Result.IN_QUEUE receive them

Represents a chat interest that the user optionally selects for chat matching

Used in: FindChatPartnerRequest

• string interest_id = 1

• string interest_name = 2

Used in: EndChatSessionResponse

• OK = 0

Used in: FindChatPartnerResponse

• PARTNER_FOUND = 0

  Chat partner immediately found and will be returned with this response

• IN_QUEUE = 1

  Chat partner not found (yet), user has been put in queue

• REJECTED = 2

  The rejected response is a general rejection status that encompasses any rejections not covered by other REJECTED_* result codes, such as too many active chat sessions, or Bouncer rejections (spam analysis) If the user is in the queue already his requested is updated but not rejected

• REJECTED_NO_REMAINING_SESSIONS = 3

  User has exceeded their daily limit of sessions

• REJECTED_TEMPORARILY_BANNED = 4

  User is temporarily banned for bad behavior

Used in: GetChatSessionResponse

• OK = 0

  Chat session found, details will be provided.

• NOT_FOUND = 1

  Chat session not found. Either invalid id or session already cleaned up.

Used in: GetRemainingAnonChatsResponse

• OK = 0

Contains details of a 1on1 anonymous chat match session

Used in: FindChatPartnerResponse, GetChatSessionResponse

• optional common.XiUuid session_id = 1

  The session id

• optional common.v1.XiAliasJid chat_partner_alias = 3

  The alias jid of the chat partner.

• optional google.protobuf.Timestamp session_end_time = 4

  Chat session end time (UTC)

• optional google.protobuf.Timestamp session_expiry_time = 5

  Session vote expiry (UTC), the session could be cleaned up any time after this. no further actions can be taken on this session after this time.

• common.matching.v1.ChatSessionState session_state = 6