Skip to content

v0.0.201

pan-direct-proto

atom/ladies/first.proto

Category

FieldTypeLabelDescription
idint64
namestring
sortint64

Lady

FieldTypeLabelDescription
uidint64
namestring
summarystring
coverstring
style_tagstringrepeated

LadyRank

FieldTypeLabelDescription
uidint64
namestring
coverstring
vote_countint64
rankint64

atom/ladyapp/first.proto

FileContent

FieldTypeLabelDescription
indexint64
file_urlstring

LadyImage

FieldTypeLabelDescription
logo_urlstring
model_card_urlFileContentrepeated
identity_card_urlFileContentrepeated
bank_account_urlstring

LadyIntro

FieldTypeLabelDescription
girl_typestring
hash_tagstring
skillstringrepeated
likestringrepeated
afraidstringrepeated
sexy_partstringrepeated

LadyProfileData

FieldTypeLabelDescription
idint64
member_uuidstring
lady_textLadyText
lady_imageLadyImage
lady_recordLadyRecord
profile_verifyint64
general_dataint64
reject_columnsstringrepeated
created_atgoogle.protobuf.Timestamp
updated_atgoogle.protobuf.Timestamp

LadyRecord

FieldTypeLabelDescription
be_jkf_lady_urlstring
join_jkf_urlstring
work_urlstring
dreamboat_urlstring
choose_urlstring
interest_urlstring
future_urlstring

LadyText

FieldTypeLabelDescription
phonestring
stage_namestring
real_namestring
addressstring
birthdaygoogle.protobuf.Timestamp
blood_typeLadyText.BloodType
buststring
waistint64
hipsint64
heightint64
weightint64
linestring
instagramstring
facebookstring
twitterstring
lady_introLadyIntro

LadyText.BloodType

NameNumberDescription
BLOOD_TYPE_EMPTY0
BLOOD_TYPE_A1
BLOOD_TYPE_B2
BLOOD_TYPE_AB3
BLOOD_TYPE_O4
BLOOD_TYPE_UNKNOWN5

atom/member/first.proto

AddressBook

FieldTypeLabelDescription
idint64
full_namestring
zip_codestring
addressstring
phonestring
platformstring
default_buyerbool
typeAddressBook.Type

AddressBookAll

FieldTypeLabelDescription
valueAddressBookrepeated

Education

FieldTypeLabelDescription
edu_levelstring
graduate_schoolstring

History

FieldTypeLabelDescription
jobJob
eduEducation
socialSocial
salaryHistory.Salary
summarystring

Identity

FieldTypeLabelDescription
uidint64
object_idstring
huidstring
emailstring
usernamestring

Individual

FieldTypeLabelDescription
full_namestring
birthdaygoogle.protobuf.Timestamp

Job

FieldTypeLabelDescription
company_namestring
positionstring
professionalstring

Object

FieldTypeLabelDescription
object_idstring
uidint64
usernamestring
avatarstring
group_idint64Deprecated. group_id deprecated
group_namestringDeprecated. group_name deprecated
emailstring
activate_ipstring
activate_dategoogle.protobuf.Timestamp
phonestring僅會員自身可見
activatebool
display_namestring
genderGender
vip_expire_dategoogle.protobuf.Timestamp
hash_uidstring
phone_idstring僅會員自身可見
email_statusint64
is_ownerbool
createdgoogle.protobuf.Timestamp
modifiedgoogle.protobuf.Timestamp
can_new_childbool
email_verifiedbool

Secure

FieldTypeLabelDescription
passwordstring
saltstring
expiresgoogle.protobuf.Timestamp

Social

FieldTypeLabelDescription
linestring
fbstring
igstring
jvidstring

Status

FieldTypeLabelDescription
group_namestring

TokenInfo

FieldTypeLabelDescription
object_idstring
uidint64
usernamestring
group_idint64
group_namestring
display_namestring
phone_idstring

VirtualAddress

FieldTypeLabelDescription
areastring
citystring
detailstring
countrystring
zipstring

AddressBook.Type

NameNumberDescription
TypeNone0
TypeMainLive1
TypeMainShipping2

Gender

NameNumberDescription
GENDER_NOTSET0
Male1
Female2

History.Salary

NameNumberDescription
SalaryNone0
SalaryLevel11
SalaryLevel22
SalaryLevel33
SalaryLevel44
SalaryLevel55
SalaryLevel66

general/admin/admin.proto

AddLadyCategoryRequest

FieldTypeLabelDescription
namestring
sortint64

AddLadyCategoryResponse

FieldTypeLabelDescription
categorypan.atom.ladies.Category

ChangeMemberEmailRequest

FieldTypeLabelDescription
admin_tokenstring
uidint64
emailstring

ChangeMemberEmailResponse

ChangeMemberEmailResponse.Error

ChangeMemberPasswordRequest

FieldTypeLabelDescription
admin_tokenstring
uidint64
passwordstring

ChangeMemberPasswordResponse

ChangeMemberPasswordResponse.Error

DeleteLadyCategoryRequest

FieldTypeLabelDescription
idint64

DeleteLadyCategoryResponse

GoogleLoginRequest

FieldTypeLabelDescription
access_tokenstring

GoogleLoginResponse

FieldTypeLabelDescription
admin_tokenstring

LadyCategoriesRequest

LadyCategoriesResponse

FieldTypeLabelDescription
categoriespan.atom.ladies.Categoryrepeated

LadyData

FieldTypeLabelDescription
uidint64
jkf_usernamestring
display_namestring
style_tagstringrepeated
phone_numberstring
category_idint64
category_sortint64

LadyListRequest

FieldTypeLabelDescription
uidint64optional, fuzzy search
namestringoptional, fuzzy search
style_tagstringoptional
category_idint64optional

LadyListResponse

FieldTypeLabelDescription
LadyLadyDatarepeated

LadySetCategoryRequest

FieldTypeLabelDescription
target_uidint64
category_idint64
sortint64

LadySetCategoryResponse

LadySetStyleTagsRequest

FieldTypeLabelDescription
target_uidint64
style_tagstringrepeated

LadySetStyleTagsResponse

LadyUpdateRequest

FieldTypeLabelDescription
target_uidint64
display_namestring
phone_numberstring

LadyUpdateResponse

RemoveMemberAvatarRequest

FieldTypeLabelDescription
admin_tokenstring
uidint64

RemoveMemberAvatarResponse

RemoveMemberAvatarResponse.Error

ValidateAdminTokenRequest

FieldTypeLabelDescription
admin_tokenstring

ValidateAdminTokenResponse

FieldTypeLabelDescription
is_validbool
emailstring
rolesstringrepeated

ChangeMemberEmailResponse.Error.Value

NameNumberDescription
None0
NotAuthorized1001
UserNotFound1002
EmailInUseInJKF1003
EmailNotUsableInJKF1004
EmailInUseInPan1005
UpdateEmailFailed1006
InternalError1007

ChangeMemberPasswordResponse.Error.Value

NameNumberDescription
None0
NotAuthorized1001
ParsePasswordFailed1002
PasswordFormatIncorrect1003
UserNotFound1004
UpdatePasswordFailed1005

RemoveMemberAvatarResponse.Error.Value

NameNumberDescription
None0
NotAuthorized1001
UserNotFound1002
RemoveAvatarFailed1003
RemoveAvatarInJKFFailed1004
InternalError1005

AdminService

Method NameRequest TypeResponse TypeDescription
GoogleLoginGoogleLoginRequestGoogleLoginResponse
ValidateAdminTokenValidateAdminTokenRequestValidateAdminTokenResponse
ChangeMemberPasswordChangeMemberPasswordRequestChangeMemberPasswordResponsemember api
ChangeMemberEmailChangeMemberEmailRequestChangeMemberEmailResponse
RemoveMemberAvatarRemoveMemberAvatarRequestRemoveMemberAvatarResponse
LadyListLadyListRequestLadyListResponselady api
LadyUpdateLadyUpdateRequestLadyUpdateResponse
LadySetStyleTagsLadySetStyleTagsRequestLadySetStyleTagsResponse
LadySetCategoryLadySetCategoryRequestLadySetCategoryResponse
LadyCategoriesLadyCategoriesRequestLadyCategoriesResponselady category
AddLadyCategoryAddLadyCategoryRequestAddLadyCategoryResponse
DeleteLadyCategoryDeleteLadyCategoryRequestDeleteLadyCategoryResponse

general/application/app.proto

AppId

AppId.Value

NameNumberDescription
None0
jkforum1
jkfpost2
jkfstar3
jkface4
jr24h5
jktalk6
jcontrol7
shop24h8
sugar9
jktank10
avplus11

general/ladies/error.proto

ErrVote

ErrVote.General

NameNumberDescription
DEFAULT0
PHONE_REQUIRED1001
OUT_OF_QUOTA_FOR_TIME1002
OUT_OF_QUOTA_FOR_LADY1003
LOGIN_OR_REGISTER_REQUIRED1004

general/ladies/first.proto

CanIVoteRequest

FieldTypeLabelDescription
access_tokenstring
lady_uidint64

CanIVoteResponse

CategoriesRequest

CategoriesResponse

FieldTypeLabelDescription
categoriespan.atom.ladies.Categoryrepeated

GetMyRankRequest

FieldTypeLabelDescription
access_tokenstring這個 string 可以直接當作 uid 查詢

LadiesListRequest

FieldTypeLabelDescription
namestring
tagstring
category_idint64

LadiesListResponse

FieldTypeLabelDescription
Ladypan.atom.ladies.Ladyrepeated

LadyVoteType

RankListRequest

FieldTypeLabelDescription
pageint64
limitint64
periodRankListRequest.Period

RankListResponse

FieldTypeLabelDescription
ladypan.atom.ladies.LadyRankrepeated

VoteRequest

FieldTypeLabelDescription
access_tokenstring
lady_uidint64

VoteResponse

LadyVoteType.General

NameNumberDescription
LadyVoteTypeNormal0
LadyVoteTypeUserVoteReward1
LadyVoteTypeDayReward2
LadyVoteTypeRankReward3

RankListRequest.Period

NameNumberDescription
all0
week1
month2

LadiesService

Method NameRequest TypeResponse TypeDescription
LadiesListLadiesListRequestLadiesListResponse
RankListRankListRequestRankListResponse
VoteVoteRequestVoteResponse
GetMyRankGetMyRankRequest.pan.atom.ladies.LadyRank
CanIVoteCanIVoteRequestCanIVoteResponse
CategoriesCategoriesRequestCategoriesResponse

general/ladyadmin/ladyadmin.proto

GeneralLadyDataReq

FieldTypeLabelDescription
lady_register_profile_idint64

GeneralLadyDataRes

LadyProfileAttachmentReq

FieldTypeLabelDescription
lady_register_profile_idint64
attachment_typeLadyProfileAttachmentReq.AttachmentType

LadyProfileAttachmentRes

FieldTypeLabelDescription
lady_profile_attachmentpan.atom.ladyapp.LadyProfileData

LadyProfileDataVerifyReq

FieldTypeLabelDescription
lady_register_profile_idint64
data_verifyLadyProfileDataVerifyReq.DataVerify
column_namestring

LadyProfileDataVerifyRes

LadyProfileListReq

FieldTypeLabelDescription
pageint64
limitint64
phone_numberstringoptional, fuzzy search
stage_namestringoptional, fuzzy search
profile_verifyint64optional

LadyProfileListRes

FieldTypeLabelDescription
lady_profile_datapan.atom.ladyapp.LadyProfileDatarepeated
totalint64

SendMessageToLadyReq

FieldTypeLabelDescription
phonestring

SendMessageToLadyRes

LadyProfileAttachmentReq.AttachmentType

NameNumberDescription
IMAGE0
RECORD1
ALL2

LadyProfileDataVerifyReq.DataVerify

NameNumberDescription
DATA_ONE_DENY0
DATA_ALL_CONFIRM1

LadyAdminService

Method NameRequest TypeResponse TypeDescription
SendMessageToLadySendMessageToLadyReqSendMessageToLadyRes傳送手機簡訊給女郎
LadyProfileListLadyProfileListReqLadyProfileListRes取得女郎註冊資料列表 + 查詢
LadyProfileAttachmentLadyProfileAttachmentReqLadyProfileAttachmentRes取得女郎圖片或錄音檔案
LadyProfileDataVerifyLadyProfileDataVerifyReqLadyProfileDataVerifyRes審核女郎註冊資料
GeneralLadyDataGeneralLadyDataReqGeneralLadyDataRes建立女郎相關資料給Pan

general/ladyapp/error.proto

ErrBase

ErrSaveLady

ErrSendSmsCode

ErrBase.General

NameNumberDescription
NOTSET0
INVALID_PARAMETER1001
SERVER_ERROR1002
TOKEN_INVALID1003

ErrSaveLady.General

NameNumberDescription
NOTSET0
LADY_DATA_EMPTY3001

ErrSendSmsCode.General

NameNumberDescription
NOTSET0
PLEASE_GO_PAN_LOGIN2001
SMS_RESEND_DENIED2002
SMS_RESEND_LIMIT2003

general/ladyapp/first.proto

CheckLadyRegisterProfileReq

FieldTypeLabelDescription
access_tokenstring

CheckLadyRegisterProfileRes

FieldTypeLabelDescription
profile_statusCheckLadyRegisterProfileRes.ProfileStatus
check_columnstringrepeated

CheckPhoneReq

FieldTypeLabelDescription
phone_numberstring
country_codestring

CheckPhoneRes

FieldTypeLabelDescription
phone_statusCheckPhoneRes.PhoneStatus

GenerateAuthTokenReq

FieldTypeLabelDescription
access_tokenstring
app_idstring

GenerateAuthTokenRes

FieldTypeLabelDescription
auth_tokenstring

LadyAppLoginReq

FieldTypeLabelDescription
phone_numberstring
country_codestring
verify_codestring

LadyAppLoginRes

FieldTypeLabelDescription
access_tokenstring

LadyProfileReq

FieldTypeLabelDescription
access_tokenstring

LadyProfileRes

FieldTypeLabelDescription
profilepan.atom.ladyapp.LadyProfileData

SaveLadyReq

FieldTypeLabelDescription
access_tokenstring
profilepan.atom.ladyapp.LadyText

SaveLadyRes

SendSmsCodeReq

FieldTypeLabelDescription
phone_numberstring
country_codestring
session_validstring
platformSendSmsCodeReq.Platform

SendSmsCodeRes

UploadFileReq

FieldTypeLabelDescription
access_tokenstring
content_typeContentType
filebytes檔案本身
content_indexint64

UploadFileRes

ValidateStageNameReq

FieldTypeLabelDescription
access_tokenstring
stage_namestring

ValidateStageNameRes

CheckLadyRegisterProfileRes.ProfileStatus

NameNumberDescription
CREATED0
CONFIRMED1
REJECTED2
EDITED3
REGISTERED_TO_JKF4

CheckPhoneRes.PhoneStatus

NameNumberDescription
EXIST0
IS_BE_LADY1
EMPTY2

ContentType

NameNumberDescription
LOGO0
MODEL_CARD1
IDENTITY_CARD2
BANK_ACCOUNT3
RECORD_BE_JKF_LADY4
RECORD_JOIN_JKF5
RECORD_WORK6
RECORD_DREAMBOAT7
RECORD_CHOOSE8
RECORD_INTEREST9
RECORD_FUTURE10

SendSmsCodeReq.Platform

NameNumberDescription
ANDROID0
IOS1

LadyAppService

Method NameRequest TypeResponse TypeDescription
CheckPhoneCheckPhoneReqCheckPhoneRes
SendSmsCodeSendSmsCodeReqSendSmsCodeRes
LadyAppLoginLadyAppLoginReqLadyAppLoginRes
CheckLadyRegisterProfileCheckLadyRegisterProfileReqCheckLadyRegisterProfileRes確認女郎資料是否已驗證,未驗證需回傳未認可
ValidateStageNameValidateStageNameReqValidateStageNameRes
SaveLadySaveLadyReqSaveLadyRes儲存女郎資料
UploadLadyAttachmentUploadFileReqUploadFileRes上傳檔案
LadyProfileLadyProfileReqLadyProfileRes取得女郎Profile資料
GenerateAuthTokenGenerateAuthTokenReqGenerateAuthTokenRes產生Forum用AuthToken

general/member/dangerous/dangerous.proto

CmdDeleteAccountRequest

FieldTypeLabelDescription
app_idstring
pan_access_tokenstring
del_tokenstring

CmdDeleteAccountResponse

CmdDeleteMemberRequest

FieldTypeLabelDescription
app_idstring
pan_access_tokenstring
del_tokenstring

CmdDeleteMemberResponse

CmdDeleteAccountResponse.Error

NameNumberDescription
Error__None0
Error__Failed1001

CmdDeleteMemberResponse.Error

NameNumberDescription
Error__None0
Error__Failed1001

Command

Method NameRequest TypeResponse TypeDescription
DeleteMemberCmdDeleteMemberRequestCmdDeleteMemberResponse
DeleteAccountCmdDeleteAccountRequestCmdDeleteAccountResponse

general/member/error.proto

ErrAccessToken

ErrDisplayName

ErrInitGender

ErrLogin

ErrMakeLoginToken

ErrMe

ErrMemberMigrationStatus

ErrNewMember

ErrObject

ErrOtherMember

ErrReadObject

ErrRegister

ErrSetMemberEmail

ErrSetMemberPassword

ErrSys

ErrUnlockSessionToken

ErrValidateAccessToken

ErrValidateLoginToken

ErrValidateNewMember

ErrValidatePhone

ErrValidatePhoneV2

ErrAccessToken.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001
EXPIRED1002
INVALID1003

ErrDisplayName.General

NameNumberDescription
GENERAL_DEFAULT0
DISPLAY_NAME_ALREADY_EXISTS1001

ErrInitGender.General

NameNumberDescription
GENERAL_NOTSET0
GENERAL_TOKEN_INVALID1001
GENERAL_FAILED1002

ErrLogin.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001
SESSION_INVALID1002
CODE_INVALID1003
CODE_PENDING_101004
CODE_PENDING1005
NOT_FOUND1006
GENERAL_RECAPTCHA_FAILED1100
USERNAME_NOT_FOUND1007
PHONE_HAS_NO_MEMBER1008
MAIN_MEMBER_NOT_SET1009
DISPLAY_NAME_CORRUPTED1010
USERNAME_DENORMALIZED1011

ErrMakeLoginToken.General

NameNumberDescription
GENERAL_NOTSET0
GENERAL_FAILED1001
GENERAL_APPID_APPSECRET_REQUIRED1002

ErrMe.General

NameNumberDescription
GENERAL_DEFAULT0
TOKEN_INVALID1001
FAILED1002

ErrMemberMigrationStatus.General

NameNumberDescription
GENERAL_DEFAULT0
GENERAL_FAILED1001

ErrNewMember.General

NameNumberDescription
GENERAL_DEFAULT0
TOKEN_INVALID1001
DISPLAY_NAME_INVALID1002
MAXIMUM_MEMBER1003手機下的用戶已達上限
FAILED1004

ErrObject.General

NameNumberDescription
GENERAL_DEFAULT0
NOT_FOUND1000

ErrOtherMember.General

NameNumberDescription
GENERAL_DEFAULT0
TOKEN_INVALID1001
FAILED1002

ErrReadObject.General

NameNumberDescription
GENERAL_NOTSET0
GENERAL_FAILED1001
GENERAL_UIDS_OR_UUIDS_REQUIRED1002
GENERAL_NOT_FOUND_ANY1003

ErrRegister.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001
EXISTING_MEMBER1002
SESSION_INVALID1003
CODE_INVALID1004
NAME_INVALID1005
NAME_EXISTING1006
CODE_PENDING_101007
CODE_PENDING1008
RETRY_REQUIRED1009
GENERAL_RECAPTCHA_FAILED1100

ErrSetMemberEmail.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001
EMAIL_EXISTS1002

ErrSetMemberPassword.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001
PWD_ISSUE1002

ErrSys.General

NameNumberDescription
GENERAL_DEFAULT0
READONLY1001
NOT_ONLINE1002

ErrUnlockSessionToken.General

NameNumberDescription
GENERAL_DEFAULT0
GENERAL_FAILED1001
GENERAL_RECAPTCHA_FAILED1100

ErrValidateAccessToken.General

NameNumberDescription
GENERAL_DEFAULT0
TOKEN_INVALID1001
FAILED1002

ErrValidateLoginToken.General

NameNumberDescription
GENERAL_NOTSET0
GENERAL_FAILED1001
GENERAL_INVALID1002
GENERAL_APPID_APPSECRET_REQUIRED1003

ErrValidateNewMember.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001
EXISTING_PHONE1002
NAME_INVALID1005
TOKEN_INVALID1006
MAXIMUM_MEMBER1010手機下的用戶已達上限

ErrValidatePhone.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001
EXISTING_PHONE1002
SESSION_INVALID1003
CODE_INVALID1004
NAME_INVALID1005
TOKEN_INVALID1006
NAME_EXISTING1007
CODE_PENDING_101008
CODE_PENDING1009
MAXIMUM_MEMBER1010手機下的用戶已達上限
GENERAL_RECAPTCHA_FAILED1100

ErrValidatePhoneV2.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001
EXISTING_PHONE1002
SESSION_INVALID1003
CODE_INVALID1004
TOKEN_INVALID1006
CODE_PENDING_101008
CODE_PENDING1009
MAXIMUM_MEMBER1010手機下的用戶已達上限
GENERAL_RECAPTCHA_FAILED1100

general/member/first.proto

AccessTokenRequest

FieldTypeLabelDescription
auth_tokenstring
object_idstringoptional, 不填則自動選為預設用戶
app_idstring

AccessTokenResponse

FieldTypeLabelDescription
access_tokenstring

AuthResetUpdateRequest

FieldTypeLabelDescription
auth_reset_tokenstring
passwordstring
confirm_passwordstring
security_questionSecurityQuestion

AuthResetUpdateResponse

AuthResetVerifyEmailCodeRequest

FieldTypeLabelDescription
codestring

AuthResetVerifyEmailCodeResponse

FieldTypeLabelDescription
auth_reset_tokenstring

AuthResetVerifyEmailRequest

FieldTypeLabelDescription
recaptcha_tokenstring
redirect_emailstringredirect link in email template
display_namestring
emailstring
redirect_successstring

AuthResetVerifyEmailResponse

AuthResetVerifyPhoneCodeRequest

FieldTypeLabelDescription
codestring
phonestring
displayNamestring

AuthResetVerifyPhoneCodeResponse

FieldTypeLabelDescription
auth_reset_tokenstring

AuthResetVerifyPhoneRequest

FieldTypeLabelDescription
recaptcha_tokenstring
display_namestring
phonestring

AuthResetVerifyPhoneResponse

AvPlusRequest

FieldTypeLabelDescription
pan_access_tokenstring

AvPlusResponse

FieldTypeLabelDescription
is_vipbool

DeleteAddressBookRequest

FieldTypeLabelDescription
access_tokenstring
address_book_idint64

DeleteAddressBookResponse

GetAddressBooksRequest

FieldTypeLabelDescription
access_tokenstring

GetAddressBooksResponse

FieldTypeLabelDescription
address_bookspan.atom.member.AddressBookrepeated

GetPassportTokenRequest

FieldTypeLabelDescription
access_tokenstring

GetPassportTokenResponse

FieldTypeLabelDescription
passport_tokenstring
qrcode_base64string
barcode_base64string

GetQRCodeRequest

FieldTypeLabelDescription
pan_access_tokenstring

GetQRCodeResponse

FieldTypeLabelDescription
image_contentstring
display_namestring
uidint64
avatarstring
uuidstring
verify_codestring
phone_idstring

InitGenderRequest

FieldTypeLabelDescription
access_tokenstring
genderpan.atom.member.Gender

InitGenderResponse

LoginRequest

FieldTypeLabelDescription
phaseLoginRequest.Phase
phase_session_validstring
phase_session_tokenstring
phase_check_existence_valuestring
phase_input_code_valuestring
phase_input_code_ques_indexint32
phase_input_code_ques_valuestring
phase_check_existence_country_codestring
app_idstring
login_typeLoginRequest.LoginType
link_to_inputstring

LoginResponse

FieldTypeLabelDescription
phaseLoginRequest.Phase
next_phaseLoginRequest.Phase
phase_check_existence_login_typeLoginResponse.LoginType
phase_check_existence_questionbool
phase_input_code_resultLoginResponse.CodeResult
phase_input_code_time_remainingint64
phase_input_ques_resultLoginResponse.CodeResult
phase_done_auth_tokenstring
phase_session_tokenstring

LogoutRequest

FieldTypeLabelDescription
pan_access_tokenstring
token2string

LogoutResponse

LogoutResponse.Error

MakeLoginTokenRequest

FieldTypeLabelDescription
app_idstring
app_secretstring
auth_urlstring

MakeLoginTokenResponse

FieldTypeLabelDescription
login_tokenstring

MeRequest

FieldTypeLabelDescription
access_tokenstring
app_idstring

MeResponse

FieldTypeLabelDescription
userpan.atom.member.Object

MemberMigrationStatusRequest

FieldTypeLabelDescription
access_tokenstring

MemberMigrationStatusResponse

FieldTypeLabelDescription
statusMemberMigrationStatusResponse.MigrationStatus

NewMemberRequest

FieldTypeLabelDescription
auth_tokenstring
display_namestring
passwordstring
confirm_passwordstring
security_questionSecurityQuestion
session_tokenstring
app_idstring

NewMemberResponse

FieldTypeLabelDescription
objectpan.atom.member.Object

OtherMemberRequest

FieldTypeLabelDescription
access_tokenstring

OtherMemberResponse

FieldTypeLabelDescription
objectspan.atom.member.Objectrepeated

QueryMemberCredentialStatusRequest

FieldTypeLabelDescription
pan_access_tokenstring
object_idstring

QueryMemberCredentialStatusResponse

FieldTypeLabelDescription
has_passwordbool
has_emailbool
has_security_questionbool
email_verifiedbool

ReadObjectRequest

FieldTypeLabelDescription
uidsint64repeated
uuidsstringrepeated
ignore_dzbool
keywordstring

ReadObjectResponse

FieldTypeLabelDescription
objectspan.atom.member.Objectrepeated

RegisterRequest

FieldTypeLabelDescription
phaseRegisterRequest.Phase
phase_session_validstring
phase_session_tokenstring
phase_check_existence_valuestring
phase_input_code_valuestring
phase_input_name_valuestring
phase_check_existence_country_codestring
app_idstring

RegisterResponse

FieldTypeLabelDescription
phaseRegisterRequest.Phase
next_phaseRegisterRequest.Phase
phase_input_code_resultRegisterResponse.CodeResult
phase_input_code_time_remainingint64
phase_done_auth_tokenstring
phase_session_tokenstring

SaveAddressBookRequest

FieldTypeLabelDescription
access_tokenstring
address_bookpan.atom.member.AddressBookid <= 0 為新增

SaveAddressBookResponse

FieldTypeLabelDescription
address_bookpan.atom.member.AddressBook

SecurityQuestion

FieldTypeLabelDescription
questionstring
answerstring

SendEmailVerificationRequest

FieldTypeLabelDescription
redirectstringonly jkf hosts
pan_access_tokenstring
session_tokenstring
uidint32

SendEmailVerificationResponse

SendPhoneVerificationRequest

FieldTypeLabelDescription
pan_access_tokenstring
session_tokenstring
target_phone_orderint64

SendPhoneVerificationResponse

SetMemberEmailRequest

FieldTypeLabelDescription
access_tokenstring
emailstring
redirectstring

SetMemberEmailResponse

SetMemberPasswordRequest

FieldTypeLabelDescription
access_tokenstring
passwordstring
confirm_passwordstring
reset_codestring

SetMemberPasswordResponse

SwitchMemberRequest

FieldTypeLabelDescription
verify_tokenstring
pan_access_tokenstring
switch_to_object_idstring
app_idstring

SwitchMemberResponse

FieldTypeLabelDescription
auth_tokenstring
object_idstring

UniversalReadObjectRequest

FieldTypeLabelDescription
uidsint64repeated
uuidsstringrepeated
hash_idsstringrepeated
ignore_dzbool
keywordstring只支援 hashids and uids

UniversalReadObjectResponse

FieldTypeLabelDescription
objectspan.atom.member.Objectrepeated

UnlockSessionTokenRequest

FieldTypeLabelDescription
phase_session_tokenstring
phase_session_validstring
platformUnlockSessionTokenRequest.Platform

UnlockSessionTokenResponse

UpdateAvatarRequest

FieldTypeLabelDescription
access_tokenstring
avatarbytes

UpdateCredentialRequest

FieldTypeLabelDescription
pan_auth_tokenstring
object_idstring
original_passwordstring
new_passwordstring
confirm_new_passwordstring
emailstring
security_questionSecurityQuestion
email_verification_redirectstring
verify_tokenstring

UpdateCredentialResponse

UpdateSecurityQuestionRequest

FieldTypeLabelDescription
pan_access_tokenstring
update_tokenstring
security_questionSecurityQuestion

UpdateSecurityQuestionResponse

UpdateSecurityQuestionResponse.Error

ValidateAccessTokenRequest

FieldTypeLabelDescription
access_tokenstring

ValidateAccessTokenResponse

FieldTypeLabelDescription
infopan.atom.member.TokenInfo

ValidateDisplayNameRequest

FieldTypeLabelDescription
display_namestring

ValidateDisplayNameResponse

ValidateDisplayNameV2Request

FieldTypeLabelDescription
display_namestring

ValidateDisplayNameV2Response

ValidateLoginTokenRequest

FieldTypeLabelDescription
login_tokenstring
app_idstring
app_secretstring

ValidateLoginTokenResponse

FieldTypeLabelDescription
auth_urlstring

ValidateNewMemberRequest

FieldTypeLabelDescription
current_phone_auth_tokenstring
new_member_access_tokenstring
display_namestring
session_tokenstring

ValidateNewMemberResponse

FieldTypeLabelDescription
objectpan.atom.member.Object

ValidatePassportTokenRequest

FieldTypeLabelDescription
passport_tokenstring

ValidatePassportTokenResponse

FieldTypeLabelDescription
uuidstring
uidint64
phonestring
display_namestring

ValidatePhoneRequest

FieldTypeLabelDescription
phaseValidatePhoneRequest.Phase
phase_session_validstring
phase_session_tokenstring
phase_check_existence_valuestring
phase_input_code_valuestring
phase_input_name_valuestring
phase_check_existence_country_codestring
access_tokenstring
app_idstring

ValidatePhoneResponse

FieldTypeLabelDescription
phaseValidatePhoneRequest.Phase
next_phaseValidatePhoneRequest.Phase
phase_input_code_resultValidatePhoneResponse.CodeResult
phase_input_code_time_remainingint64
phase_session_tokenstring
new_auth_tokenstring

ValidatePhoneV2Request

FieldTypeLabelDescription
phaseValidatePhoneV2Request.Phase
phase_session_validstring
phase_session_tokenstring
phase_check_existence_valuestring
phase_input_code_valuestring
phase_check_existence_country_codestring
access_tokenstring
app_idstring

ValidatePhoneV2Response

FieldTypeLabelDescription
phaseValidatePhoneV2Request.Phase
next_phaseValidatePhoneV2Request.Phase
phase_input_code_resultValidatePhoneV2Response.CodeResult
phase_input_code_time_remainingint64
phase_session_tokenstring
new_auth_tokenstring

ValidateQRCodeRequest

FieldTypeLabelDescription
uuidstring
uidint64
verify_codestring

ValidateQRCodeResponse

VerifyEmailCodeRequest

FieldTypeLabelDescription
codestring

VerifyEmailCodeResponse

FieldTypeLabelDescription
verify_tokenstring

VerifyMemberByPasswordRequest

FieldTypeLabelDescription
recaptcha_tokenstring
display_namestring
emailstring
passwordstring
security_questionSecurityQuestion
session_tokenstring

VerifyMemberByPasswordResponse

FieldTypeLabelDescription
verify_tokenstring

VerifyPhoneCodeRequest

FieldTypeLabelDescription
codestring
pan_access_tokenstring
session_tokenstring

VerifyPhoneCodeResponse

FieldTypeLabelDescription
verify_tokenstring

AuthResetUpdateResponse.Err

NameNumberDescription
ErrNone0
ErrNewPasswordConfirmingFailed1001
ErrSecurityQuestionAnswerRequired1002
ErrFailed1003
ErrNewPasswordRule1004
ErrPasswordRequired1005

AuthResetVerifyEmailCodeResponse.Err

NameNumberDescription
ErrNone0
ErrCodeInvalid1001
ErrFailed1002

AuthResetVerifyEmailResponse.Err

NameNumberDescription
ErrNone0
ErrSessionInvalid1001
ErrEmailRequired1002
ErrFailed1003
ErrReachSendLimit1004
ErrDisplayNameRequired1005

AuthResetVerifyPhoneCodeResponse.Err

NameNumberDescription
ErrNone0
ErrCodeInvalid1001
ErrFailed1002

AuthResetVerifyPhoneResponse.Err

NameNumberDescription
ErrNone0
ErrReachSendLimit1001
ErrFailed1002
ErrSessionInvalid1003
ErrPhoneRequired1004
ErrDisplayNameRequired1005

GetQRCodeResponse.Error

NameNumberDescription
Error__None0
Error__Failed1001

LoginRequest.LoginType

NameNumberDescription
LOGIN_TYPE_DEFAULT0
LOGIN_TYPE_PHONE1
LOGIN_TYPE_EMAIL2
LOGIN_TYPE_EMAIL_OTC3

LoginRequest.Phase

NameNumberDescription
PHASE_DEFAULT0
PHASE_CHECK_EXISTENCE1
PHASE_INPUT_CODE2
PHASE_DONE3
PHASE_ANDROID_DEFAULT4
PHASE_IOS_DEFAULT5
PHASE_ANDROID_ENTERPISE6For Android Enterprise reCaptcha
PHASE_IOS_ENTERPISE7For iOS Enterprise reCaptcha

LoginResponse.CodeResult

NameNumberDescription
CODE_RESULT_DEFAULT0
CODE_RESULT_OK1
CODE_RESULT_RESENT3

LoginResponse.LoginType

NameNumberDescription
LOGIN_TYPE_DEFAULT0
LOGIN_TYPE_PHONE1
LOGIN_TYPE_EMAIL2
LOGIN_TYPE_EMAIL_OTC3

LogoutResponse.Error.Code

NameNumberDescription
None0
Failed1001

MeResponse.Error

NameNumberDescription
Error__None0
Error__NotExists1001
Error__Failed1002

MemberMigrationStatusResponse.MigrationStatus

NameNumberDescription
STATUS_DEFAULT0
STATUS_NEW_PAN1
STATUS_OLD_JKF2
STATUS_OLD_11283
STATUS_RETURNED_USER4
STATUS_VALID_PAN5
STATUS_VERIFY_PHONE6

NewMemberResponse.Err

NameNumberDescription
ErrNone0
ErrPasswordIsEmpty2001
ErrPasswordConfirmingFailed2002

QueryMemberCredentialStatusResponse.Err

NameNumberDescription
ErrNone0
ErrFailed1002

RegisterRequest.Phase

NameNumberDescription
PHASE_DEFAULT0
PHASE_CHECK_EXISTENCE1
PHASE_INPUT_CODE2
PHASE_INPUT_NAME3
PHASE_DONE4

RegisterResponse.CodeResult

NameNumberDescription
CODE_RESULT_DEFAULT0
CODE_RESULT_OK1
CODE_RESULT_RESENT3

SendEmailVerificationResponse.Err

NameNumberDescription
ErrNone0
ErrReachSendLimit1001
ErrFailed1002

SendPhoneVerificationResponse.Err

NameNumberDescription
ErrNone0
ErrReachSendLimit1001
ErrFailed1002

SwitchMemberResponse.Err

NameNumberDescription
ErrNone0
ErrVerifyTokenInvalid1001
ErrFailed1002
ErrObjectIDRequired1003

UnlockSessionTokenRequest.Platform

NameNumberDescription
WEB0
IOS1
ANDROID2
IOS_ENTERPRISE3
ANDROID_ENTERPRISE4

UpdateCredentialResponse.Err

NameNumberDescription
ErrNone0
ErrOriginalPasswordInvalid1001
ErrNewPasswordConfirmingFailed1002
ErrEmailDuplicated1003
ErrFailed1004
ErrNewPasswordRule1005

UpdateSecurityQuestionResponse.Error.Code

NameNumberDescription
None0
Failed1001

ValidateDisplayNameV2Response.Err

NameNumberDescription
ErrNone0
ErrSpecialChar1001
ErrDuplicated1002
ErrLength1003
ErrFailed1004

ValidatePhoneRequest.Phase

NameNumberDescription
PHASE_DEFAULT0
PHASE_CHECK_EXISTENCE1
PHASE_INPUT_CODE2
PHASE_INPUT_NAME3
PHASE_DONE4
PHASE_ANDROID_DEFAULT5
PHASE_IOS_DEFAULT6
PHASE_ANDROID_ENTERPISE7For Android Enterprise reCaptcha
PHASE_IOS_ENTERPISE8For iOS Enterprise reCaptcha

ValidatePhoneResponse.CodeResult

NameNumberDescription
CODE_RESULT_DEFAULT0
CODE_RESULT_OK1
CODE_RESULT_RESENT3

ValidatePhoneV2Request.Phase

NameNumberDescription
PHASE_DEFAULT0
PHASE_CHECK_EXISTENCE1
PHASE_INPUT_CODE2
PHASE_DONE4
PHASE_ANDROID_DEFAULT5
PHASE_IOS_DEFAULT6
PHASE_ANDROID_ENTERPISE7For Android Enterprise reCaptcha
PHASE_IOS_ENTERPISE8For iOS Enterprise reCaptcha

ValidatePhoneV2Response.CodeResult

NameNumberDescription
CODE_RESULT_DEFAULT0
CODE_RESULT_OK1
CODE_RESULT_RESENT3

ValidateQRCodeResponse.Error

NameNumberDescription
Error__None0
Error__Failed1001

VerifyEmailCodeResponse.Err

NameNumberDescription
ErrNone0
ErrCodeInvalid1001
ErrFailed1002

VerifyMemberByPasswordResponse.Err

NameNumberDescription
ErrNone0
ErrPasswordRequired1001
ErrIdentityRequired1002
ErrFailed1003
ErrAuthFailed1004
ErrSecurityQuestionRequired1005

VerifyPhoneCodeResponse.Err

NameNumberDescription
ErrNone0
ErrCodeInvalid1001
ErrFailed1002

MemberService

Method NameRequest TypeResponse TypeDescription
MeMeRequestMeResponse
OtherMemberOtherMemberRequestOtherMemberResponse
NewMemberNewMemberRequestNewMemberResponse
RegisterRegisterRequestRegisterResponse
LoginLoginRequestLoginResponse
AccessTokenAccessTokenRequestAccessTokenResponse
ValidateAccessTokenValidateAccessTokenRequestValidateAccessTokenResponse
ValidatePhoneValidatePhoneRequestValidatePhoneResponse
ValidateNewMemberValidateNewMemberRequestValidateNewMemberResponse
InitGenderInitGenderRequestInitGenderResponse
ReadObjectReadObjectRequestReadObjectResponse
MakeLoginTokenMakeLoginTokenRequestMakeLoginTokenResponse
ValidateLoginTokenValidateLoginTokenRequestValidateLoginTokenResponse
ValidateDisplayNameValidateDisplayNameRequestValidateDisplayNameResponse
UpdateAvatarUpdateAvatarRequestMeResponse
UniversalReadObjectUniversalReadObjectRequestUniversalReadObjectResponseSupport reading member data from jkforum ucenter and pan
SetMemberEmailSetMemberEmailRequestSetMemberEmailResponsev2
SetMemberPasswordSetMemberPasswordRequestSetMemberPasswordResponse
UnlockSessionTokenUnlockSessionTokenRequestUnlockSessionTokenResponse
ValidatePhoneV2ValidatePhoneV2RequestValidatePhoneV2Response
MemberMigrationStatusMemberMigrationStatusRequestMemberMigrationStatusResponse
GetAddressBooksGetAddressBooksRequestGetAddressBooksResponse通訊資料
SaveAddressBookSaveAddressBookRequestSaveAddressBookResponse
DeleteAddressBookDeleteAddressBookRequestDeleteAddressBookResponse
GetPassportTokenGetPassportTokenRequestGetPassportTokenResponsePassport Token
ValidatePassportTokenValidatePassportTokenRequestValidatePassportTokenResponse

MemberServiceV2

Method NameRequest TypeResponse TypeDescription
MeMeRequestMeResponse
OtherMemberOtherMemberRequestOtherMemberResponse
NewMemberNewMemberRequestNewMemberResponse
RegisterRegisterRequestRegisterResponse
LoginLoginRequestLoginResponse
LogoutLogoutRequestLogoutResponse
AccessTokenAccessTokenRequestAccessTokenResponse
ValidateAccessTokenValidateAccessTokenRequestValidateAccessTokenResponse
ValidatePhoneValidatePhoneRequestValidatePhoneResponse
ValidateNewMemberValidateNewMemberRequestValidateNewMemberResponse
InitGenderInitGenderRequestInitGenderResponse
ReadObjectReadObjectRequestReadObjectResponse
MakeLoginTokenMakeLoginTokenRequestMakeLoginTokenResponse
ValidateLoginTokenValidateLoginTokenRequestValidateLoginTokenResponse
ValidateDisplayNameValidateDisplayNameRequestValidateDisplayNameResponse
UpdateAvatarUpdateAvatarRequestMeResponse
UniversalReadObjectUniversalReadObjectRequestUniversalReadObjectResponseSupport reading member data from jkforum ucenter and pan
AvPlusAvPlusRequestAvPlusResponse
UpdateSecurityQuestionUpdateSecurityQuestionRequestUpdateSecurityQuestionResponse
SetMemberEmailSetMemberEmailRequestSetMemberEmailResponsev2
SetMemberPasswordSetMemberPasswordRequestSetMemberPasswordResponse
UnlockSessionTokenUnlockSessionTokenRequestUnlockSessionTokenResponse
ValidatePhoneV2ValidatePhoneV2RequestValidatePhoneV2Response
MemberMigrationStatusMemberMigrationStatusRequestMemberMigrationStatusResponse
SendEmailVerificationSendEmailVerificationRequestSendEmailVerificationResponse
VerifyEmailCodeVerifyEmailCodeRequestVerifyEmailCodeResponse
VerifyPhoneCodeVerifyPhoneCodeRequestVerifyPhoneCodeResponse
SendPhoneVerificationSendPhoneVerificationRequestSendPhoneVerificationResponse
AuthResetVerifyPhoneAuthResetVerifyPhoneRequestAuthResetVerifyPhoneResponse
AuthResetVerifyEmailAuthResetVerifyEmailRequestAuthResetVerifyEmailResponse
AuthResetVerifyEmailCodeAuthResetVerifyEmailCodeRequestAuthResetVerifyEmailCodeResponse
AuthResetVerifyPhoneCodeAuthResetVerifyPhoneCodeRequestAuthResetVerifyPhoneCodeResponse
AuthResetUpdateAuthResetUpdateRequestAuthResetUpdateResponse
UpdateCredentialUpdateCredentialRequestUpdateCredentialResponse
ValidateDisplayNameV2ValidateDisplayNameV2RequestValidateDisplayNameV2Response
MemberCredentialStatusQueryMemberCredentialStatusRequestQueryMemberCredentialStatusResponse
SwitchMemberSwitchMemberRequestSwitchMemberResponse
VerifyMemberByPasswordVerifyMemberByPasswordRequestVerifyMemberByPasswordResponse
GetAddressBooksGetAddressBooksRequestGetAddressBooksResponse通訊資料
SaveAddressBookSaveAddressBookRequestSaveAddressBookResponse
DeleteAddressBookDeleteAddressBookRequestDeleteAddressBookResponse
GetPassportTokenGetPassportTokenRequestGetPassportTokenResponsePassport Token
ValidatePassportTokenValidatePassportTokenRequestValidatePassportTokenResponse
GetQRCodeGetQRCodeRequestGetQRCodeResponse
ValidateQRCodeValidateQRCodeRequestValidateQRCodeResponse

lever/member/error.proto

ErrAuthToken

ErrDeactivateMember

ErrObject

ErrReadObject

ErrRevokeAuth

ErrAuthToken.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001
LOGIN_TOKEN_INVALID1002

ErrDeactivateMember.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001

ErrObject.General

NameNumberDescription
GENERAL_DEFAULT0
NOT_FOUND1001

ErrReadObject.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001

ErrRevokeAuth.General

NameNumberDescription
GENERAL_DEFAULT0
FAILED1001

lever/member/first.proto

AuthTokenRequest

FieldTypeLabelDescription
uidint64
login_tokenstring

AuthTokenResponse

FieldTypeLabelDescription
auth_tokenstring

SendSMSRequest

FieldTypeLabelDescription
object_idstring
textstring

SendSMSResponse

MemberService

Method NameRequest TypeResponse TypeDescription
AuthTokenAuthTokenRequestAuthTokenResponse
SendSMSSendSMSRequestSendSMSResponse

oauth/app.proto

GetAccessTokenRequest

GetAccessTokenResponse

GetDetailRequest

FieldTypeLabelDescription
scopestring
redirect_uristring
client_idstring
statestring
response_typestring
noncestring

GetDetailResponse

FieldTypeLabelDescription
app_display_namestring
app_privacy_policy_urlstring
app_terms_of_service_urlstring
permission_allstringrepeated
app_logo_urlstring
userpan.atom.member.Identity
app_summarystring

GetRefreshTokenRequest

GetRefreshTokenResponse

GetDetailResponse.Error

NameNumberDescription
Error__none0

App

Method NameRequest TypeResponse TypeDescription
GetDetailGetDetailRequestGetDetailResponse
GetAccessTokenGetAccessTokenRequestGetAccessTokenResponse
GetRefreshTokenGetRefreshTokenRequestGetRefreshTokenResponse

ApproveRequest

ApproveResponse

DoRequest

DoResponse

RejectRequest

RejectResponse

ConsentProcess

Method NameRequest TypeResponse TypeDescription
DoDoRequestDoResponse
ApproveApproveRequestApproveResponse
RejectRejectRequestRejectResponse

pan/account/v1/base/general.proto

App

NameNumberDescription
None0
AvPlus1
Jvid2
JkFace3
Forum4

pan/account/v1/member/base.proto

BaseInfo

FieldTypeLabelDescription
object_idstring
uidint64
huidstringhashed uid
usernamestring用戶名
display_namestring暱稱
avatarstring大頭貼路徑
emailstringoptional綁定信箱
is_activatedbool是否已被啟用
jpass_idstring= jkf_id, phone_id
is_ownerbool是否為主帳號
can_new_childbool是否可以新增子帳號
is_email_verifiedbool
last_used_atgoogle.protobuf.Timestamp最後登入時間
created_atgoogle.protobuf.Timestamp創建時間
modified_atgoogle.protobuf.Timestamp最後修改時間
is_ladybool是否為女郎
connected_appspan.account.v1.base.Apprepeated有關聯的平台

pan/account/v1/account/account.proto

AccountAddressLiving

FieldTypeLabelDescription
idstring
full_namestring
countrystring
zip_codestring
citystring
areastring
addressstring
phonestring
main_livingbool

AccountAddressLivingInfoAnswer

FieldTypeLabelDescription
address_allAccountAddressLivingrepeated

AccountAddressLivingInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring

AccountAddressLivingPayload

FieldTypeLabelDescription
pan_access_tokenstring
dataAccountAddressLiving

AccountAddressShipping

FieldTypeLabelDescription
idstring
full_namestring
countrystring
zip_codestring
citystring
areastring
addressstring
phonestring
default_shippingbool

AccountAddressShippingInfoAnswer

FieldTypeLabelDescription
address_allAccountAddressShippingrepeated

AccountAddressShippingInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring

AccountAddressShippingPayload

FieldTypeLabelDescription
pan_access_tokenstring
dataAccountAddressShipping

AccountBasicInfoAnswer

FieldTypeLabelDescription
full_namestring
phonestring

AccountBasicInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring

ListMembersAnswer

FieldTypeLabelDescription
memberspan.account.v1.member.BaseInforepeated所有帳號的資料

ListMembersPayload

FieldTypeLabelDescription
pan_access_tokenstring

SetAddressLivingAsMainPayload

FieldTypeLabelDescription
pan_access_tokenstring
address_idstring

SetAddressLivingAsMainStatus

SetAddressShippingAsDefaultPayload

FieldTypeLabelDescription
pan_access_tokenstring
address_idstring

SetAddressShippingAsDefaultStatus

AccountCommand

Method NameRequest TypeResponse TypeDescription
SetAddressLivingAsMainSetAddressLivingAsMainPayloadSetAddressLivingAsMainStatus
SetAddressShippingAsDefaultSetAddressShippingAsDefaultPayloadSetAddressShippingAsDefaultStatus

AccountQuery

Method NameRequest TypeResponse TypeDescription
BasicInfoAccountBasicInfoPayloadAccountBasicInfoAnswerdeprecated
AddressLivingInfoAccountAddressLivingInfoPayloadAccountAddressLivingInfoAnswer
AddressShippingAccountAddressShippingInfoPayloadAccountAddressShippingInfoAnswer
ListMembersListMembersPayloadListMembersAnswer查詢指定pan_access_token的資料

AddressLivingCRUD

Method NameRequest TypeResponse TypeDescription
CreateAccountAddressLivingPayloadAccountAddressLiving
ReadAccountAddressLivingPayloadAccountAddressLiving
UpdateAccountAddressLivingPayloadAccountAddressLiving
DeleteAccountAddressLivingPayloadAccountAddressLiving

AddressShippingCRUD

Method NameRequest TypeResponse TypeDescription
CreateAccountAddressShippingPayloadAccountAddressShipping
ReadAccountAddressShippingPayloadAccountAddressShipping
UpdateAccountAddressShippingPayloadAccountAddressShipping
DeleteAccountAddressShippingPayloadAccountAddressShipping

pan/account/v1/apea/apea.proto

APEACommandError

APEAQueryError

MIDStatusRequest

FieldTypeLabelDescription
pan_access_tokenstring

MIDStatusResponse

FieldTypeLabelDescription
is_validbool身份已通過TWID驗證

ValidateMIDRequest

FieldTypeLabelDescription
pan_access_tokenstring
identitystring身分證
phone_orderint64在pan存儲的電話編號,來自PhoneNumberList

ValidateMIDResponse

APEACommandError.Code

NameNumberDescription
None0
TokenInValid2001
IdentityInValid2002
InLocked2003

APEAQueryError.Code

NameNumberDescription
None0
TokenInValid2001
IdentityInValid2002
InLocked2003

APEACommand

Method NameRequest TypeResponse TypeDescription
ValidateMIDValidateMIDRequestValidateMIDResponse以手機號碼+身份證驗證TWID

APEAQuery

Method NameRequest TypeResponse TypeDescription
MIDStatusMIDStatusRequestMIDStatusResponse查詢該pan帳號在APEA存儲的TWID驗證狀態

pan/account/v1/base/error.proto

Error

Error.Value

NameNumberDescription
None0
RecaptchaFailed1100recaptcha驗證失敗
VerifyTokenInvalid1151verify token無效
JPassTokenInvalid1152jpass domain相關token無效
AccessTokenInvalid1201pan access token無效
PhoneDuplicated1202電話號碼已被使用
PhoneFormatInvalid1203電話號碼格式錯誤
ReachedMessageLimit1204達到簡訊發送上限
VerificationFailed1205驗證失敗
NoNeedToProcess1206不需要調用該API
UsernameInvalid1207username格式有誤
UsernameDuplicated1208username已被使用
OperatorNotMainMember1209當前操作者非主帳號
MemberNotFound1210查無指定member
MemberInvalid1211member存在,但並非可操作對象
MemberDuplicated1212member關聯重複
FailedToNotifyEvent1213Pub/Sub fail
FailedToIdentifyIP1214無法解析用戶IP

pan/account/v1/member/member.proto

AddPhoneAnswer

AddPhonePayload

FieldTypeLabelDescription
pan_access_tokenstring
verify_tokenstring身份驗證token
recaptcha_tokenstringrecaptcha驗證得到的token
phonestring新電話號碼
country_codestring電話的國家分類

CredentialStatusAnswer

FieldTypeLabelDescription
recordsCredentialStatusAnswer.Recordrepeated

CredentialStatusAnswer.Record

FieldTypeLabelDescription
target_idIdentity
has_phonebool
has_emailbool
has_sec_questbool
has_passwordbool
is_virtualbool
is_main_memberbool

CredentialStatusPayload

FieldTypeLabelDescription
pan_access_tokenstring
target_idsIdentityrepeated

GetUsernamesBySessionAnswer

FieldTypeLabelDescription
namesGetUsernamesBySessionAnswer.Namerepeated

GetUsernamesBySessionAnswer.Name

FieldTypeLabelDescription
usernamestring
is_validbool
name_typeGetUsernamesBySessionAnswer.NameType

GetUsernamesBySessionPayload

FieldTypeLabelDescription
session_tokenstring

Identity

FieldTypeLabelDescription
uidint64
object_idstring
huidstring
emailstring
usernamestring
display_namestring

MemberAvatarUploaderAnswer

FieldTypeLabelDescription
signed_post_policyMemberAvatarUploaderAnswer.SignedPostPolicyEntryrepeated
url_to_uploadstring
display_image_pathstring

MemberAvatarUploaderAnswer.Error

MemberAvatarUploaderAnswer.SignedPostPolicyEntry

FieldTypeLabelDescription
keystring
valuestring

MemberAvatarUploaderPayload

FieldTypeLabelDescription
pan_access_tokenstring
image_typeMemberAvatarUploaderPayload.Image.FileType

MemberAvatarUploaderPayload.Image

MemberBasicInfoAnswer

FieldTypeLabelDescription
full_namestring
genderMemberBasicInfoAnswer.Gender.Value
birthdaygoogle.protobuf.Timestamp
salaryMemberBasicInfoAnswer.Salary.Value
professionalstring

MemberBasicInfoAnswer.Gender

MemberBasicInfoAnswer.Salary

MemberBasicInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring

MemberCommandError

MemberCompanyJobInfoAnswer

FieldTypeLabelDescription
companystring
positionstring

MemberCompanyJobInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring

MemberEducationInfoAnswer

FieldTypeLabelDescription
schoolstring
max_levelstring

MemberEducationInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring

MemberIntroductionAnswer

FieldTypeLabelDescription
introductionstring

MemberIntroductionPayload

FieldTypeLabelDescription
pan_access_tokenstring

MemberPreferenceAnswer

FieldTypeLabelDescription
localestring

MemberPreferencePayload

FieldTypeLabelDescription
pan_access_tokenstring

MemberQueryError

MemberSocialInfoAnswer

FieldTypeLabelDescription
linestring
facebookstring
instagramstring
jvidstring
linkstring
twitterstring
tiktokstring

MemberSocialInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring

MergeUsernameAnswer

MergeUsernamePayload

FieldTypeLabelDescription
session_tokenstring登入pan時產生的臨時token
usernamestring新username

MyOperationLogAnswer

FieldTypeLabelDescription
log_allOperationLogrepeated
pagerPager

MyOperationLogPayload

FieldTypeLabelDescription
pan_access_tokenstring
start_atgoogle.protobuf.Timestamp
pagerPager

OperationLog

FieldTypeLabelDescription
action_namestring
action_payloadstring
occur_dategoogle.protobuf.Timestamp

Pager

FieldTypeLabelDescription
page_currentint64
page_totalint64
page_sizeint64
item_totalint64

PhoneNumberListAnswer

error -> Internal

FieldTypeLabelDescription
recordsPhoneNumberListAnswer.Recordrepeated
default_indexint64該帳戶的默認手機號碼,默認值0
twid_verified_phone_indexint64默認值-1 (need_twid_status設為false會返回-1)

PhoneNumberListAnswer.Record

FieldTypeLabelDescription
phonestring電話號碼
phone_orderint64電話號碼升序編號,從1起算
created_atgoogle.protobuf.Timestamp電話號碼綁定時間

PhoneNumberListPayload

FieldTypeLabelDescription
pan_access_tokenstring
need_twid_statusbool是否需要標示有通過twid驗證的號碼

ResendEmailCodeAnswer

FieldTypeLabelDescription
verify_tokenstring身份驗證token

ResendEmailCodePayload

FieldTypeLabelDescription
verify_tokenstring身份驗證token

ResendSmsCodeAnswer

ResendSmsCodePayload

FieldTypeLabelDescription
pan_access_tokenstring
verify_tokenstring身份驗證token

SwitchDefaultPhoneAnswer

SwitchDefaultPhonePayload

FieldTypeLabelDescription
pan_access_tokenstringmain member only
verify_tokenstring身份驗證token
recaptcha_tokenstring驗證recaptcha得到的token
phone_orderint64要設定為默認電話的電話編號(升序,從1起算)

SwitchMainMemberAnswer

SwitchMainMemberPayload

FieldTypeLabelDescription
pan_access_tokenstring若該token並非當前主帳號則進行阻擋
uidint64新的主帳號的uid,若非當前子帳號之一則阻擋

UpdateBasicInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring
basic_infoMemberBasicInfoAnswer

UpdateBasicInfoStatus

UpdateCompanyJobInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring
company_jobMemberCompanyJobInfoAnswer

UpdateCompanyJobInfoStatus

UpdateEducationInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring
educationMemberEducationInfoAnswer

UpdateEducationInfoStatus

UpdateEmailPayload

FieldTypeLabelDescription
pan_access_tokenstring
verify_tokenstring驗證身份的token
emailstring新信箱
redirect_urlstring信箱連結的跳轉URL
session_validstring完成recaptcha驗證的token
verify_token_typeVerifyTokenType身份驗證途徑

UpdateEmailStatus

FieldTypeLabelDescription
verify_tokenstring驗證身份的token

UpdateIntroductionPayload

FieldTypeLabelDescription
pan_access_tokenstring
introductionMemberIntroductionAnswer

UpdateIntroductionStatus

UpdatePasswordPayload

FieldTypeLabelDescription
pan_access_tokenstring
verify_tokenstring身份驗證token
passwordstring新密碼
verify_token_typeVerifyTokenType身份驗證途徑

UpdatePasswordStatus

UpdatePreferencePayload

FieldTypeLabelDescription
pan_access_tokenstring
preferenceMemberPreferenceAnswer

UpdatePreferenceStatus

UpdateSecurityQuestionPayload

FieldTypeLabelDescription
pan_access_tokenstring
verify_tokenstring身份驗證token
questionstring新提問
answerstring新答案
verify_token_typeVerifyTokenType身份驗證途徑

UpdateSecurityQuestionStatus

UpdateSocialInfoPayload

FieldTypeLabelDescription
pan_access_tokenstring
social_infoMemberSocialInfoAnswer

UpdateSocialInfoStatus

VerifyEmailCodePayload

FieldTypeLabelDescription
codestringOTP code
verify_tokenstring身份驗證token

VerifyEmailCodeStatus

VerifySmsCodeAnswer

VerifySmsCodePayload

FieldTypeLabelDescription
pan_access_tokenstring
verify_tokenstring身份驗證token
sms_codestringsms的otp code

GetUsernamesBySessionAnswer.NameType

error code -> VerificationFailed | NoNeedToProcess | Internal

NameNumberDescription
None0
Username1
DisplayName2
LegacyName3

MemberAvatarUploaderAnswer.Error.Code

NameNumberDescription
None0
Failed1001

MemberAvatarUploaderPayload.Image.FileType

NameNumberDescription
None0
Jpeg1
Png2
Gif3
Bmp4

MemberBasicInfoAnswer.Gender.Value

NameNumberDescription
None0
Male1
Female2

MemberBasicInfoAnswer.Salary.Value

NameNumberDescription
None0
Level11
Level22
Level33
Level44
Level55
Level66

MemberCommandError.Code

NameNumberDescription
None0
EmailInvalid2001信箱格式有誤
EmailDuplicated2002信箱重複
EmailUnchangeable2003信箱無變更
FailedToSendEmail2004驗證信發送失敗
ReachedEmailSendCountLimit2005驗證信發送超過次數上限
NoNeedToProcess2006不需要調用該API
SessionNotFound2007查詢不到對應verify token的session紀錄
OperatorNotMainMember2008當前操作者非主帳號
NewMainMemberInvalid2009新主帳號為無效的uid
PasswordInvalid2010密碼格式有誤
CodeInvalid2011otp code不符

MemberQueryError.Code

NameNumberDescription
None0
SessionNotFound2001查詢不到對應verify token的session紀錄
OperatorNotMainMember2002當前操作者非主帳號

VerifyTokenType

NameNumberDescription
Phone0
Password1

MemberCommand

Method NameRequest TypeResponse TypeDescription
UpdateBasicInfoUpdateBasicInfoPayloadUpdateBasicInfoStatus
UpdateSocialInfoUpdateSocialInfoPayloadUpdateSocialInfoStatus
UpdateIntroductionUpdateIntroductionPayloadUpdateIntroductionStatus
UpdateCompanyJobInfoUpdateCompanyJobInfoPayloadUpdateCompanyJobInfoStatus
UpdateEducationInfoUpdateEducationInfoPayloadUpdateEducationInfoStatus
UpdatePreferenceUpdatePreferencePayloadUpdatePreferenceStatus
UpdateEmailUpdateEmailPayloadUpdateEmailStatus更改帳號信箱
ResendEmailCodeResendEmailCodePayloadResendEmailCodeAnswer重發驗證信
VerifyEmailCodeVerifyEmailCodePayloadVerifyEmailCodeStatus驗證信箱OTP code
UpdatePasswordUpdatePasswordPayloadUpdatePasswordStatus更新密碼
UpdateSecurityQuestionUpdateSecurityQuestionPayloadUpdateSecurityQuestionStatus更新安全提問
MergeUsernameMergeUsernamePayloadMergeUsernameAnswer整合username (username升級)
SwitchMainMemberSwitchMainMemberPayloadSwitchMainMemberAnswer將某一子帳號改為主帳號
AddPhoneAddPhonePayloadAddPhoneAnswer新增電話 (只可透過手機驗證身份,如果是虛擬帳號且操作者為主帳號、可以透過帳密驗證)
ResendSmsCodeResendSmsCodePayloadResendSmsCodeAnswer重新發送SMS驗證簡訊
VerifySmsCodeVerifySmsCodePayloadVerifySmsCodeAnswer驗證SMS的OTP code,若成功會發送PhoneUpdated Pub/Sub event
SwitchDefaultPhoneSwitchDefaultPhonePayloadSwitchDefaultPhoneAnswer切換帳號默認電話,可透過手機或帳密驗證身份,若操作者非主帳號會阻擋,若成功會發送PhoneUpdated Pub/Sub event

MemberQuery

Method NameRequest TypeResponse TypeDescription
AvatarUploaderMemberAvatarUploaderPayloadMemberAvatarUploaderAnswer
BasicInfoMemberBasicInfoPayloadMemberBasicInfoAnswer
SocialInfoMemberSocialInfoPayloadMemberSocialInfoAnswer
IntroductionMemberIntroductionPayloadMemberIntroductionAnswer
CompanyJobInfoMemberCompanyJobInfoPayloadMemberCompanyJobInfoAnswer
EducationInfoMemberEducationInfoPayloadMemberEducationInfoAnswer
PreferenceMemberPreferencePayloadMemberPreferenceAnswer
MyOperationLogMyOperationLogPayloadMyOperationLogAnswer
GetUsernamesBySessionGetUsernamesBySessionPayloadGetUsernamesBySessionAnswer透過登入pan所產生的session token,得到該用戶的usernames (需完成Login phase 2驗證,且若username不需要升級會報錯)
PhoneNumberListPhoneNumberListPayloadPhoneNumberListAnswer該帳號擁有的全部電話,default_index表示結果集中「默認電話」的對應index,twid_verified_phone_index表示結果集中「有通過TWID驗證的電話」的對應index。若操作者為子帳號會遮蔽號碼中的3碼
CredentialStatusCredentialStatusPayloadCredentialStatusAnswer

pan/account/v1/friend/friendcommand.proto

AcceptFriendByPairTokenPayload

FieldTypeLabelDescription
pan_access_tokenstring接收方token
pair_tokenstring如果pair token驗證失敗,fallback會作為QR Code來驗證

AcceptFriendByPairTokenStatus

AcceptFriendByPairTokenStatus.Error

AddBlackPayload

FieldTypeLabelDescription
pan_access_tokenstring加入方token
member_idpan.account.v1.member.Identity被加入方id

AddBlackStatus

AddBlackStatus.Error

CancelFriendRequestPayload

FieldTypeLabelDescription
pan_access_tokenstring取消方token
requesterpan.account.v1.member.Identity取消方id (如果和token不符會報錯)
targetpan.account.v1.member.Identity當初收到邀請的用戶的id

CancelFriendRequestStatus

CancelFriendRequestStatus.Error

CreateFriendRequestPayload

FieldTypeLabelDescription
pan_access_tokenstring邀請方token
requesterpan.account.v1.member.Identity邀請方id (如果和token不合會報錯)
targetpan.account.v1.member.Identity被邀請方id
messagestringdeprecated

CreateFriendRequestStatus

CreateFriendRequestStatus.Error

RemoveBlackPayload

FieldTypeLabelDescription
pan_access_tokenstring解除方的token
member_idpan.account.v1.member.Identity被解除方的id

RemoveBlackStatus

RemoveBlackStatus.Error

RemoveBuddyPayload

FieldTypeLabelDescription
pan_access_tokenstring解除方的token
member_idpan.account.v1.member.Identity被解除方的id

RemoveBuddyStatus

RemoveBuddyStatus.Error

ReplyFriendRequestPayload

FieldTypeLabelDescription
pan_access_tokenstring回覆方token
requesterpan.account.v1.member.Identity回覆方id
targetpan.account.v1.member.Identity接受回覆方id
replyReplyFriendRequestPayload.Reply.Value是否同意成為好友

ReplyFriendRequestPayload.Reply

ReplyFriendRequestStatus

ReplyFriendRequestStatus.Error

AcceptFriendByPairTokenStatus.Error.Value

NameNumberDescription
None0
Failed1001
Expired1002
Invalid1003

AddBlackStatus.Error.Value

NameNumberDescription
None0
Failed1001

CancelFriendRequestStatus.Error.Value

NameNumberDescription
None0
Failed1001

CreateFriendRequestStatus.Error.Value

NameNumberDescription
None0
Failed1001

RemoveBlackStatus.Error.Value

NameNumberDescription
None0
Failed1001

RemoveBuddyStatus.Error.Value

NameNumberDescription
None0
Failed1001

ReplyFriendRequestPayload.Reply.Value

NameNumberDescription
None0
Accept1
Deny2

ReplyFriendRequestStatus.Error.Value

NameNumberDescription
None0
Failed1001

FriendCommand

Method NameRequest TypeResponse TypeDescription
RemoveBuddyRemoveBuddyPayloadRemoveBuddyStatus解除好友(如果對方是官方帳號會阻擋)
RemoveBlackRemoveBlackPayloadRemoveBlackStatus將對方從黑名單移除
AddBlackAddBlackPayloadAddBlackStatus將對方加入黑名單
CreateFriendRequestCreateFriendRequestPayloadCreateFriendRequestStatus發送好友邀請
ReplyFriendRequestReplyFriendRequestPayloadReplyFriendRequestStatus回覆好友邀請(同意或拒絕)
CancelFriendRequestCancelFriendRequestPayloadCancelFriendRequestStatus取消送出的好友邀請
AcceptFriendByPairTokenAcceptFriendByPairTokenPayloadAcceptFriendByPairTokenStatus透過pair token新增為好友

pan/account/v1/friend/friendquery.proto

Buddy

FieldTypeLabelDescription
member_idpan.account.v1.member.Identity好友id
display_namestring好友暱稱
avatarstring好友大頭貼路徑
modifiedgoogle.protobuf.Timestamp最後修改的時間
connected_atgoogle.protobuf.Timestamp成為好友(或是封鎖對方)的時間

FriendMyBlackAllAnswer

FieldTypeLabelDescription
buddy_allBuddyrepeated用戶列表
pagerPagerpagination的相關參數封裝

FriendMyBlackAllPayload

FieldTypeLabelDescription
pan_access_tokenstring
searchstring用戶暱稱的部分比對
pagerPagerpagination的相關參數封裝

FriendMyBuddyAllAnswer

FieldTypeLabelDescription
buddy_allBuddyrepeated好友列表
pagerPagerpagination的相關參數封裝

FriendMyBuddyAllPayload

FieldTypeLabelDescription
pan_access_tokenstring
searchstring用戶暱稱的部分比對
pagerPagerpagination的相關參數封裝

FriendMyBuddyByNewerDateAnswer

FieldTypeLabelDescription
buddy_allBuddyrepeated
pagerPager

FriendMyBuddyByNewerDatePayload

FieldTypeLabelDescription
pan_access_tokenstring
dategoogle.protobuf.Timestamp
pagerPager

FriendMyBuddyByOlderDateAnswer

FieldTypeLabelDescription
buddy_allBuddyrepeated
pagerPager

FriendMyBuddyByOlderDatePayload

FieldTypeLabelDescription
pan_access_tokenstring
dategoogle.protobuf.Timestamp
pagerPager

FriendMyBuddyWithFilterAnswer

FieldTypeLabelDescription
buddy_allBuddyrepeated好友列表

FriendMyBuddyWithFilterAnswer.Error

FriendMyBuddyWithFilterAnswer.IdError

查無用戶

FieldTypeLabelDescription
codeFriendMyBuddyWithFilterAnswer.IdError.Code
member_idpan.account.v1.member.Identity對方id
descriptionstring

FriendMyBuddyWithFilterAnswer.StatusError

查無好友關聯

FieldTypeLabelDescription
codeFriendMyBuddyWithFilterAnswer.StatusError.Code
member_idpan.account.v1.member.Identity對方id

FriendMyBuddyWithFilterPayload

FieldTypeLabelDescription
pan_access_tokenstring
counterpart_allpan.account.v1.member.Identityrepeated要查詢是否為好友的用戶id list

FriendMyFriendRequestStatusWithFilterAnswer

FieldTypeLabelDescription
status_allFriendRequestStatusrepeated好友邀請回覆狀態列表

FriendMyFriendRequestStatusWithFilterAnswer.Error

FriendMyFriendRequestStatusWithFilterAnswer.IdError

查無用戶

FieldTypeLabelDescription
codeFriendMyFriendRequestStatusWithFilterAnswer.IdError.Code
member_idpan.account.v1.member.Identity
descriptionstring

FriendMyFriendRequestStatusWithFilterAnswer.StatusError

查無好友邀請

FieldTypeLabelDescription
codeFriendMyFriendRequestStatusWithFilterAnswer.StatusError.Code
member_idpan.account.v1.member.Identity

FriendMyFriendRequestStatusWithFilterPayload

FieldTypeLabelDescription
pan_access_tokenstring
counterpart_allpan.account.v1.member.Identityrepeated要查詢的用戶id list

FriendMyPendingAllAnswer

FieldTypeLabelDescription
pending_allFriendRequestPendingrepeated好友邀請列表
pagerPagerpagination的相關參數封裝

FriendMyPendingAllPayload

FieldTypeLabelDescription
pan_access_tokenstring
pagerPagerpagination的相關參數封裝
searchstring用戶暱稱的部分比對

FriendMyPendingWithFilterAnswer

FieldTypeLabelDescription
pending_allFriendRequestPendingrepeated好友邀請列表

FriendMyPendingWithFilterAnswer.Error

FriendMyPendingWithFilterAnswer.IdError

查無用戶

FieldTypeLabelDescription
codeFriendMyPendingWithFilterAnswer.IdError.Code
member_idpan.account.v1.member.Identity
descriptionstring

FriendMyPendingWithFilterAnswer.StatusError

查無好友邀請

FieldTypeLabelDescription
codeFriendMyPendingWithFilterAnswer.StatusError.Code
member_idpan.account.v1.member.Identity

FriendMyPendingWithFilterPayload

FieldTypeLabelDescription
pan_access_tokenstring
counterpart_allpan.account.v1.member.Identityrepeated查詢是否有收到對方邀請的用戶id list

FriendMyRelationAnswer

FieldTypeLabelDescription
relation_allRelationStaterepeated所有關聯狀態

FriendMyRelationAnswer.Error

FriendMyRelationAnswer.IdError

查無用戶

FieldTypeLabelDescription
codeFriendMyRelationAnswer.IdError.Code
member_idpan.account.v1.member.Identity
descriptionstring

FriendMyRelationAnswer.StatusError

查無操作者資料(pan access token無效)

FieldTypeLabelDescription
codeFriendMyRelationAnswer.StatusError.Code
member_idpan.account.v1.member.Identity

FriendMyRelationPayload

FieldTypeLabelDescription
pan_access_tokenstring
counterpart_allpan.account.v1.member.Identityrepeated要查詢的用戶id list

FriendMyRelationStatusAnswer

FieldTypeLabelDescription
friend_countint64好友總數

FriendMyRelationStatusAnswer.Error

FriendMyRelationStatusPayload

FieldTypeLabelDescription
pan_access_tokenstring

FriendRequestPending

FieldTypeLabelDescription
requesterpan.account.v1.member.Identity發出好友邀請者的id
targetpan.account.v1.member.Identity收到好友邀請者的id
createdgoogle.protobuf.Timestamp邀請的發送時間
modifiedgoogle.protobuf.Timestamp邀請的最後修改時間

FriendRequestStatus

FieldTypeLabelDescription
requesterpan.account.v1.member.Identity發出好友邀請者
targetpan.account.v1.member.Identity收到好友邀請者
stateFriendRequestStatus.State.Value回覆狀態
createdgoogle.protobuf.Timestamp邀請發出的時間

FriendRequestStatus.State

MyFriendPairTokenAnswer

FieldTypeLabelDescription
pair_tokenstring

MyFriendPairTokenAnswer.Error

MyFriendPairTokenPayload

FieldTypeLabelDescription
pan_access_tokenstring

Pager

FieldTypeLabelDescription
page_currentint64
page_totalint64
page_sizeint64
item_totalint64
sortPager.Sort

RelationState

FieldTypeLabelDescription
member_idpan.account.v1.member.Identity該用戶的id
is_friendbool是好友
is_blackbool已加入黑名單

FriendMyBuddyWithFilterAnswer.Error.Code

NameNumberDescription
None0
Failed1001

FriendMyBuddyWithFilterAnswer.IdError.Code

NameNumberDescription
None0
NotFound1001
Failed1002

FriendMyBuddyWithFilterAnswer.StatusError.Code

NameNumberDescription
None0
NotFound1001
Failed1002

FriendMyFriendRequestStatusWithFilterAnswer.Error.Code

NameNumberDescription
None0
Failed1001

FriendMyFriendRequestStatusWithFilterAnswer.IdError.Code

NameNumberDescription
None0
NotFound1001
Failed1002

FriendMyFriendRequestStatusWithFilterAnswer.StatusError.Code

NameNumberDescription
None0
NotFound1001
Failed1002

FriendMyPendingWithFilterAnswer.Error.Code

NameNumberDescription
None0
Failed1001

FriendMyPendingWithFilterAnswer.IdError.Code

NameNumberDescription
None0
NotFound1001
Failed1002

FriendMyPendingWithFilterAnswer.StatusError.Code

NameNumberDescription
None0
NotFound1001
Failed1002

FriendMyRelationAnswer.Error.Code

NameNumberDescription
None0
Failed1001

FriendMyRelationAnswer.IdError.Code

NameNumberDescription
None0
NotFound1001
Failed1002

FriendMyRelationAnswer.StatusError.Code

NameNumberDescription
None0
NotFound1001
Failed1002

FriendMyRelationStatusAnswer.Error.Code

NameNumberDescription
None0
Failed1001

FriendRequestStatus.State.Value

NameNumberDescription
None0
Sent1
Pending2
Rejected3
Accepted4

MyFriendPairTokenAnswer.Error.Code

NameNumberDescription
None0
Failed1001

Pager.Sort

NameNumberDescription
ASC0
DESC1

FriendQuery

Method NameRequest TypeResponse TypeDescription
MyBuddyAllFriendMyBuddyAllPayloadFriendMyBuddyAllAnswer查詢所有好友
MyBuddyWithFilterFriendMyBuddyWithFilterPayloadFriendMyBuddyWithFilterAnswer查詢指定名單是否皆為好友(如果其中有任一用戶不存在、或不為好友,即報錯)
MyBlackAllFriendMyBlackAllPayloadFriendMyBlackAllAnswer查詢所有已加入黑名單的用戶
MyPendingAllFriendMyPendingAllPayloadFriendMyPendingAllAnswer查詢收到的所有好友邀請
MyPendingWithFilterFriendMyPendingWithFilterPayloadFriendMyPendingWithFilterAnswer查詢指定名單是否皆有發送好友邀請給自己(如果其中有任一用戶不存在、或沒有發送邀請給自己,即報錯)
MyRelationFriendMyRelationPayloadFriendMyRelationAnswer查詢指定名單是否為好友或已加入黑名單的用戶
MyRelationStatusFriendMyRelationStatusPayloadFriendMyRelationStatusAnswer查詢好友總數
MyBuddyByNewerDateFriendMyBuddyByNewerDatePayloadFriendMyBuddyByNewerDateAnswer查詢所有好友中「用戶資料的最後修改時間」在指定時間之後的用戶(sort by asc)
MyBuddyByOlderDateFriendMyBuddyByOlderDatePayloadFriendMyBuddyByOlderDateAnswer查詢所有好友中「用戶資料的最後修改時間」在指定時間之前的用戶(sort by desc)
MyFriendRequestStatusWithFilterFriendMyFriendRequestStatusWithFilterPayloadFriendMyFriendRequestStatusWithFilterAnswer查詢針對指定名單,自己發出的好友邀請的回覆狀態(如果其中有任一用戶不存在、或沒有發送邀請給對方,即報錯)
MyFriendPairTokenMyFriendPairTokenPayloadMyFriendPairTokenAnswer用自己的access token創建一個pair token (HS256 in JWT, token ttl = 10min. secret key ttl = 11min)

pan/account/v1/general/general.proto

GeneralCommandError

UnlockSessionTokenAnswer

UnlockSessionTokenPayload

FieldTypeLabelDescription
session_tokenstring要解除鎖定的session token
session_validstringrecaptcha驗證後生成的token
platformUnlockSessionTokenPayload.Platform目標裝置

GeneralCommandError.Code

NameNumberDescription
None0

UnlockSessionTokenPayload.Platform

NameNumberDescription
WEB0
IOS1
ANDROID2

GeneralCommand

Method NameRequest TypeResponse TypeDescription
UnlockSessionTokenUnlockSessionTokenPayloadUnlockSessionTokenAnswer解除session token的鎖定狀態(需要先完成recaptcha驗證)

pan/account/v1/jpass/jpass_upgrader_command.proto

FinishUpgradeAnswer

FieldTypeLabelDescription
phone_idstring生成或綁定的phone_id
object_idstring生成或綁定的object_id
uidint64生成或綁定的uid

FinishUpgradePayload

FieldTypeLabelDescription
jpass_upgrade_tokenstring必填。jpass升級token
pan_access_tokenstring選填。當user選擇「已有JKF帳號才需要」。
object_idstring選填。member的object_id,當user選擇「已有JKF帳號才需要」。

JpassUpgraderCommandError

JpassUpgraderCommandError.Code

NameNumberDescription
None0
JPassTokenInvalid2001jpass domain相關token無效
MemberInvalid2002member存在,但並非可操作對象
MemberDuplicated2003member關聯重複

JpassUpgraderCommand

Method NameRequest TypeResponse TypeDescription
FinishUpgradeFinishUpgradePayloadFinishUpgradeAnswer接收由pan-direct-api.CreateJpassUpgradeToken創建的jut,加上用戶登入後收到的pan access token,完成jpass升級流程

pan/account/v1/platform/platform.proto

App

FieldTypeLabelDescription
idstring
display_namestring
iconstring
coverstring

ApplicationListAnswer

FieldTypeLabelDescription
record_allApplicationListAnswer.Recordrepeated

ApplicationListAnswer.Record

FieldTypeLabelDescription
app_idstring平台id
app_display_namestring平台名稱
uidint64用戶uid
registered_dategoogle.protobuf.Timestamp註冊時間

ApplicationListPayload

FieldTypeLabelDescription
pan_access_tokenstring

Error

PlatformOffAppAllAnswer

FieldTypeLabelDescription
app_allApprepeated

PlatformOffAppAllPayload

FieldTypeLabelDescription
pan_access_tokenstring

PlatformOnAppAllAnswer

FieldTypeLabelDescription
app_allApprepeated

PlatformOnAppAllPayload

FieldTypeLabelDescription
pan_access_tokenstring

PlatformQuery

Method NameRequest TypeResponse TypeDescription
OnAppAllPlatformOnAppAllPayloadPlatformOnAppAllAnswer
OffAppAllPlatformOffAppAllPayloadPlatformOffAppAllAnswer
ApplicationListApplicationListPayloadApplicationListAnswer查詢自己有被授權使用的所有平台列表

pan/account/v1/security/loginlog.proto

LoginDevice

FieldTypeLabelDescription
object_idstring
member_idstring
app_idstring
ip_addressstring
user_agentstring
expiregoogle.protobuf.Timestamp
modifiedgoogle.protobuf.Timestamp
nationstring
citystring

LoginLogCommandError

LoginLogDeviceSomeAnswer

FieldTypeLabelDescription
device_allLoginDevicerepeated

LoginLogDeviceSomePayload

FieldTypeLabelDescription
pan_access_tokenstring

LogoutAllDeviceAnswer

LogoutAllDevicePayload

FieldTypeLabelDescription
pan_access_tokenstring移除該access_token之member的所有登入紀錄
check_onlybool若為true則檢查工作是否in progress,若是則拋錯

LoginLogCommandError.Code

NameNumberDescription
None0
InProgress2001刪除作業執行中

LoginLogCommand

Method NameRequest TypeResponse TypeDescription
LogoutAllDeviceLogoutAllDevicePayloadLogoutAllDeviceAnswer登出該帳號所有裝置

LoginLogQuery

Method NameRequest TypeResponse TypeDescription
DeviceSomeLoginLogDeviceSomePayloadLoginLogDeviceSomeAnswer

pan/account/v1/security/onetimecode.proto

OneTimeCodeCommand

rpc SetEmail(SetEmailPayload) returns (SetEmailStatus);

Method NameRequest TypeResponse TypeDescription

pan/account/v1/subscription/subscription.proto

AvailablePlanAllAnswer

FieldTypeLabelDescription
plansPlanrepeated

AvailablePlanAllPayload

FieldTypeLabelDescription
pan_access_tokenstring

Plan

FieldTypeLabelDescription
app_namestring產品名稱
plan_namestring方案名稱
plan_descstring方案描述
plan_icon_urlstring方案icon的URL
plan_site_urlstring產品端對應該方案的網址
has_subscribedbool該帳號是否已訂閱此方案
subscribed_atgoogle.protobuf.Timestamp訂閱時間

ServiceItem

FieldTypeLabelDescription
idstring
display_namestring
iconstring
coverstring

SubscriptionOffServiceItemAllAnswer

FieldTypeLabelDescription
service_item_allServiceItemrepeated

SubscriptionOffServiceItemAllPayload

FieldTypeLabelDescription
pan_access_tokenstring

SubscriptionOnServiceItemAllAnswer

FieldTypeLabelDescription
service_item_allServiceItemrepeated

SubscriptionOnServiceItemAllPayload

FieldTypeLabelDescription
pan_access_tokenstring

SubscriptionQuery

Method NameRequest TypeResponse TypeDescription
OnServiceItemAllSubscriptionOnServiceItemAllPayloadSubscriptionOnServiceItemAllAnswer
OffServiceItemAllSubscriptionOffServiceItemAllPayloadSubscriptionOffServiceItemAllAnswer
AvailablePlanAllAvailablePlanAllPayloadAvailablePlanAllAnswer產品端訂閱方案一覽

pan/account/v2/base/base.proto

Page

FieldTypeLabelDescription
sizeint32單頁資料筆數
numberint32第幾頁
total_countint64資料總計筆數

pan/account/v2/base/error.proto

Error

MemberQueryError

Error.Code

NameNumberDescription
None0
PanAccessTokenInvalid1201
PinnedFriendOverLimit1202
AchievementNotFound1203

MemberQueryError.Code

NameNumberDescription
None0
UidInvalid1301

pan/account/v2/base/friend.proto

Friend

Friend.Reply

Friend.Reply.Status

NameNumberDescription
None0
Accept1
Reject2

pan/account/v2/base/member.proto

MemberBaseInfo

FieldTypeLabelDescription
object_idstring
uidint64
huidstringhashed uid
usernamestring用戶名
display_namestring暱稱
avatarstring大頭貼路徑
emailstringoptional綁定信箱
is_activatedbool是否已被啟用
jpass_idstringaka jkf_id, phone_id
is_mainbool是否為主帳號
can_new_childbool是否可以新增子帳號
is_email_verifiedbool
last_used_atgoogle.protobuf.Timestamp最後登入時間
created_atgoogle.protobuf.Timestamp創建時間
modified_atgoogle.protobuf.Timestamp最後修改時間
connected_appsstringrepeated有關聯的平台; app_id array

pan/account/v2/base/meta.proto

Achievement

Achievement consists of Type(Title), Label(Achievement), Relation(J_TAGGED_AS)

FieldTypeLabelDescription
issuer_jpass_idstring稱號發行者
issued_atgoogle.protobuf.Timestamp稱號發行時間
qualificationsQualificationrepeated稱號資格條件
typeAchievement.Type.Value稱號類型
labelstring稱號名稱
part_levelAchievement.PartLevel.Value稱號等級
seriesSeries系列資料

Achievement.PartLevel

Achievement.Type

DisplayTitle

FieldTypeLabelDescription
dataAchievement稱號資料
qualifiedQualified使用者獲得稱號的原因

DisplayTitleArray

FieldTypeLabelDescription
titlesDisplayTitlerepeated

Qualification

FieldTypeLabelDescription
qualification_idstring
app_idstring
app_display_namestring
reasonstring

Qualified

FieldTypeLabelDescription
qualification_idstring
attained_atgoogle.protobuf.Timestamp
revoked_atgoogle.protobuf.Timestamp

Series

FieldTypeLabelDescription
series_idstring
series_display_namestring

Achievement.PartLevel.Value

NameNumberDescription
None0
Red1
White2
Gold3
Rainbow4

Achievement.Type.Value

NameNumberDescription
None0
FirstPart1
SecondPart2

pan/account/v2/base/user.proto

User

User.Type

NameNumberDescription
None0
General1
Business2
Official3
Superstar4JvidModel, Lady, Actress

pan/account/v2/friend/command.proto

BlockAnswer

FieldTypeLabelDescription
resultsResultrepeated
all_successbool全部操作皆成功

BlockPayload

FieldTypeLabelDescription
pan_access_tokenstring
target_hashed_uidsstringrepeated要封鎖的好友pan hashed uid

ConfirmAllInvitationAnswer

ConfirmAllInvitationPayload

FieldTypeLabelDescription
pan_access_tokenstring同意該access_token之member的所有好友邀請
check_onlybool若為true則檢查工作是否in progress,若是則拋錯

FriendCommandError

HideAnswer

FieldTypeLabelDescription
resultsResultrepeated
all_successbool全部操作皆成功

HidePayload

FieldTypeLabelDescription
pan_access_tokenstring
target_hashed_uidsstringrepeated要隱藏的好友pan hashed uid

PinAnswer

FieldTypeLabelDescription
resultsResultrepeated
all_successbool全部操作皆成功

PinPayload

FieldTypeLabelDescription
pan_access_tokenstring
target_hashed_uidsstringrepeated要釘選的好友pan hashed uid

Result

FieldTypeLabelDescription
hashed_uidstring操作對象的pan hashed uid
successbool操作結果是否成功
reasonstring失敗理由。若success = true則reason為空

UnBlockAnswer

FieldTypeLabelDescription
resultsResultrepeated
all_successbool全部操作皆成功

UnBlockPayload

FieldTypeLabelDescription
pan_access_tokenstring
target_hashed_uidsstringrepeated要解除封鎖的好友pan hashed uid

UnHideAnswer

FieldTypeLabelDescription
resultsResultrepeated
all_successbool全部操作皆成功

UnHidePayload

FieldTypeLabelDescription
pan_access_tokenstring
target_hashed_uidsstringrepeated要解除隱藏的好友pan hashed uid

UnPinAnswer

FieldTypeLabelDescription
resultsResultrepeated
all_successbool全部操作皆成功

UnPinPayload

FieldTypeLabelDescription
pan_access_tokenstring
target_hashed_uidsstringrepeated要解除釘選的好友pan hashed uid

FriendCommandError.Code

NameNumberDescription
None0
InProgress2001作業執行中

FriendCommand

Method NameRequest TypeResponse TypeDescription
PinPinPayloadPinAnswer釘選好友 累計不可超過20個釘選,會同時解除hide
UnPinUnPinPayloadUnPinAnswer解除釘選好友 單次操作最多20筆
BlockBlockPayloadBlockAnswer封鎖好友 單次操作最多20筆,會同時解除pin並且hide
UnBlockUnBlockPayloadUnBlockAnswer解除封鎖好友 單次操作最多20筆,會同時解除hide
HideHidePayloadHideAnswer隱藏好友 單次操作最多20筆,會解除pin
UnHideUnHidePayloadUnHideAnswer解除隱藏好友 單次操作最多20筆
ConfirmAllInvitationConfirmAllInvitationPayloadConfirmAllInvitationAnswer同意所有好友邀請

pan/account/v2/friend/query.proto

BlockedListAnswer

FieldTypeLabelDescription
friendsFriendrepeated
pagepan.account.v2.base.Page

BlockedListAnswer.Record

有效欄位的參考,實際使用Friend

FieldTypeLabelDescription
hashed_uidstring
display_namestring
avatarstring
user_typepan.account.v2.base.User.Typerepeated
is_pinnedbool

BlockedListPayload

FieldTypeLabelDescription
pan_access_tokenstring
pagepan.account.v2.base.Pagepage和size不可小於1

Friend

FieldTypeLabelDescription
hashed_uidstringpan的hashed uid
uidint64pan的uid
display_namestringpan的display name
avatarstringpan的大頭貼url
typepan.account.v2.base.User.Typerepeated該用戶擁有的身份
is_friendbool和查詢者是好友
is_pinnedbool被查詢者釘選
is_blockedbool被查詢者封鎖
is_hiddenbool被查詢者隱藏

FriendCountAnswer

FieldTypeLabelDescription
countint64

FriendCountPayload

FieldTypeLabelDescription
pan_access_tokenstring

FriendListAnswer

FieldTypeLabelDescription
uid_match_friendFriendpayload中page number是1且search是uid才會有值
friendsFriendrepeated
pagepan.account.v2.base.Page

FriendListAnswer.Record

有效欄位的參考,實際使用Friend

FieldTypeLabelDescription
hashed_uidstring
uidint64
display_namestring
avatarstring
typepan.account.v2.base.User.Typerepeated
is_friendbool
is_pinnedbool
is_blockedbool
is_hiddenbool

FriendListPayload

FieldTypeLabelDescription
pan_access_tokenstring
pagepan.account.v2.base.Pagepage和size不可小於1
searchstring部分比對display_name。如果page = 1,會同時作為uid來完全比對,uid查詢結果為uid_match_friend
start_after_huidstring若不為空則優先於page
end_before_huidstring分頁用,start_after_huid和end_before_huid不可同時存在

FriendStatusAnswer

FieldTypeLabelDescription
relation_pairFriendStatusAnswer.Relationrepeatedex: from_huid = 123, to_huid = 456, status = WaitingReply -> 123已發出好友邀請給456 ex: from_huid = 123, to_huid = 456, status = Rejected -> 123發出好友邀請給456,但已被456拒絕

FriendStatusAnswer.Relation

FieldTypeLabelDescription
from_huidstring狀態發起方 (action的主詞)
to_huidstring狀態接受方 (action的受詞)
statusFriendStatusAnswer.FriendStatus好友狀態 (action)

FriendStatusPayload

FieldTypeLabelDescription
pan_access_tokenstring
target_hashed_uidstring查詢對象的pan hashed uid

HiddenListAnswer

FieldTypeLabelDescription
friendsFriendrepeated
pagepan.account.v2.base.Page

HiddenListAnswer.Record

有效欄位的參考,實際使用Friend

FieldTypeLabelDescription
hashed_uidstring
display_namestring
avatarstring
user_typepan.account.v2.base.User.Typerepeated

HiddenListPayload

FieldTypeLabelDescription
pan_access_tokenstring
pagepan.account.v2.base.Pagepage和size不可小於1

JkTalkUserInfosAnswer

FieldTypeLabelDescription
friendsFriendrepeated

JkTalkUserInfosAnswer.Record

有效欄位的參考,實際使用Friend

FieldTypeLabelDescription
hashed_uidstring
display_namestring
avatarstring
typepan.account.v2.base.User.Typerepeated
is_friendbool
is_pinnedbool
is_blockedbool
is_hiddenbool

JkTalkUserInfosPayload

FieldTypeLabelDescription
pan_access_tokenstring
hashed_uidsstringrepeated上限100,如果為空則是查自己

FriendStatusAnswer.FriendStatus

NameNumberDescription
None0
WaitingReply2已發出邀請,等待回覆中
Rejected3發出的邀請已被拒絕
IsFriend4是好友

FriendQuery

Method NameRequest TypeResponse TypeDescription
FriendListFriendListPayloadFriendListAnswer查詢好友列表 有釘選的先置頂。被釘選的好友中,官方帳號會置頂。其餘非釘選帳號中,官方帳號也會置頂。
BlockedListBlockedListPayloadBlockedListAnswer查詢已封鎖用戶列表
HiddenListHiddenListPayloadHiddenListAnswer查詢已隱藏好友列表
JkTalkUserInfosJkTalkUserInfosPayloadJkTalkUserInfosAnswer查詢指定用戶的「好友狀態」和「身份」

查是否為好友 (放pan-account) | | FriendStatus | FriendStatusPayload | FriendStatusAnswer | 查詢與指定用戶的「雙向好友狀態」

查單人 (放pan-account) | | FriendCount | FriendCountPayload | FriendCountAnswer | |

pan/account/v2/member/query.proto

DisplayTitlesAnswer

FieldTypeLabelDescription
title_mapDisplayTitlesAnswer.TitleMapEntryrepeated該用戶擁有的稱號, int64: uid

DisplayTitlesAnswer.TitleMapEntry

FieldTypeLabelDescription
keyint64
valuepan.account.v2.base.DisplayTitleArray

DisplayTitlesPayload

FieldTypeLabelDescription
pan_access_tokenstring品牌發行者
uidsint64repeated查詢 uid 是否持有稱號
app_idstringpan application id

IssuedTitlesAnswer

FieldTypeLabelDescription
title_mapIssuedTitlesAnswer.TitleMapEntryrepeated該用戶擁有的稱號, int64: uid

IssuedTitlesAnswer.TitleMapEntry

FieldTypeLabelDescription
keyint64
valuepan.account.v2.base.DisplayTitleArray

IssuedTitlesPayload

FieldTypeLabelDescription
pan_access_tokenstring品牌發行者
series_idstring系列 ID
uidsint64repeated查詢 uid 是否持有稱號

JkcMemberAuthTokenAnswer

FieldTypeLabelDescription
short_lived_auth_tokenstring

JkcMemberAuthTokenPayload

FieldTypeLabelDescription
app_idstringpan application id
pan_access_tokenstring
target_object_idstring切換帳號的 pan.members.object_id

JkcMemberListAnswer

FieldTypeLabelDescription
member_listpan.account.v2.base.MemberBaseInforepeatedJKC 專屬特規子帳號列表

JkcMemberListPayload

FieldTypeLabelDescription
app_idstringpan application id
pan_access_tokenstring

MyTitlesAnswer

FieldTypeLabelDescription
first_partpan.account.v2.base.DisplayTitle該用戶目前配戴中的頭銜-形容詞
second_partpan.account.v2.base.DisplayTitle該用戶目前配戴中的頭銜-名詞

MyTitlesPayload

FieldTypeLabelDescription
pan_access_tokenstring頭銜配戴者

MemberQuery

Method NameRequest TypeResponse TypeDescription
DisplayTitlesDisplayTitlesPayloadDisplayTitlesAnswer查詢指定 uid 持有的稱號
IssuedTitlesIssuedTitlesPayloadIssuedTitlesAnswer查詢指定系列和指定 uid 持有的發行稱號
MyTitlesMyTitlesPayloadMyTitlesAnswer查詢帳號本身擁有的頭銜且設定為配戴狀態
JkcMemberAuthTokenJkcMemberAuthTokenPayloadJkcMemberAuthTokenAnswerJKC 專屬特規切換帳號
JkcMemberListJkcMemberListPayloadJkcMemberListAnswerJKC 專屬特規查詢子帳號列表

pan/auth/v1/base.proto

Auth

FieldTypeLabelDescription
pan_access_tokenstringoptional
pan_refresh_tokenstringoptional
pan_auth_tokenstringoptional
pan_app_tokenstringoptional
pkce_code_challengestringoptional
pkce_code_verifierstringoptional

pan/direct/account/query.proto

BoundMemberAllAnswer

FieldTypeLabelDescription
main_memberpan.atom.member.Object
other_member_allpan.atom.member.Objectrepeated

BoundMemberAllAnswer.Error

BoundMemberAllPayload

FieldTypeLabelDescription
member_idpan.account.v1.member.Identity

BoundMemberAllAnswer.Error.Code

NameNumberDescription
None0
UserIdRequired1001
Failed1002

Query

Method NameRequest TypeResponse TypeDescription
BoundMemberAllBoundMemberAllPayloadBoundMemberAllAnswer

pan/direct/account/v1/jpass_upgrader/command.proto

CreateJPassUpgradeTokenAnswer

FieldTypeLabelDescription
jpass_upgrade_tokenstringerror : InvalidArgument -> 必填參數為空 Unauthenticated -> app_code無效,或無該平台資料 PermissionDenied -> 該平台無權限執行此操作 Internal -> 內部錯誤,創建token失敗

CreateJPassUpgradeTokenPayload

FieldTypeLabelDescription
pan_app_codestring必填。
app_member_idstring必填。jvid的場合,會是jvid的uid。
app_member_phonestring必填。
app_member_emailstring選填,用戶信箱。
app_member_namestring必填。jvid的場合,會是channel name。

JpassUpgraderCommand

Method NameRequest TypeResponse TypeDescription
CreateJPassUpgradeTokenCreateJPassUpgradeTokenPayloadCreateJPassUpgradeTokenAnswer創建jut token,用於將產品端帳號升級為jpass帳號

pan/direct/application/v1/base.proto

Application

FieldTypeLabelDescription
app_idstring
display_namestring

ApplicationMember

FieldTypeLabelDescription
app_idstring
app_member_idstring
pan_member_idpan.account.v1.member.Identity
last_used_atgoogle.protobuf.Timestamp
created_atgoogle.protobuf.Timestamp

pan/direct/application/v1/error.proto

BaseError

ListMemberByPanError

ListMemberByPanError.SomeMemberNotFoundDetail

FieldTypeLabelDescription
codeListMemberByPanError.SomeMemberNotFoundDetail.Code
member_idstring

BaseError.Code

NameNumberDescription
None0
Failed1001

ListMemberByPanError.Code

NameNumberDescription
None0
SomeMemberNotFound2001

ListMemberByPanError.SomeMemberNotFoundDetail.Code

NameNumberDescription
None0
UuidNotFound2001
UidNotFound2002
UnknownId2003

pan/direct/application/v1/query_member.proto

ListMemberByPanAnswer

FieldTypeLabelDescription
resultsListMemberByPanAnswer.ResultsEntryrepeatedkey: pan_member_id

ListMemberByPanAnswer.Result

FieldTypeLabelDescription
app_membersListMemberByPanAnswer.Result.AppMembersEntryrepeatedkey: app_id One pan member can have one app member in each app

ListMemberByPanAnswer.Result.AppMembersEntry

FieldTypeLabelDescription
keystring
valueApplicationMember

ListMemberByPanAnswer.ResultsEntry

FieldTypeLabelDescription
keystring
valueListMemberByPanAnswer.Result

ListMemberByPanPayload

FieldTypeLabelDescription
authpan.auth.v1.Auth
pan_member_idspan.account.v1.member.Identityrepeated

MemberQuery

Method NameRequest TypeResponse TypeDescription
ListMemberByPanListMemberByPanPayloadListMemberByPanAnswer

pan/direct/base/v1/base.proto

Error

Error.Value

NameNumberDescription
None0
ReachedMessageLimit1201
FailedToPublishEvent1202
MemberNotFound1203
AppTokenInvalid1204
IdentifiedDisplayNameDuplicated1205
MemberAlreadyIdentified1206
UsernameDuplicated1207
EmailDuplicated1208
PhoneNumberInvalid1209
MemberNotIdentified1210

pan/direct/friend/command.proto

CreateRelationshipPayload

FieldTypeLabelDescription
requesterpan.account.v1.member.Identity發出邀請方
targetpan.account.v1.member.Identity收到邀請方。talk domain related: target若為官方帳號,會發送歡迎訊息。target收到的「成為好友」小黑黑會強制為靜音模式。
relation_typeRelation.Type

CreateRelationshipStatus

DeleteRelationshipPayload

FieldTypeLabelDescription
requesterpan.account.v1.member.Identity
targetpan.account.v1.member.Identity
relation_typeRelation.Type

DeleteRelationshipStatus

Relation

CreateRelationshipStatus.Error

NameNumberDescription
Error__None0
Error__Failed1

DeleteRelationshipStatus.Error

NameNumberDescription
Error__None0
Error__Failed1

Relation.Type

NameNumberDescription
Type__None0
Type__Friend1
Type__ClosedFriend2
Type__Family3
Type__Colleague4
Type__Classmate5
Type__Nodding6
Type__Stranger7
Type__Other8

Command

Method NameRequest TypeResponse TypeDescription
CreateRelationshipCreateRelationshipPayloadCreateRelationshipStatus
DeleteRelationshipDeleteRelationshipPayloadDeleteRelationshipStatus

pan/direct/friend/query.proto

FriendPlQuery

FriendPlQuery.Answer

FieldTypeLabelDescription
pagerPager
member_plpan.account.v1.member.Identityrepeated

FriendPlQuery.Error

FriendPlQuery.Payload

FieldTypeLabelDescription
memberpan.account.v1.member.Identity
pagerPager

FriendPlStream

FriendPlStream.Error

FriendPlStream.Payload

FieldTypeLabelDescription
memberpan.account.v1.member.Identity
limitint64

Pager

FieldTypeLabelDescription
page_currentint64
page_totalint64
page_sizeint64
item_totalint64

RelationBetweenAnswer

FieldTypeLabelDescription
are_friendbool
are_blackbool

RelationBetweenAnswer.Error

RelationBetweenPayload

FieldTypeLabelDescription
counterpart_apan.account.v1.member.Identity
counterpart_bpan.account.v1.member.Identity

RelationShipPayload

FieldTypeLabelDescription
requestorpan.account.v1.member.Identity
respondentIdpan.account.v1.member.Identity

FriendPlQuery.Error.Code

NameNumberDescription
None0
Failed1001

FriendPlStream.Error.Code

NameNumberDescription
None0
Failed1001

RelationBetweenAnswer.Error.Code

NameNumberDescription
None0
Failed1001

Query

Method NameRequest TypeResponse TypeDescription
FriendStreamFriendPlStream.Payload.pan.account.v1.member.Identity stream
RelationBetweenRelationBetweenPayloadRelationBetweenAnswera b之間的關係
RelationShipRelationShipPayloadRelationBetweenAnswera->b的關係
FriendPlFriendPlQuery.PayloadFriendPlQuery.Answer

pan/direct/friend/v2/base.proto

Error

Page

FieldTypeLabelDescription
sizeint32單頁資料筆數
numberint32第幾頁
total_countint64資料總計筆數

User

Error.Code

NameNumberDescription
None0
MemberNotFound2001

User.Type

NameNumberDescription
None0
General1
Business2
Official3
Superstar4JvidModel, Lady, Actress

pan/direct/friend/v2/command.proto

BlockMemberAnswer

FieldTypeLabelDescription
successIdsstringrepeated
saga_idstring

BlockMemberPayload

FieldTypeLabelDescription
user_idstring
target_idsstringrepeated

UnBlockMemberAnswer

FieldTypeLabelDescription
successIdsstringrepeated
saga_idstring

UnBlockMemberPayload

FieldTypeLabelDescription
user_idstring
target_idsstringrepeated

Command

Method NameRequest TypeResponse TypeDescription
BlockMemberBlockMemberPayloadBlockMemberAnswer
UnBlockMemberUnBlockMemberPayloadUnBlockMemberAnswer

pan/direct/friend/v2/query.proto

BlockedListAnswer

FieldTypeLabelDescription
friendsFriendrepeated
pagePage

BlockedListAnswer.Record

有效欄位的參考,實際使用Friend

FieldTypeLabelDescription
hashed_uidstring
display_namestring
avatarstring
user_typesUser.Typerepeated

BlockedListPayload

FieldTypeLabelDescription
hashed_uidstring
pagePage

CheckMultiBlackStatusAnswer

FieldTypeLabelDescription
multi_statusCheckMultiBlackStatusAnswer.Statusrepeated

CheckMultiBlackStatusAnswer.Status

FieldTypeLabelDescription
from_huidstring
to_huidstring
blackbool

CheckMultiBlackStatusPayload

FieldTypeLabelDescription
hashed_uidstring
target_hashed_uidsstringrepeated

Friend

FieldTypeLabelDescription
hashed_uidstring
display_namestring
avatarstring
typeUser.Typerepeated
is_friendbool
is_blockedbool
member_identifiedbool

SearchFriendStatusAnswer

FieldTypeLabelDescription
friendsFriendrepeated

SearchFriendStatusAnswer.Record

FieldTypeLabelDescription
hashed_uidstring
display_namestring
avatarstring
typeUser.Typerepeated
is_friendbool
is_pinnedbool
is_blockedbool
is_hiddenbool

SearchFriendStatusPayload

FieldTypeLabelDescription
from_idstring
to_idsstringrepeated
check_self_onlybool

SearchPairsStatusAnswer

FieldTypeLabelDescription
pairsSearchPairsStatusAnswer.Pairrepeated

SearchPairsStatusAnswer.Pair

FieldTypeLabelDescription
fromSearchPairsStatusAnswer.UserInfo
toSearchPairsStatusAnswer.UserInfo

SearchPairsStatusAnswer.UserInfo

FieldTypeLabelDescription
hashed_uidstring
display_namestring
avatarstring
typeUser.Typerepeated
is_friendbool
is_blockedbool

SearchPairsStatusPayload

FieldTypeLabelDescription
pair_idsSearchPairsStatusPayload.PairIdrepeated

SearchPairsStatusPayload.PairId

FieldTypeLabelDescription
from_hashed_uidstring
to_hashed_uidstring

Query

Method NameRequest TypeResponse TypeDescription
CheckMultiBlackStatusCheckMultiBlackStatusPayloadCheckMultiBlackStatusAnswer
SearchFriendStatusSearchFriendStatusPayloadSearchFriendStatusAnswer
BlockedListBlockedListPayloadBlockedListAnswer
SearchPairsStatusSearchPairsStatusPayloadSearchPairsStatusAnswer

pan/direct/guardian/role.proto

ExchangeForVerifyLcPayload

FieldTypeLabelDescription
app_codestring
emailstring
expected_role_allstringrepeated

ExchangeForVerifyLcStatus

FieldTypeLabelDescription
exchange_tokenExchangeTokenForLc

ExchangeForVerifyVendorPayload

FieldTypeLabelDescription
app_codestring
pan_access_tokenstring
expected_role_allstringrepeated

ExchangeForVerifyVendorStatus

FieldTypeLabelDescription
exchange_tokenExchangeToken

ExchangeToken

FieldTypeLabelDescription
valuestring

ExchangeTokenForLc

FieldTypeLabelDescription
valuestring

ExchangeTokenForLcPayload

FieldTypeLabelDescription
emailstring
expected_role_allstringrepeated
track_idstring
app_idstring

ExchangeTokenPayload

FieldTypeLabelDescription
pan_access_tokenstring
expected_role_allstringrepeated
track_idstring
app_idstring

LcRole

FieldTypeLabelDescription
role_idint64
namestring

VendorRole

FieldTypeLabelDescription
role_idint64
namestring

VerifyLcPayload

FieldTypeLabelDescription
exchange_tokenExchangeTokenForLc

VerifyLcStatus

FieldTypeLabelDescription
role_allstringrepeated

VerifyVendorPayload

FieldTypeLabelDescription
exchange_tokenExchangeToken

VerifyVendorStatus

FieldTypeLabelDescription
role_allstringrepeated

ExchangeForVerifyLcStatus.Error

NameNumberDescription
Error__None0
Error__Failed1001
Error__TokenInvalid1002
Error__EmailInvalid1003

ExchangeForVerifyVendorStatus.Error

NameNumberDescription
Error__None0
Error__Failed1001
Error__TokenInvalid1002

VerifyLcStatus.Error

NameNumberDescription
Error__None0
Error__Failed1001
Error__NotExpectedRole1002
Error__InvalidToken1003

VerifyVendorStatus.Error

NameNumberDescription
Error__None0
Error__Failed1001
Error__NotExpectedVendor1002
Error__InvalidToken1003

Role

Method NameRequest TypeResponse TypeDescription
VerifyVendorVerifyVendorPayloadVerifyVendorStatus
VerifyLcVerifyLcPayloadVerifyLcStatus

Token

Method NameRequest TypeResponse TypeDescription
ExchangeForVerifyVendorExchangeForVerifyVendorPayloadExchangeForVerifyVendorStatus
ExchangeForVerifyLcExchangeForVerifyLcPayloadExchangeForVerifyLcStatus

pan/direct/meta/v1/tag.proto

AvPlus

AvPlus.RelationField

RelationField

FieldTypeLabelDescription
namestring
int64int64
strstring
boolbool
string_arrayStringArray

StringArray

FieldTypeLabelDescription
valuesstringrepeated

Tag

FieldTypeLabelDescription
labelTag.Label.Value
relationTag.Relation.Value
relation_typeTag.Type.Value
field_mapTag.FieldMapEntryrepeated
label_field_mapTag.LabelFieldMapEntryrepeated

Tag.FieldMapEntry

FieldTypeLabelDescription
keystring
valueRelationField

Tag.Label

Tag.LabelFieldMapEntry

FieldTypeLabelDescription
keystring
valueRelationField

Tag.Relation

Tag.Type

TagPl

FieldTypeLabelDescription
tag_plTagrepeated

AvPlus.RelationField.Value

NameNumberDescription
Name0
ActressId1

Tag.Label.Value

NameNumberDescription
None0
FaceLady1
FaceCompany2
FaceSubscription_Monthly_Small3
FaceSubscription_Monthly4
FaceOfficial5
AvPlusVip6
AvPlusOfficial7
Jr24hVip8
Jr24hOfficial9
JkfPlatinumVip10
ForumOfficial11
KeyOpinionLeader12
AvPlusIdol13
TankOfficial14
Achievement15

Tag.Relation.Value

NameNumberDescription
None0
J_TAGGED_AS1for Entertainer, Official, others...
J_FAMOUS_AS2論壇名人

Tag.Type.Value

NameNumberDescription
None0
Company1
Official2彩色盾牌出現
Title3
Subscription4
Entertainer5藍勾勾出現

pan/direct/member/cmd.proto

CmdAddMemberToPhoneReq

FieldTypeLabelDescription
phone_numberstring
display_namestring
passwordstring

CmdAddMemberToPhoneRes

FieldTypeLabelDescription
object_idstring
uidint64
phone_idstring

CmdCreateAddressReq

FieldTypeLabelDescription
pan_idpan.atom.member.Identity
addresspan.atom.member.AddressBook

CmdCreateAddressRes

CmdCreateMemberWithVirtualPhoneReq

FieldTypeLabelDescription
app_codestring
display_namestring
tag_plpan.direct.meta.v1.Tagrepeated
passwordstring
is_auto_emoji_for_duplicatebool
usernamestring

CmdCreateMemberWithVirtualPhoneRes

FieldTypeLabelDescription
phone_idstring
object_idstring
uidint64

CmdDelAddressReq

FieldTypeLabelDescription
pan_idpan.atom.member.Identity
address_idint64

CmdDelAddressRes

CmdGenerateAuthTokenReq

FieldTypeLabelDescription
uidint64
login_tokenstring
token_durationgoogle.protobuf.Durationoptional可選,默認為 10 年後
app_idstringoptional

CmdGenerateAuthTokenRes

FieldTypeLabelDescription
auth_tokenstring

CmdMakePanAccessTokenReq

FieldTypeLabelDescription
member_identitypan.atom.member.Identity

CmdMakePanAccessTokenRes

FieldTypeLabelDescription
pan_access_tokenstring

CmdRegisterPhoneWithMemberReq

FieldTypeLabelDescription
phone_numberstring
display_namestring
app_idstring

CmdRegisterPhoneWithMemberRes

FieldTypeLabelDescription
object_idstring
uidint64
phone_idstring

CmdUpdateMemberHistoryReq

FieldTypeLabelDescription
pan_idpan.atom.member.Identity
historypan.atom.member.History

CmdUpdateMemberHistoryRes

CmdUpdateMemberIndividualReq

FieldTypeLabelDescription
pan_idpan.atom.member.Identity
individualpan.atom.member.Individual

CmdUpdateMemberIndividualRes

CmdUpdatePasswordReq

FieldTypeLabelDescription
uidint64
passwordstring

CmdUpdatePasswordRes

CmdUpdatePhoneReq

FieldTypeLabelDescription
phone_idstring
phone_numberstring

CmdUpdatePhoneRes

CmdAddMemberToPhoneRes.Error

NameNumberDescription
Error__None0
Error__Failed1001

CmdCreateMemberWithVirtualPhoneRes.Error

NameNumberDescription
Error__None0
Error__Failed1001

CmdMakePanAccessTokenRes.Error

NameNumberDescription
Error__None0
Error__Failed1001

CmdRegisterPhoneWithMemberRes.Error

NameNumberDescription
Error__None0
Error__Failed1001

CmdUpdatePasswordRes.Error

NameNumberDescription
Error__None0
Error__Failed1001

CmdUpdatePhoneRes.Error

NameNumberDescription
Error__None0
Error__Failed1001

Cmd

pan member 修改資料的操作方法

Method NameRequest TypeResponse TypeDescription
RegisterPhoneWithMemberCmdRegisterPhoneWithMemberReqCmdRegisterPhoneWithMemberRes
AddMemberToPhoneCmdAddMemberToPhoneReqCmdAddMemberToPhoneRes
UpdateMemberHistoryCmdUpdateMemberHistoryReqCmdUpdateMemberHistoryRes
UpdateMemberIndividualCmdUpdateMemberIndividualReqCmdUpdateMemberIndividualRes
CreateAddressCmdCreateAddressReqCmdCreateAddressRes
DelAddressCmdDelAddressReqCmdDelAddressRes
UpdatePhoneCmdUpdatePhoneReqCmdUpdatePhoneRes
MakePanAccessTokenCmdMakePanAccessTokenReqCmdMakePanAccessTokenRes
CreateMemberWithVirtualPhoneCmdCreateMemberWithVirtualPhoneReqCmdCreateMemberWithVirtualPhoneRes
UpdatePasswordCmdUpdatePasswordReqCmdUpdatePasswordRes
GenerateAuthTokenCmdGenerateAuthTokenReqCmdGenerateAuthTokenRes

pan/direct/member/query.proto

MemberDetailSelectedMetaAnswer

FieldTypeLabelDescription
object_plpan.atom.member.Objectrepeated
history_mapMemberDetailSelectedMetaAnswer.HistoryMapEntryrepeated
individual_mapMemberDetailSelectedMetaAnswer.IndividualMapEntryrepeated
virtual_address_all_mapMemberDetailSelectedMetaAnswer.VirtualAddressAllMapEntryrepeated
tag_mapMemberDetailSelectedMetaAnswer.TagMapEntryrepeated

MemberDetailSelectedMetaAnswer.Error

MemberDetailSelectedMetaAnswer.HistoryMapEntry

FieldTypeLabelDescription
keystring
valuepan.atom.member.History

MemberDetailSelectedMetaAnswer.IdError

FieldTypeLabelDescription
codeMemberDetailSelectedMetaAnswer.IdError.Code
uidint64
object_idstring
huidstring

MemberDetailSelectedMetaAnswer.IndividualMapEntry

FieldTypeLabelDescription
keystring
valuepan.atom.member.Individual

MemberDetailSelectedMetaAnswer.TagMapEntry

FieldTypeLabelDescription
keystring
valuepan.direct.meta.v1.TagPl

MemberDetailSelectedMetaAnswer.VirtualAddressAllMapEntry

FieldTypeLabelDescription
keystring
valuepan.atom.member.AddressBookAll

MemberDetailSelectedMetaPayload

FieldTypeLabelDescription
member_plpan.account.v1.member.Identityrepeated
tag_plpan.direct.meta.v1.Tagrepeated

MemberDetailWithMetaAnswer

FieldTypeLabelDescription
object_plpan.atom.member.Objectrepeated
history_mapMemberDetailWithMetaAnswer.HistoryMapEntryrepeated
individual_mapMemberDetailWithMetaAnswer.IndividualMapEntryrepeated
virtual_address_all_mapMemberDetailWithMetaAnswer.VirtualAddressAllMapEntryrepeated
tag_mapMemberDetailWithMetaAnswer.TagMapEntryrepeated

MemberDetailWithMetaAnswer.Error

MemberDetailWithMetaAnswer.HistoryMapEntry

FieldTypeLabelDescription
keystring
valuepan.atom.member.History

MemberDetailWithMetaAnswer.IdError

FieldTypeLabelDescription
codeMemberDetailWithMetaAnswer.IdError.Code
uidint64
object_idstring
huidstring

MemberDetailWithMetaAnswer.IndividualMapEntry

FieldTypeLabelDescription
keystring
valuepan.atom.member.Individual

MemberDetailWithMetaAnswer.TagMapEntry

FieldTypeLabelDescription
keystring
valuepan.direct.meta.v1.TagPl

MemberDetailWithMetaAnswer.VirtualAddressAllMapEntry

FieldTypeLabelDescription
keystring
valuepan.atom.member.AddressBookAll

MemberDetailWithMetaPayload

FieldTypeLabelDescription
member_plpan.account.v1.member.Identityrepeated
tag_plpan.direct.meta.v1.Tagrepeated

PhoneQuery

PhoneQuery.Answer

FieldTypeLabelDescription
phonestring

PhoneQuery.Payload

FieldTypeLabelDescription
app_codestring
memberpan.account.v1.member.Identity
reasonstring

QueryAvatarUploaderReq

FieldTypeLabelDescription
image_typeQueryAvatarUploaderReq.ImageType
object_idstring

QueryAvatarUploaderRes

FieldTypeLabelDescription
signed_post_policyQueryAvatarUploaderRes.SignedPostPolicyEntryrepeated
url_to_uploadstring
display_image_pathstring

QueryAvatarUploaderRes.SignedPostPolicyEntry

FieldTypeLabelDescription
keystring
valuestring

QueryMemberDetailRequest

FieldTypeLabelDescription
uid_allint64repeated
object_id_allstringrepeated
huid_allstringrepeatedhash-uid

QueryMemberDetailResponse

FieldTypeLabelDescription
object_allpan.atom.member.Objectrepeated
history_mapQueryMemberDetailResponse.HistoryMapEntryrepeated
individual_mapQueryMemberDetailResponse.IndividualMapEntryrepeated
virtual_address_all_mapQueryMemberDetailResponse.VirtualAddressAllMapEntryrepeated

QueryMemberDetailResponse.Error

QueryMemberDetailResponse.HistoryMapEntry

FieldTypeLabelDescription
keystring
valuepan.atom.member.History

QueryMemberDetailResponse.IdError

FieldTypeLabelDescription
codeQueryMemberDetailResponse.IdError.Code
uidint64
object_idstring
huidstring

QueryMemberDetailResponse.IndividualMapEntry

FieldTypeLabelDescription
keystring
valuepan.atom.member.Individual

QueryMemberDetailResponse.VirtualAddressAllMapEntry

FieldTypeLabelDescription
keystring
valuepan.atom.member.AddressBookAll

MemberDetailSelectedMetaAnswer.Error.Code

NameNumberDescription
None0
IdRequired1001
IdFailed1002
Failed1003

MemberDetailSelectedMetaAnswer.IdError.Code

NameNumberDescription
None0
DecodeHashFailed1004NotFound = 1003;
Failed1005

MemberDetailWithMetaAnswer.Error.Code

NameNumberDescription
None0
IdRequired1001
IdFailed1002
Failed1003

MemberDetailWithMetaAnswer.IdError.Code

NameNumberDescription
None0
DecodeHashFailed1004NotFound = 1003;
Failed1005

QueryAvatarUploaderReq.ImageType

NameNumberDescription
ImageType__None0
ImageType__Jpeg1

QueryAvatarUploaderRes.Error

NameNumberDescription
Error__None0
Error__Failed1001

QueryMemberDetailResponse.Error.Code

NameNumberDescription
None0
IdRequired1001
IdFailed1002
Failed1003

QueryMemberDetailResponse.IdError.Code

NameNumberDescription
None0
DecodeHashFailed1004NotFound = 1003;
Failed1005

Query

Method NameRequest TypeResponse TypeDescription
AvatarUploaderQueryAvatarUploaderReqQueryAvatarUploaderRes
MemberDetailQueryMemberDetailRequestQueryMemberDetailResponse
PhonePhoneQuery.PayloadPhoneQuery.Answer
MemberDetailWithMetaMemberDetailWithMetaPayloadMemberDetailWithMetaAnswer
MemberDetailSelectedMetaMemberDetailSelectedMetaPayloadMemberDetailSelectedMetaAnswer

pan/direct/member/v2/command.proto

AvatarUploaderAnswer

FieldTypeLabelDescription
signed_post_policyAvatarUploaderAnswer.SignedPostPolicyEntryrepeated
url_to_uploadstring
display_image_pathstring

AvatarUploaderAnswer.SignedPostPolicyEntry

FieldTypeLabelDescription
keystring
valuestring

AvatarUploaderPayload

FieldTypeLabelDescription
app_tokenstring
uidint64
image_typeImage.FileType要上傳的圖檔格式

CreateGraphMemberAnswer

FieldTypeLabelDescription
saga_idstring

CreateGraphMemberPayload

FieldTypeLabelDescription
uidint64
hashed_uidstring
object_idstring
display_namestring

DisidentifyMemberAnswer

FieldTypeLabelDescription
saga_idstring

DisidentifyMemberPayload

FieldTypeLabelDescription
app_tokenstring
uidint64

IdentifyMemberAnswer

FieldTypeLabelDescription
uidint64
object_idstring
phone_idstring
saga_idstring

IdentifyMemberPayload

FieldTypeLabelDescription
app_tokenstring
uidint64optional,要指定為認證帳號的uid,若空則新建帳號
usernamestringoptional, 若無指定uid、或指定的uid為論壇舊會員需補齊pan資料,則需提供
display_namestringrequired,若和其他認證帳號重複則報錯
phonestringoptional,若有提供則自動設定為已驗證手機,若重複則報錯。若有指定uid且資料已齊全、則不會寫入
emailstringoptional, 若有提供則自動設定為已驗證信箱,若重複則報錯。若有指定uid且資料已齊全、則不會寫入
passwordstringoptional,若為補齊資料或新建帳號且無提供phone,會自動創建為虛擬帳號,需要密碼登入
client_ipstringrequired

Image

Image.FileType

NameNumberDescription
None0
Jpeg1
Png2
Gif3
Bmp4

Command

Method NameRequest TypeResponse TypeDescription
CreateGraphMemberCreateGraphMemberPayloadCreateGraphMemberAnswer
IdentifyMemberIdentifyMemberPayloadIdentifyMemberAnswer
AvatarUploaderAvatarUploaderPayloadAvatarUploaderAnswer
DisidentifyMemberDisidentifyMemberPayloadDisidentifyMemberAnswer

pan/direct/member/v2/query.proto

FindMemberListAnswer

FieldTypeLabelDescription
membersFindMemberListAnswer.Memberrepeated
total_countint64

FindMemberListAnswer.Member

FieldTypeLabelDescription
uidint64
object_idstring
phone_idstring
usernamestring
display_namestring
emailstring
phone_numbersstringrepeated

FindMemberListPayload

FieldTypeLabelDescription
app_tokenstring
uidint64
phonestring
usernamestring
display_namestring
emailstring
start_after_uidint64給當前頁最後一筆,則回傳下一頁
end_before_uidint64給當前頁第一筆,則回傳上一頁
page_sizeint64每頁筆數

Query

Method NameRequest TypeResponse TypeDescription
FindMemberListFindMemberListPayloadFindMemberListAnswer

pan/direct/message/v1/sms_command.proto

SendMessageAnswer

error -> Internal | InvalidArgument | Error_FailedToPublishEvent | Error_ReachedMessageLimit

SendMessagePayload

FieldTypeLabelDescription
phonestring要發送的電話號碼
messagestring要發送的訊息
caller_projectstringPub/Sub event使用的caller標示。ex: "JKF-pan-account-api-AddPhone"

SendVerifyCodeAnswer

error -> Internal | InvalidArgument | Error_FailedToPublishEvent | Error_ReachedMessageLimit

SendVerifyCodePayload

FieldTypeLabelDescription
phonestring要發送的電話號碼
sms_codestring要發送的驗證碼
domainstring調用domain,用於log。ex: "jkforum.net"
ipstring發出請求處的IP,用於log。
caller_projectstringPub/Sub event使用的caller標示。ex: "JKF-pan-account-api-AddPhone"

SmsCommand

Method NameRequest TypeResponse TypeDescription
SendMessageSendMessagePayloadSendMessageAnswer發送簡訊 如果電話號碼沒有+號prefix,會自動加上 會根據國碼分類限制24小時內可允許的總發送量
SendVerifyCodeSendVerifyCodePayloadSendVerifyCodeAnswer發送簡訊驗證碼 如果電話號碼沒有+號prefix,會自動加上 會根據國碼分類限制24小時內可允許的總發送量 會有GCP log紀錄簡訊發送資訊(電話號碼、OTP code、domain、IP、caller)

pan/direct/meta/v1/subscription.proto

Subscription

FieldTypeLabelDescription
jkfSubscription.JKF
jkFaceSubscription.JKFace
avPlusSubscription.AVPlus

Subscription.AVPlus

NameNumberDescription
AVPlus_Not_Set0
AVPlus_Vip1

Subscription.JKF

NameNumberDescription
JKF_Not_Set0
JKF_Vip1

Subscription.JKFace

NameNumberDescription
JKFace_Not_Set0
JKFace_Monthly_Card_Small1
JKFace_Monthly_Card2

pan/direct/meta/v1/subscriptioncommmand.proto

AddSubscriptionAnswer

AddSubscriptionAnswer.Error

AddSubscriptionPayload

FieldTypeLabelDescription
subsriptionSubscription
member_plpan.account.v1.member.Identityrepeated

MemberSubscriptionInfo

FieldTypeLabelDescription
memberpan.account.v1.member.Identity
due_timegoogle.protobuf.Timestamp

RemoveSubscriptionAnswer

RemoveSubscriptionAnswer.Error

RemoveSubscriptionPayload

FieldTypeLabelDescription
subsriptionSubscription
member_plpan.account.v1.member.Identityrepeated

UpdateSubscriptionAnswer

UpdateSubscriptionAnswer.Error

UpdateSubscriptionPayload

FieldTypeLabelDescription
subscriptionSubscription
member_infosMemberSubscriptionInforepeated

AddSubscriptionAnswer.Error.Code

NameNumberDescription
None0
Failed1001

RemoveSubscriptionAnswer.Error.Code

NameNumberDescription
None0
Failed1001

UpdateSubscriptionAnswer.Error.Code

NameNumberDescription
None0
Failed1001

SubscriptionCommand

Method NameRequest TypeResponse TypeDescription
AddSubscriptionAddSubscriptionPayloadAddSubscriptionAnswer
UpdateSubscriptionUpdateSubscriptionPayloadUpdateSubscriptionAnswer
RemoveSubscriptionRemoveSubscriptionPayloadRemoveSubscriptionAnswer

pan/direct/meta/v1/tagcommand.proto

RemoveTagOfMemberPlAnswer

RemoveTagOfMemberPlAnswer.Error

RemoveTagOfMemberPlPayload

FieldTypeLabelDescription
tag_plTagrepeated
member_plpan.account.v1.member.Identityrepeated

TagAddMemberAnswer

TagAddMemberAnswer.Error

TagAddMemberPayload

FieldTypeLabelDescription
relationTag.Relation.Value
labelTag.Label.Value
typeTag.Type.Value
member_plpan.account.v1.member.Identityrepeated
field_mapTagAddMemberPayload.FieldMapEntryrepeated
label_field_mapTagAddMemberPayload.LabelFieldMapEntryrepeated

TagAddMemberPayload.FieldMapEntry

FieldTypeLabelDescription
keystring
valueRelationField

TagAddMemberPayload.LabelFieldMapEntry

FieldTypeLabelDescription
keystring
valueRelationField

RemoveTagOfMemberPlAnswer.Error.Code

NameNumberDescription
None0
Failed1001

TagAddMemberAnswer.Error.Code

NameNumberDescription
None0
Failed1001

TagCommand

Method NameRequest TypeResponse TypeDescription
AddMemberTagAddMemberPayloadTagAddMemberAnswer
RemoveTagOfMemberPlRemoveTagOfMemberPlPayloadRemoveTagOfMemberPlAnswer

pan/direct/meta/v1/tagquery.proto

MemberTagInfoPlAnswer

FieldTypeLabelDescription
tag_mapMemberTagInfoPlAnswer.TagMapEntryrepeated

MemberTagInfoPlAnswer.Error

MemberTagInfoPlAnswer.TagMapEntry

FieldTypeLabelDescription
keystring
valueTagPl

MemberTagInfoPlPayload

FieldTypeLabelDescription
member_plpan.account.v1.member.Identityrepeated
include_field_mapboolinclude_field_map 為 true 時, 才會回傳 tag.field_map & tag.label_field_map

MemberTagInfoPlWithFilterAnswer

FieldTypeLabelDescription
tag_mapMemberTagInfoPlWithFilterAnswer.TagMapEntryrepeated

MemberTagInfoPlWithFilterAnswer.Error

MemberTagInfoPlWithFilterAnswer.TagMapEntry

FieldTypeLabelDescription
keystring
valueTagPl

MemberTagInfoPlWithFilterPayload

FieldTypeLabelDescription
member_plpan.account.v1.member.Identityrepeated
tag_plTagrepeated

TagMemberPlAnswer

FieldTypeLabelDescription
member_plpan.account.v1.member.Identityrepeated

TagMemberPlAnswer.Error

TagMemberPlPayload

FieldTypeLabelDescription
relationTag.Relation.Value
labelTag.Label.Value
typeTag.Type.Value

MemberTagInfoPlAnswer.Error.Code

NameNumberDescription
None0
Failed1001

MemberTagInfoPlWithFilterAnswer.Error.Code

NameNumberDescription
None0
Failed1001

TagMemberPlAnswer.Error.Code

NameNumberDescription
None0
Failed1001

TagQuery

Method NameRequest TypeResponse TypeDescription
MemberPlTagMemberPlPayloadTagMemberPlAnswer
MemberTagInfoPlMemberTagInfoPlPayloadMemberTagInfoPlAnswer
MemberTagInfoPlWithFilterMemberTagInfoPlWithFilterPayloadMemberTagInfoPlWithFilterAnswer

pan/direct/revert/command.proto

Error

RevertAnswer

RevertPayload

FieldTypeLabelDescription
app_tokenstringThe app token for authentication
saga_idstringThe saga ID to revert

Error.Code

NameNumberDescription
None0
ReversionPartiallyFailed2001

Command

Method NameRequest TypeResponse TypeDescription
RevertRevertPayloadRevertAnswer

pan/direct/secure/v1/apikey.proto

GetByAppAnswer

FieldTypeLabelDescription
public_keybytes

GetByAppPayload

FieldTypeLabelDescription
app_idstring
kidstring

ApiKeyQuery

Method NameRequest TypeResponse TypeDescription
GetByAppGetByAppPayloadGetByAppAnswer

pan/direct/secure/v1/appcode.proto

ValidateAppCodeAnswer

ValidateAppCodeAnswer.Error

ValidateAppCodePayload

FieldTypeLabelDescription
app_codestring

ValidateAppCodeAnswer.Error.Code

NameNumberDescription
None0
Failed1001

Enforcer

Method NameRequest TypeResponse TypeDescription
ValidateAppCodeValidateAppCodePayloadValidateAppCodeAnswer

pan/direct/secure/v1/jwe.proto

GetDecryptedDataAnswer

FieldTypeLabelDescription
plain_datastring

GetDecryptedDataAnswer.Error

GetDecryptedDataPayload

FieldTypeLabelDescription
app_codestring
encrypted_databytes

GetEncryptedDataAnswer

FieldTypeLabelDescription
encrypted_databytes

GetEncryptedDataAnswer.Error

GetEncryptedDataPayload

FieldTypeLabelDescription
app_codestring
plain_datastring

GetDecryptedDataAnswer.Error.Code

NameNumberDescription
None0
Failed1001

GetEncryptedDataAnswer.Error.Code

NameNumberDescription
None0
Failed1001

JsonWebEncryptionQuery

Method NameRequest TypeResponse TypeDescription
GetEncryptedDataGetEncryptedDataPayloadGetEncryptedDataAnswer
GetDecryptedDataGetDecryptedDataPayloadGetDecryptedDataAnswer

pan/direct/secure/v1/token.proto

ExchangeAuthTokenAnswer

FieldTypeLabelDescription
auth_tokenstring

ExchangeAuthTokenPayload

FieldTypeLabelDescription
app_codestring
uidint64

ValidateLinkTokenAnswer

ValidateLinkTokenPayload

FieldTypeLabelDescription
link_tokenstring

TokenQuery

Method NameRequest TypeResponse TypeDescription
ExchangeAuthTokenExchangeAuthTokenPayloadExchangeAuthTokenAnswer
ValidateLinkTokenValidateLinkTokenPayloadValidateLinkTokenAnswer

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)