package mobile.groups.v2

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetGroupInfoFull (GetGroupInfoFullRequest, GetGroupInfoFullResponse)

  group_service.proto:17

  Get full group information for a given group chat.

  message GetGroupInfoFullRequest

  group_service.proto:69

  • optional common.v2.ChatId chat_id = 1

  • optional common.v2.PersonaId requestor_persona_id = 2

    Persona with the necessary permissions in the group chat to view full group chat info.

  message GetGroupInfoFullResponse

  group_service.proto:80

  • GetGroupInfoFullResponse.Result result = 1

  • optional common.chats.v2.GroupInfoFull info = 2

    Set if result == OK.

• rpc GetBannedGroupMembersStream (GetBannedGroupMembersStreamRequest, stream GetBannedGroupMembersStreamResponse)

  group_service.proto:20

  Streams batches of banned group members in the given group chat.

  message GetBannedGroupMembersStreamRequest

  group_service.proto:93

  • optional common.v2.ChatId chat_id = 1

  • optional common.v2.PersonaId requestor_persona_id = 2

    Persona with the necessary permissions in the group chat to view banned members.

  message GetBannedGroupMembersStreamResponse

  group_service.proto:104

  • GetBannedGroupMembersStreamResponse.Result result = 1

  • repeated BannedGroupMember banned_group_members = 2

    Set if result == OK

• rpc CreateGroup (CreateGroupRequest, CreateGroupResponse)

  group_service.proto:23

  Create a group chat. Returns a ChatId corresponding to the created group chat.

  message CreateGroupRequest

  group_service.proto:128

  • optional common.v2.PersonaId creator_id = 1

    Creator of the group.

  • repeated common.v2.PersonaId initial_members = 2

    Initial members of the group NOT including the group creator. Note that the upper bound on the number of members in a group is a configuration setting and likely to be less than 1024.

  • optional GroupName group_name = 3

    Optional name of the group.

  • optional common.groups.v2.PublicGroupFields public_group_fields = 4

    Set this if creating a public group.

  • optional common.v2.Uuid request_id = 5

    Mandatory request id used to make this call idempotent and avoid races. The request id should be unique and randomly generated by the client for each group to be created. The request will fail if this id is not unique, meaning the group is already created/being created.

  message CreateGroupResponse

  group_service.proto:156

  • CreateGroupResponse.Result result = 1

  • optional common.messaging.v2.Chat chat = 2

    Chat info for the newly created chat. This will only be set if result == OK.

  • repeated CreateGroupResponse.RestrictedField restricted_fields = 3

    This field is set if result == POLICY_RESTRICTION. Will contain the all RestrictedFields in the request that caused the request to fail with POLICY_RESTRICTION.

• rpc LeaveGroup (LeaveGroupRequest, LeaveGroupResponse)

  group_service.proto:30

  Leave a group chat. Notes: - This should be called by a member of group chat that wishes to _leave_. - A group admin cannot not use this to remove another member from the group chat, see RemoveFromGroup.

  message LeaveGroupRequest

  group_service.proto:195

  • optional common.v2.ChatId chat_id = 1

    Group chat to leave.

  • optional common.v2.PersonaId leaver_id = 2

    Persona leaving group.

  message LeaveGroupResponse

  group_service.proto:207

  • LeaveGroupResponse.Result result = 1

• rpc AddToGroup (AddToGroupRequest, AddToGroupResponse)

  group_service.proto:37

  Add persona(s) to a group chat. Notes: - A non-member persona may add themeselves to a group chat if the group chat allows this (e.g. is a public group). - A member of the group chat may add other personas to this group chat.

  message AddToGroupRequest

  group_service.proto:214

  • optional common.v2.ChatId chat_id = 1

    Chat to add persona to.

  • optional common.v2.PersonaId adder_id = 2

    Persona adding members to the group. This persona must be a member of the group and have the necessary permissions to add other personas to the group.

  • repeated common.v2.PersonaId new_member_ids = 3

    Persona ids to add to the group. Note that the upper bound on the number of members in a group is a configuration setting and likely to be less than 1024.

  message AddToGroupResponse

  group_service.proto:237

  • AddToGroupResponse.Result result = 1

  • repeated AddToGroupResponse.FailureDetails failure_details = 2

    Personas that failed to be added to the group.

• rpc RemoveFromGroup (RemoveFromGroupRequest, RemoveFromGroupResponse)

  group_service.proto:46

  Remove persona(s) from a group chat. Notes: - A group admin should use this to remove another member from the group chat. - This method is only useable by a member that is either an Admin or SuperAdmin. - The group member to remove cannot be the requesting member. - Admins cannot be removed by other Admins except SuperAdmins.

  message RemoveFromGroupRequest

  group_service.proto:270

  • optional common.v2.ChatId chat_id = 1

    Group to remove persona from.

  • optional common.v2.PersonaId remover_id = 2

    Persona removing others from the group.

  • repeated common.v2.PersonaId removee_ids = 3

    Personas to remove.

  message RemoveFromGroupResponse

  group_service.proto:289

  • RemoveFromGroupResponse.Result result = 1

  • repeated RemoveFromGroupResponse.FailureDetails failure_details = 2

    Personas that failed to be removed from the group.

Used in: AddToGroupResponse

• optional common.v2.PersonaId persona_id = 1

• FailureDetails.Reason reason = 2

Used in: FailureDetails

• UNKNOWN = 0

  An unknown/transient failure occurred while adding this persona. Caller should retry.

• BANNED = 1

  Persona is banned from the chat.

• GROUP_FULL = 2

  Group member limit was reached.

• NOT_PERMITTED = 3

  Adder was not permitted to add this persona to the group chat.

Used in: AddToGroupResponse

• OK = 0

  The request was successfully processed. Note that this does not mean all new member ids specified in the request were sucessfully added to the group. See failure_details for any failures.

• NOT_PERMITTED = 1

  Adder was not permitted to add other personas to this group chat.

Banned Member of a group

Used in: GetBannedGroupMembersStreamResponse

• optional common.v2.PersonaId persona_id = 1

  ID of group member Keep this field compatible with the common.groups.v2.GroupMember message

Used in: CreateGroupResponse

• UNSPECIFIED = 0

• GROUP_NAME = 1

• GROUP_HASHTAG = 2

Used in: CreateGroupResponse

• OK = 0

• CREATION_ID_EXISTS = 1

  The provided creation id already exists so a group is already created/being created.

• POLICY_RESTRICTION = 2

  The provided group creation request contained restricted values. See restricted_field for details on what was rejected.

• HASHTAG_NOT_UNIQUE = 3

  The provided hashtag is not unique and has already been taken. Hashtags must be unique.

• NOT_PERMITTED = 4

  Creator persona was not permitted to create a group chat with the given request.

Used in: GetBannedGroupMembersStreamResponse

• OK = 0

• NOT_FOUND = 1

  No group was found in which requesting persona could retrieve banned members.

Used in: GetGroupInfoFullResponse

• OK = 0

• NOT_FOUND = 1

  No group was found in which requesting persona could retrieve full group info.

Used in: CreateGroupRequest

• string group_name = 1

Used in: LeaveGroupResponse

• OK = 0

Used in: RemoveFromGroupResponse

• optional common.v2.PersonaId persona_id = 1

• FailureDetails.Reason reason = 2

Used in: FailureDetails

• UNKNOWN = 0

  An unknown/transient failure occurred while removing this persona. Caller should retry.

• NOT_PERMITTED = 1

  The remover was not permitted to remove this persona from the group chat.

Used in: RemoveFromGroupResponse

• OK = 0

  The request was successfully processed. Note that this does not mean all removee ids specified in the request were sucessfully removed to the group. See failure_details for any failures.

• NOT_PERMITTED = 1

  Remover was not permitted to remove other personas from this group chat.