package org.signal.registration.rpc
Get desktop application:
View/edit binary Protocol Buffers messages
* Create a new registration session for a given destination phone number.
message
registration_service.proto:33uint64 e164 = 1
* The phone number for which to create a new registration session.
bool account_exists_with_e164 = 2
* Indicates whether an account already exists with the given e164 (i.e. this session represents a "re-registration" attempt).
message
registration_service.proto:46oneof response
session_metadata = 1
* Metadata for the newly-created session.
error = 2
* A response explaining why a session could not be created as requested.
* Retrieves session metadata for a given session.
message
registration_service.proto:176bytes session_id = 1
* The ID of the session for which to retrieve metadata.
message
registration_service.proto:183oneof response
session_metadata = 1
error = 2
* Sends a verification code to a destination phone number within the context of a previously-created registration session.
message
registration_service.proto:203MessageTransport transport = 2
* The message transport to use to send a verification code to the destination phone number.
string accept_language = 3
* A prioritized list of languages accepted by the destination; should be provided in the same format as the value of an HTTP Accept-Language header.
ClientType client_type = 4
* The type of client requesting a verification code.
bytes session_id = 5
* The ID of a session within which to send (or re-send) a verification code.
string sender_name = 6
* If provided, always attempt to use the specified sender to send this message.
message
registration_service.proto:249optional session_metadata = 2
* Metadata for the named session. May be absent if the session could not be found or has expired.
optional error = 3
* If a code could not be sent, explains the underlying error. Will be absent if a code was sent successfully. Note that both an error and session metadata may be present in the same response because the session metadata may include information helpful for resolving the underlying error (i.e. "next attempt" times).
* Checks a client-provided verification code for a given registration session.
message
registration_service.proto:335optional session_metadata = 2
* Metadata for the named session. May be absent if the session could not be found or has expired.
optional error = 3
* If a code could not be checked, explains the underlying error. Will be absent if no error occurred. Note that both an error and session metadata may be present in the same response because the session metadata may include information helpful for resolving the underlying error (i.e. "next attempt" times).
message
registration_service.proto:354bool verified = 1
* Indicates whether the verification code given in the request that produced this response was correct.
optional error = 2
* If a code could not be checked, explains the underlying error. Will be absent if no error occurred.
message
registration_service.proto:368Used in: ,
CheckVerificationCodeErrorType error_type = 1
* The type of error that prevented a verification code from being checked.
bool may_retry = 2
* Indicates that this error may succeed if retried without modification after a delay indicated by `retry_after_seconds`. If false, callers should not retry the request without modification.
uint64 retry_after_seconds = 3
* If this error may be retried,, indicates the duration in seconds from the present after which the request may be retried without modification. This value has no meaning otherwise.
Used in:
CHECK_VERIFICATION_CODE_ERROR_TYPE_UNSPECIFIED = 0
CHECK_VERIFICATION_CODE_ERROR_TYPE_NO_CODE_SENT = 1
* The caller has attempted to submit a verification code even though no verification codes have been sent within the scope of this session. The caller must issue a "send code" request before trying again.
CHECK_VERIFICATION_CODE_ERROR_TYPE_RATE_LIMITED = 2
* The caller has made too many guesses within some period of time. Callers should wait for the duration prescribed in the session metadata object elsewhere in the response before trying again.
CHECK_VERIFICATION_CODE_ERROR_TYPE_SESSION_NOT_FOUND = 3
* The session identified in this request could not be found (possibly due to session expiration).
CHECK_VERIFICATION_CODE_ERROR_TYPE_ATTEMPT_EXPIRED = 4
* The session identified in this request is still active, but the most recently-sent code has expired. Callers should request a new code, then try again.
message
registration_service.proto:323Used as request type in: RegistrationService.check_verification_code, RegistrationService.legacy_check_verification_code
bytes session_id = 1
* The session ID returned when sending a verification code.
string verification_code = 2
* The client-provided verification code.
Used in:
CLIENT_TYPE_UNSPECIFIED = 0
CLIENT_TYPE_IOS = 1
CLIENT_TYPE_ANDROID_WITH_FCM = 2
CLIENT_TYPE_ANDROID_WITHOUT_FCM = 3
message
registration_service.proto:139Used in:
CreateRegistrationSessionErrorType error_type = 1
* The type of error that prevented a session from being created.
bool may_retry = 2
* Indicates that this error may succeed if retried without modification after a delay indicated by `retry_after_seconds`. If false, callers should not retry the request without modification.
uint64 retry_after_seconds = 3
* If this error may be retried,, indicates the duration in seconds from the present after which the request may be retried without modification. This value has no meaning otherwise.
Used in:
CREATE_REGISTRATION_SESSION_ERROR_TYPE_UNSPECIFIED = 0
CREATE_REGISTRATION_SESSION_ERROR_TYPE_RATE_LIMITED = 1
* Indicates that a session could not be created because too many requests to create a session for the given phone number have been received in some window of time. Callers should wait and try again later.
CREATE_REGISTRATION_SESSION_ERROR_TYPE_ILLEGAL_PHONE_NUMBER = 2
* Indicates that the provided phone number could not be parsed.
message
registration_service.proto:190Used in:
GetRegistrationSessionMetadataErrorType error_type = 1
Used in:
GET_REGISTRATION_SESSION_METADATA_ERROR_TYPE_UNSPECIFIED = 0
GET_REGISTRATION_SESSION_METADATA_ERROR_TYPE_NOT_FOUND = 1
* No session was found with the given identifier.
Used in:
MESSAGE_TRANSPORT_UNSPECIFIED = 0
MESSAGE_TRANSPORT_SMS = 1
MESSAGE_TRANSPORT_VOICE = 2
message
registration_service.proto:60Used in: , , ,
bytes session_id = 1
* An opaque sequence of bytes that uniquely identifies the registration session associated with this registration attempt.
bool verified = 2
* Indicates whether a valid verification code has been submitted in the scope of this session.
uint64 e164 = 3
* The phone number associated with this registration session.
bool may_request_sms = 4
* Indicates whether the caller may request delivery of a verification code via SMS now or at some time in the future. If true, the time a caller must wait before requesting a verification code via SMS is given in the `next_sms_seconds` field.
uint64 next_sms_seconds = 5
* The duration, in seconds, after which a caller will next be allowed to request delivery of a verification code via SMS if `may_request_sms` is true. If zero, a caller may request a verification code via SMS immediately. If `may_request_sms` is false, this field has no meaning.
bool may_request_voice_call = 6
* Indicates whether the caller may request delivery of a verification code via a phone call now or at some time in the future. If true, the time a caller must wait before requesting a verification code via SMS is given in the `next_voice_call_seconds` field. If false, simply waiting will not allow the caller to request a phone call and the caller may need to perform some other action (like attempting verification code delivery via SMS) before requesting a voice call.
uint64 next_voice_call_seconds = 7
* The duration, in seconds, after which a caller will next be allowed to request delivery of a verification code via a phone call if `may_request_voice_call` is true. If zero, a caller may request a verification code via a phone call immediately. If `may_request_voice_call` is false, this field has no meaning.
bool may_check_code = 8
* Indicates whether the caller may submit new verification codes now or at some time in the future. If true, the time a caller must wait before submitting a verification code is given in the `next_code_check_seconds` field. If false, simply waiting will not allow the caller to submit a verification code and the caller may need to perform some other action (like requesting delivery of a verification code) before checking a verification code.
uint64 next_code_check_seconds = 9
* The duration, in seconds, after which a caller will next be allowed to submit a verification code if `may_check_code` is true. If zero, a caller may submit a verification code immediately. If `may_check_code` is false, this field has no meaning.
uint64 expiration_seconds = 10
* The duration, in seconds, after which this session will expire.
message
registration_service.proto:268Used in:
SendVerificationCodeErrorType error_type = 1
* The type of error that prevented a verification code from being sent.
bool may_retry = 2
* Indicates that this error may succeed if retried without modification after a delay indicated by `retry_after_seconds`. If false, callers should not retry the request without modification.
uint64 retry_after_seconds = 3
* If this error may be retried,, indicates the duration in seconds from the present after which the request may be retried without modification. This value has no meaning otherwise.
Used in:
SEND_VERIFICATION_CODE_ERROR_TYPE_UNSPECIFIED = 0
SEND_VERIFICATION_CODE_ERROR_TYPE_SENDER_REJECTED = 1
* The sender received and understood the request to send a verification code, but declined to do so (i.e. due to rate limits or suspected fraud).
SEND_VERIFICATION_CODE_ERROR_TYPE_SENDER_ILLEGAL_ARGUMENT = 2
* The sender could not process or would not accept some part of a request (e.g. a valid phone number that cannot receive SMS messages).
SEND_VERIFICATION_CODE_ERROR_TYPE_RATE_LIMITED = 3
* A verification could could not be sent via the requested channel due to timing/rate restrictions. The response object containing this error should include session metadata that indicates when the next attempt is allowed.
SEND_VERIFICATION_CODE_ERROR_TYPE_SESSION_NOT_FOUND = 4
* No session was found with the given ID.
SEND_VERIFICATION_CODE_ERROR_TYPE_SESSION_ALREADY_VERIFIED = 5
* A new verification could could not be sent because the session has already been verified.