Skip to main content

Package: skiserver

The skiserver package is the protobuf designed for communicating with backend grpc messaging service.

skiserver/AcquireAuthCodeRequest.proto

AcquireAuthCodeRequest

Request for acquiring auth code.

FieldTypeLabelDescription
authenticatorstringEmail (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.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
ttlint32Time to live (seconds) for auth code that has

Top

skiserver/AcquireGroupMemberInfosRequest.proto

AcquireGroupMemberInfosRequest

Request for acquiring group member info list.

FieldTypeLabelDescription
user_addresse2ees.E2eeAddressUser address with userId and domain.

Top

skiserver/AcquireGroupMemberInfosResponse.proto

AcquireGroupMemberInfosResponse

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

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
group_member_infose2ees.GroupMemberInforepeatedList of groupMemberInfo that consists of sign public key of uploaded identity public key.

Top

skiserver/AcquireServerInfoRequest.proto

AcquireServerInfoRequest

Request for acquiring server info.

FieldTypeLabelDescription
heartbeate2ees.ClientHeartbeatMsgSend the heartbeat msg to server.

Top

skiserver/AcquireServerInfoResponse.proto

AcquireServerInfoResponse

Response for acquiring server info.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
heartbeate2ees.ServerHeartbeatMsg

Top

skiserver/AddFriendRequest.proto

AddFriendRequest

Request for adding a friend.

FieldTypeLabelDescription
user_addresse2ees.E2eeAddressThe e2ee address for user who sends this request.
to_userstringThe simple e2ee address of user who will be added as a friend.
from_userstringThe simple e2ee address of user who is adding toUser as a friend.
from_usernamestringThe name of user who is adding toUser as a friend.

Top

skiserver/AddFriendResponse.proto

AddFriendResponse

Response for adding a friend.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
statusAddAttentionStatusThe friendship status.
friende2ees.FriendshipDTOThe friendship data.

AddAttentionStatus

The friendship status.

NameNumberDescription
ADD_ATTENTION_STATUS_REJECTED0
ADD_ATTENTION_STATUS_ATTENTION_ADDED1
ADD_ATTENTION_STATUS_FRIEND_ADDED2
ADD_ATTENTION_STATUS_ALREADY_ATTENDED3
ADD_ATTENTION_STATUS_ALREADY_FRIENDED4
ADD_ATTENTION_STATUS_REMOVE_BLOCKED5
ADD_ATTENTION_STATUS_EXCEPTION6

Top

skiserver/AskUserIdAvailableRequest.proto

AskUserIdAvailableRequest

Request for checking if a userId is available.

FieldTypeLabelDescription
user_idstringThe userId to be registered.

Top

skiserver/AskUserIdAvailableResponse.proto

AskUserIdAvailableResponse

Response for checking if a userId is available.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Top

skiserver/BackupMsgRequest.proto

BackupMsgRequest

Request for backing up a message.

FieldTypeLabelDescription
backup_msgMsgBackupDTOThe backup data.

Top

skiserver/BackupMsgResponse.proto

BackupMsgResponse

Response for backing up a message.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
time_backupint64The back up time of the backup msg.

Top

skiserver/BackupPasskey.proto

BackupPasskey

Message for BackupPasskey.

FieldTypeLabelDescription
passkeysBackupPasskeyItemrepeatedA list of passkey items.

BackupPasskeyItem

Message for BackupPasskeyItem.

FieldTypeLabelDescription
verint32
e2ee_pack_iduint32The e2ee pack ID used for this passkey.
indexint32The index of passkey item start from 0.
passkeybytesThe passkey for backing up msg.
passkey_fingerprintbytesThe hash value as the fingerprint of passkey.
signing_private_keybytesThe private key data for signing backup msg.
signing_public_keybytesThe public key data for verifying backup msg.
signing_public_key_fingerprintbytesThe hash value as the fingerprint of the signing public key.

Top

skiserver/BlockFriendRequest.proto

BlockFriendRequest

Request for blocking a friend.

FieldTypeLabelDescription
user_addresse2ees.E2eeAddressThe e2ee address for user who sends this request.
to_userstringThe simple e2ee address for a user to be blocked.
from_userstringThe simple e2ee address for the user who is blocking toUser.

Top

skiserver/BlockFriendResponse.proto

BlockFriendResponse

Response for blocking a friend.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
friende2ees.FriendshipDTOThe updated friendship data.

Top

skiserver/E2eeBackupService.proto

E2eeBackupService

The backup unary grpc service.

Method NameRequest TypeResponse TypeDescription
GetMsgBackupTsGetMsgBackupTsRequestGetMsgBackupTsResponse
BackupMsgBackupMsgRequestBackupMsgResponse
RecoverMsgRecoverMsgRequestRecoverMsgResponse

Top

skiserver/E2eeBidiService.proto

E2eeBidiService

The e2ee bidirection stream grpc service.

Method NameRequest TypeResponse TypeDescription
Communicate.e2ees.ProtoMsg stream.e2ees.ProtoMsg streambidi streaming operations

Top

skiserver/E2eeS2SService.proto

E2eeS2SService

The e2ee server to server unary grpc service.

Method NameRequest TypeResponse TypeDescription
ServerAcquireLoginServerAcquireLoginRequestServerAcquireLoginResponse
ServerLoginServerLoginRequestServerLoginResponse
ServerRefreshTokenServerRefreshTokenRequestServerRefreshTokenResponse
GetPreKeyBundle.e2ees.GetPreKeyBundleRequest.e2ees.GetPreKeyBundleResponse
Invite.e2ees.InviteRequest.e2ees.InviteResponse
SendOne2oneMsg.e2ees.SendOne2oneMsgRequest.e2ees.SendOne2oneMsgResponse
GetUserGetUserRequestGetUserResponse
RemoveUserDeviceRemoveUserDeviceRequestRemoveUserDeviceResponse
AddFriendAddFriendRequestAddFriendResponse
RemoveFriendRemoveFriendRequestRemoveFriendResponse
BlockFriendBlockFriendRequestBlockFriendResponse
UnBlockFriendUnBlockFriendRequestUnBlockFriendResponse
AddGroupMembers.e2ees.AddGroupMembersRequest.e2ees.AddGroupMembersResponse
AddGroupMemberDevice.e2ees.AddGroupMemberDeviceRequest.e2ees.AddGroupMemberDeviceResponse
RemoveGroupMembers.e2ees.RemoveGroupMembersRequest.e2ees.RemoveGroupMembersResponse
JoinGroupJoinGroupRequestJoinGroupResponse
LeaveGroup.e2ees.LeaveGroupRequest.e2ees.LeaveGroupResponse
UpdateGroupNameUpdateGroupNameRequestUpdateGroupNameResponse
UpdateGroupManagersUpdateGroupManagersRequestUpdateGroupManagersResponse
GetGroup.e2ees.GetGroupRequest.e2ees.GetGroupResponse
SendGroupMsg.e2ees.SendGroupMsgRequest.e2ees.SendGroupMsgResponse
AcquireGroupMemberInfosAcquireGroupMemberInfosRequestAcquireGroupMemberInfosResponse
SubmitProtoMsgSubmitProtoMsgRequestSubmitProtoMsgResponse
NotifyCertUpdateNotifyCertUpdateRequestNotifyCertUpdateResponse

Top

skiserver/E2eeUnaryService.proto

E2eeUnaryService

The e2ee unary grpc service.

Method NameRequest TypeResponse TypeDescription
AcquireAuthCodeAcquireAuthCodeRequestAcquireAuthCodeResponse
AskUserIdAvailableAskUserIdAvailableRequestAskUserIdAvailableResponse
RegisterUser.e2ees.RegisterUserRequest.e2ees.RegisterUserResponse
UpdateAuthenticatorUpdateAuthenticatorRequestUpdateAuthenticatorResponse
LoginLoginRequestLoginResponse
LogoutLogoutRequestLogoutResponse
AcquireServerInfoAcquireServerInfoRequestAcquireServerInfoResponse
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
AddFriendAddFriendRequestAddFriendResponse
RemoveFriendRemoveFriendRequestRemoveFriendResponse
BlockFriendBlockFriendRequestBlockFriendResponse
UnBlockFriendUnBlockFriendRequestUnBlockFriendResponse
MemoFriendMemoFriendRequestMemoFriendResponse
GetFriendsGetFriendsRequestGetFriendsResponse
GetUserGetUserRequestGetUserResponse
FindUserFindUserRequestFindUserResponse
CreateGroup.e2ees.CreateGroupRequest.e2ees.CreateGroupResponse
AddGroupMembers.e2ees.AddGroupMembersRequest.e2ees.AddGroupMembersResponse
AddGroupMemberDevice.e2ees.AddGroupMemberDeviceRequest.e2ees.AddGroupMemberDeviceResponse
RemoveGroupMembers.e2ees.RemoveGroupMembersRequest.e2ees.RemoveGroupMembersResponse
JoinGroupJoinGroupRequestJoinGroupResponse
LeaveGroup.e2ees.LeaveGroupRequest.e2ees.LeaveGroupResponse
UpdateGroupNameUpdateGroupNameRequestUpdateGroupNameResponse
UpdateGroupManagersUpdateGroupManagersRequestUpdateGroupManagersResponse
GetGroup.e2ees.GetGroupRequest.e2ees.GetGroupResponse
SendGroupMsg.e2ees.SendGroupMsgRequest.e2ees.SendGroupMsgResponse
UpdatePushIdUpdatePushIdRequestUpdatePushIdResponse
UpdateUserNameUpdateUserNameRequestUpdateUserNameResponse
UpdateUserPrivacyUpdateUserPrivacyRequestUpdateUserPrivacyResponse
ConsumeProtoMsg.e2ees.ConsumeProtoMsgRequest.e2ees.ConsumeProtoMsgResponse

Top

skiserver/FindUserRequest.proto

FindUserRequest

Request for finding user.

FieldTypeLabelDescription
querystringurl-encoded string such as: userId%3Dxxx%26domain%3Dxxxx or authenticator%3Duser%40example.com.
user_addresse2ees.E2eeAddressThe address of the user who us sending this request.

Top

skiserver/FindUserResponse.proto

FindUserResponse

Response for finding a user.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
friende2ees.FriendshipDTOThe friendship data of a retrieved user.

Top

skiserver/GetFriendsRequest.proto

GetFriendsRequest

Request for getting friendship data.

FieldTypeLabelDescription
last_modified_dateint64The latest modified time stamp of friendship in client side.

Top

skiserver/GetFriendsResponse.proto

GetFriendsResponse

Response for getting friendship data.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
friendse2ees.FriendshipDTOrepeatedThe list of friendship data.

Top

skiserver/GetMsgBackupTsRequest.proto

GetMsgBackupTsRequest

Request for acquiring time stamps of backed up msgs.

FieldTypeLabelDescription
msg_idsstringrepeatedThe array of msg ids to be queried.

Top

skiserver/GetMsgBackupTsResponse.proto

GetMsgBackupTsResponse

Response for acquiring time stamps of backed up msgs.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
backup_tsesMsgBackupTsDTOrepeatedThe array of backup time stamps.

Top

skiserver/GetUserRequest.proto

GetUserRequest

Request for retrieving information of a user.

FieldTypeLabelDescription
to_userstringThe simple e2ee address for the user whose information is retrieved.
user_addresse2ees.E2eeAddressThe address of the user who is retrieving the information of toUser.

Top

skiserver/GetUserResponse.proto

GetUserResponse

Response for retrieving information of a user.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
friende2ees.FriendshipDTOThe friendship data of a retrieved user.

Top

skiserver/JoinGroupRequest.proto

JoinGroupRequest

Request for joining a group.

FieldTypeLabelDescription
to_groupstringThe simple e2ee address of the joining group.
user_addresse2ees.E2eeAddressThe address of the user joining the group

Top

skiserver/JoinGroupResponse.proto

JoinGroupResponse

Response for joining a group.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Top

skiserver/JwtToken.proto

JwtToken

Message for jwt token.

FieldTypeLabelDescription
tokenstringThe token.
expires_inint64The expiry time.

Top

skiserver/LoginRequest.proto

LoginRequest

Request for login.

FieldTypeLabelDescription
user_addresse2ees.E2eeAddressThe user e2ee address for whom is going to login.
passwordstringThe password to login the e2ee service.

Top

skiserver/LoginResponse.proto

LoginResponse

Response for login.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
authstringThe updated authorization code.
expires_inint64The time of expiration for the authorization code.
user_stateski.UserStateThe user state.
msgBackup_device_idstringThe optional main backup deviceId.

Top

skiserver/LogoutRequest.proto

LogoutRequest

Request for logout.

FieldTypeLabelDescription
user_addresse2ees.E2eeAddressThe user e2ee address (with device id) for whom is going to logout.

Top

skiserver/LogoutResponse.proto

LogoutResponse

Response for logout.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Top

skiserver/MemoFriendRequest.proto

MemoFriendRequest

Request for giving a memo name to a friend.

FieldTypeLabelDescription
user_addresse2ees.E2eeAddressThe e2ee address for user who sends this request.
to_userstringThe simple e2ee address for the user who is giving a memo name.
memonamestringThe memo name (max len = 12 utf-8 chars).

Top

skiserver/MemoFriendResponse.proto

MemoFriendResponse

Response for giving a memo name to a friend.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
friende2ees.FriendshipDTOThe updated friendship data.

Top

skiserver/MsgBackupDTO.proto

MsgBackupDTO

Message for a backup msg.

FieldTypeLabelDescription
msg_idstringThe msgId of the backup msg.
time_sendint64The time of the backup msg that was sent.
time_backupint64The back up time of the backup msg.
passkey_fingerprintbytesThe passkey fingerprint for the backup msg.
signing_public_key_fingerprintbytesThe hash value as the fingerprint of the signing public key.
encrypted_msgbytesThe encrypted backup msg.
plain_msg_signaturebytesThe signature of plain msg to be backed up.
encrypted_attachmentbytesThe optional encrypted attachment data of the backup msg.
plain_attachment_signaturebytesThe 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.

FieldTypeLabelDescription
msg_idstringThe msgId of the backup msg.
time_sendint64The time of the backup msg that was sent.
time_backupint64The time of the backup msg that was backed up.

Top

skiserver/NotifyCertUpdateRequest.proto

NotifyCertUpdateRequest

Request for notifying certificates update.

FieldTypeLabelDescription
tsint64The lastest time stamp for current list of certificates.

Top

skiserver/NotifyCertUpdateResponse.proto

NotifyCertUpdateResponse

Response for notifying certificates update.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Top

skiserver/RecoverMsgRequest.proto

RecoverMsgRequest

Request for recovering some backed up msgs.

FieldTypeLabelDescription
last_msg_idstringOptional last msgId that has been downloaded previously.
last_time_sendint64Optional last timestamp for a sent msg.
limitint32The maximal number of messages to be downloaded. (max 500)

Top

skiserver/RecoverMsgResponse.proto

RecoverMsgResponse

Response for recovering backed up msgs.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
backuped_msgsMsgBackupDTOrepeatedThe recovered data.

Top

skiserver/RemoveFriendRequest.proto

RemoveFriendRequest

Request for removing a friend.

FieldTypeLabelDescription
user_addresse2ees.E2eeAddressThe e2ee address for user who sends this request.
to_userstringThe simple e2ee address of user who will be removed as a friend.
from_userstringThe simple e2ee address of user who is removing toUser from contacts.

Top

skiserver/RemoveFriendResponse.proto

RemoveFriendResponse

Response for removing a friend.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
friende2ees.FriendshipDTOThe updated friendship data.

Top

skiserver/RemoveUserDeviceRequest.proto

RemoveUserDeviceRequest

Request for removing a user device.

FieldTypeLabelDescription
user_addresse2ees.E2eeAddressThe e2ee address for user who sends this request.
remove_user_device_msge2ees.RemoveUserDeviceMsgThe remove_user_device_msg.

Top

skiserver/RemoveUserDeviceResponse.proto

RemoveUserDeviceResponse

Response for removing a user device.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Top

skiserver/ServerAcquireLoginRequest.proto

ServerAcquireLoginRequest

Request for acquiring server login challenge.

FieldTypeLabelDescription
domainstringThe domain.

Top

skiserver/ServerAcquireLoginResponse.proto

ServerAcquireLoginResponse

Response for acquiring server login challenge..

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
challengestringThe chanllenge base64 string.

Top

skiserver/ServerLoginRequest.proto

ServerLoginRequest

Request for server login.

FieldTypeLabelDescription
domainstringThe domain.
certFingerprintbytesThe certFingerprint for the certificate that can be used to verify the response;
challengestringThe challenge base64 string.
responsestringThe base64 string that is the signature created by signing the challenge with server's key.

Top

skiserver/ServerLoginResponse.proto

ServerLoginResponse

Response for server login.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
cnstringThe common name.
domainstringThe domain.
access_tokenJwtTokenThe access token.
refresh_tokenJwtTokenThe refresh token.

Top

skiserver/ServerRefreshTokenRequest.proto

ServerRefreshTokenRequest

The request for refreshing server token.

FieldTypeLabelDescription
domainstringThe domain.
refresh_tokenstringThe refresh token.

Top

skiserver/ServerRefreshTokenResponse.proto

ServerRefreshTokenResponse

The response for refreshing server token.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
access_tokenJwtTokenThe accessToken for 30 days.
refresh_tokenJwtTokenThe refreshToken for 180 days.

Top

skiserver/SubmitProtoMsgRequest.proto

SubmitProtoMsgRequest

Request for submitting protoMsg to a s2s service.

FieldTypeLabelDescription
protoMsge2ees.ProtoMsgThe protoMsg to be delivered.
ignoredDeviceIdListstringrepeatedOptional ignored deviceId list.

Top

skiserver/SubmitProtoMsgResponse.proto

SubmitProtoMsgResponse

Response for submitting protoMsg to a s2s service.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Top

skiserver/UnBlockFriendRequest.proto

UnBlockFriendRequest

Request for unblocking a friend.

FieldTypeLabelDescription
user_addresse2ees.E2eeAddressThe e2ee address for user who sends this request.
to_userstringThe simple e2ee address for a user to be unblocked.
from_userstringThe simple e2ee address for the user who is unblocking toUser.

Top

skiserver/UnBlockFriendResponse.proto

UnBlockFriendResponse

Response for unblocking a friend.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
friende2ees.FriendshipDTOThe updated friendship data.

Top

skiserver/UpdateAuthenticatorRequest.proto

UpdateAuthenticatorRequest

Request for updating authenticator.

FieldTypeLabelDescription
authenticatorstringEmail (mailto:xxx@xxx) or mobile phone number (tel:xxx@xxx) to receive auth code.
auth_codestringThe auth code received from authenticator.

Top

skiserver/UpdateAuthenticatorResponse.proto

UpdateAuthenticatorResponse

Response for updating authenticator.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Top

skiserver/UpdateGroupManagersRequest.proto

UpdateGroupManagersRequest

Request for updating group managers.

FieldTypeLabelDescription
to_groupstringThe simple e2ee address of the updating group.
from_userstringThe simple e2ee address of the user who is updating the group.
updating_memberse2ees.GroupMemberrepeatedThe list of updated group members with new roles.

Top

skiserver/UpdateGroupManagersResponse.proto

UpdateGroupManagersResponse

Response for updating group managers.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
group_managerse2ees.GroupMemberrepeatedThe list of new group managers.

Top

skiserver/UpdateGroupNameRequest.proto

UpdateGroupNameRequest

Request for renaming a group.

FieldTypeLabelDescription
to_groupstringThe simple e2ee address of the renaming group.
from_userstringThe simple e2ee address of the user who is renaming the group.
group_namestringThe group name.

Top

skiserver/UpdateGroupNameResponse.proto

UpdateGroupNameResponse

Response for renaming a group.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Top

skiserver/UpdatePushIdRequest.proto

UpdatePushIdRequest

Request for updating pushId.

FieldTypeLabelDescription
push_idstringThe pushId for push notification.
typePushIDTypeThe optional pushId type.

PushIDType

NameNumberDescription
PUSH_ID_TYPE_NORMAL0PushId for general circumstances.
PUSH_ID_TYPE_APNS_VOIP1PushId for apns voip.

Top

skiserver/UpdatePushIdResponse.proto

UpdatePushIdResponse

Response for updating pushId.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Top

skiserver/UpdateUserNameRequest.proto

UpdateUserNameRequest

Request for updating user name.

FieldTypeLabelDescription
usernamestringThe user name (max len = 12 utf-8 chars).

Top

skiserver/UpdateUserNameResponse.proto

UpdateUserNameResponse

Response for updating user name.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Top

skiserver/UpdateUserPrivacyRequest.proto

UpdateUserPrivacyRequest

Request for updating user privacy.

FieldTypeLabelDescription
allow_attentionboolAllow being added as a friend.
allow_greetingboolAllow receiving msg from strangers.
allow_auto_friendboolAllow adding friend automatically when someone is adding user as friend.

Top

skiserver/UpdateUserPrivacyResponse.proto

UpdateUserPrivacyResponse

Response for updating user privacy.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)