Package: ski

The ski package is the protobuf designed for common e2ee instant messenger applications.

e2ees/AcceptMsg.proto

AcceptMsg

Msg form invitee for completing a key agreement.

Field	Type	Description
from	E2eeAddress	The sender's address.
to	E2eeAddress	The receiver's address.
e2ees_pack_id	uint32	The E2EE Security pack ID.
encaps_ciphertext	bytes	The ciphertext encapsulated by the inviter's identity public key, empty in ECC.
ratchet_key	bytes	The invitee's ratchet key.

Top

e2ees/AcceptRequest.proto

AcceptRequest

Request for sending an accept msg.

Field	Type	Label	Description
msg	AcceptMsg		The included msg for this request.

Top

e2ees/AcceptResponse.proto

AcceptResponse

Response for sending Accept msg.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.

Top

e2ees/Account.proto

Account

Account for keeping keys and registeration information.

Field	Type	Label	Description
version	string		The version used for this account.
e2ees_pack_id	uint32		The e2ee pack ID used for this account.
address	E2eeAddress		The address with device ID for this account.
server_cert	Certificate		The certificate of the server that create this account.
identity_key	IdentityKey		The identity key pair.
signed_pre_key	SignedPreKey		The signed pre-key pair.
one_time_pre_key_list	OneTimePreKey	repeated	The one-time pre-key pairs.
next_one_time_pre_key_id	uint32		Next one-time pre-key pair ID.
saved	bool		The account is saved or not.
password	string		The password for logining to server.
auth	string		The jwt for authorizing request to server.
expires_in	int64		The expiration time of auth.

Top

e2ees/AcquireSyncMsg.proto

AcquireSyncMsg

Msg for acquiring un-processed msgs form server.

Field	Type	Label	Description
last_proto_msg_tag	ProtoMsgTag		The last handled tag for acquiring un-handled msg from server.

Top

e2ees/AddGroupMemberDeviceMsg.proto

AddGroupMemberDeviceMsg

Msg for adding a device of group member.

Field	Type	Description
e2ees_pack_id	uint32	The E2EE Security pack ID.
sender_address	E2eeAddress	The sender's address.
sequence	uint32	The sequence for related group session.
group_info	GroupInfo	The group information, including the group name, the group address and all of the group members.
adding_member_device	GroupMemberInfo	The information of a group member's new device.

Top

e2ees/AddGroupMemberDeviceRequest.proto

AddGroupMemberDeviceRequest

Request for adding a device of group member.

Field	Type	Label	Description
msg	AddGroupMemberDeviceMsg		The included msg for this request.

Top

e2ees/AddGroupMemberDeviceResponse.proto

AddGroupMemberDeviceResponse

Response for adding a device of group member.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.
group_member_list	GroupMember	repeated	The group members.
adding_member_device_info	GroupMemberInfo		The information of a group member's new device.

Top

e2ees/AddGroupMembersMsg.proto

AddGroupMembersMsg

Msg for adding group members.

Field	Type	Label	Description
e2ees_pack_id	uint32		The E2EE Security pack ID.
sender_address	E2eeAddress		The sender's address.
sequence	uint32		The sequence for related group session.
group_info	GroupInfo		The group information, including the group name, the group address and all of the group members.
adding_member_list	GroupMember	repeated	The adding group members.
adding_member_info_list	GroupMemberInfo	repeated	The adding group members' information.

Top

e2ees/AddGroupMembersRequest.proto

AddGroupMembersRequest

Request for adding group members.

Field	Type	Label	Description
msg	AddGroupMembersMsg		The included msg for this request.

Top

e2ees/AddGroupMembersResponse.proto

AddGroupMembersResponse

Response for adding group members.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server
msg	string		The message given by the server
added_group_member_list	GroupMember	repeated	The added group members
group_member_list	GroupMember	repeated	The group members
adding_member_info_list	GroupMemberInfo	repeated	The adding group members' information

Top

e2ees/AddUserDeviceMsg.proto

AddUserDeviceMsg

Msg for adding user device.

Field	Type	Label	Description
user_address	E2eeAddress		The added user e2ee address
old_address_list	E2eeAddress	repeated	The list of other e2ee address that has the same user ID

Top

e2ees/AlgTypeDs.proto

AlgTypeDs

Algorithm type for Digital signature.

Name	Number	Description
ALG_TYPE_DS_CURVE25519	0
ALG_TYPE_DS_MLDSA_44	1
ALG_TYPE_DS_MLDSA_65	9
ALG_TYPE_DS_MLDSA_87	17
ALG_TYPE_DS_FALCON_512	33
ALG_TYPE_DS_FALCON_1024	41
ALG_TYPE_DS_SPHINCS_SHA2_128F	65
ALG_TYPE_DS_SPHINCS_SHA2_128S	69
ALG_TYPE_DS_SPHINCS_SHA2_192F	73
ALG_TYPE_DS_SPHINCS_SHA2_192S	77
ALG_TYPE_DS_SPHINCS_SHA2_256F	81
ALG_TYPE_DS_SPHINCS_SHA2_256S	85
ALG_TYPE_DS_SPHINCS_SHAKE_128F	89
ALG_TYPE_DS_SPHINCS_SHAKE_128S	93
ALG_TYPE_DS_SPHINCS_SHAKE_192F	97
ALG_TYPE_DS_SPHINCS_SHAKE_192S	101
ALG_TYPE_DS_SPHINCS_SHAKE_256F	105
ALG_TYPE_DS_SPHINCS_SHAKE_256S	109

Top

e2ees/AlgTypeHash.proto

AlgTypeHash

Algorithm type for hash function.

Name	Number	Description
ALG_TYPE_HASH_SHA2_224	0
ALG_TYPE_HASH_SHA2_256	1
ALG_TYPE_HASH_SHA2_384	2
ALG_TYPE_HASH_SHA2_512	3
ALG_TYPE_HASH_SHA3_224	8
ALG_TYPE_HASH_SHA3_256	9
ALG_TYPE_HASH_SHA3_384	10
ALG_TYPE_HASH_SHA3_512	11
ALG_TYPE_HASH_SHAKE_128	12
ALG_TYPE_HASH_SHAKE_256	13

Top

e2ees/AlgTypeKem.proto

AlgTypeKem

Algorithm type for Kem.

Name	Number	Description
ALG_TYPE_KEM_CURVE25519	0
ALG_TYPE_KEM_HQC_128	1
ALG_TYPE_KEM_HQC_192	9
ALG_TYPE_KEM_HQC_256	17
ALG_TYPE_KEM_MLKEM_512	33
ALG_TYPE_KEM_MLKEM_768	41
ALG_TYPE_KEM_MLKEM_1024	49
ALG_TYPE_KEM_MCELIECE_348864	65
ALG_TYPE_KEM_MCELIECE_348864F	69
ALG_TYPE_KEM_MCELIECE_460896	73
ALG_TYPE_KEM_MCELIECE_460896F	77
ALG_TYPE_KEM_MCELIECE_6688128	81
ALG_TYPE_KEM_MCELIECE_6688128F	85
ALG_TYPE_KEM_MCELIECE_6960119	89
ALG_TYPE_KEM_MCELIECE_6960119F	93
ALG_TYPE_KEM_MCELIECE_8192128	97
ALG_TYPE_KEM_MCELIECE_8192128F	101

Top

e2ees/AlgTypeSe.proto

AlgTypeSe

Algorithm type for Symmetric encryption.

Name	Number	Description
ALG_TYPE_SE_AES256GCM	0

Top

e2ees/Certificate.proto

Cert

A cert data with public key is provided by an issuee and can be signed by an issuer.

Field	Type	Description
issuee	Subject	The owner of this certificate.
public_key_alg	AlgTypeDs	The public key algorithm.
public_key	bytes	The public key data.
issuer	Subject	The signer of this certificate.
not_before	int64	The certificate issue date.
not_after	int64	The certificate expiry date.

Certificate

The certificate message.

Field	Type	Description
version	uint32	The version number
hash_alg	AlgTypeHash	The hash algorithm for creating fingerprint of cert attribute and signing public key.
signing_alg	AlgTypeDs	The algorithm for generating the signature.
cert	Cert	The cert data that is provided by issuee.
cert_fingerprint	bytes	The hash value as the fingerprint of cert attribute.
signing_public_key_fingerprint	bytes	The hash value as the fingerprint of the signing public key.
signature	bytes	The signature that is signed by signing private key that is owned by issuer.
ts	int64	The lastest update time stamp for this certificate.
valid	bool	The validity of this certificate.

Subject

A subject is used to describe issuer or issuee.

Field	Type	Label	Description
cn	string		The common name.
domain	string		The domain name.
o	string		The organization name
ou	string	repeated	The organization unit name.

Top

e2ees/ChainKey.proto

ChainKey

The chain key.

Field	Type	Label	Description
index	uint32		The index of the chain key.
shared_key	bytes		The chain key data.

Top

e2ees/ClientHeartbeatMsg.proto

ClientHeartbeatMsg

Msg for client heartbeat.

Field	Type	Label	Description
client_t	int64		The timestamp of client.

Top

e2ees/ConsumeProtoMsgRequest.proto

ConsumeProtoMsgRequest

Request for consuming a proto msg received from server.

Field	Type	Label	Description
proto_msg_id	string		The proto msg ID to be consumed.
state	ProtoMsgOpState		The operational state of the consumed proto msg.

ProtoMsgOpState

The operational state of proto msg.

Name	Number	Description
PROTO_MSG_OP_STATE_UNSPECIFIED	0
PROTO_MSG_OP_STATE_SUCCEEDEDED	1
PROTO_MSG_OP_STATE_FAILED_SIGNATURE	2
PROTO_MSG_OP_STATE_FAILED_DECRYPTION	3
PROTO_MSG_OP_STATE_FAILED_ESCAPE	4

Top

e2ees/ConsumeProtoMsgResponse.proto

ConsumeProtoMsgResponse

Response for consuming a proto msg.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.

Top

e2ees/CreateGroupMsg.proto

CreateGroupMsg

Msg for creating a group.

Field	Type	Label	Description
e2ees_pack_id	uint32		The E2EE Security pack ID.
sender_address	E2eeAddress		The sender's address.
group_info	GroupInfo		The group information, including the group name, the group address and all of the group members.
member_info_list	GroupMemberInfo	repeated	The group members' information.

Top

e2ees/CreateGroupRequest.proto

CreateGroupRequest

Request for creating a group.

Field	Type	Label	Description
msg	CreateGroupMsg		The included msg for this request.

Top

e2ees/CreateGroupResponse.proto

CreateGroupResponse

Response for creating a group.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.
group_address	E2eeAddress		The group address.
member_info_list	GroupMemberInfo	repeated	The group members' information.

Top

e2ees/DsAlgType.proto

DsAlgType

Digital signature algorithm type.

Name	Number	Description
DS_ALG_TYPE_CURVE25519	0
DS_ALG_TYPE_MLDSA_44	1
DS_ALG_TYPE_MLDSA_65	9
DS_ALG_TYPE_MLDSA_87	17
DS_ALG_TYPE_FALCON_512	33
DS_ALG_TYPE_FALCON_1024	41
DS_ALG_TYPE_SPHINCS_SHA2_128F	65
DS_ALG_TYPE_SPHINCS_SHA2_128S	69
DS_ALG_TYPE_SPHINCS_SHA2_192F	73
DS_ALG_TYPE_SPHINCS_SHA2_192S	77
DS_ALG_TYPE_SPHINCS_SHA2_256F	81
DS_ALG_TYPE_SPHINCS_SHA2_256S	85
DS_ALG_TYPE_SPHINCS_SHAKE_128F	89
DS_ALG_TYPE_SPHINCS_SHAKE_128S	93
DS_ALG_TYPE_SPHINCS_SHAKE_192F	97
DS_ALG_TYPE_SPHINCS_SHAKE_192S	101
DS_ALG_TYPE_SPHINCS_SHAKE_256F	105
DS_ALG_TYPE_SPHINCS_SHAKE_256S	109

Top

e2ees/E2eeAddress.proto

E2eeAddress

The address for designating an end point of user or group.

Field	Type	Description
domain	string	The domain of the address.
user	PeerUser	The user peer of the address.
group	PeerGroup	The group peer of the address.

PeerGroup

Group peer.

Field	Type	Label	Description
group_name	string		The optional group name.
group_id	string		The group ID.

PeerUser

User peer.

Field	Type	Description
user_name	string	The optional user name.
user_id	string	The user's ID.
device_id	string	The user's device ID.

Top

e2ees/E2eeMsg.proto

E2eeMsg

Msg for end to end encryption.

Field	Type	Description
version	string	The version.
from	E2eeAddress	The sender's address.
to	E2eeAddress	The receiver's address.
msg_id	string
session_id	string	The session ID.
notif_level	NotifLevel
one2one_msg	One2oneMsgPayload	The payload for one2one msg.
group_msg	GroupMsgPayload	The payload for group msg.

Top

e2ees/E2eePackId.proto

E2eePackId

Msg for e2ee pack ID.

Field	Type	Description
ver	int32	The version.
ds	AlgTypeDs	The digital signature algorithm type.
kem	AlgTypeKem	The kem algorithm type.
se	AlgTypeSe	The symmetric encryption algorithm type.
hash	AlgTypeHash	The hash function algorithm type.

Top

e2ees/FriendManagerMsg.proto

FriendManagerMsg

Msg for friend manager.

Field	Type	Description
modified_date	int64	The modified date of the friend manager msg.
msgId	string	The msg ID.
user_address	E2eeAddress	The user address.
user_name	string	The user name.
op	FriendOp	The operation of this msg.
friend	FriendshipDTO	The friend data.

FriendshipDTO

The data object representing a friend.

Field	Type	Label	Description
modified_date	int64
from_user	string
to_user	string
nickname	string
memoname	string
block_state	int32
friend_status	int32

FriendOp

The friend operations.

Name	Number	Description
FRIEND_OP_ADDING_SEND	0
FRIEND_OP_ADDING_RECEIVE	1
FRIEND_OP_ADDED	2
FRIEND_OP_BLOCKED	3
FRIEND_OP_UNBLOCKED	4
FRIEND_OP_REMOVED	5
FRIEND_OP_UPDATE_MEMONAME	6
FRIEND_OP_RECOMMEND	7

Top

e2ees/GetGroupRequest.proto

GetGroupRequest

Request for getting a group.

Field	Type	Label	Description
group_address	E2eeAddress		The group address.
sender_address	E2eeAddress		The sender address.

Top

e2ees/GetGroupResponse.proto

GetGroupResponse

Response for getting a group.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.
group_name	string		The group name.
group_address	E2eeAddress		The group address.
group_member_list	GroupMember	repeated	The list of group members.

Top

e2ees/GetPreKeyBundleRequest.proto

GetPreKeyBundleRequest

Request for getting pre-key bundle.

Field	Type	Description
domain	string	The domain.
user_id	string	The user's ID.
device_id	string	The user's device ID.

Top

e2ees/GetPreKeyBundleResponse.proto

GetPreKeyBundleResponse

Response for getting pre-key bundle.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.
user_id	string		The user's ID.
pre_key_bundles	PreKeyBundle	repeated	The user's pre-key bundles for all devices.

Top

e2ees/GroupInfo.proto

GroupInfo

The group information.

Field	Type	Label	Description
group_name	string		The group name.
group_address	E2eeAddress		The group address.
group_member_list	GroupMember	repeated	The list of group members.

Top

e2ees/GroupManagerMsg.proto

AddGroupMembersArg

Argument for adding group members.

Field	Type	Label	Description
user_address	E2eeAddress
added_member_list	GroupMember	repeated

CreateGroupArg

Argument for creating a group.

Field	Type	Label	Description
creator_address	E2eeAddress
group_member_list	GroupMember	repeated

DestroyGroupArg

Argument for destroying a group.

Field	Type	Label	Description
user_address	E2eeAddress

GroupManagerMsg

Msg for group manager.

Field	Type	Description
modified_date	int64	The modified date of the group manager msg.
msgId	string	The msg ID.
group_address	E2eeAddress	The group address.
group_name	string	The group name.
op	GroupOp	The operation of this msg.
create_group_arg	CreateGroupArg	The argument for creating group.
update_group_name_arg	UpdateGroupNameArg	The argument for updating group name.
update_group_avatar_arg	UpdateGroupAvatarArg	The argument for updating group avatar.
update_group_admins_arg	UpdateGroupAdminsArg	The argument for updating group admins.
add_group_members_arg	AddGroupMembersArg	The argument for adding group members.
join_group_arg	JoinGroupArg	The argument for joining group.
remove_group_members_arg	RemoveGroupMembersArg	The argument for removing group members.
destroy_group_arg	DestroyGroupArg	The argument for destroying group.

JoinGroupArg

Argument for joining a group.

Field	Type	Label	Description
user_address	E2eeAddress
joined_member	GroupMember

RemoveGroupMembersArg

Argument for removing group members.

Field	Type	Label	Description
user_address	E2eeAddress
removed_member_list	GroupMember	repeated

UpdateGroupAdminsArg

Argument for updating the group admins.

Field	Type	Label	Description
user_address	E2eeAddress
group_admin_list	GroupMember	repeated

UpdateGroupAvatarArg

Argument for updating the group avatar.

Field	Type	Label	Description
user_address	E2eeAddress
groupAvatarUrl	string

UpdateGroupNameArg

Argument for updating the group name.

Field	Type	Label	Description
user_address	E2eeAddress
group_name	string

GroupOp

The group operations.

Name	Number	Description
GROUP_OP_UNSPECIFIED	0
GROUP_OP_CREATE_GROUP	11
GROUP_OP_UPDATE_GROUP_NAME	12
GROUP_OP_UPDATE_GROUP_AVATAR	13
GROUP_OP_UPDATE_GROUP_ADMINS	14
GROUP_OP_ADD_GROUP_MEMBERS	21
GROUP_OP_JOIN_GROUP	22
GROUP_OP_REMOVE_GROUP_MEMBERS	23
GROUP_OP_DESTROY_GROUP	30

Top

e2ees/GroupMember.proto

GroupMember

The group member.

Field	Type	Description
user_id	string	The group member's users ID.
domain	string	The group member's domain.
role	GroupRole	The group member's role.

GroupRole

The group role.

Name	Number	Description
GROUP_ROLE_MEMBER	0
GROUP_ROLE_MANAGER	1
GROUP_ROLE_PENDING_MEMBER	10
GROUP_ROLE_PENDING_MANAGER	11

Top

e2ees/GroupMemberInfo.proto

GroupMemberInfo

The group member information with signed public key that is bound to a user device.

Field	Type	Label	Description
member_address	E2eeAddress		The group member's address.
sign_public_key	bytes		The signed public key part of the user's uploaded public identity key.

Top

e2ees/GroupMsgPayload.proto

GroupMsgPayload

Payload for group msg.

Field	Type	Description
sequence	uint32	The sequence of the related group session.
ciphertext	bytes	The ciphertext.
signature	bytes	The signature signed by the sender.

Top

e2ees/GroupPreKeyBundle.proto

GroupPreKeyBundle

Bundle for group pre-key.

Field	Type	Description
version	string	The version.
e2ees_pack_id	uint32	The E2EE Security pack ID.
sender	E2eeAddress	The sender's address.
session_id	string	The session ID.
old_session_id	string	The optional old session ID.
group_info	GroupInfo	The group information.
sequence	uint32	The sequence of the related group session.
group_seed	bytes	The seed for the related group session.

Top

e2ees/GroupSession.proto

GroupSession

The group session.

Field	Type	Description
version	string	The version.
e2ees_pack_id	uint32	The E2EE Security pack ID.
session_id	string	The group session ID.
sender	E2eeAddress	The sender's address.
session_owner	E2eeAddress	The group session owner's address.
group_info	GroupInfo	The group information.
sequence	uint32	The sequence of the chain key.
chain_key	bytes	The chain key.
group_seed	bytes	The random seed generated by the group creator.
associated_data	bytes	The associated data.

Top

e2ees/GroupUpdateKeyBundle.proto

GroupUpdateKeyBundle

Bundle for group update key.

Field	Type	Label	Description
version	string		The version.
e2ees_pack_id	uint32		The E2EE Security pack ID.
sender	E2eeAddress		The sender's address.
adding	bool		The flag for identifying this bundle is used for adding or not.
session_id	string		The session ID.
group_info	GroupInfo		Thi group information.
sequence	uint32		The sequence of the chain key.
chain_key	bytes		The chain key.
sign_public_key	bytes		The signed public key part of the user's uploaded public identity key.
adding_member_info_list	GroupMemberInfo	repeated	The list of adding group member information.

Top

e2ees/IdentityKey.proto

IdentityKey

The identity key.

Field	Type	Label	Description
asym_key_pair	KeyPair		The key pair for asymmetric encryption and decryption.
sign_key_pair	KeyPair		The key pair for signing and verifying signature.

Top

e2ees/IdentityKeyPublic.proto

IdentityKeyPublic

The public key part of an identity key.

Field	Type	Label	Description
asym_public_key	bytes		The public key part for asymmetric encryption.
sign_public_key	bytes		The public key part for verifying signature.

Top

e2ees/InviteMsg.proto

InviteMsg

Msg form inviter for initiating a key agreement.

Field	Type	Label	Description
version	string		The version.
e2ees_pack_id	uint32		The E2EE Security pack ID.
session_id	string		The session ID.
from	E2eeAddress		The sender's address.
to	E2eeAddress		The receiver's address.
alice_identity_key	bytes		The inviter's identity key.
alice_base_key	bytes		The inviter's base key that is the first ratchet public key.
pre_shared_input_list	bytes	repeated	The data that needs to generate some shared secret.
bob_signed_pre_key_id	uint32		The invitee's signed pre-key ID.
bob_one_time_pre_key_id	uint32		The invitee's one-time pre-key ID.
invite_t	int64		The server time of invitation for creating this session.

Top

e2ees/InviteRequest.proto

InviteRequest

Request for sending an invite msg.

Field	Type	Label	Description
msg	InviteMsg		The included msg for this request.

Top

e2ees/InviteResponse.proto

InviteResponse

Response for sending an invite msg.

Field	Type	Description
code	ResponseCode	The response code given by the server.
msg	string	The message given by the server.
session_id	string	The session ID.
invite_t	int64	The server time of invitation for creating this session.

Top

e2ees/KemAlgType.proto

KemAlgType

Kem algorithm type.

Name	Number	Description
KEM_ALG_TYPE_CURVE25519	0
KEM_ALG_TYPE_HQC_128	1
KEM_ALG_TYPE_HQC_192	9
KEM_ALG_TYPE_HQC_256	17
KEM_ALG_TYPE_MLKEM_512	33
KEM_ALG_TYPE_MLKEM_768	41
KEM_ALG_TYPE_MLKEM_1024	49
KEM_ALG_TYPE_MCELIECE_348864	65
KEM_ALG_TYPE_MCELIECE_348864F	69
KEM_ALG_TYPE_MCELIECE_460896	73
KEM_ALG_TYPE_MCELIECE_460896F	77
KEM_ALG_TYPE_MCELIECE_6688128	81
KEM_ALG_TYPE_MCELIECE_6688128F	85
KEM_ALG_TYPE_MCELIECE_6960119	89
KEM_ALG_TYPE_MCELIECE_6960119F	93
KEM_ALG_TYPE_MCELIECE_8192128	97
KEM_ALG_TYPE_MCELIECE_8192128F	101

Top

e2ees/KeyPair.proto

KeyPair

The Keypair.

Field	Type	Label	Description
public_key	bytes		The public key.
private_key	bytes		The private key.

Top

e2ees/LeaveGroupMsg.proto

LeaveGroupMsg

Msg for leaving a group.

Field	Type	Label	Description
user_address	E2eeAddress		The address of the user leaving the group.
group_address	E2eeAddress		The group address.

Top

e2ees/LeaveGroupRequest.proto

LeaveGroupRequest

Request for leaving a group.

Field	Type	Label	Description
msg	LeaveGroupMsg		The included msg for this request.

Top

e2ees/LeaveGroupResponse.proto

LeaveGroupResponse

Response for leaving a group.

Field	Type	Description
code	ResponseCode	The response code given by the server.
msg	string	The message given by the server.
leave_group_member_address	E2eeAddress	The address of the user leaving the group.
group_address	E2eeAddress	The group address.

Top

e2ees/MsgKey.proto

MsgKey

The msg key.

Field	Type	Label	Description
index	uint32		The index of the message key.
derived_key	bytes		The data of the message key.

Top

e2ees/NotifLevel.proto

NotifLevel

The notification level used to identify the urgency of a msg.

Name	Number	Description
NOTIF_LEVEL_NORMAL	0	The notification level indicates that server will not send push notification to device.
NOTIF_LEVEL_SESSION	1	The notification level indicates that server will forward msg for establishing session.
NOTIF_LEVEL_PUSH	11	The notification level indicates that server will send push notification to device.
NOTIF_LEVEL_STREAM	12	The notification level indicates that server will send push notification with streaming flags to device.

Top

e2ees/One2oneMsgPayload.proto

One2oneMsgPayload

Payload for one2one msg.

Field	Type	Description
sequence	uint32	The sequence of the chain key.
ciphertext	bytes	The ciphertext.
ratchet_key	bytes	The ratchet public key.
root_sequence	uint32	The root sequence.
sending_message_sequence	uint32	The sequence of the sending message.

Top

e2ees/OneTimePreKey.proto

OneTimePreKey

The one-time pre-key.

Field	Type	Description
opk_id	uint32	The one-time pre-key ID.
used	bool	This one-time pre-key is used or not.
key_pair	KeyPair	The one-time pre-key data.

Top

e2ees/OneTimePreKeyPublic.proto

OneTimePreKeyPublic

The public part of an one-time pre-key.

Field	Type	Label	Description
opk_id	uint32		The one-time pre-key ID.
public_key	bytes		The public part of this one-time pre-key pair.

Top

e2ees/PendingRequest.proto

PendingRequest

The pending request.

Field	Type	Label	Description
type	PendingRequestType		The type of the pending request
request_data	bytes		The data for the pending request.
request_arg_list	bytes	repeated	The optional arguments for the pending request .

PendingRequestType

The pending request types.

Name	Number	Description
PENDING_REQUEST_TYPE_GET_PRE_KEY_BUNDLE	0
PENDING_REQUEST_TYPE_INVITE	1
PENDING_REQUEST_TYPE_ACCEPT	2
PENDING_REQUEST_TYPE_PUBLISH_SPK	3
PENDING_REQUEST_TYPE_SUPPLY_OPKS	4
PENDING_REQUEST_TYPE_SEND_ONE2ONE_MSG	5
PENDING_REQUEST_TYPE_CREATE_GROUP	6
PENDING_REQUEST_TYPE_ADD_GROUP_MEMBERS	7
PENDING_REQUEST_TYPE_ADD_GROUP_MEMBER_DEVICE	8
PENDING_REQUEST_TYPE_REMOVE_GROUP_MEMBERS	9
PENDING_REQUEST_TYPE_LEAVE_GROUP	10
PENDING_REQUEST_TYPE_SEND_GROUP_MSG	11
PENDING_REQUEST_TYPE_PROTO_MSG	12

Top

e2ees/Plaintext.proto

Plaintext

The plaintext.

Field	Type	Description
version	string	The version.
common_msg	bytes	The common msg payload that is used for general purpose from application.
common_sync_msg	bytes	The sync msg payload that is forwarded to other devices of the user.
user_devices_bundle	UserDevicesBundle	The user devices' bundle that is used to help sync session with other devices of the user.
group_pre_key_bundle	GroupPreKeyBundle	The group pre-key bundle that is used to help create group session.
group_update_key_bundle	GroupUpdateKeyBundle	The group update key bundle that is used to help renew group session.

Top

e2ees/PreKeyBundle.proto

PreKeyBundle

Bundle for pre-key.

Field	Type	Description
user_address	E2eeAddress	The user's address.
e2ees_pack_id	uint32	The E2EE Security pack ID.
identity_key_public	IdentityKeyPublic	The public part of the identity key pair.
signed_pre_key_public	SignedPreKeyPublic	The public part of the signed pre-key pair.
one_time_pre_key_public	OneTimePreKeyPublic	The public part of the one-time pre-key pair.
signature	ServerSignedSignature	The signature of pre-key bundle signed by the server's key.

Top

e2ees/ProtoMsg.proto

ProtoMsg

The proto msg from server.

Field	Type	Label	Description
tag	ProtoMsgTag		The tag for helping server consume this msg.
from	E2eeAddress		The sender's address.
to	E2eeAddress		The receiver's address.
acquire_sync_msg	AcquireSyncMsg		The acquire sync msg.
supply_opks_msg	SupplyOpksMsg		The supply one-time pre-key msg.
invite_msg	InviteMsg		The invite msg.
accept_msg	AcceptMsg		The accept msg.
add_user_device_msg	AddUserDeviceMsg		The add user device msg.
remove_user_device_msg	RemoveUserDeviceMsg		The remove user device msg.
create_group_msg	CreateGroupMsg		The create group msg..
add_group_members_msg	AddGroupMembersMsg		The add group members msg.
remove_group_members_msg	RemoveGroupMembersMsg		The remove group members msg.
add_group_member_device_msg	AddGroupMemberDeviceMsg		The add group member device msg.
leave_group_msg	LeaveGroupMsg		The leave group msg.
e2ee_msg	E2eeMsg		The end to end encryption msg.
update_user_msg	UpdateUserMsg		The update user msg.
friend_manager_msg	FriendManagerMsg		The friend manager msg.
group_manager_msg	GroupManagerMsg		The group manager msg.
system_manager_msg	SystemManagerMsg		The system manager msg.
client_heartbeat_msg	ClientHeartbeatMsg		The client heart beat msg.
server_heartbeat_msg	ServerHeartbeatMsg		The server heart beat msg.
upgrade_e2ee_pack_msg	UpgradeE2eePackMsg		The upgrade e2ee pack msg.
signature_list	ServerSignedSignature	repeated	The list of signatures created by signing the fingerprint of tag

Top

e2ees/ProtoMsgTag.proto

ProtoMsgTag

The proto msg tag.

Field	Type	Label	Description
proto_msg_t	int64		The server time stamp.
proto_msg_id	string		The proto msg ID.

Top

e2ees/PublishSpkRequest.proto

PublishSpkRequest

Request for publishing signed pre-key.

Field	Type	Label	Description
user_address	E2eeAddress		The user's address.
signed_pre_key_public	SignedPreKeyPublic		The public part of the signed pre-key pair.

Top

e2ees/PublishSpkResponse.proto

PublishSpkResponse

Response for publishing signed pre-key.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.

Top

e2ees/Ratchet.proto

Ratchet

The ratchet.

Field	Type	Label	Description
root_key	bytes		The root key.
root_sequence	uint32		The sequence of the root key.
sending_message_sequence	uint32		The sequence of the sending message.
received_message_sequence	uint32		The sequence of the received message.
sender_chain	SenderChainNode		The sender chain.
receiver_chain	ReceiverChainNode		The receiver chains.
skipped_msg_key_list	SkippedMsgKeyNode	repeated	The skipped message keys.

Top

e2ees/ReceiverChainNode.proto

ReceiverChainNode

The receiver chain node.

Field	Type	Description
their_ratchet_public_key	bytes	The public part of the ratchet key pair in ECC or the ciphertext given by the sender in PQC.
our_ratchet_private_key	bytes	Our ratchet private key.
chain_key	ChainKey	The chain key.

Top

e2ees/RegisterUserRequest.proto

RegisterUserRequest

Request for registering an account.

Field	Type	Label	Description
user_name	string		The user's name.
user_id	string		The user's ID.
device_id	string		The ID of the user's device.
authenticator	string		Authenticator is the email (mailto:xxx@xxx) that is bound to the registering user.
auth_code	string		Auth code is a 6-digits number that is received by email or an invitation in this format (e2ee:invitorUserId@invitorDomain;invite=xxxxx).
e2ees_pack_id	uint32		The E2EE Security pack ID.
identity_key_public	IdentityKeyPublic		The public part of the identity key pair.
signed_pre_key_public	SignedPreKeyPublic		The public part of the signed pre-key pair.
one_time_pre_key_list	OneTimePreKeyPublic	repeated	The public part of all of the user's one-time pre-key pairs.

Top

e2ees/RegisterUserResponse.proto

RegisterUserResponse

Response for registering an account.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.
address	E2eeAddress		The user's address.
username	string		The user's name.
password	string		The password.
auth	string		The authorization token.
expires_in	int64		The expiry time of authorization token.
authenticator	string		The optional authenticator that is bound to this userId.
server_cert	Certificate		The certificate of the server that support the registration.
other_device_address_list	E2eeAddress	repeated	The addresses of other devices that is created with this userId.
other_user_address_list	E2eeAddress	repeated	The addresses of other users who had built session with this userId.
group_info_list	GroupInfo	repeated	The information of groups that had been created or joined by this userId.

Top

e2ees/RemoveGroupMembersMsg.proto

RemoveGroupMembersMsg

Msg for removing group members.

Field	Type	Label	Description
e2ees_pack_id	uint32		The E2EE Security pack ID.
sender_address	E2eeAddress		The sender's address.
group_info	GroupInfo		The group information.
removing_member_list	GroupMember	repeated	The members going to be removed.
member_info_list	GroupMemberInfo	repeated	The remaining group members' information.

Top

e2ees/RemoveGroupMembersRequest.proto

RemoveGroupMembersRequest

Request for removing group members.

Field	Type	Label	Description
msg	RemoveGroupMembersMsg		The included msg for this request.

Top

e2ees/RemoveGroupMembersResponse.proto

RemoveGroupMembersResponse

Response for removing group members.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.
removed_group_member_list	GroupMember	repeated	The removed group members.
group_member_list	GroupMember	repeated	The group members.
member_info_list	GroupMemberInfo	repeated	The remaining group members' information.

Top

e2ees/RemoveUserDeviceMsg.proto

RemoveUserDeviceMsg

Msg for removing user device.

Field	Type	Label	Description
user_address	E2eeAddress		The removed user e2ee address.

Top

e2ees/ResponseCode.proto

ResponseCode

Response status codes indicate whether a specific request has been successfully completed. Responses are grouped in four classes: (ref: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes) Informational responses 100–199 Successful responses 200–299 Client error responses 400–499 Server error responses 500–599 Custom responses 1000–1007

Name	Number	Description
RESPONSE_CODE_UNSPECIFIED	0	Unknown response.
RESPONSE_CODE_OK	200	The request succeeded, and some resources were read or updated.
RESPONSE_CODE_CREATED	201	The request succeeded, and some new resources were created as a result.
RESPONSE_CODE_ACCEPTED	202	The request has been received but not yet acted upon.
RESPONSE_CODE_NO_CONTENT	204	There is no content to send for this request, and some resources were deleted.
RESPONSE_CODE_BAD_REQUEST	400	The server cannot or will not process the request due to something that is perceived to be a client error.
RESPONSE_CODE_UNAUTHORIZED	401	The client is not authenticated to get the requested response.
RESPONSE_CODE_FORBIDDEN	403	The client is authenticated but does not have access rights to the content.
RESPONSE_CODE_NOT_FOUND	404	The server can not find the requested resource.
RESPONSE_CODE_REQUEST_TIMEOUT	408	The server timed out waiting for the request, or client timeout waiting for the response.
RESPONSE_CODE_REQUEST_CONFLICT	409	Indicates that the request could not be processed because of conflict in the current state of the resource.
RESPONSE_CODE_EXPECTATION_FAILED	417	The server cannot meet the requirements of the expected request data.
RESPONSE_CODE_INTERNAL_SERVER_ERROR	500	The server has encountered a situation it does not know how to handle.
RESPONSE_CODE_SERVICE_UNAVAILABLE	503	The server is down for maintenance or overloaded.
RESPONSE_CODE_CUSTOM_1000	1000	A custom response code supports the flexibility of diverse server implementations.
RESPONSE_CODE_CUSTOM_1001	1001	A custom response code supports the flexibility of diverse server implementations.
RESPONSE_CODE_CUSTOM_1002	1002	A custom response code supports the flexibility of diverse server implementations.
RESPONSE_CODE_CUSTOM_1003	1003	A custom response code supports the flexibility of diverse server implementations.
RESPONSE_CODE_CUSTOM_1004	1004	A custom response code supports the flexibility of diverse server implementations.
RESPONSE_CODE_CUSTOM_1005	1005	A custom response code supports the flexibility of diverse server implementations.
RESPONSE_CODE_CUSTOM_1006	1006	A custom response code supports the flexibility of diverse server implementations.
RESPONSE_CODE_CUSTOM_1007	1007	A custom response code supports the flexibility of diverse server implementations.

Top

e2ees/SenderChainNode.proto

SenderChainNode

The sender chain node.

Field	Type	Description
our_ratchet_public_key	bytes	The public part of the ratchet key pair in ECC or the ciphertext of the encapsulation in PQC.
their_ratchet_public_key	bytes	Their ratchet public key.
chain_key	ChainKey	The chain key.

Top

e2ees/SendGroupMsgRequest.proto

SendGroupMsgRequest

Request for sending a group msg.

Field	Type	Label	Description
msg	E2eeMsg		The included msg for this request.
allow_list	E2eeAddress	repeated	Optional allow list.
deny_list	E2eeAddress	repeated	Optional deny list.

Top

e2ees/SendGroupMsgResponse.proto

SendGroupMsgResponse

Response for sending a group msg.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.

Top

e2ees/SendOne2oneMsgRequest.proto

SendOne2oneMsgRequest

Request for sending an one2one msg.

Field	Type	Label	Description
msg	E2eeMsg		The included msg for this request.

Top

e2ees/SendOne2oneMsgResponse.proto

SendOne2oneMsgResponse

Response for sending an one2one msg.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.

Top

e2ees/ServerHeartbeatMsg.proto

ServerHeartbeatMsg

Msg for server heartbeat.

Field	Type	Label	Description
hostname	string		The optional server host name.
server_t	int64		The server time stamp.

Top

e2ees/ServerSignedSignature.proto

ServerSignedSignature

The server signed signature.

Field	Type	Description
version	uint32	The version number
hash_alg	AlgTypeHash	The hash algorithm for creating fingerprint of cert attribute and signing public key.
signing_alg	AlgTypeDs	The algorithm for generating the signature.
signer	Subject	The signer information.
signing_public_key_fingerprint	bytes	The hash value as the fingerprint of the signing public key.
msg_fingerprint	bytes	The hash value as the fingerprint of message to be signed.
signature	bytes	The signature of some message signed by the signer's key.

Top

e2ees/Session.proto

Session

The Session.

Field	Type	Label	Description
version	string		The version.
e2ees_pack_id	uint32		The E2EE Security pack ID.
session_id	string		The session ID.
our_address	E2eeAddress		Our address.
their_address	E2eeAddress		Their address.
ratchet	Ratchet		The ratchet data.
associated_data	bytes		The associated data.
temp_shared_secret	bytes		The shared secret encapsulated by the invitee's pre-key bundle, empty in ECC.
fingerprint	bytes		The fingerprint.
alice_base_key	KeyPair		The inviter's base key pair.
bob_signed_pre_key_id	uint32		The invitee's signed pre-key ID.
bob_one_time_pre_key_id	uint32		The invitee's one-time pre-key ID.
pre_shared_input_list	bytes	repeated	The data that needs to generate some shared secret.
f2f	bool		The session is face-to-face verified or not.
responded	bool		The invitee has responded or not.
invite_t	int64		The server time of invitation for creating this session.
short_term	bool		The flag indicates that session is used for short term.

Top

e2ees/SignedPreKey.proto

SignedPreKey

The signed pre-key.

Field	Type	Description
spk_id	uint32	The signed pre-key ID.
key_pair	KeyPair	The signed pre-key pair.
signature	bytes	The signature of key_pair's public_key signed by the user's identity key.
ttl	int64	The time stamp indicates that the signed pre-key will be removed.

Top

e2ees/SignedPreKeyPublic.proto

SignedPreKeyPublic

The public part of a signed pre-key.

Field	Type	Description
spk_id	uint32	The signed pre-key ID.
public_key	bytes	The public part of the signed pre-key pair.
signature	bytes	The signature of public_key signed by the user's identity key.

Top

e2ees/SkippedMsgKeyNode.proto

SkippedMsgKeyNode

The skipped msg key node.

Field	Type	Label	Description
ratchet_key_public	bytes		The public part of the ratchet key.
msg_key	MsgKey		The msg key.

Top

e2ees/SupplyOpksMsg.proto

SupplyOpksMsg

Msg for sypplying one-time pre-keys.

Field	Type	Description
server_t	int64
opks_num	uint32	The number of one-time pre-keys needed to be upload.
user_address	E2eeAddress	The user's address.

Top

e2ees/SupplyOpksRequest.proto

SupplyOpksRequest

Request for sypplying one-time pre-keys.

Field	Type	Label	Description
e2ees_pack_id	uint32		The E2EE Security pack ID.
user_address	E2eeAddress		The user's address.
one_time_pre_key_public_list	OneTimePreKeyPublic	repeated	The public part of one-time pre-key pairs.

Top

e2ees/SupplyOpksResponse.proto

SupplyOpksResponse

Response for sypplying one-time pre-keys.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.

Top

e2ees/SystemManagerMsg.proto

SystemManagerMsg

Msg for system manager.

Field	Type	Description
modified_date	int64	The modified date of the system manager msg.
op	SystemOp	The operation of the system manager msg.
payload	bytes	The optional payload data.

SystemOp

The system operations.

Name	Number	Description
SYSTEM_OP_WELCOME_MSG	0
SYSTEM_OP_REGISTER_MSG	1
SYSTEM_OP_REGISTER_SUCCESS_MSG	2
SYSTEM_OP_ANNOUNCEMENT_MSG	3
SYSTEM_OP_NOTIFICATION_MSG	4

Top

e2ees/UpdateUserMsg.proto

UpdateUserAvatarArg

Argument for updating the user avatar.

Field	Type	Label	Description
user_avatar_url	string

UpdateUserBackupPasskeyArg

Argument for updating the user backup passkey.

Field	Type	Label	Description
backup_passkey	bytes

UpdateUserMsg

Msg for updating user.

Field	Type	Description
modified_date	int64
user_address	E2eeAddress
op	UpdateUserOp
update_user_name_arg	UpdateUserNameArg	The argument for updating user name.
update_user_avatar_arg	UpdateUserAvatarArg	The argument for updating user avatar.
update_user_state_arg	UpdateUserStateArg	The argument for updating user state.
update_user_privacy_arg	UpdateUserPrivacyArg	The argument for updating user privacy.
update_user_backup_passkey_arg	UpdateUserBackupPasskeyArg	The argument for updating user backup passkey.

UpdateUserNameArg

Argument for updating the user name.

Field	Type	Label	Description
username	string

UpdateUserPrivacyArg

Argument for updating the user privacy.

Field	Type	Label	Description
user_privacy_json	string

UpdateUserStateArg

Argument for updating the user state.

Field	Type	Label	Description
user_state	int32

UpdateUserOp

The update user operations.

Name	Number	Description
UPDATE_USER_OP_NAME	0
UPDATE_USER_OP_AVATAR	1
UPDATE_USER_OP_STATE	2
UPDATE_USER_OP_PRIVACY	3
UPDATE_USER_OP_BACKUP_PASSKEY	4

Top

e2ees/UpdateUserRequest.proto

UpdateUserRequest

Request for updating user.

Field	Type	Label	Description
msg	UpdateUserMsg		The included msg for this request.

Top

e2ees/UpdateUserResponse.proto

UpdateUserResponse

Response for updating user.

Field	Type	Label	Description
code	ResponseCode		The response code given by the server.
msg	string		The message given by the server.

Top

e2ees/UpgradeE2eePackMsg.proto

UpgradeE2eePackMsg

Message for upgrading e2ee pack.

Field	Type	Label	Description
upgrade_ts	int64		The server timestamp for upgrading e2ee pack.
e2ees_pack_id	uint32		The new e2ee pack ID.

Top

e2ees/UserDevicesBundle.proto

UserDevicesBundle

Bundle for user devices.

Field	Type	Label	Description
domain	string		The domain.
user_id	string		The user's ID.
device_id_list	string	repeated	All of the user's devices ID.

Top

ski/AnsweredStreamEvent.proto

AnsweredStreamEvent

The message for answering event of the stream.

Field	Type	Label	Description
user_address	e2ees.E2eeAddress		E2ee address with deviceId for whom send this event.

Top

ski/AudioPayload.proto

AudioPayload

Message for encrypted audio file.

Field	Type	Description
file_name	string	The file name.
file_path	string	The url that is used to download this audio file.
file_size	int64	The file size.
modified_date	int64	The time stamp of this message.
mime_type	string	The mime type.
time_len	int64	The time length in milliseconds.
passkey	bytes	The passkey that is used to decrypt the download audio file.

Top

ski/BlockState.proto

BlockState

State to identify if a friend is blocked or not.

Name	Number	Description
BLOCK_STATE_NORMAL	0	Normal status.
BLOCK_STATE_BLOCKED	1	Block status.

Top

ski/ContactPayload.proto

ContactPayload

Message for contact payload.

Field	Type	Label	Description
user	string		Simple e2ee address.
nickname	string		The nickname provided by user.

Top

ski/CreateStreamEvent.proto

CreateStreamEvent

The message for creating event of the stream.

Field	Type	Label	Description
stream_type	StreamType		The type of stream.
caller	string		The simple e2ee address for caller.
participants	string	repeated	The list of simple e2ee addresses for whom join the stream.
pin_code	string		The pin code for accessing the stream.
passkey	bytes		The key for encrypting/decrypting the stream.

Top

ski/DataPayload.proto

DataPayload

The message for data payload.

Field	Type	Label	Description
name	string		The class name for decoding data.
data	bytes		The raw data encoded in a sequence of bytes no longer than 2^32 (4GB).

Top

ski/DeclineStreamEvent.proto

DeclineStreamEvent

The message for declining event of the stream.

Field	Type	Label	Description
user_address	string		The simple e2ee address who send this event.

Top

ski/DecryptStatusPayload.proto

DecryptStatusPayload

The decrypt status message will be sent when a peer decrypted the message and loaded in UI.

Field	Type	Label	Description
msg_ids	string	repeated	The array of message ids for the messages that have been decrypted.
time_decrypt	int64		The time stamp that the messages are decrypted.

Top

ski/DeletePayload.proto

DeletePayload

The message for deleting some msgs.

Field	Type	Label	Description
to_address	string		Optional Simple user or group address for which all its msgs will be deleted.
delete_msg_ids	string	repeated	The array of message ids of a message to be deleted.

Top

ski/DestroyStreamEvent.proto

DestroyStreamEvent

The message for destroying event of the stream.

Field	Type	Label	Description
user_address	string		The simple e2ee address who send this event.
duration	int64		The duration for the stream.

Top

ski/FilePayload.proto

FilePayload

Message for encrypted file payload.

Field	Type	Description
file_name	string	The file name.
file_path	string	The url that is used to download this file.
file_size	int64	The file size.
modified_date	int64	The time stamp of this message.
mime_type	string	The mime type.
passkey	bytes	The passkey that is used to decrypt the download file.

Top

ski/Forward.proto

Forward

Message for forwarding another message.

Field	Type	Description
from	string	The simple e2ee address for whom is the sender of the forwarded message.
msg_id	string	The message id of the forwarded message.
time_stamp	int64	The time stamp that this message is forwarded.

Top

ski/FriendNotifPayload.proto

FriendNotifPayload

Message for friend manager.

Field	Type	Label	Description
op	e2ees.FriendOp		The friend operation.
friend	e2ees.FriendshipDTO		The data transmission object of a friend.

Top

ski/FriendStatus.proto

FriendStatus

The frind status message identifies the status of a friendship.

Name	Number	Description
FRIEND_STATUS_UNSPECIFIED	0	The friendship is in unknown status.
FRIEND_STATUS_STRANGER	1	The friendship is in stranger status.
FRIEND_STATUS_ATTENTION	2	The friendship is in attention status.
FRIEND_STATUS_FRIEND	3	The friendship is in friend status.
FRIEND_STATUS_REMOVED	9	The friendship is removed. (the friend account may have been removed)

Top

ski/GroupNotifPayload.proto

GroupNotifPayload

Message from group manager.

Field	Type	Description
op	e2ees.GroupOp	The group operation.
create_group_arg	e2ees.CreateGroupArg	The argement for creating group message.
update_group_name_arg	e2ees.UpdateGroupNameArg	The argement for updating group name message.
update_group_avatar_arg	e2ees.UpdateGroupAvatarArg	The argement for updating group avatar message.
update_group_admins_arg	e2ees.UpdateGroupAdminsArg	The argement for updatinge group admins message.
add_group_members_arg	e2ees.AddGroupMembersArg	The argement for adding group member message.
join_group_arg	e2ees.JoinGroupArg	The argement for joining group member message.
remove_group_members_arg	e2ees.RemoveGroupMembersArg	The argement for removing group member message.
destroy_group_arg	e2ees.DestroyGroupArg	The argement for destroying group member message.

Top

ski/HidePayload.proto

HidePayload

Message for hiding another messgae by manager of a group.

Field	Type	Label	Description
hide_msg_ids	string	repeated	The array of message ids of a message to be hided.

Top

ski/ImagePayload.proto

ImagePayload

Message for encrypted image file.

Field	Type	Description
file_name	string	The file name.
file_path	string	The url that is used to download this image file.
file_size	int64	The file size.
modified_date	int64	The time stamp of this message.
mime_type	string	The mime type.
orientation	int32	The orientation of this message in degrees (0, 90, 180, 270).
passkey	bytes	The passkey that is used to decrypt the download image file.

Top

ski/LocationPayload.proto

LocationPayload

Message for location payload.

Field	Type	Description
lat	double	The latitude of a location.
lng	double	The longitude of a location.
address	string	The text address that identify a specific place.

Top

ski/MsgState.proto

MsgState

The state of a message is used to indicate the state of a transmitted message.

Name	Number	Description
MSG_STATE_UNSPECIFIED	0	The message is in unknown state.
MSG_STATE_SENDING	1	The message is in sending state.
MSG_STATE_SEND_FAILED	2	The message is failed to send.
MSG_STATE_SEND_PENDED	3	The message is pended to send and kept in local database.
MSG_STATE_SEND_SUCCEEDED	5	The message is succeeded to send and received by server .
MSG_STATE_RECEIVED	10	The message is received by peer.
MSG_STATE_DECRYPT_SUCCEEDED	11	The message is succeeded to decrypt by peer.
MSG_STATE_DECRYPT_FAILED	12	The message is failed to decrypt by peer.
MSG_STATE_READ	13	The message is read by peer
MSG_STATE_HIDED	20	The message is hided (by a manager of group).
MSG_STATE_DELETED	21	The message is deleted.

Top

ski/MsgType.proto

MsgType

The type of a message is used to identify the message type of a plainMsg. @see PlainMsg#msg

Name	Number	Description
MSG_TYPE_UNSPECIFIED	0
MSG_TYPE_TEXT	11
MSG_TYPE_CONTACT	12
MSG_TYPE_LOCATION	13
MSG_TYPE_STICKER	14
MSG_TYPE_IMAGE	21
MSG_TYPE_AUDIO	22
MSG_TYPE_VIDEO	23
MSG_TYPE_FILE	24
MSG_TYPE_STREAM	31
MSG_TYPE_DATA	41
MSG_TYPE_FRIEND_NOTIF	61
MSG_TYPE_GROUP_NOTIF	62
MSG_TYPE_SYSTEM_NOTIF	63
MSG_TYPE_RETRACT	71
MSG_TYPE_DECRYPT_STATUS	72
MSG_TYPE_HIDE	73
MSG_TYPE_DELETE	74

Top

ski/PlainMsg.proto

PlainMsg

PlainMsg is the main proto type to transfer plaintext among peers.

Field	Type	Label	Description
version	string		The version number is reserved to keep forward compatibility.
msg_id	string		The uuid for this plain message.
from	string		The sender's address in simple e2ee address format without devideId.
to	string		The recipient's address in simple e2ee address format without devideId.
time_send	int64		The time stamp that is provided by server.
time_delete	int64		The optional time to delete by client.
text	TextPayload		Text message.
contact	ContactPayload		Contact message.
location	LocationPayload		Location message.
sticker	StickerPayload		Sticker message.
image	ImagePayload		Image message.
audio	AudioPayload		Audio message.
video	VideoPayload		Video message.
file	FilePayload		File message.
stream	StreamPayload		Stream message.
data	DataPayload		Data message
friend_notif	FriendNotifPayload		Notification message from the friend manager.
group_notif	GroupNotifPayload		Notification message from the group manager.
system_notif	SystemNotifPayload		Notification message from the system manager.
retract	RetractPayload		Special message to retract some plainMsgs.
decrypt_status	DecryptStatusPayload		Special message to identify the decryption status of some plainMsgs.
hide	HidePayload		Special message to hide some plainMsgs.
delete	DeletePayload		Special message to delete some plainMsgs.
reply	Reply		The reply attribute is provided if this plainMsg is used to reply another plainMsg.
forwards	Forward	repeated	The forwards attribute is an array to keep track the forwarded records.
report	Report		The reply attribute is provided if this plainMsg is used to report against another plainMsg.

Top

ski/Reply.proto

Reply

The message for replying another message.

Field	Type	Description
replied_msg_from	string	The simple e2ee address for whom is the sender of replied message.
replied_msg_id	string	The message id of the message that is replied.
replied_msg_type	int32	The message type of the message that is replied.
replied_msg_text	string	The replied text.

Top

ski/Report.proto

Report

The message for reporting another message that is considered to be objectionable.

Field	Type	Description
msg_id	string	The message id of a message to be reported.
from	string	The simple e2ee address for whom send the reported message.
reason	ReportReason	The reason for this report.

Top

ski/ReportReason.proto

ReportReason

The reason for a report of an objectionable message.

Name	Number	Description
REPORT_REASON_HARASSMENT	0	The message is related to harassment. (騷擾)
REPORT_REASON_OBJECTIONABLE_ADVERTISING	100	The message is related to advertising. (不當內容：廣告)
REPORT_REASON_OBJECTIONABLE_FALSE_INFO	101	The message is related to false information. (不當內容：不實)
REPORT_REASON_OBJECTIONABLE_BLOODINESS	102	The message is related to bloodiness. (不當內容：血腥)
REPORT_REASON_OBJECTIONABLE_VIOLENCE	103	The message is related to violence. (不當內容：暴力)
REPORT_REASON_OBJECTIONABLE_PORNOGRAPHY	104	The message is related to pornography. (不當內容：色情)
REPORT_REASON_OBJECTIONABLE_HATRED	105	The message is related to hatred. (不當內容：仇恨)
REPORT_REASON_OBJECTIONABLE_DISCRIMINATION	106	The message is related to discrimination.(不當內容：歧視)
REPORT_REASON_OBJECTIONABLE_SELF_HARM	107	The message is related to self-harm. (不當內容：自殘)
REPORT_REASON_CONTRABAND_DRUGS	200	The message is involved in contraband of drugs. (違禁品：毒品、藥物)
REPORT_REASON_CONTRABAND_FIREARMS	201	The message is involved in contraband of firearms. (違禁品：槍械)
REPORT_REASON_COUNTERFEITING_ME	300	The message is a counterfeit of me. (冒充：我)
REPORT_REASON_COUNTERFEITING_FRIEND	301	The message is a counterfeit of some friend. (冒充：朋友)
REPORT_REASON_COUNTERFEITING_OTHER	302	The message is a counterfeit of some person. (冒充：其他人)
REPORT_REASON_COUNTERFEITING_CELEBRITY	303	The message is a counterfeit of some celebrity. (冒充：名人)
REPORT_REASON_MALFUNCTION	400	The message is malfunctioned. (功能錯誤)
REPORT_REASON_OTHER	900	Something else. (其它)

Top

ski/RetractPayload.proto

RetractPayload

The message to retract some other msgs.

Field	Type	Label	Description
retract_msg_ids	string	repeated	The array of message ids to be retracted.

Top

ski/StickerPayload.proto

StickerPayload

The message for sticker.

Field	Type	Description
namespace	string	The name space of this sticker.
category	string	The category of this sticker.
sticker_pack_id	string	The sticker pack id to that this sticker is belonged.
sticker_id	string	The sticker id of this sticker.
desc	string	The text description of this sticker.

Top

ski/StreamPayload.proto

StreamPayload

The message for streaming.

Field	Type	Description
server_url	string	Server url for serving the stream.
room_id	string	The room id of the stream.
create	CreateStreamEvent
decline	DeclineStreamEvent
destroy	DestroyStreamEvent
answered	AnsweredStreamEvent

Top

ski/StreamType.proto

StreamType

The stream type message.

Name	Number	Description
STREAM_TYPE_AUDIO	0
STREAM_TYPE_VIDEO	1
STREAM_TYPE_CAMERA	2
STREAM_TYPE_DESKTOP	3

Top

ski/SyncMsg.proto

SyncMsg

Msg for syncing data among devices.

Field	Type	Label	Description
op	SyncOp		The operation of this msg.
update_backup_passkey_arg	UpdateBackupPasskeyArg		The argument for updating backup passkey.

UpdateBackupPasskeyArg

Argument for updating backup passkey.

Field	Type	Label	Description
backup_passkey	bytes

SyncOp

The sync operations.

Name	Number	Description
SYNC_OP_UNSPECIFIED	0
SYNC_OP_UPDATE_BACKUP_PASSKEY	11

Top

ski/SystemNotifPayload.proto

SystemNotifPayload

The message from system manager.

Field	Type	Label	Description
op	e2ees.SystemOp		The ststem operation.
payload	bytes		The utf-8 json string content.

Top

ski/TextPayload.proto

TextPayload

The message for text payload.

Field	Type	Label	Description
content	string		The text message that has utf-8 encoding and length limit 20480.

Top

ski/UserState.proto

UserState

The user state message.

Name	Number	Description
USER_STATE_NORMAL	0
USER_STATE_BLOCKED	1
USER_STATE_REVOKED	2
USER_STATE_DEPRECATED	3

Top

ski/UserType.proto

UserType

The user type message.

Name	Number	Description
USER_TYPE_PERSON	0
USER_TYPE_GROUP	1
USER_TYPE_BOT	2
USER_TYPE_EDU	3
USER_TYPE_GOV	4
USER_TYPE_ORG	5
USER_TYPE_COM	6

Top

ski/VideoPayload.proto

VideoPayload

The message for encrypted video file.

Field	Type	Description
file_name	string	The file name.
file_path	string	The url that is used to download this video file.
file_size	int64	The file size.
modified_date	int64	The time stamp of this message.
mime_type	string	The mime type.
time_len	int64	The time length in milliseconds.
passkey	bytes	The passkey that is used to decrypt the download video file.

Top

skiserver/AcquireAuthCodeRequest.proto

AcquireAuthCodeRequest

Request for acquiring auth code.

Field	Type	Label	Description
authenticator	string		Email (mailto:xxx@xxx) or maybe mobile phone number (tel:xxx@xxx) to receive auth code.

Top

skiserver/AcquireAuthCodeResponse.proto

AcquireAuthCodeResponse

Response for acquiring auth code.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
ttl	int32	Time to live (seconds) for auth code that has

Top

skiserver/AcquireGroupMemberInfosRequest.proto

AcquireGroupMemberInfosRequest

Request for acquiring group member info list.

Field	Type	Label	Description
user_address	e2ees.E2eeAddress		User address with userId and domain.

Top

skiserver/AcquireGroupMemberInfosResponse.proto

AcquireGroupMemberInfosResponse

Response for acquiring sign public key of uploaded identity public key.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.
group_member_infos	e2ees.GroupMemberInfo	repeated	List of groupMemberInfo that consists of sign public key of uploaded identity public key.

Top

skiserver/AcquireServerInfoRequest.proto

AcquireServerInfoRequest

Request for acquiring server info.

Field	Type	Label	Description
heartbeat	e2ees.ClientHeartbeatMsg		Send the heartbeat msg to server.

Top

skiserver/AcquireServerInfoResponse.proto

AcquireServerInfoResponse

Response for acquiring server info.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
heartbeat	e2ees.ServerHeartbeatMsg

Top

skiserver/AddFriendRequest.proto

AddFriendRequest

Request for adding a friend.

Field	Type	Description
user_address	e2ees.E2eeAddress	The e2ee address for user who sends this request.
to_user	string	The simple e2ee address of user who will be added as a friend.
from_user	string	The simple e2ee address of user who is adding toUser as a friend.
from_username	string	The name of user who is adding toUser as a friend.

Top

skiserver/AddFriendResponse.proto

AddFriendResponse

Response for adding a friend.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
status	AddAttentionStatus	The friendship status.
friend	e2ees.FriendshipDTO	The friendship data.

AddAttentionStatus

The friendship status.

Name	Number	Description
ADD_ATTENTION_STATUS_REJECTED	0
ADD_ATTENTION_STATUS_ATTENTION_ADDED	1
ADD_ATTENTION_STATUS_FRIEND_ADDED	2
ADD_ATTENTION_STATUS_ALREADY_ATTENDED	3
ADD_ATTENTION_STATUS_ALREADY_FRIENDED	4
ADD_ATTENTION_STATUS_REMOVE_BLOCKED	5
ADD_ATTENTION_STATUS_EXCEPTION	6

Top

skiserver/AskUserIdAvailableRequest.proto

AskUserIdAvailableRequest

Request for checking if a userId is available.

Field	Type	Label	Description
user_id	string		The userId to be registered.

Top

skiserver/AskUserIdAvailableResponse.proto

AskUserIdAvailableResponse

Response for checking if a userId is available.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/BackupMsgRequest.proto

BackupMsgRequest

Request for backing up a message.

Field	Type	Label	Description
backup_msg	MsgBackupDTO		The backup data.

Top

skiserver/BackupMsgResponse.proto

BackupMsgResponse

Response for backing up a message.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
time_backup	int64	The back up time of the backup msg.

Top

skiserver/BackupPasskey.proto

BackupPasskey

Message for BackupPasskey.

Field	Type	Label	Description
passkeys	BackupPasskeyItem	repeated	A list of passkey items.

BackupPasskeyItem

Message for BackupPasskeyItem.

Field	Type	Description
ver	int32
e2ee_pack_id	uint32	The e2ee pack ID used for this passkey.
index	int32	The index of passkey item start from 0.
passkey	bytes	The passkey for backing up msg.
passkey_fingerprint	bytes	The hash value as the fingerprint of passkey.
signing_private_key	bytes	The private key data for signing backup msg.
signing_public_key	bytes	The public key data for verifying backup msg.
signing_public_key_fingerprint	bytes	The hash value as the fingerprint of the signing public key.

Top

skiserver/BlockFriendRequest.proto

BlockFriendRequest

Request for blocking a friend.

Field	Type	Description
user_address	e2ees.E2eeAddress	The e2ee address for user who sends this request.
to_user	string	The simple e2ee address for a user to be blocked.
from_user	string	The simple e2ee address for the user who is blocking toUser.

Top

skiserver/BlockFriendResponse.proto

BlockFriendResponse

Response for blocking a friend.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
friend	e2ees.FriendshipDTO	The updated friendship data.

Top

skiserver/E2eeBackupService.proto

E2eeBackupService

The backup unary grpc service.

Method Name	Request Type	Response Type
GetMsgBackupTs	GetMsgBackupTsRequest	GetMsgBackupTsResponse
BackupMsg	BackupMsgRequest	BackupMsgResponse
RecoverMsg	RecoverMsgRequest	RecoverMsgResponse

Top

skiserver/E2eeBidiService.proto

E2eeBidiService

The e2ee bidirection stream grpc service.

Method Name	Request Type	Response Type	Description
Communicate	.e2ees.ProtoMsg stream	.e2ees.ProtoMsg stream	bidi streaming operations

Top

skiserver/E2eeS2SService.proto

E2eeS2SService

The e2ee server to server unary grpc service.

Method Name	Request Type	Response Type
ServerAcquireLogin	ServerAcquireLoginRequest	ServerAcquireLoginResponse
ServerLogin	ServerLoginRequest	ServerLoginResponse
ServerRefreshToken	ServerRefreshTokenRequest	ServerRefreshTokenResponse
GetPreKeyBundle	.e2ees.GetPreKeyBundleRequest	.e2ees.GetPreKeyBundleResponse
Invite	.e2ees.InviteRequest	.e2ees.InviteResponse
SendOne2oneMsg	.e2ees.SendOne2oneMsgRequest	.e2ees.SendOne2oneMsgResponse
GetUser	GetUserRequest	GetUserResponse
RemoveUserDevice	RemoveUserDeviceRequest	RemoveUserDeviceResponse
AddFriend	AddFriendRequest	AddFriendResponse
RemoveFriend	RemoveFriendRequest	RemoveFriendResponse
BlockFriend	BlockFriendRequest	BlockFriendResponse
UnBlockFriend	UnBlockFriendRequest	UnBlockFriendResponse
AddGroupMembers	.e2ees.AddGroupMembersRequest	.e2ees.AddGroupMembersResponse
AddGroupMemberDevice	.e2ees.AddGroupMemberDeviceRequest	.e2ees.AddGroupMemberDeviceResponse
RemoveGroupMembers	.e2ees.RemoveGroupMembersRequest	.e2ees.RemoveGroupMembersResponse
JoinGroup	JoinGroupRequest	JoinGroupResponse
LeaveGroup	.e2ees.LeaveGroupRequest	.e2ees.LeaveGroupResponse
UpdateGroupName	UpdateGroupNameRequest	UpdateGroupNameResponse
UpdateGroupManagers	UpdateGroupManagersRequest	UpdateGroupManagersResponse
GetGroup	.e2ees.GetGroupRequest	.e2ees.GetGroupResponse
SendGroupMsg	.e2ees.SendGroupMsgRequest	.e2ees.SendGroupMsgResponse
AcquireGroupMemberInfos	AcquireGroupMemberInfosRequest	AcquireGroupMemberInfosResponse
SubmitProtoMsg	SubmitProtoMsgRequest	SubmitProtoMsgResponse
NotifyCertUpdate	NotifyCertUpdateRequest	NotifyCertUpdateResponse

Top

skiserver/E2eeUnaryService.proto

E2eeUnaryService

The e2ee unary grpc service.

Method Name	Request Type	Response Type
AcquireAuthCode	AcquireAuthCodeRequest	AcquireAuthCodeResponse
AskUserIdAvailable	AskUserIdAvailableRequest	AskUserIdAvailableResponse
RegisterUser	.e2ees.RegisterUserRequest	.e2ees.RegisterUserResponse
UpdateAuthenticator	UpdateAuthenticatorRequest	UpdateAuthenticatorResponse
Login	LoginRequest	LoginResponse
Logout	LogoutRequest	LogoutResponse
AcquireServerInfo	AcquireServerInfoRequest	AcquireServerInfoResponse
GetPreKeyBundle	.e2ees.GetPreKeyBundleRequest	.e2ees.GetPreKeyBundleResponse
Invite	.e2ees.InviteRequest	.e2ees.InviteResponse
Accept	.e2ees.AcceptRequest	.e2ees.AcceptResponse
PublishSpk	.e2ees.PublishSpkRequest	.e2ees.PublishSpkResponse
SupplyOpks	.e2ees.SupplyOpksRequest	.e2ees.SupplyOpksResponse
SendOne2oneMsg	.e2ees.SendOne2oneMsgRequest	.e2ees.SendOne2oneMsgResponse
AddFriend	AddFriendRequest	AddFriendResponse
RemoveFriend	RemoveFriendRequest	RemoveFriendResponse
BlockFriend	BlockFriendRequest	BlockFriendResponse
UnBlockFriend	UnBlockFriendRequest	UnBlockFriendResponse
MemoFriend	MemoFriendRequest	MemoFriendResponse
GetFriends	GetFriendsRequest	GetFriendsResponse
GetUser	GetUserRequest	GetUserResponse
FindUser	FindUserRequest	FindUserResponse
CreateGroup	.e2ees.CreateGroupRequest	.e2ees.CreateGroupResponse
AddGroupMembers	.e2ees.AddGroupMembersRequest	.e2ees.AddGroupMembersResponse
AddGroupMemberDevice	.e2ees.AddGroupMemberDeviceRequest	.e2ees.AddGroupMemberDeviceResponse
RemoveGroupMembers	.e2ees.RemoveGroupMembersRequest	.e2ees.RemoveGroupMembersResponse
JoinGroup	JoinGroupRequest	JoinGroupResponse
LeaveGroup	.e2ees.LeaveGroupRequest	.e2ees.LeaveGroupResponse
UpdateGroupName	UpdateGroupNameRequest	UpdateGroupNameResponse
UpdateGroupManagers	UpdateGroupManagersRequest	UpdateGroupManagersResponse
GetGroup	.e2ees.GetGroupRequest	.e2ees.GetGroupResponse
SendGroupMsg	.e2ees.SendGroupMsgRequest	.e2ees.SendGroupMsgResponse
UpdatePushId	UpdatePushIdRequest	UpdatePushIdResponse
UpdateUserName	UpdateUserNameRequest	UpdateUserNameResponse
UpdateUserPrivacy	UpdateUserPrivacyRequest	UpdateUserPrivacyResponse
ConsumeProtoMsg	.e2ees.ConsumeProtoMsgRequest	.e2ees.ConsumeProtoMsgResponse

Top

skiserver/FindUserRequest.proto

FindUserRequest

Request for finding user.

Field	Type	Label	Description
query	string		url-encoded string such as: userId%3Dxxx%26domain%3Dxxxx or authenticator%3Duser%40example.com.
user_address	e2ees.E2eeAddress		The address of the user who us sending this request.

Top

skiserver/FindUserResponse.proto

FindUserResponse

Response for finding a user.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
friend	e2ees.FriendshipDTO	The friendship data of a retrieved user.

Top

skiserver/GetFriendsRequest.proto

GetFriendsRequest

Request for getting friendship data.

Field	Type	Label	Description
last_modified_date	int64		The latest modified time stamp of friendship in client side.

Top

skiserver/GetFriendsResponse.proto

GetFriendsResponse

Response for getting friendship data.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.
friends	e2ees.FriendshipDTO	repeated	The list of friendship data.

Top

skiserver/GetMsgBackupTsRequest.proto

GetMsgBackupTsRequest

Request for acquiring time stamps of backed up msgs.

Field	Type	Label	Description
msg_ids	string	repeated	The array of msg ids to be queried.

Top

skiserver/GetMsgBackupTsResponse.proto

GetMsgBackupTsResponse

Response for acquiring time stamps of backed up msgs.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.
backup_tses	MsgBackupTsDTO	repeated	The array of backup time stamps.

Top

skiserver/GetUserRequest.proto

GetUserRequest

Request for retrieving information of a user.

Field	Type	Label	Description
to_user	string		The simple e2ee address for the user whose information is retrieved.
user_address	e2ees.E2eeAddress		The address of the user who is retrieving the information of toUser.

Top

skiserver/GetUserResponse.proto

GetUserResponse

Response for retrieving information of a user.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
friend	e2ees.FriendshipDTO	The friendship data of a retrieved user.

Top

skiserver/JoinGroupRequest.proto

JoinGroupRequest

Request for joining a group.

Field	Type	Label	Description
to_group	string		The simple e2ee address of the joining group.
user_address	e2ees.E2eeAddress		The address of the user joining the group

Top

skiserver/JoinGroupResponse.proto

JoinGroupResponse

Response for joining a group.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/JwtToken.proto

JwtToken

Message for jwt token.

Field	Type	Label	Description
token	string		The token.
expires_in	int64		The expiry time.

Top

skiserver/LoginRequest.proto

LoginRequest

Request for login.

Field	Type	Label	Description
user_address	e2ees.E2eeAddress		The user e2ee address for whom is going to login.
password	string		The password to login the e2ee service.

Top

skiserver/LoginResponse.proto

LoginResponse

Response for login.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
auth	string	The updated authorization code.
expires_in	int64	The time of expiration for the authorization code.
user_state	ski.UserState	The user state.
msgBackup_device_id	string	The optional main backup deviceId.

Top

skiserver/LogoutRequest.proto

LogoutRequest

Request for logout.

Field	Type	Label	Description
user_address	e2ees.E2eeAddress		The user e2ee address (with device id) for whom is going to logout.

Top

skiserver/LogoutResponse.proto

LogoutResponse

Response for logout.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/MemoFriendRequest.proto

MemoFriendRequest

Request for giving a memo name to a friend.

Field	Type	Description
user_address	e2ees.E2eeAddress	The e2ee address for user who sends this request.
to_user	string	The simple e2ee address for the user who is giving a memo name.
memoname	string	The memo name (max len = 12 utf-8 chars).

Top

skiserver/MemoFriendResponse.proto

MemoFriendResponse

Response for giving a memo name to a friend.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
friend	e2ees.FriendshipDTO	The updated friendship data.

Top

skiserver/MsgBackupDTO.proto

MsgBackupDTO

Message for a backup msg.

Field	Type	Description
msg_id	string	The msgId of the backup msg.
time_send	int64	The time of the backup msg that was sent.
time_backup	int64	The back up time of the backup msg.
passkey_fingerprint	bytes	The passkey fingerprint for the backup msg.
signing_public_key_fingerprint	bytes	The hash value as the fingerprint of the signing public key.
encrypted_msg	bytes	The encrypted backup msg.
plain_msg_signature	bytes	The signature of plain msg to be backed up.
encrypted_attachment	bytes	The optional encrypted attachment data of the backup msg.
plain_attachment_signature	bytes	The optional signature of plain attachment data to be backed up.

Top

skiserver/MsgBackupTsDTO.proto

MsgBackupTsDTO

Message for the time stamp of a backed up msg.

Field	Type	Description
msg_id	string	The msgId of the backup msg.
time_send	int64	The time of the backup msg that was sent.
time_backup	int64	The time of the backup msg that was backed up.

Top

skiserver/NotifyCertUpdateRequest.proto

NotifyCertUpdateRequest

Request for notifying certificates update.

Field	Type	Label	Description
ts	int64		The lastest time stamp for current list of certificates.

Top

skiserver/NotifyCertUpdateResponse.proto

NotifyCertUpdateResponse

Response for notifying certificates update.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/RecoverMsgRequest.proto

RecoverMsgRequest

Request for recovering some backed up msgs.

Field	Type	Description
last_msg_id	string	Optional last msgId that has been downloaded previously.
last_time_send	int64	Optional last timestamp for a sent msg.
limit	int32	The maximal number of messages to be downloaded. (max 500)

Top

skiserver/RecoverMsgResponse.proto

RecoverMsgResponse

Response for recovering backed up msgs.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.
backuped_msgs	MsgBackupDTO	repeated	The recovered data.

Top

skiserver/RemoveFriendRequest.proto

RemoveFriendRequest

Request for removing a friend.

Field	Type	Description
user_address	e2ees.E2eeAddress	The e2ee address for user who sends this request.
to_user	string	The simple e2ee address of user who will be removed as a friend.
from_user	string	The simple e2ee address of user who is removing toUser from contacts.

Top

skiserver/RemoveFriendResponse.proto

RemoveFriendResponse

Response for removing a friend.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
friend	e2ees.FriendshipDTO	The updated friendship data.

Top

skiserver/RemoveUserDeviceRequest.proto

RemoveUserDeviceRequest

Request for removing a user device.

Field	Type	Label	Description
user_address	e2ees.E2eeAddress		The e2ee address for user who sends this request.
remove_user_device_msg	e2ees.RemoveUserDeviceMsg		The remove_user_device_msg.

Top

skiserver/RemoveUserDeviceResponse.proto

RemoveUserDeviceResponse

Response for removing a user device.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/ServerAcquireLoginRequest.proto

ServerAcquireLoginRequest

Request for acquiring server login challenge.

Field	Type	Label	Description
domain	string		The domain.

Top

skiserver/ServerAcquireLoginResponse.proto

ServerAcquireLoginResponse

Response for acquiring server login challenge..

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
challenge	string	The chanllenge base64 string.

Top

skiserver/ServerLoginRequest.proto

ServerLoginRequest

Request for server login.

Field	Type	Description
domain	string	The domain.
certFingerprint	bytes	The certFingerprint for the certificate that can be used to verify the response;
challenge	string	The challenge base64 string.
response	string	The base64 string that is the signature created by signing the challenge with server's key.

Top

skiserver/ServerLoginResponse.proto

ServerLoginResponse

Response for server login.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
cn	string	The common name.
domain	string	The domain.
access_token	JwtToken	The access token.
refresh_token	JwtToken	The refresh token.

Top

skiserver/ServerRefreshTokenRequest.proto

ServerRefreshTokenRequest

The request for refreshing server token.

Field	Type	Label	Description
domain	string		The domain.
refresh_token	string		The refresh token.

Top

skiserver/ServerRefreshTokenResponse.proto

ServerRefreshTokenResponse

The response for refreshing server token.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
access_token	JwtToken	The accessToken for 30 days.
refresh_token	JwtToken	The refreshToken for 180 days.

Top

skiserver/SubmitProtoMsgRequest.proto

SubmitProtoMsgRequest

Request for submitting protoMsg to a s2s service.

Field	Type	Label	Description
protoMsg	e2ees.ProtoMsg		The protoMsg to be delivered.
ignoredDeviceIdList	string	repeated	Optional ignored deviceId list.

Top

skiserver/SubmitProtoMsgResponse.proto

SubmitProtoMsgResponse

Response for submitting protoMsg to a s2s service.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/UnBlockFriendRequest.proto

UnBlockFriendRequest

Request for unblocking a friend.

Field	Type	Description
user_address	e2ees.E2eeAddress	The e2ee address for user who sends this request.
to_user	string	The simple e2ee address for a user to be unblocked.
from_user	string	The simple e2ee address for the user who is unblocking toUser.

Top

skiserver/UnBlockFriendResponse.proto

UnBlockFriendResponse

Response for unblocking a friend.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
friend	e2ees.FriendshipDTO	The updated friendship data.

Top

skiserver/UpdateAuthenticatorRequest.proto

UpdateAuthenticatorRequest

Request for updating authenticator.

Field	Type	Label	Description
authenticator	string		Email (mailto:xxx@xxx) or mobile phone number (tel:xxx@xxx) to receive auth code.
auth_code	string		The auth code received from authenticator.

Top

skiserver/UpdateAuthenticatorResponse.proto

UpdateAuthenticatorResponse

Response for updating authenticator.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/UpdateGroupManagersRequest.proto

UpdateGroupManagersRequest

Request for updating group managers.

Field	Type	Label	Description
to_group	string		The simple e2ee address of the updating group.
from_user	string		The simple e2ee address of the user who is updating the group.
updating_members	e2ees.GroupMember	repeated	The list of updated group members with new roles.

Top

skiserver/UpdateGroupManagersResponse.proto

UpdateGroupManagersResponse

Response for updating group managers.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.
group_managers	e2ees.GroupMember	repeated	The list of new group managers.

Top

skiserver/UpdateGroupNameRequest.proto

UpdateGroupNameRequest

Request for renaming a group.

Field	Type	Description
to_group	string	The simple e2ee address of the renaming group.
from_user	string	The simple e2ee address of the user who is renaming the group.
group_name	string	The group name.

Top

skiserver/UpdateGroupNameResponse.proto

UpdateGroupNameResponse

Response for renaming a group.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/UpdatePushIdRequest.proto

UpdatePushIdRequest

Request for updating pushId.

Field	Type	Label	Description
push_id	string		The pushId for push notification.
type	PushIDType		The optional pushId type.

PushIDType

Name	Number	Description
PUSH_ID_TYPE_NORMAL	0	PushId for general circumstances.
PUSH_ID_TYPE_APNS_VOIP	1	PushId for apns voip.

Top

skiserver/UpdatePushIdResponse.proto

UpdatePushIdResponse

Response for updating pushId.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/UpdateUserNameRequest.proto

UpdateUserNameRequest

Request for updating user name.

Field	Type	Label	Description
username	string		The user name (max len = 12 utf-8 chars).

Top

skiserver/UpdateUserNameResponse.proto

UpdateUserNameResponse

Response for updating user name.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skiserver/UpdateUserPrivacyRequest.proto

UpdateUserPrivacyRequest

Request for updating user privacy.

Field	Type	Description
allow_attention	bool	Allow being added as a friend.
allow_greeting	bool	Allow receiving msg from strangers.
allow_auto_friend	bool	Allow adding friend automatically when someone is adding user as friend.

Top

skiserver/UpdateUserPrivacyResponse.proto

UpdateUserPrivacyResponse

Response for updating user privacy.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Top

skirobot/E2eeRobotService.proto

E2eeRobotService

Method Name	Request Type	Response Type	Description
CreateAccount	RobotCreateAccountRequest	.e2ees.RegisterUserResponse	account
Login	RobotLoginRequest	.skiserver.LoginResponse
Logout	RobotLogoutRequest	.skiserver.LogoutResponse
Invite	RobotInviteRequest	.e2ees.InviteResponse	One2one
SendOne2oneMsg	RobotSendPlainMsgRequest	RobotMsgDTO
SendSyncMsg	RobotSendSyncPlainMsgRequest	RobotSendSyncPlainMsgResponse
CreateGroup	RobotCreateGroupRequest	.e2ees.CreateGroupResponse	Group
AddGroupMembers	RobotAddGroupMembersRequest	.e2ees.AddGroupMembersResponse
RemoveGroupMembers	RobotRemoveGroupMembersRequest	.e2ees.RemoveGroupMembersResponse
UpdateGroupName	.skiserver.UpdateGroupNameRequest	.skiserver.UpdateGroupNameResponse
JoinGroup	.skiserver.JoinGroupRequest	.skiserver.JoinGroupResponse
LeaveGroup	.e2ees.LeaveGroupRequest	.e2ees.LeaveGroupResponse
UpdateGroupManagers	.skiserver.UpdateGroupManagersRequest	.skiserver.UpdateGroupManagersResponse
SendGroupMsg	RobotSendPlainMsgRequest	RobotMsgDTO
AddFriend	RobotAddFriendRequest	.skiserver.AddFriendResponse	Friendship
RemoveFriend	RobotRemoveFriendRequest	.skiserver.RemoveFriendResponse
BlockFriend	RobotBlockFriendRequest	.skiserver.BlockFriendResponse
UnBlockFriend	RobotUnBlockFriendRequest	.skiserver.UnBlockFriendResponse
MemoFriend	RobotMemoFriendRequest	.skiserver.MemoFriendResponse
GetFriends	RobotGetFriendsRequest	.skiserver.GetFriendsResponse
GetUser	.skiserver.GetUserRequest	.skiserver.GetUserResponse
UpdatePushId	.skiserver.UpdatePushIdRequest	.skiserver.UpdatePushIdResponse	Settings
UpdateUserName	.skiserver.UpdateUserNameRequest	.skiserver.UpdateUserNameResponse
UpdateUserPrivacy	.skiserver.UpdateUserPrivacyRequest	.skiserver.UpdateUserPrivacyResponse
SendDecryptStatusMsg	RobotSendDecryptStatusRequest	RobotSendDecryptStatusResponse	Misc
EncryptFile	RobotEncryptFileRequest	RobotEncryptFileResponse
DecryptFile	RobotDecryptFileRequest	RobotDecryptFileResponse
Subscribe	EventSubscription	EventNotification stream	server streaming operations

Top

skirobot/EventNotification.proto

EventNotification

Message for event notification from subscription service.

Field	Type	Label	Description
inited	OnInited
user_registered	OnUserRegistered
group_created	OnGroupCreated
group_members_added	OnGroupMembersAdded
group_members_removed	OnGroupMembersRemoved
user_updated	OnUserUpdated
one2one_msg_received	OnOne2oneMsgReceived
other_device_msg_received	OnOtherDeviceMsgReceived
group_msg_received	OnGroupMsgReceived
friend_manager_msg_received	OnFriendManagerMsgReceived
group_manager_msg_received	OnGroupManagerMsgReceived
system_manager_msg_received	OnSystemManagerMsgReceived

OnFriendManagerMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
friend_manager_msg	e2ees.FriendManagerMsg

OnGroupCreated

Field	Type	Label
user_address	e2ees.E2eeAddress
group_address	e2ees.E2eeAddress
group_name	string
group_member_list	e2ees.GroupMember	repeated

OnGroupManagerMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
group_manager_msg	e2ees.GroupManagerMsg

OnGroupMembersAdded

Field	Type	Label
user_address	e2ees.E2eeAddress
group_address	e2ees.E2eeAddress
group_name	string
group_member_list	e2ees.GroupMember	repeated
added_group_member_list	e2ees.GroupMember	repeated

OnGroupMembersRemoved

Field	Type	Label
user_address	e2ees.E2eeAddress
group_address	e2ees.E2eeAddress
group_name	string
group_member_list	e2ees.GroupMember	repeated
removed_group_member_list	e2ees.GroupMember	repeated

OnGroupMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
plain_msg	ski.PlainMsg

OnInited

OnOne2oneMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
plain_msg	ski.PlainMsg

OnOtherDeviceMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
plain_msg	ski.PlainMsg

OnSystemManagerMsgReceived

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
system_manager_msg	e2ees.SystemManagerMsg

OnUserRegistered

Field	Type	Label	Description
user_address	e2ees.E2eeAddress

OnUserUpdated

Field	Type	Label	Description
user_address	e2ees.E2eeAddress
update_user_msg	e2ees.UpdateUserMsg

Top

skirobot/EventSubscription.proto

EventSubscription

Top

skirobot/RobotAddFriendRequest.proto

RobotAddFriendRequest

Field	Type	Label	Description
to_user	string

Top

skirobot/RobotAddGroupMembersRequest.proto

RobotAddGroupMembersRequest

Field	Type	Label	Description
to_group	string
adding_members	e2ees.GroupMember	repeated

Top

skirobot/RobotBlockFriendRequest.proto

RobotBlockFriendRequest

Field	Type	Label	Description
to_user	string

Top

skirobot/RobotCreateAccountRequest.proto

RobotCreateAccountRequest

Field	Type	Label	Description
username	string
user_id	string
authenticator	string
auth_code	string

Top

skirobot/RobotCreateGroupRequest.proto

RobotCreateGroupRequest

Field	Type	Label	Description
group_name	string
group_members	e2ees.GroupMember	repeated

Top

skirobot/RobotDecryptFileRequest.proto

RobotDecryptFileRequest

Request for decrypting file.

Field	Type	Label	Description
passkey	bytes
in_file_path	string

Top

skirobot/RobotDecryptFileResponse.proto

RobotDecryptFileResponse

Response for decrypting a file.

Field	Type	Description
code	e2ees.ResponseCode	The response code given by the server.
msg	string	The message given by the server.
url	string	The url for decrypted file.

Top

skirobot/RobotEncryptFileRequest.proto

RobotEncryptFileRequest

Request for encrypting file.

Field	Type	Label	Description
passkey	bytes
in_file_path	string

Top

skirobot/RobotEncryptFileResponse.proto

RobotEncryptFileResponse

Response for encrypting a file.

Field	Type	Description
code	e2ees.ResponseCode	The response code given by the server.
msg	string	The message given by the server.
url	string	The url for encrypted file.

Top

skirobot/RobotGetFriendsRequest.proto

RobotGetFriendsRequest

Top

skirobot/RobotGetUserRequest.proto

RobotGetUserRequest

Field	Type	Label	Description
user_address	string

Top

skirobot/RobotInviteRequest.proto

RobotInviteRequest

Field	Type	Label	Description
to_user	string

Top

skirobot/RobotLoginRequest.proto

RobotLoginRequest

Field	Type	Label	Description
user_address	string

Top

skirobot/RobotLogoutRequest.proto

RobotLogoutRequest

Top

skirobot/RobotMemoFriendRequest.proto

RobotMemoFriendRequest

Field	Type	Label	Description
to_user	string
memoname	string

Top

skirobot/RobotMsgDTO.proto

RobotMsgDTO

Field	Type	Label	Description
po_id	string

Top

skirobot/RobotRemoveFriendRequest.proto

RobotRemoveFriendRequest

Field	Type	Label	Description
to_user	string

Top

skirobot/RobotRemoveGroupMembersRequest.proto

RobotRemoveGroupMembersRequest

Field	Type	Label	Description
to_group	string
removing_members	e2ees.GroupMember	repeated

Top

skirobot/RobotSendDecryptStatusRequest.proto

RobotSendDecryptStatusRequest

Field	Type	Label	Description
to	string
msg_ids	string	repeated

Top

skirobot/RobotSendDecryptStatusResponse.proto

RobotSendDecryptStatusResponse

Field	Type	Label	Description
code	e2ees.ResponseCode
msg	string

Top

skirobot/RobotSendPlainMsgRequest.proto

RobotSendPlainMsgRequest

Send a group or one2one plainMsg.

Field	Type	Label	Description
plain_msg	ski.PlainMsg
notif_level	e2ees.NotifLevel

Top

skirobot/RobotSendSyncPlainMsgRequest.proto

RobotSendSyncPlainMsgRequest

Send a sync plainMsg.

Field	Type	Label	Description
plain_msg	ski.PlainMsg

Top

skirobot/RobotSendSyncPlainMsgResponse.proto

RobotSendSyncPlainMsgResponse

Response for sending a sync plainMsg.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code given by the server.
msg	string		The message given by the server.

Top

skirobot/RobotUnBlockFriendRequest.proto

RobotUnBlockFriendRequest

Field	Type	Label	Description
to_user	string

Top

skirobot/RobotUpdatePushIdRequest.proto

RobotUpdatePushIdRequest

Field	Type	Label	Description
push_id	string

Top

skirobot/RobotUpdateUserNameRequest.proto

RobotUpdateUserNameRequest

Field	Type	Label	Description
username	string

Top

directory/E2eeDirectoryService.proto

E2eeDirectoryService

The directory unary grpc service.

Method Name	Request Type	Response Type
LookupDomainProfile	LookupDomainProfileRequest	LookupDomainProfileResponse
RetrieveCert	RetrieveCertRequest	RetrieveCertResponse
RetrieveCertList	RetrieveCertListRequest	RetrieveCertListResponse
ValidateCert	ValidateCertRequest	ValidateCertResponse

Top

directory/E2eeDomainProfile.proto

E2eeDomainProfile

Profile of an e2ee service domain.

Field	Type	Description
api_server_grpc	ServiceConnection	The grpc api server host:port.
api_server_http	ServiceConnection	The http api server host:port.
file_server_grpc	ServiceConnection	The reserved grpc file server host:port.
file_server_http	ServiceConnection	The http file server host:port.
backup_server_grpc	ServiceConnection	The optional grpc backup server host:port.
backup_server_http	ServiceConnection	The optional http backup server host:port.
streaming_server	ServiceConnection	The optional streaming server url.

ServiceConnection

Field	Type	Description
api	string	The api style (ex: restful, grpc, ws).
host	string	The host.
port	int32	The port.

Top

directory/LookupDomainProfileRequest.proto

LookupDomainProfileRequest

Request for looking up an e2ee service profile.

Field	Type	Label	Description
domain	string		The domain for retriving the profile.

Top

directory/LookupDomainProfileResponse.proto

LookupDomainProfileResponse

Response for looking up an e2ee service profile.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
profile	E2eeDomainProfile	The returned e2ee service profile.

Top

directory/RetrieveCertListRequest.proto

RetrieveCertListRequest

Request for retriving list of certificates by giving time stamp.

Field	Type	Label	Description
ts	int64		The timestamp for retriving the certificates that is updated later.

Top

directory/RetrieveCertListResponse.proto

RetrieveCertListResponse

Response for retrieving list of certificates.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.
certificate_list	e2ees.Certificate	repeated	The returned list of certificates.

Top

directory/RetrieveCertRequest.proto

RetrieveCertRequest

Request for retriving a certificate by domain.

Field	Type	Label	Description
domain	string		The domain for retriving the profile.

Top

directory/RetrieveCertResponse.proto

RetrieveCertResponse

Response for retrieving a certificate.

Field	Type	Description
code	e2ees.ResponseCode	The response code.
msg	string	Optional response message.
certificate	e2ees.Certificate	The returned certificate.

Top

directory/ValidateCertRequest.proto

ValidateCertRequest

Request for validating a certificate by domain.

Field	Type	Label	Description
domain	string		The domain for retriving the profile.
cert_fingerprint	bytes		The hash value as the fingerprint of cert that is being validated.

Top

directory/ValidateCertResponse.proto

ValidateCertResponse

Response for validating a certificate.

Field	Type	Label	Description
code	e2ees.ResponseCode		The response code.
msg	string		Optional response message.

Scalar Value Types

.proto Type	Notes	C++	Java	Python	Go	C#	PHP	Ruby
double		double	double	float	float64	double	float	Float
float		float	float	float	float32	float	float	Float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long	int64	long	integer/string	Bignum
uint32	Uses variable-length encoding.	uint32	int	int/long	uint32	uint	integer	Bignum or Fixnum (as required)
uint64	Uses variable-length encoding.	uint64	long	int/long	uint64	ulong	integer/string	Bignum or Fixnum (as required)
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long	int64	long	integer/string	Bignum
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int	uint32	uint	integer	Bignum or Fixnum (as required)
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long	uint64	ulong	integer/string	Bignum
sfixed32	Always four bytes.	int32	int	int	int32	int	integer	Bignum or Fixnum (as required)
sfixed64	Always eight bytes.	int64	long	int/long	int64	long	integer/string	Bignum
bool		bool	boolean	boolean	bool	bool	boolean	TrueClass/FalseClass
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode	string	string	string	String (UTF-8)
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str	[]byte	ByteString	string	String (ASCII-8BIT)

e2ees/AcceptMsg.proto
- AcceptMsg
e2ees/AcceptRequest.proto
- AcceptRequest
e2ees/AcceptResponse.proto
- AcceptResponse
e2ees/Account.proto
- Account
e2ees/AcquireSyncMsg.proto
- AcquireSyncMsg
e2ees/AddGroupMemberDeviceMsg.proto
- AddGroupMemberDeviceMsg
e2ees/AddGroupMemberDeviceRequest.proto
- AddGroupMemberDeviceRequest
e2ees/AddGroupMemberDeviceResponse.proto
- AddGroupMemberDeviceResponse
e2ees/AddGroupMembersMsg.proto
- AddGroupMembersMsg
e2ees/AddGroupMembersRequest.proto
- AddGroupMembersRequest
e2ees/AddGroupMembersResponse.proto
- AddGroupMembersResponse
e2ees/AddUserDeviceMsg.proto
- AddUserDeviceMsg
e2ees/AlgTypeDs.proto
- AlgTypeDs
e2ees/AlgTypeHash.proto
- AlgTypeHash
e2ees/AlgTypeKem.proto
- AlgTypeKem
e2ees/AlgTypeSe.proto
- AlgTypeSe
e2ees/Certificate.proto
- Cert
- Certificate
- Subject
e2ees/ChainKey.proto
- ChainKey
e2ees/ClientHeartbeatMsg.proto
- ClientHeartbeatMsg
e2ees/ConsumeProtoMsgRequest.proto
- ConsumeProtoMsgRequest
- ProtoMsgOpState
e2ees/ConsumeProtoMsgResponse.proto
- ConsumeProtoMsgResponse
e2ees/CreateGroupMsg.proto
- CreateGroupMsg
e2ees/CreateGroupRequest.proto
- CreateGroupRequest
e2ees/CreateGroupResponse.proto
- CreateGroupResponse
e2ees/DsAlgType.proto
- DsAlgType
e2ees/E2eeAddress.proto
- E2eeAddress
- PeerGroup
- PeerUser
e2ees/E2eeMsg.proto
- E2eeMsg
e2ees/E2eePackId.proto
- E2eePackId
e2ees/FriendManagerMsg.proto
- FriendManagerMsg
- FriendshipDTO
- FriendOp
e2ees/GetGroupRequest.proto
- GetGroupRequest
e2ees/GetGroupResponse.proto
- GetGroupResponse
e2ees/GetPreKeyBundleRequest.proto
- GetPreKeyBundleRequest
e2ees/GetPreKeyBundleResponse.proto
- GetPreKeyBundleResponse
e2ees/GroupInfo.proto
- GroupInfo
e2ees/GroupManagerMsg.proto
- AddGroupMembersArg
- CreateGroupArg
- DestroyGroupArg
- GroupManagerMsg
- JoinGroupArg
- RemoveGroupMembersArg
- UpdateGroupAdminsArg
- UpdateGroupAvatarArg
- UpdateGroupNameArg
- GroupOp
e2ees/GroupMember.proto
- GroupMember
- GroupRole
e2ees/GroupMemberInfo.proto
- GroupMemberInfo
e2ees/GroupMsgPayload.proto
- GroupMsgPayload
e2ees/GroupPreKeyBundle.proto
- GroupPreKeyBundle
e2ees/GroupSession.proto
- GroupSession
e2ees/GroupUpdateKeyBundle.proto
- GroupUpdateKeyBundle
e2ees/IdentityKey.proto
- IdentityKey
e2ees/IdentityKeyPublic.proto
- IdentityKeyPublic
e2ees/InviteMsg.proto
- InviteMsg
e2ees/InviteRequest.proto
- InviteRequest
e2ees/InviteResponse.proto
- InviteResponse
e2ees/KemAlgType.proto
- KemAlgType
e2ees/KeyPair.proto
- KeyPair
e2ees/LeaveGroupMsg.proto
- LeaveGroupMsg
e2ees/LeaveGroupRequest.proto
- LeaveGroupRequest
e2ees/LeaveGroupResponse.proto
- LeaveGroupResponse
e2ees/MsgKey.proto
- MsgKey
e2ees/NotifLevel.proto
- NotifLevel
e2ees/One2oneMsgPayload.proto
- One2oneMsgPayload
e2ees/OneTimePreKey.proto
- OneTimePreKey
e2ees/OneTimePreKeyPublic.proto
- OneTimePreKeyPublic
e2ees/PendingRequest.proto
- PendingRequest
- PendingRequestType
e2ees/Plaintext.proto
- Plaintext
e2ees/PreKeyBundle.proto
- PreKeyBundle
e2ees/ProtoMsg.proto
- ProtoMsg
e2ees/ProtoMsgTag.proto
- ProtoMsgTag
e2ees/PublishSpkRequest.proto
- PublishSpkRequest
e2ees/PublishSpkResponse.proto
- PublishSpkResponse
e2ees/Ratchet.proto
- Ratchet
e2ees/ReceiverChainNode.proto
- ReceiverChainNode
e2ees/RegisterUserRequest.proto
- RegisterUserRequest
e2ees/RegisterUserResponse.proto
- RegisterUserResponse
e2ees/RemoveGroupMembersMsg.proto
- RemoveGroupMembersMsg
e2ees/RemoveGroupMembersRequest.proto
- RemoveGroupMembersRequest
e2ees/RemoveGroupMembersResponse.proto
- RemoveGroupMembersResponse
e2ees/RemoveUserDeviceMsg.proto
- RemoveUserDeviceMsg
e2ees/ResponseCode.proto
- ResponseCode
e2ees/SenderChainNode.proto
- SenderChainNode
e2ees/SendGroupMsgRequest.proto
- SendGroupMsgRequest
e2ees/SendGroupMsgResponse.proto
- SendGroupMsgResponse
e2ees/SendOne2oneMsgRequest.proto
- SendOne2oneMsgRequest
e2ees/SendOne2oneMsgResponse.proto
- SendOne2oneMsgResponse
e2ees/ServerHeartbeatMsg.proto
- ServerHeartbeatMsg
e2ees/ServerSignedSignature.proto
- ServerSignedSignature
e2ees/Session.proto
- Session
e2ees/SignedPreKey.proto
- SignedPreKey
e2ees/SignedPreKeyPublic.proto
- SignedPreKeyPublic
e2ees/SkippedMsgKeyNode.proto
- SkippedMsgKeyNode
e2ees/SupplyOpksMsg.proto
- SupplyOpksMsg
e2ees/SupplyOpksRequest.proto
- SupplyOpksRequest
e2ees/SupplyOpksResponse.proto
- SupplyOpksResponse
e2ees/SystemManagerMsg.proto
- SystemManagerMsg
- SystemOp
e2ees/UpdateUserMsg.proto
- UpdateUserAvatarArg
- UpdateUserBackupPasskeyArg
- UpdateUserMsg
- UpdateUserNameArg
- UpdateUserPrivacyArg
- UpdateUserStateArg
- UpdateUserOp
e2ees/UpdateUserRequest.proto
- UpdateUserRequest
e2ees/UpdateUserResponse.proto
- UpdateUserResponse
e2ees/UpgradeE2eePackMsg.proto
- UpgradeE2eePackMsg
e2ees/UserDevicesBundle.proto
- UserDevicesBundle
ski/AnsweredStreamEvent.proto
- AnsweredStreamEvent
ski/AudioPayload.proto
- AudioPayload
ski/BlockState.proto
- BlockState
ski/ContactPayload.proto
- ContactPayload
ski/CreateStreamEvent.proto
- CreateStreamEvent
ski/DataPayload.proto
- DataPayload
ski/DeclineStreamEvent.proto
- DeclineStreamEvent
ski/DecryptStatusPayload.proto
- DecryptStatusPayload
ski/DeletePayload.proto
- DeletePayload
ski/DestroyStreamEvent.proto
- DestroyStreamEvent
ski/FilePayload.proto
- FilePayload
ski/Forward.proto
- Forward
ski/FriendNotifPayload.proto
- FriendNotifPayload
ski/FriendStatus.proto
- FriendStatus
ski/GroupNotifPayload.proto
- GroupNotifPayload
ski/HidePayload.proto
- HidePayload
ski/ImagePayload.proto
- ImagePayload
ski/LocationPayload.proto
- LocationPayload
ski/MsgState.proto
- MsgState
ski/MsgType.proto
- MsgType
ski/PlainMsg.proto
- PlainMsg
ski/Reply.proto
- Reply
ski/Report.proto
- Report
ski/ReportReason.proto
- ReportReason
ski/RetractPayload.proto
- RetractPayload
ski/StickerPayload.proto
- StickerPayload
ski/StreamPayload.proto
- StreamPayload
ski/StreamType.proto
- StreamType
ski/SyncMsg.proto
- SyncMsg
- UpdateBackupPasskeyArg
- SyncOp
ski/SystemNotifPayload.proto
- SystemNotifPayload
ski/TextPayload.proto
- TextPayload
ski/UserState.proto
- UserState
ski/UserType.proto
- UserType
ski/VideoPayload.proto
- VideoPayload
skiserver/AcquireAuthCodeRequest.proto
- AcquireAuthCodeRequest
skiserver/AcquireAuthCodeResponse.proto
- AcquireAuthCodeResponse
skiserver/AcquireGroupMemberInfosRequest.proto
- AcquireGroupMemberInfosRequest
skiserver/AcquireGroupMemberInfosResponse.proto
- AcquireGroupMemberInfosResponse
skiserver/AcquireServerInfoRequest.proto
- AcquireServerInfoRequest
skiserver/AcquireServerInfoResponse.proto
- AcquireServerInfoResponse
skiserver/AddFriendRequest.proto
- AddFriendRequest
skiserver/AddFriendResponse.proto
- AddFriendResponse
- AddAttentionStatus
skiserver/AskUserIdAvailableRequest.proto
- AskUserIdAvailableRequest
skiserver/AskUserIdAvailableResponse.proto
- AskUserIdAvailableResponse
skiserver/BackupMsgRequest.proto
- BackupMsgRequest
skiserver/BackupMsgResponse.proto
- BackupMsgResponse
skiserver/BackupPasskey.proto
- BackupPasskey
- BackupPasskeyItem
skiserver/BlockFriendRequest.proto
- BlockFriendRequest
skiserver/BlockFriendResponse.proto
- BlockFriendResponse
skiserver/E2eeBackupService.proto
- E2eeBackupService
skiserver/E2eeBidiService.proto
- E2eeBidiService
skiserver/E2eeS2SService.proto
- E2eeS2SService
skiserver/E2eeUnaryService.proto
- E2eeUnaryService
skiserver/FindUserRequest.proto
- FindUserRequest
skiserver/FindUserResponse.proto
- FindUserResponse
skiserver/GetFriendsRequest.proto
- GetFriendsRequest
skiserver/GetFriendsResponse.proto
- GetFriendsResponse
skiserver/GetMsgBackupTsRequest.proto
- GetMsgBackupTsRequest
skiserver/GetMsgBackupTsResponse.proto
- GetMsgBackupTsResponse
skiserver/GetUserRequest.proto
- GetUserRequest
skiserver/GetUserResponse.proto
- GetUserResponse
skiserver/JoinGroupRequest.proto
- JoinGroupRequest
skiserver/JoinGroupResponse.proto
- JoinGroupResponse
skiserver/JwtToken.proto
- JwtToken
skiserver/LoginRequest.proto
- LoginRequest
skiserver/LoginResponse.proto
- LoginResponse
skiserver/LogoutRequest.proto
- LogoutRequest
skiserver/LogoutResponse.proto
- LogoutResponse
skiserver/MemoFriendRequest.proto
- MemoFriendRequest
skiserver/MemoFriendResponse.proto
- MemoFriendResponse
skiserver/MsgBackupDTO.proto
- MsgBackupDTO
skiserver/MsgBackupTsDTO.proto
- MsgBackupTsDTO
skiserver/NotifyCertUpdateRequest.proto
- NotifyCertUpdateRequest
skiserver/NotifyCertUpdateResponse.proto
- NotifyCertUpdateResponse
skiserver/RecoverMsgRequest.proto
- RecoverMsgRequest
skiserver/RecoverMsgResponse.proto
- RecoverMsgResponse
skiserver/RemoveFriendRequest.proto
- RemoveFriendRequest
skiserver/RemoveFriendResponse.proto
- RemoveFriendResponse
skiserver/RemoveUserDeviceRequest.proto
- RemoveUserDeviceRequest
skiserver/RemoveUserDeviceResponse.proto
- RemoveUserDeviceResponse
skiserver/ServerAcquireLoginRequest.proto
- ServerAcquireLoginRequest
skiserver/ServerAcquireLoginResponse.proto
- ServerAcquireLoginResponse
skiserver/ServerLoginRequest.proto
- ServerLoginRequest
skiserver/ServerLoginResponse.proto
- ServerLoginResponse
skiserver/ServerRefreshTokenRequest.proto
- ServerRefreshTokenRequest
skiserver/ServerRefreshTokenResponse.proto
- ServerRefreshTokenResponse
skiserver/SubmitProtoMsgRequest.proto
- SubmitProtoMsgRequest
skiserver/SubmitProtoMsgResponse.proto
- SubmitProtoMsgResponse
skiserver/UnBlockFriendRequest.proto
- UnBlockFriendRequest
skiserver/UnBlockFriendResponse.proto
- UnBlockFriendResponse
skiserver/UpdateAuthenticatorRequest.proto
- UpdateAuthenticatorRequest
skiserver/UpdateAuthenticatorResponse.proto
- UpdateAuthenticatorResponse
skiserver/UpdateGroupManagersRequest.proto
- UpdateGroupManagersRequest
skiserver/UpdateGroupManagersResponse.proto
- UpdateGroupManagersResponse
skiserver/UpdateGroupNameRequest.proto
- UpdateGroupNameRequest
skiserver/UpdateGroupNameResponse.proto
- UpdateGroupNameResponse
skiserver/UpdatePushIdRequest.proto
- UpdatePushIdRequest
- PushIDType
skiserver/UpdatePushIdResponse.proto
- UpdatePushIdResponse
skiserver/UpdateUserNameRequest.proto
- UpdateUserNameRequest
skiserver/UpdateUserNameResponse.proto
- UpdateUserNameResponse
skiserver/UpdateUserPrivacyRequest.proto
- UpdateUserPrivacyRequest
skiserver/UpdateUserPrivacyResponse.proto
- UpdateUserPrivacyResponse
skirobot/E2eeRobotService.proto
- E2eeRobotService
skirobot/EventNotification.proto
- EventNotification
- OnFriendManagerMsgReceived
- OnGroupCreated
- OnGroupManagerMsgReceived
- OnGroupMembersAdded
- OnGroupMembersRemoved
- OnGroupMsgReceived
- OnInited
- OnOne2oneMsgReceived
- OnOtherDeviceMsgReceived
- OnSystemManagerMsgReceived
- OnUserRegistered
- OnUserUpdated
skirobot/EventSubscription.proto
- EventSubscription
skirobot/RobotAddFriendRequest.proto
- RobotAddFriendRequest
skirobot/RobotAddGroupMembersRequest.proto
- RobotAddGroupMembersRequest
skirobot/RobotBlockFriendRequest.proto
- RobotBlockFriendRequest
skirobot/RobotCreateAccountRequest.proto
- RobotCreateAccountRequest
skirobot/RobotCreateGroupRequest.proto
- RobotCreateGroupRequest
skirobot/RobotDecryptFileRequest.proto
- RobotDecryptFileRequest
skirobot/RobotDecryptFileResponse.proto
- RobotDecryptFileResponse
skirobot/RobotEncryptFileRequest.proto
- RobotEncryptFileRequest
skirobot/RobotEncryptFileResponse.proto
- RobotEncryptFileResponse
skirobot/RobotGetFriendsRequest.proto
- RobotGetFriendsRequest
skirobot/RobotGetUserRequest.proto
- RobotGetUserRequest
skirobot/RobotInviteRequest.proto
- RobotInviteRequest
skirobot/RobotLoginRequest.proto
- RobotLoginRequest
skirobot/RobotLogoutRequest.proto
- RobotLogoutRequest
skirobot/RobotMemoFriendRequest.proto
- RobotMemoFriendRequest
skirobot/RobotMsgDTO.proto
- RobotMsgDTO
skirobot/RobotRemoveFriendRequest.proto
- RobotRemoveFriendRequest
skirobot/RobotRemoveGroupMembersRequest.proto
- RobotRemoveGroupMembersRequest
skirobot/RobotSendDecryptStatusRequest.proto
- RobotSendDecryptStatusRequest
skirobot/RobotSendDecryptStatusResponse.proto
- RobotSendDecryptStatusResponse
skirobot/RobotSendPlainMsgRequest.proto
- RobotSendPlainMsgRequest
skirobot/RobotSendSyncPlainMsgRequest.proto
- RobotSendSyncPlainMsgRequest
skirobot/RobotSendSyncPlainMsgResponse.proto
- RobotSendSyncPlainMsgResponse
skirobot/RobotUnBlockFriendRequest.proto
- RobotUnBlockFriendRequest
skirobot/RobotUpdatePushIdRequest.proto
- RobotUpdatePushIdRequest
skirobot/RobotUpdateUserNameRequest.proto
- RobotUpdateUserNameRequest
directory/E2eeDirectoryService.proto
- E2eeDirectoryService
directory/E2eeDomainProfile.proto
- E2eeDomainProfile
- ServiceConnection
directory/LookupDomainProfileRequest.proto
- LookupDomainProfileRequest
directory/LookupDomainProfileResponse.proto
- LookupDomainProfileResponse
directory/RetrieveCertListRequest.proto
- RetrieveCertListRequest
directory/RetrieveCertListResponse.proto
- RetrieveCertListResponse
directory/RetrieveCertRequest.proto
- RetrieveCertRequest
directory/RetrieveCertResponse.proto
- RetrieveCertResponse
directory/ValidateCertRequest.proto
- ValidateCertRequest
directory/ValidateCertResponse.proto
- ValidateCertResponse
Scalar Value Types

Package: ski

e2ees/AcceptMsg.proto​

AcceptMsg​

e2ees/AcceptRequest.proto​

AcceptRequest​

e2ees/AcceptResponse.proto​

AcceptResponse​

e2ees/Account.proto​

Account​

e2ees/AcquireSyncMsg.proto​

AcquireSyncMsg​

e2ees/AddGroupMemberDeviceMsg.proto​

AddGroupMemberDeviceMsg​

e2ees/AddGroupMemberDeviceRequest.proto​

AddGroupMemberDeviceRequest​

e2ees/AddGroupMemberDeviceResponse.proto​

AddGroupMemberDeviceResponse​

e2ees/AddGroupMembersMsg.proto​

AddGroupMembersMsg​

e2ees/AddGroupMembersRequest.proto​

AddGroupMembersRequest​

e2ees/AddGroupMembersResponse.proto​

AddGroupMembersResponse​

e2ees/AddUserDeviceMsg.proto​

AddUserDeviceMsg​

e2ees/AlgTypeDs.proto​

AlgTypeDs​

e2ees/AlgTypeHash.proto​

AlgTypeHash​

e2ees/AlgTypeKem.proto​

AlgTypeKem​

e2ees/AlgTypeSe.proto​

AlgTypeSe​

e2ees/Certificate.proto​

Cert​

Certificate​

Subject​

e2ees/ChainKey.proto​

ChainKey​

e2ees/ClientHeartbeatMsg.proto​

ClientHeartbeatMsg​

e2ees/ConsumeProtoMsgRequest.proto​

ConsumeProtoMsgRequest​

ProtoMsgOpState​

e2ees/ConsumeProtoMsgResponse.proto​

ConsumeProtoMsgResponse​

e2ees/CreateGroupMsg.proto​

CreateGroupMsg​

e2ees/CreateGroupRequest.proto​

CreateGroupRequest​

e2ees/CreateGroupResponse.proto​

CreateGroupResponse​

e2ees/DsAlgType.proto​

DsAlgType​

e2ees/E2eeAddress.proto​

E2eeAddress​

PeerGroup​

PeerUser​

e2ees/E2eeMsg.proto​

E2eeMsg​

e2ees/E2eePackId.proto​

E2eePackId​

e2ees/FriendManagerMsg.proto​

FriendManagerMsg​

FriendshipDTO​

FriendOp​

e2ees/GetGroupRequest.proto​

GetGroupRequest​

e2ees/GetGroupResponse.proto​

GetGroupResponse​

e2ees/GetPreKeyBundleRequest.proto​

GetPreKeyBundleRequest​

e2ees/GetPreKeyBundleResponse.proto​

GetPreKeyBundleResponse​

e2ees/GroupInfo.proto​

GroupInfo​

e2ees/GroupManagerMsg.proto​

AddGroupMembersArg​

CreateGroupArg​

DestroyGroupArg​