package pbx

Get desktop application:
View/edit binary Protocol Buffers messages

This is the single method that needs to be implemented by a gRPC client.

• rpc MessageLoop (stream ClientMsg, stream ServerMsg)

  model.proto:8

  Client sends a stream of ClientMsg, server responds with a stream of ServerMsg

Plugin interface.

• rpc FireHose (ClientReq, ServerResp)

  model.proto:18

  This plugin method is called by Tinode server for every message received from the clients. The method returns a ServerCtrl message. Non-zero ServerCtrl.code indicates that no further processing is needed. The Tinode server will generate a {ctrl} message from the returned ServerCtrl and forward it to the client session. ServerCtrl.code equals to 0 instructs the server to continue with default processing of the client message.

  message ClientReq

  model.proto:517

  • optional ClientMsg msg = 1

  • optional Session sess = 2

  message ServerResp

  model.proto:500

  • RespCode status = 1

  • optional ServerMsg srvmsg = 2

  • optional ClientMsg clmsg = 3

• rpc Find (SearchQuery, SearchFound)

  model.proto:22

  An alteranative user and topic discovery mechanism. A search request issued on a 'fnd' topic. This method is called to generate an alternative result set.

  message SearchQuery

  model.proto:524

  • string user_id = 1

  • string query = 2

  message SearchFound

  model.proto:529

  • RespCode status = 1

  • string query = 2

    New search query If status == REPLACE, otherwise unset.

  • repeated TopicSub result = 3

    Search results.

• rpc Account (AccountEvent, Unused)

  model.proto:27

  Account created, updated or deleted

  message AccountEvent

  model.proto:551

  • Crud action = 1

  • string user_id = 2

  • optional DefaultAcsMode default_acs = 3

  • bytes public = 4

  • repeated string tags = 8

    Indexable tags for user discovery

• rpc Topic (TopicEvent, Unused)

  model.proto:30

  Topic created, updated [or deleted -- not supported yet]

  message TopicEvent

  model.proto:545

  • Crud action = 1

  • string name = 2

  • optional TopicDesc desc = 3

• rpc Subscription (SubscriptionEvent, Unused)

  model.proto:33

  Subscription created, updated or deleted

  message SubscriptionEvent

  model.proto:562

  • Crud action = 1

  • string topic = 2

  • string user_id = 3

  • int32 del_id = 4

  • int32 read_id = 5

  • int32 recv_id = 6

  • optional AccessMode mode = 7

  • bytes private = 8

• rpc Message (MessageEvent, Unused)

  model.proto:36

  Message published or deleted

  message MessageEvent

  model.proto:576

  • Crud action = 1

  • optional ServerData msg = 2

Actual access mode

Used in: ServerPres, SubscriptionEvent, TopicDesc, TopicSub

• string want = 1

  Access mode requested by the user

• string given = 2

  Access mode granted to the user by the admin

Authentication level

Used in: ClientAcc, ClientExtra, Session

• NONE = 0

• ANON = 10

• AUTH = 20

• ROOT = 30

Used in: ClientNote, ServerInfo

• X2 = 0

  Invalid value. The name must be globally unique.

• ACCEPT = 1

• ANSWER = 2

• HANG_UP = 3

• ICE_CANDIDATE = 4

• INVITE = 5

• OFFER = 6

• RINGING = 7

User creation message {acc}

Used in: ClientMsg

• string id = 1

• string user_id = 2

  User being created or updated

• string scheme = 3

  The initial authentication scheme the account can use

• bytes secret = 4

  Shared secret

• bool login = 5

  Authenticate session with the newly created account

• repeated string tags = 6

  Indexable tags for user discovery

• optional SetDesc desc = 7

  User initialization data when creating a new user, otherwise ignored

• repeated ClientCred cred = 8

  Credentials for verification.

• bytes token = 9

  Authentication token used for resetting a password.

• string state = 10

  Account state: normal ("ok"), suspended

• AuthLevel auth_level = 11

  AuthLevel

• string tmp_scheme = 12

  Temporary auth params for one-off actions like password reset.

• bytes tmp_secret = 13

Credentials such as email or phone number

Used in: ClientAcc, ClientDel, ClientLogin, SetQuery

• string method = 1

  Credential type, i.e. `email` or `tel`.

• string value = 2

  Value to verify, i.e. `user@example.com` or `+18003287448`

• string response = 3

  Verification response

• map<string, bytes> params = 4

  Request parameters, such as preferences or country code.

ClientDel delete messages or topic

Used in: ClientMsg

• string id = 1

• string topic = 2

• ClientDel.What what = 3

• repeated SeqRange del_seq = 4

  Delete messages by id or range of ids

• string user_id = 5

  User ID of the subscription to delete

• optional ClientCred cred = 6

  Credential to delete.

• bool hard = 7

  Request to hard-delete messages for all users, if such option is available.

What to delete, either "msg" to delete messages (default) or "topic" to delete the topic or "sub" to delete a subscription to topic.

Used in: ClientDel

• X0 = 0

  Invalid value. The name must be globally unique.

• MSG = 1

• TOPIC = 2

• SUB = 3

• USER = 4

• CRED = 5

Used in: ClientMsg

• repeated string attachments = 1

• string on_behalf_of = 2

  Root user may send messages on behalf of other users.

• AuthLevel auth_level = 3

Query topic state {get}

Used in: ClientMsg

• string id = 1

• string topic = 2

• optional GetQuery query = 3

Client handshake

Used in: ClientMsg

• string id = 1

• string user_agent = 2

• string ver = 3

• string device_id = 4

• string lang = 5

• string platform = 6

• bool background = 7

Unsubscribe {leave} request message

Used in: ClientMsg

• string id = 1

• string topic = 2

• bool unsub = 3

Login {login} message

Used in: ClientMsg

• string id = 1

• string scheme = 2

  Authentication scheme

• bytes secret = 3

  Shared secret

• repeated ClientCred cred = 4

  Credentials for verification.

Used as request type in: Node.MessageLoop

Used as field type in: ClientReq, ServerResp

• oneof Message

  • ClientHi hi = 1

  • ClientAcc acc = 2

  • ClientLogin login = 3

  • ClientSub sub = 4

  • ClientLeave leave = 5

  • ClientPub pub = 6

  • ClientGet get = 7

  • ClientSet set = 8

  • ClientDel del = 9

  • ClientNote note = 10

• optional ClientExtra extra = 13

  Additional message parameters.

ClientNote is a client-generated notification for topic subscribers

Used in: ClientMsg

• string topic = 1

• InfoNote what = 2

  what is being reported: "recv" - message received, "read" - message read, "kp" - typing notification, "call" - voice/video call

• int32 seq_id = 3

  Server-issued message ID being reported

• int32 unread = 4

  Client's count of unread messages to report back to the server. Used in push notifications on iOS.

• CallEvent event = 5

  Call event.

• bytes payload = 6

  Arbitrary json payload (used in video calls).

ClientPub is client's request to publish data to topic subscribers {pub}

Used in: ClientMsg

• string id = 1

• string topic = 2

• bool no_echo = 3

• map<string, bytes> head = 4

• bytes content = 5

Update topic state {set}

Used in: ClientMsg

• string id = 1

• string topic = 2

• optional SetQuery query = 3

Subscription request {sub} message

Used in: ClientMsg

• string id = 1

• string topic = 2

• optional SetQuery set_query = 3

  mirrors {set}

• optional GetQuery get_query = 4

  mirrors {get}

Used in: AccountEvent, MessageEvent, SubscriptionEvent, TopicEvent

• CREATE = 0

• UPDATE = 1

• DELETE = 2

Topic default access mode

Used in: AccountEvent, SetDesc, TopicDesc

• string auth = 1

• string anon = 2

Used in: ServerMeta

• int32 del_id = 1

• repeated SeqRange del_seq = 2

Used in: GetQuery

• int64 if_modified_since = 1

  Timestamp in milliseconds since epoch 01/01/1970

• string user = 2

  Limit search to this user ID

• string topic = 3

  Limit search results to one topic;

• int32 since_id = 4

  Load messages with seq id equal or greater than this

• int32 before_id = 5

  Load messages with seq id lower than this

• int32 limit = 6

  Maximum number of results to return

Used in: ClientGet, ClientSub

• string what = 1

• optional GetOpts desc = 2

  Parameters of "desc" request

• optional GetOpts sub = 3

  Parameters of "sub" request

• optional GetOpts data = 4

  Parameters of "data" request

Used in: ClientNote, ServerInfo

• X1 = 0

  Invalid value. The name must be globally unique.

• READ = 1

• RECV = 2

• KP = 3

• CALL = 4

Plugin response codes

Used in: SearchFound, ServerResp

• CONTINUE = 0

  Instruct Tinode server to continue with default processing of the client request.

• DROP = 1

  Drop the request as if the client did not send it

• RESPOND = 2

  Send the the provided response to the client.

• REPLACE = 3

  Replace client's original request with the provided request then continue with processing.

Used in: ClientDel, DelValues, ServerPres

• int32 low = 1

• int32 hi = 2

Credentials

Used in: ServerMeta

• string method = 1

  Credential type, i.e. `email` or `tel`.

• string value = 2

  Value to verify, i.e. `user@example.com` or `+18003287448`

• bool done = 3

  Indicator that the credential is validated

{ctrl} message

Used in: ServerMsg

• string id = 1

• string topic = 2

• int32 code = 3

• string text = 4

• map<string, bytes> params = 5

{data} message

Used in: MessageEvent, ServerMsg

• string topic = 1

• string from_user_id = 2

  ID of the user who originated the message as {pub}, could be empty if sent by the system

• int64 timestamp = 7

  Timestamp when the message was sent.

• int64 deleted_at = 3

  Timestamp when the message was deleted or 0. Milliseconds since the epoch 01/01/1970

• int32 seq_id = 4

• map<string, bytes> head = 5

• bytes content = 6

{info} message: server-side copy of ClientNote with From and optional Src added.

Used in: ServerMsg

• string topic = 1

• string from_user_id = 2

• InfoNote what = 3

• int32 seq_id = 4

• string src = 5

• CallEvent event = 6

• bytes payload = 7

{meta} message

Used in: ServerMsg

• string id = 1

• string topic = 2

• optional TopicDesc desc = 3

• repeated TopicSub sub = 4

• optional DelValues del = 5

• repeated string tags = 6

• repeated ServerCred cred = 7

Cumulative message

Used as response type in: Node.MessageLoop

Used as field type in: ServerResp

• oneof Message

  • ServerCtrl ctrl = 1

  • ServerData data = 2

  • ServerPres pres = 3

  • ServerMeta meta = 4

  • ServerInfo info = 5

• string topic = 6

  DEPRECATED. Will be removed soon. When response is sent to Root, send internal topic name too.

{pres} message

Used in: ServerMsg

• string topic = 1

• string src = 2

• ServerPres.What what = 3

• string user_agent = 4

• int32 seq_id = 5

• int32 del_id = 6

• repeated SeqRange del_seq = 7

• string target_user_id = 8

• string actor_user_id = 9

• optional AccessMode acs = 10

Used in: ServerPres

• X3 = 0

  Invalid value. The name must be globally unique.

• ON = 1

• OFF = 2

• UA = 3

• UPD = 4

• GONE = 5

• ACS = 6

• TERM = 7

• MSG = 8

• READ = 9

• RECV = 10

• DEL = 11

• TAGS = 12

Context message

Used in: ClientReq

• string session_id = 1

• string user_id = 2

• AuthLevel auth_level = 3

• string remote_addr = 4

• string user_agent = 5

• string device_id = 6

• string language = 7

SetDesc: C2S in set.what == "desc" and sub.init message

Used in: ClientAcc, SetQuery

• optional DefaultAcsMode default_acs = 1

• bytes public = 2

• bytes private = 3

• bytes trusted = 4

Used in: ClientSet, ClientSub

• optional SetDesc desc = 1

  Topic metadata, new topic & new subscriptions only

• optional SetSub sub = 2

  Subscription parameters

• repeated string tags = 3

  Indexable tags

• optional ClientCred cred = 4

  Credential being updated.

SetSub: payload in set.sub request to update current subscription or invite another user, {sub.what} == "sub"

Used in: SetQuery

• string user_id = 1

  User affected by this request. Default (empty): current user

• string mode = 2

  Access mode change, either Given or Want depending on context

Topic description, S2C in Meta message

Used in: ServerMeta, TopicEvent

• int64 created_at = 1

• int64 updated_at = 2

• int64 touched_at = 3

• optional DefaultAcsMode defacs = 4

• optional AccessMode acs = 5

• int32 seq_id = 6

• int32 read_id = 7

• int32 recv_id = 8

• int32 del_id = 9

• bytes public = 10

• bytes private = 11

• string state = 12

• int64 state_at = 13

• bytes trusted = 14

• bool is_chan = 17

  17!

• bool online = 18

• int64 last_seen_time = 15

  P2P only: other user's last online timestamp & user agent

• string last_seen_user_agent = 16

MsgTopicSub: topic subscription details, sent in Meta message

Used in: SearchFound, ServerMeta

• int64 updated_at = 1

• int64 deleted_at = 2

• bool online = 3

• optional AccessMode acs = 4

• int32 read_id = 5

• int32 recv_id = 6

• bytes public = 7

• bytes trusted = 16

  16!

• bytes private = 8

• string user_id = 9

  Uid of the subscribed user

• string topic = 10

  Topic name of this subscription

• int64 touched_at = 11

• int32 seq_id = 12

  ID of the last {data} message in a topic

• int32 del_id = 13

  Messages are deleted up to this ID

• int64 last_seen_time = 14

  Other user's last online timestamp & user agent

• string last_seen_user_agent = 15

Dummy placeholder message.

Used as response type in: Plugin.Account, Plugin.Message, Plugin.Subscription, Plugin.Topic

(message has no fields)