Notifications

Notifications#

Events you can subscribe to, and the associated notifications content.

Message Notification Service#

Info

Associated Datatype: Message

MessageReceived#

Receive a notification each time you receive a new message.

Subscription: SubscribeToMessageReceivedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageReceivedNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

MessageSent#

Receive a notification each time an you sent a new message.

Subscription: SubscribeToMessageSentNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageSentNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

MessageDeleted#

Receive a notification each time a message has been deleted.
This can happen under different circumstances:

  • you deleted a message locally

  • someone else deleted it’s own message for everyone in the discussion

Subscription: SubscribeToMessageDeletedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • message_ids (repeated MessageId - you will only receive notifications about messages specified in this list.)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageDeletedNotification

Error Codes:

  • NOT_FOUND: at least one of the message_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

MessageBodyUpdated#

datatypes.v1.Message updates

Subscription: SubscribeToMessageBodyUpdatedNotification MessageBodyUpdated Receive a notification each time a message text body have been updated. Only the message sender can edit its own messages.

Error codes: NOT_FOUND: at least one of the message_ids does not exists. UNAUTHENTICATED: client key is invalid.

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • message_ids (repeated MessageId - you will only receive notifications about messages specified in this list.)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageBodyUpdatedNotification

  • message (Message)

  • previous_body (string)

MessageUploaded#

Receive a notification each time an outbound message have been uploaded on server.
Note: You cannot guarantee this notification will arrive when working with ephemeral message

Subscription: SubscribeToMessageUploadedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • message_ids (repeated MessageId - you will only receive notifications about messages specified in this list.)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageUploadedNotification

Error Codes:

  • INVALID_ARGUMENT: at least one of message_ids is not an outbound message.

  • NOT_FOUND: at least one of the message_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

MessageDelivered#

Receive a notification each time an outbound message have been delivered on at least one recipient’s device.
Note: You cannot guarantee this notification will arrive when working with ephemeral message

Subscription: SubscribeToMessageDeliveredNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • message_ids (repeated MessageId - you will only receive notifications about messages specified in this list.)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageDeliveredNotification

Error Codes:

  • INVALID_ARGUMENT: at least one of message_ids is not an outbound message.

  • NOT_FOUND: at least one of the message_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

MessageRead#

Receive a notification each time an outbound message have been read by at least one recipient.
Note: You cannot guarantee this notification will arrive when working with ephemeral message

Subscription: SubscribeToMessageReadNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • message_ids (repeated MessageId - you will only receive notifications about messages specified in this list.)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageReadNotification

Error Codes:

  • INVALID_ARGUMENT: at least one of message_ids is not an outbound message.

  • NOT_FOUND: at least one of the message_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

MessageLocationReceived#

location message

Subscription: SubscribeToMessageLocationReceivedNotification MessageLocationReceived Receive a notification each time you received a location message. Location messages are different from location sharing messages as they contains one static position. A received location message also triggers the MessageReceived notification.

Error codes: UNAUTHENTICATED: client key is invalid.

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageLocationReceivedNotification

MessageLocationSent#

Receive a notification each time you sent a location message.
Location messages are different from location sharing messages as they contains one static position.
A sent location message also triggers the MessageSent notification.

Subscription: SubscribeToMessageLocationSentNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageLocationSentNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

MessageLocationSharingStart#

Receive a notification each time you sent or you received a new location sharing message.
Location sharing messages are supposed to be updated for a given while.
A new location sharing message also triggers the MessageReceived or MessageSent notification.

Subscription: SubscribeToMessageLocationSharingStartNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageLocationSharingStartNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

MessageLocationSharingUpdate#

Receive a notification each time a location sharing message have been updated with a new location.
This might concern inbound or outbound messages.

Subscription: SubscribeToMessageLocationSharingUpdateNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • message_ids (repeated MessageId - you will only receive notifications about messages specified in this list.)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageLocationSharingUpdateNotification

Error Codes:

  • NOT_FOUND: at least one of the message_ids does not exists.

  • INVALID_ARGUMENT: one of message_ids is not a live location sharing.

  • UNAUTHENTICATED: client key is invalid.

MessageLocationSharingEnd#

Receive a notification each time a location sharing message have been stopped or automatically finished.
This might concern inbound or outbound messages.

Subscription: SubscribeToMessageLocationSharingEndNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • message_ids (repeated MessageId - you will only receive notifications about messages specified in this list.)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

Notification (Stream): MessageLocationSharingEndNotification

Error Codes:

  • NOT_FOUND: at least one of the message_ids does not exists.

  • INVALID_ARGUMENT: one of message_ids is not a live location sharing.

  • UNAUTHENTICATED: client key is invalid.

MessageReactionAdded#

datatypes.v1.Message reactions

Subscription: SubscribeToMessageReactionAddedNotification MessageReactionAdded Receive a notification each time a reaction was added to a message. It can concern your reactions or any contact reactions.

Error codes: NOT_FOUND: at least one of the message_ids does not exists. UNAUTHENTICATED: client key is invalid.

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • message_ids (repeated MessageId - you will only receive notifications about messages specified in this list.)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

  • reaction_filter (optional ReactionFilter - you will only receive notifications about reactions that match this filter.)

Notification (Stream): MessageReactionAddedNotification

MessageReactionUpdated#

Receive a notification each time a reaction on a message was updated.
It can concern your reactions or any contact reactions.

Subscription: SubscribeToMessageReactionUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • message_ids (repeated MessageId - you will only receive notifications about messages specified in this list.)

  • message_filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

  • reaction_filter (optional ReactionFilter - you will only receive notifications about reactions that match this filter.)

  • previous_reaction_filter (optional ReactionFilter - you will only receive notifications about reactions that match this filter, before update.)

Notification (Stream): MessageReactionUpdatedNotification

Error Codes:

  • NOT_FOUND: at least one of the message_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

MessageReactionRemoved#

Receive a notification each time a reaction on a message was removed.
It can concern your reactions or any contact reactions.

Subscription: SubscribeToMessageReactionRemovedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • message_ids (repeated MessageId - you will only receive notifications about messages specified in this list.)

  • filter (optional MessageFilter - you will only receive notifications about messages that match this filter.)

  • reaction_filter (optional ReactionFilter - you will only receive notifications about reactions that match this filter.)

Notification (Stream): MessageReactionRemovedNotification

Error Codes:

  • NOT_FOUND: at least one of the message_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

Attachment Notification Service#

Info

Associated Datatype: Attachment

AttachmentReceived#

Receive a notification every time you receive an attachment in a discussion (one-to-one or group discussion).
When you receive a message with multiple attachments, you will receive one notification for each attachment.

Subscription: SubscribeToAttachmentReceivedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional AttachmentFilter - you will only receive notifications about attachments that match all the filter params.)

Notification (Stream): AttachmentReceivedNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

AttachmentUploaded#

Receive a notification every time an attachment you sent has been marked as uploaded.
A message with attachments is delivered to recipients only when all attachments have been uploaded.

Subscription: SubscribeToAttachmentUploadedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional AttachmentFilter - you will only receive notifications about attachments that match all the filter params.)

  • message_ids (repeated MessageId - you will only receive notifications about attachments related to messages specified in this list.)

  • attachment_ids (repeated AttachmentId - you will only receive notifications about attachments specified in this list.)

Notification (Stream): AttachmentUploadedNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

  • INVALID_ARGUMENT: cannot subscribe for non-outbound messages.

  • NOT_FOUND: at least one of the message_ids is incorrect.

Discussion Notification Service#

Info

Associated Datatype: Discussion

DiscussionNew#

Receive a notification every time a discussion is created or re-used.
This can happen under different circumstances:

  • a new contact was added

  • you created or joined a group

Subscription: SubscribeToDiscussionNewNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional DiscussionFilter - you will only receive notifications about discussions that match all the filter params.)

Notification (Stream): DiscussionNewNotification

Error Codes:

  • UNAUTHENTICATED: Client key is invalid.

DiscussionLocked#

Receive a notification each time a discussion is locked.
This can happen under different circumstances:

  • the contact associated to this discussion was removed from your contact book

  • you left the associated group or the group was disbanded

Subscription: SubscribeToDiscussionLockedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional DiscussionFilter - you will only receive notifications about discussions that match all the filter params.)

  • discussion_ids (repeated uint64 - you will only receive notifications about discussions specified in this list.)

Notification (Stream): DiscussionLockedNotification

Error Codes:

  • NOT_FOUND: at least one of the discussion_ids was not found.

  • UNAUTHENTICATED: client key is invalid.

DiscussionTitleUpdated#

Receive a notification each time a discussion title changed.
This can happen under different circumstances:

  • the contact associated to this discussion changed it’s details

  • the associated group was renamed

Subscription: SubscribeToDiscussionTitleUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional DiscussionFilter - you will only receive notifications about discussions that match all the filter params.)

  • discussion_ids (repeated uint64 - you will only receive notifications about discussions specified in this list.)

Notification (Stream): DiscussionTitleUpdatedNotification

Error Codes:

  • NOT_FOUND: at least one of the discussion_ids was not found.

  • UNAUTHENTICATED: client key is invalid.

DiscussionSettingsUpdated#

Receive a notification each time the discussion shared settings have been updated.
Any group group member with the change_settings permission can update shared settings.
By default admin members have this permission.

Subscription: SubscribeToDiscussionSettingsUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional DiscussionFilter - you will only receive notifications about discussions that match all the filter params.)

  • discussion_ids (repeated uint64 - you will only receive notifications about discussions specified in this list.)

Notification (Stream): DiscussionSettingsUpdatedNotification

Error Codes:

  • NOT_FOUND: at least one of the discussion_ids was not found.

  • UNAUTHENTICATED: client key is invalid.

Contact Notification Service#

Info

Associated Datatype: Contact

ContactNew#

Receive a notification each time a contact is added to your contact book.

Subscription: SubscribeToContactNewNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional ContactFilter - you will only receive notifications about contacts that match all the filter params.)

Notification (Stream): ContactNewNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

ContactDeleted#

Receive a notification each time a contact is removed from your contact book.
This can happen under different circumstances:

  • you deleted the contact

  • he contact deleted you

  • the contact deleted his identity and chose to notify his contacts

Subscription: SubscribeToContactDeletedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional ContactFilter - you will only receive notifications about contacts that match all the filter params.)

  • contact_ids (repeated uint64 - you will only receive notifications about contacts specified in this list.)

Notification (Stream): ContactDeletedNotification

Error Codes:

  • NOT_FOUND: at least one of the contact_ids was not found.

  • UNAUTHENTICATED: client key is invalid.

ContactDetailsUpdated#

Receive a notification each time a contact update it’s identity details.
This implies that this contact display name changed.
This can happen under different circumstances:

  • the contact updated his details

  • for keycloak_managed contacts the directory updated it’s details

Subscription: SubscribeToContactDetailsUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional ContactFilter - you will only receive notifications about contacts that match all the filter params.)

  • contact_ids (repeated uint64 - you will only receive notifications about contacts specified in this list.)

Notification (Stream): ContactDetailsUpdatedNotification

Error Codes:

  • NOT_FOUND: at least one of the contact_ids was not found.

  • UNAUTHENTICATED: client key is invalid.

ContactPhotoUpdated#

Receive a notification each time a contact profile picture has been updated.

Subscription: SubscribeToContactPhotoUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional ContactFilter - you will only receive notifications about contacts that match all the filter params.)

  • contact_ids (repeated uint64 - you will only receive notifications about contacts specified in this list.)

Notification (Stream): ContactPhotoUpdatedNotification

Error Codes:

  • NOT_FOUND: at least one of the contact_ids was not found.

  • UNAUTHENTICATED: client key is invalid.

Group Notification Service#

Info

Associated Datatype: Group

GroupNew#

Receive a notification each time you join a new group.
This can happen under different circumstances:

  • you created a group

  • you accepted a group invitation

  • for keycloak managed group: the directory created a group or added you to an existing group

Subscription: SubscribeToGroupNewNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

Notification (Stream): GroupNewNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

GroupDeleted#

Receive a notification each time you leave a group.
This can happen under different circumstances:

  • you chose to leave a group

  • you disbanded a group (you must be admin of this group)

  • a group admin disbanded the group

  • a group admin removed you from the group

  • for keycloak managed group: the keycloak directory removed you from the group or disbanded the group

Subscription: SubscribeToGroupDeletedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_ids (repeated uint64 - you will only receive notifications about groups specified in this list.)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

Notification (Stream): GroupDeletedNotification

Error Codes:

  • NOT_FOUND: at least one of the group_ids does not exist.

  • UNAUTHENTICATED: client key is invalid.

GroupNameUpdated#

Receive a notification each time a group name have been updated.
This can happen under different circumstances:

  • you updated the group name (you must be admin of this group)

  • an admin updated the group name

  • for keycloak managed groups: the group name were changed by the keycloak directory

Subscription: SubscribeToGroupNameUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_ids (repeated uint64 - you will only receive notifications about groups specified in this list.)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

  • previous_name_search (optional string - regexp filter on group.name field, before update)

Notification (Stream): GroupNameUpdatedNotification

  • group (Group)

  • previous_name (string - the group name before update)

Error Codes:

  • NOT_FOUND: at least one of the group_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

GroupPhotoUpdated#

Receive a notification when a group picture have been updated.
This can happen under different circumstances:

  • you updated the group picture (you must be admin of this group)

  • an admin updated the group picture

  • for keycloak managed groups: the group picture were changed by the keycloak directory

Subscription: SubscribeToGroupPhotoUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_ids (repeated uint64 - you will only receive notifications about groups specified in this list.)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

Notification (Stream): GroupPhotoUpdatedNotification

Error Codes:

  • NOT_FOUND: at least one of the group_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

GroupDescriptionUpdated#

Receive a notification when a group description have been updated.
This can happen under different circumstances:

  • you updated the group description (you must be admin of this group)

  • an admin updated the group description

  • for keycloak managed groups: the group description were changed by the keycloak directory

Subscription: SubscribeToGroupDescriptionUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_ids (repeated uint64 - you will only receive notifications about groups specified in this list.)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

  • previous_description_search (optional string - regexp filter on previous group.description field, before update)

Notification (Stream): GroupDescriptionUpdatedNotification

  • group (Group)

  • previous_description (string)

Error Codes:

  • NOT_FOUND: at least one of the group_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

GroupPendingMemberAdded#

Receive a notification when a pending member was added from a group.
This can happen under different circumstances:

  • an admin added a new member to the group

  • you joined a group and all group members are all considered as pending until each one acknowledge you joined this group

Subscription: SubscribeToGroupPendingMemberAddedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_ids (repeated uint64 - you will only receive notifications about groups specified in this list.)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

  • pending_member_filter (optional PendingGroupMemberFilter - you will only receive notifications about groups with a pending member that match this filter.)

Notification (Stream): GroupPendingMemberAddedNotification

Error Codes:

  • NOT_FOUND: at least one of the group_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

GroupPendingMemberRemoved#

Receive a notification when a pending member was removed from a group.
This can happen under different circumstances:

  • a pending group member accepted or declined the group invitation

  • you joined a group and a member acknowledged you joined this group

Subscription: SubscribeToGroupPendingMemberRemovedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_ids (repeated uint64 - you will only receive notifications about groups specified in this list.)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

  • pending_member_filter (optional PendingGroupMemberFilter - you will only receive notifications about groups with a pending member that match this filter.)

Notification (Stream): GroupPendingMemberRemovedNotification

Error Codes:

  • NOT_FOUND: at least one of the group_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

GroupMemberJoined#

Receive a notification when a new member joined a group.
This can happen under different circumstances:

  • a pending group member accepted the group invitation

  • for keycloak managed groups: directory added a new group member / a user registered on directory and was automatically added to existing groups

Subscription: SubscribeToGroupMemberJoinedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_ids (repeated uint64 - you will only receive notifications about groups specified in this list.)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

  • member_filter (optional GroupMemberFilter - you will only receive notifications about groups with a member that match this filter.)

Notification (Stream): GroupMemberJoinedNotification

Error Codes:

  • NOT_FOUND: at least one of the group_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

GroupMemberLeft#

Receive a notification when a group member was removed from a group.
This can happen under different circumstances:

  • you removed a group member (you must be a group admin)

  • a group member was removed by an admin

  • for keycloak managed groups: directory removed a group member / a user unregistered from directory and was automatically removed from groups

Subscription: SubscribeToGroupMemberLeftNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_ids (repeated uint64 - you will only receive notifications about groups specified in this list.)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

  • member_filter (optional GroupMemberFilter - you will only receive notifications about groups with a member that match this filter.)

Notification (Stream): GroupMemberLeftNotification

Error Codes:

  • NOT_FOUND: at least one of the group_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

GroupOwnPermissionsUpdated#

Receive a notification when your permissions have been updated in a group.

Subscription: SubscribeToGroupOwnPermissionsUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_ids (repeated uint64 - you will only receive notifications about groups specified in this list.)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

  • permissions_filter (optional GroupPermissionFilter - you will only receive notifications about groups where your permissions match this filter.)

  • previous_permissions_filter (optional GroupPermissionFilter - you will only receive notifications when your previous permissions match this filter.)

Notification (Stream): GroupOwnPermissionsUpdatedNotification

Error Codes:

  • NOT_FOUND: at least one of the group_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

GroupMemberPermissionsUpdated#

Receive a notification when a group member permissions have been updated.

Subscription: SubscribeToGroupMemberPermissionsUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • group_ids (repeated uint64 - you will only receive notifications about groups specified in this list.)

  • group_filter (optional GroupFilter - you will only receive notifications about groups that match all the filter params.)

  • member_filter (optional GroupMemberFilter - you will only receive notifications about group members that match this filter.)

  • previous_permission_filter (optional GroupPermissionFilter - you will only receive notifications when previous permissions match this filter.)

Notification (Stream): GroupMemberPermissionsUpdatedNotification

Error Codes:

  • NOT_FOUND: at least one of the group_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

Invitation Notification Service#

Info

Associated Datatype: Invitation

InvitationReceived#

Receive a notification each time you receive a new invitation.
A new invitation marks the first step of an invitation protocol.

Subscription: SubscribeToInvitationReceivedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional InvitationFilter - you will only receive notifications about invitations that match this filter.)

Notification (Stream): InvitationReceivedNotification

Error Codes:

  • UNAUTHENTICATED: Client key is invalid.

InvitationSent#

Receive a notification each time you send a new invitation.
A new invitation is the first step of an invitation protocol.

Subscription: SubscribeToInvitationSentNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional InvitationFilter - you will only receive notifications about invitations that match this filter.)

Notification (Stream): InvitationSentNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

InvitationDeleted#

Receive a notification each time an invitation is deleted.
This can happen under different circumstances:

  • an invitation protocol ended and invitation was automatically removed

  • you aborted a protocol

  • you deleted an invitation

Subscription: SubscribeToInvitationDeletedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional InvitationFilter - you will only receive notifications about invitations that match this filter.)

  • invitation_ids (repeated uint64 - you will only receive notifications about invitations specified in this list.)

Notification (Stream): InvitationDeletedNotification

Error Codes:

  • NOT_FOUND: at least one of the invitation_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

InvitationUpdated#

Receive a notification each time an invitation status have been updated.
Invitation status are updated when a new protocol step is passed.

Subscription: SubscribeToInvitationUpdatedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

  • filter (optional InvitationFilter - you will only receive notifications about invitations that match this filter.)

  • invitation_ids (repeated uint64 - you will only receive notifications about invitations specified in this list.)

Notification (Stream): InvitationUpdatedNotification

Error Codes:

  • NOT_FOUND: at least one of the invitation_ids does not exists.

  • UNAUTHENTICATED: client key is invalid.

Call Notification Service#

Info

Associated Datatype: Call

CallIncomingCall#

Receive a notification when someone tries to call you.
Daemon will automatically answer with a busy message to notify that you won’t be able to answer.
Call details are available in notification content.

Subscription: SubscribeToCallIncomingCallNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

Notification (Stream): CallIncomingCallNotification

  • call_identifier (string)

  • discussion_id (uint64 - set to group discussion if calling a group, else to contact’s discussion, even if there are multiple participants)

  • participant_id (CallParticipantId - obviously contains a contact id)

  • caller_display_name (string)

  • participant_count (uint32)

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

CallRinging#

When you initiated a call, receive a notification when a participant phone starts to ring.
Under some network circumstances a participant phone might never start ringing.

Subscription: SubscribeToCallRingingNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

Notification (Stream): CallRingingNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

CallAccepted#

When you initiated a call, receive a notification if a participant accepted the call.
Daemon will automatically hang up when a participant accept the call because we currently cannot manage the call.

Subscription: SubscribeToCallAcceptedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

Notification (Stream): CallAcceptedNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

CallDeclined#

When you initiated a call, receive a notification if a participant declined the call.

Subscription: SubscribeToCallDeclinedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

Notification (Stream): CallDeclinedNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

CallBusy#

(Outbound call)
When you initiated a call, receive a notification if a participant accepted the call.

Subscription: SubscribeToCallBusyNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

Notification (Stream): CallBusyNotification

Error Codes:

  • UNAUTHENTICATED: client key is invalid.

CallEnded#

:
For inbound or outbound call, receive a notification when every call participant left a call or declined it.

Subscription: SubscribeToCallEndedNotification

  • count (optional uint64 - limit the number of notifications you will receive , set to 0 to disable)

Notification (Stream): CallEndedNotification

  • call_identifier (string)

Error Codes:

  • UNAUTHENTICATED: client key is invalid.