Overview
Summary
Contact
Donate
Imprint
2. Modular API
2.1 Module System
2.2 Module Interfaces
API 1: CallDurationService-API (25)
Remote Method
Local Method
Module
HTTP-Method
References
(1)
/callduration
insertCallDuration(callduration)
CallDurationModule
POST
CallDuration
(2)
/callparticipant/callduration/{id}
findAllCallParticipantOfCallDuration(id)
CallDurationModule
GET
CallDuration
CallParticipant
(3)
/identitykey/{id}
findIdentityKeyById(id)
CallDurationModule
GET
IdentityKey
(4)
/callduration/{id}
deleteCallDurationById(id)
CallDurationModule
DELETE
CallDuration
(5)
/identitykey/{id}
deleteIdentityKeyById(id)
CallDurationModule
DELETE
IdentityKey
(6)
/callparticipant/{id}
deleteCallParticipantById(id)
CallDurationModule
DELETE
CallParticipant
(7)
/devicekey/{id}
updateDeviceKeyById(devicekey)
CallDurationModule
PUT
DeviceKey
(8)
/callparticipant
findAllCallParticipant()
CallDurationModule
GET
CallParticipant
(9)
/callparticipant/useraccount/{id}
findAllCallParticipantOfUserAccount(id)
CallDurationModule
GET
UserAccount
CallParticipant
(10)
/callduration/{id}
findCallDurationById(id)
CallDurationModule
GET
CallDuration
(11)
/callparticipant/{id}
findCallParticipantById(id)
CallDurationModule
GET
CallParticipant
(12)
/identitykey
insertIdentityKey(identitykey)
CallDurationModule
POST
IdentityKey
(13)
/identitykey/useraccount/{id}
findAllIdentityKeyOfUserAccount(id)
CallDurationModule
GET
UserAccount
IdentityKey
(14)
/devicekey
findAllDeviceKey()
CallDurationModule
GET
DeviceKey
(15)
/devicekey/{id}
deleteDeviceKeyById(id)
CallDurationModule
DELETE
DeviceKey
(16)
/identitykey/{id}
updateIdentityKeyById(identitykey)
CallDurationModule
PUT
IdentityKey
(17)
/callduration/conversation/{id}
findAllCallDurationOfConversation(id)
CallDurationModule
GET
Conversation
CallDuration
(18)
/devicekey/{id}
findDeviceKeyById(id)
CallDurationModule
GET
DeviceKey
(19)
/devicekey
insertDeviceKey(devicekey)
CallDurationModule
POST
DeviceKey
(20)
/callparticipant
insertCallParticipant(callparticipant)
CallDurationModule
POST
CallParticipant
(21)
/callduration
findAllCallDuration()
CallDurationModule
GET
CallDuration
(22)
/devicekey/device/{id}
findAllDeviceKeyOfDevice(id)
CallDurationModule
GET
Device
DeviceKey
(23)
/callduration/{id}
updateCallDurationById(callduration)
CallDurationModule
PUT
CallDuration
(24)
/identitykey
findAllIdentityKey()
CallDurationModule
GET
IdentityKey
(25)
/callparticipant/{id}
updateCallParticipantById(callparticipant)
CallDurationModule
PUT
CallParticipant
API 2: ConversationService-API (27)
Remote Method
Local Method
Module
HTTP-Method
References
(1)
/conversation/groupchat/{id}
findAllConversationOfGroupChat(id)
ConversationModule
GET
GroupChat
Conversation
(2)
/notificationsetting/{id}
findNotificationSettingById(id)
ConversationModule
GET
NotificationSetting
(3)
/notificationsetting/useraccount/{id}
findAllNotificationSettingOfUserAccount(id)
ConversationModule
GET
UserAccount
NotificationSetting
(4)
/conversation/{id}
updateConversationById(conversation)
ConversationModule
PUT
Conversation
(5)
/abusereport/{id}
deleteAbuseReportById(id)
ConversationModule
DELETE
AbuseReport
(6)
/abusereport/groupchat/{id}
findAllAbuseReportOfGroupChat(id)
ConversationModule
GET
GroupChat
AbuseReport
(7)
/groupchat/{id}
updateGroupChatById(groupchat)
ConversationModule
PUT
GroupChat
(8)
/conversation
findAllConversation()
ConversationModule
GET
Conversation
(9)
/abusereport/{id}
findAbuseReportById(id)
ConversationModule
GET
AbuseReport
(10)
/abusereport/{id}
updateAbuseReportById(abusereport)
ConversationModule
PUT
AbuseReport
(11)
/abusereport
findAllAbuseReport()
ConversationModule
GET
AbuseReport
(12)
/conversation
insertConversation(conversation)
ConversationModule
POST
Conversation
(13)
/notificationsetting/{id}
updateNotificationSettingById(notificationsetting)
ConversationModule
PUT
NotificationSetting
(14)
/notificationsetting/{id}
deleteNotificationSettingById(id)
ConversationModule
DELETE
NotificationSetting
(15)
/abusereport/message/{id}
findAllAbuseReportOfMessage(id)
ConversationModule
GET
Message
AbuseReport
(16)
/conversation/useraccounta/{id}
findAllConversationOfUserAccountA(id)
ConversationModule
GET
UserAccount
Conversation
(17)
/conversation/useraccountb/{id}
findAllConversationOfUserAccountB(id)
ConversationModule
GET
UserAccount
Conversation
(18)
/notificationsetting
findAllNotificationSetting()
ConversationModule
GET
NotificationSetting
(19)
/groupchat/{id}
deleteGroupChatById(id)
ConversationModule
DELETE
GroupChat
(20)
/groupchat
insertGroupChat(groupchat)
ConversationModule
POST
GroupChat
(21)
/groupchat
findAllGroupChat()
ConversationModule
GET
GroupChat
(22)
/notificationsetting
insertNotificationSetting(notificationsetting)
ConversationModule
POST
NotificationSetting
(23)
/notificationsetting/conversation/{id}
findAllNotificationSettingOfConversation(id)
ConversationModule
GET
Conversation
NotificationSetting
(24)
/groupchat/{id}
findGroupChatById(id)
ConversationModule
GET
GroupChat
(25)
/abusereport
insertAbuseReport(abusereport)
ConversationModule
POST
AbuseReport
(26)
/conversation/{id}
findConversationById(id)
ConversationModule
GET
Conversation
(27)
/conversation/{id}
deleteConversationById(id)
ConversationModule
DELETE
Conversation
API 3: MessageService-API (25)
Remote Method
Local Method
Module
HTTP-Method
References
(1)
/device
insertDevice(device)
MessageModule
POST
Device
(2)
/device/useraccount/{id}
findAllDeviceOfUserAccount(id)
MessageModule
GET
UserAccount
Device
(3)
/message/{id}
updateMessageById(message)
MessageModule
PUT
Message
(4)
/device/{id}
deleteDeviceById(id)
MessageModule
DELETE
Device
(5)
/message
findAllMessage()
MessageModule
GET
Message
(6)
/device/{id}
updateDeviceById(device)
MessageModule
PUT
Device
(7)
/message/{id}
deleteMessageById(id)
MessageModule
DELETE
Message
(8)
/messagerecipient
findAllMessageRecipient()
MessageModule
GET
MessageRecipient
(9)
/attachment/{id}
findAttachmentById(id)
MessageModule
GET
Attachment
(10)
/messagerecipient/message/{id}
findAllMessageRecipientOfMessage(id)
MessageModule
GET
Message
MessageRecipient
(11)
/message/conversation/{id}
findAllMessageOfConversation(id)
MessageModule
GET
Conversation
Message
(12)
/messagerecipient/device/{id}
findAllMessageRecipientOfDevice(id)
MessageModule
GET
Device
MessageRecipient
(13)
/attachment
insertAttachment(attachment)
MessageModule
POST
Attachment
(14)
/device/{id}
findDeviceById(id)
MessageModule
GET
Device
(15)
/message/{id}
findMessageById(id)
MessageModule
GET
Message
(16)
/messagerecipient/{id}
deleteMessageRecipientById(id)
MessageModule
DELETE
MessageRecipient
(17)
/messagerecipient
insertMessageRecipient(messagerecipient)
MessageModule
POST
MessageRecipient
(18)
/messagerecipient/{id}
updateMessageRecipientById(messagerecipient)
MessageModule
PUT
MessageRecipient
(19)
/attachment/message/{id}
findAllAttachmentOfMessage(id)
MessageModule
GET
Message
Attachment
(20)
/attachment/{id}
updateAttachmentById(attachment)
MessageModule
PUT
Attachment
(21)
/attachment
findAllAttachment()
MessageModule
GET
Attachment
(22)
/message
insertMessage(message)
MessageModule
POST
Message
(23)
/messagerecipient/{id}
findMessageRecipientById(id)
MessageModule
GET
MessageRecipient
(24)
/device
findAllDevice()
MessageModule
GET
Device
(25)
/attachment/{id}
deleteAttachmentById(id)
MessageModule
DELETE
Attachment
API 4: PaymentAccountService-API (19)
Remote Method
Local Method
Module
HTTP-Method
References
(1)
/paymenttransaction/{id}
updatePaymentTransactionById(paymenttransaction)
PaymentAccountModule
PUT
PaymentTransaction
(2)
/paymenttransaction/paymentaccountto/{id}
findAllPaymentTransactionOfPaymentAccountTo(id)
PaymentAccountModule
GET
PaymentAccount
PaymentTransaction
(3)
/paymenttransaction
insertPaymentTransaction(paymenttransaction)
PaymentAccountModule
POST
PaymentTransaction
(4)
/paymentaccount/{id}
updatePaymentAccountById(paymentaccount)
PaymentAccountModule
PUT
PaymentAccount
(5)
/paymentaccount/{id}
findPaymentAccountById(id)
PaymentAccountModule
GET
PaymentAccount
(6)
/paymenttransaction
findAllPaymentTransaction()
PaymentAccountModule
GET
PaymentTransaction
(7)
/sessionstate
findAllSessionState()
PaymentAccountModule
GET
SessionState
(8)
/sessionstate/{id}
findSessionStateById(id)
PaymentAccountModule
GET
SessionState
(9)
/paymentaccount/{id}
deletePaymentAccountById(id)
PaymentAccountModule
DELETE
PaymentAccount
(10)
/paymenttransaction/{id}
findPaymentTransactionById(id)
PaymentAccountModule
GET
PaymentTransaction
(11)
/paymenttransaction/{id}
deletePaymentTransactionById(id)
PaymentAccountModule
DELETE
PaymentTransaction
(12)
/sessionstate
insertSessionState(sessionstate)
PaymentAccountModule
POST
SessionState
(13)
/sessionstate/{id}
deleteSessionStateById(id)
PaymentAccountModule
DELETE
SessionState
(14)
/paymenttransaction/conversation/{id}
findAllPaymentTransactionOfConversation(id)
PaymentAccountModule
GET
Conversation
PaymentTransaction
(15)
/sessionstate/{id}
updateSessionStateById(sessionstate)
PaymentAccountModule
PUT
SessionState
(16)
/paymenttransaction/paymentaccountfrom/{id}
findAllPaymentTransactionOfPaymentAccountFrom(id)
PaymentAccountModule
GET
PaymentAccount
PaymentTransaction
(17)
/paymentaccount/useraccount/{id}
findAllPaymentAccountOfUserAccount(id)
PaymentAccountModule
GET
UserAccount
PaymentAccount
(18)
/paymentaccount
insertPaymentAccount(paymentaccount)
PaymentAccountModule
POST
PaymentAccount
(19)
/paymentaccount
findAllPaymentAccount()
PaymentAccountModule
GET
PaymentAccount
API 5: SafetyNumberService-API (25)
Remote Method
Local Method
Module
HTTP-Method
References
(1)
/verificationevent/safetynumber/{id}
findAllVerificationEventOfSafetyNumber(id)
SafetyNumberModule
GET
SafetyNumber
VerificationEvent
(2)
/reaction/{id}
updateReactionById(reaction)
SafetyNumberModule
PUT
Reaction
(3)
/reaction/{id}
findReactionById(id)
SafetyNumberModule
GET
Reaction
(4)
/contact/{id}
findContactById(id)
SafetyNumberModule
GET
Contact
(5)
/safetynumber/{id}
updateSafetyNumberById(safetynumber)
SafetyNumberModule
PUT
SafetyNumber
(6)
/reaction/message/{id}
findAllReactionOfMessage(id)
SafetyNumberModule
GET
Message
Reaction
(7)
/verificationevent
findAllVerificationEvent()
SafetyNumberModule
GET
VerificationEvent
(8)
/safetynumber
insertSafetyNumber(safetynumber)
SafetyNumberModule
POST
SafetyNumber
(9)
/contact
findAllContact()
SafetyNumberModule
GET
Contact
(10)
/safetynumber
findAllSafetyNumber()
SafetyNumberModule
GET
SafetyNumber
(11)
/reaction
insertReaction(reaction)
SafetyNumberModule
POST
Reaction
(12)
/reaction
findAllReaction()
SafetyNumberModule
GET
Reaction
(13)
/contact
insertContact(contact)
SafetyNumberModule
POST
Contact
(14)
/reaction/{id}
deleteReactionById(id)
SafetyNumberModule
DELETE
Reaction
(15)
/verificationevent/{id}
findVerificationEventById(id)
SafetyNumberModule
GET
VerificationEvent
(16)
/verificationevent/{id}
updateVerificationEventById(verificationevent)
SafetyNumberModule
PUT
VerificationEvent
(17)
/safetynumber/useraccountb/{id}
findAllSafetyNumberOfUserAccountB(id)
SafetyNumberModule
GET
UserAccount
SafetyNumber
(18)
/safetynumber/useraccounta/{id}
findAllSafetyNumberOfUserAccountA(id)
SafetyNumberModule
GET
UserAccount
SafetyNumber
(19)
/contact/{id}
updateContactById(contact)
SafetyNumberModule
PUT
Contact
(20)
/safetynumber/{id}
findSafetyNumberById(id)
SafetyNumberModule
GET
SafetyNumber
(21)
/reaction/useraccount/{id}
findAllReactionOfUserAccount(id)
SafetyNumberModule
GET
UserAccount
Reaction
(22)
/verificationevent
insertVerificationEvent(verificationevent)
SafetyNumberModule
POST
VerificationEvent
(23)
/contact/{id}
deleteContactById(id)
SafetyNumberModule
DELETE
Contact
(24)
/safetynumber/{id}
deleteSafetyNumberById(id)
SafetyNumberModule
DELETE
SafetyNumber
(25)
/verificationevent/{id}
deleteVerificationEventById(id)
SafetyNumberModule
DELETE
VerificationEvent
API 6: ServerNodeService-API (27)
Remote Method
Local Method
Module
HTTP-Method
References
(1)
/serverlogentry/servernode/{id}
findAllServerLogEntryOfServerNode(id)
ServerNodeModule
GET
ServerNode
ServerLogEntry
(2)
/prekey/{id}
updatePreKeyById(prekey)
ServerNodeModule
PUT
PreKey
(3)
/serverlogentry/{id}
findServerLogEntryById(id)
ServerNodeModule
GET
ServerLogEntry
(4)
/serverlogentry/message/{id}
findAllServerLogEntryOfMessage(id)
ServerNodeModule
GET
Message
ServerLogEntry
(5)
/usersetting
insertUserSetting(usersetting)
ServerNodeModule
POST
UserSetting
(6)
/prekey/device/{id}
findAllPreKeyOfDevice(id)
ServerNodeModule
GET
Device
PreKey
(7)
/servernode/{id}
updateServerNodeById(servernode)
ServerNodeModule
PUT
ServerNode
(8)
/serverlogentry/device/{id}
findAllServerLogEntryOfDevice(id)
ServerNodeModule
GET
Device
ServerLogEntry
(9)
/prekey/{id}
deletePreKeyById(id)
ServerNodeModule
DELETE
PreKey
(10)
/servernode
insertServerNode(servernode)
ServerNodeModule
POST
ServerNode
(11)
/serverlogentry
insertServerLogEntry(serverlogentry)
ServerNodeModule
POST
ServerLogEntry
(12)
/serverlogentry
findAllServerLogEntry()
ServerNodeModule
GET
ServerLogEntry
(13)
/usersetting/{id}
deleteUserSettingById(id)
ServerNodeModule
DELETE
UserSetting
(14)
/servernode/{id}
findServerNodeById(id)
ServerNodeModule
GET
ServerNode
(15)
/prekey/{id}
findPreKeyById(id)
ServerNodeModule
GET
PreKey
(16)
/prekey
insertPreKey(prekey)
ServerNodeModule
POST
PreKey
(17)
/serverlogentry/useraccount/{id}
findAllServerLogEntryOfUserAccount(id)
ServerNodeModule
GET
UserAccount
ServerLogEntry
(18)
/serverlogentry/{id}
deleteServerLogEntryById(id)
ServerNodeModule
DELETE
ServerLogEntry
(19)
/usersetting/{id}
updateUserSettingById(usersetting)
ServerNodeModule
PUT
UserSetting
(20)
/usersetting
findAllUserSetting()
ServerNodeModule
GET
UserSetting
(21)
/servernode
findAllServerNode()
ServerNodeModule
GET
ServerNode
(22)
/serverlogentry/{id}
updateServerLogEntryById(serverlogentry)
ServerNodeModule
PUT
ServerLogEntry
(23)
/usersetting/{id}
findUserSettingById(id)
ServerNodeModule
GET
UserSetting
(24)
/usersetting/useraccount/{id}
findAllUserSettingOfUserAccount(id)
ServerNodeModule
GET
UserAccount
UserSetting
(25)
/servernode/{id}
deleteServerNodeById(id)
ServerNodeModule
DELETE
ServerNode
(26)
/prekey
findAllPreKey()
ServerNodeModule
GET
PreKey
(27)
/serverlogentry/conversation/{id}
findAllServerLogEntryOfConversation(id)
ServerNodeModule
GET
Conversation
ServerLogEntry
API 7: StickerPackService-API (18)
Remote Method
Local Method
Module
HTTP-Method
References
(1)
/groupmember/{id}
deleteGroupMemberById(id)
StickerPackModule
DELETE
GroupMember
(2)
/sticker/{id}
deleteStickerById(id)
StickerPackModule
DELETE
Sticker
(3)
/groupmember
insertGroupMember(groupmember)
StickerPackModule
POST
GroupMember
(4)
/stickerpack
findAllStickerPack()
StickerPackModule
GET
StickerPack
(5)
/sticker/stickerpack/{id}
findAllStickerOfStickerPack(id)
StickerPackModule
GET
StickerPack
Sticker
(6)
/sticker/{id}
findStickerById(id)
StickerPackModule
GET
Sticker
(7)
/groupmember/{id}
updateGroupMemberById(groupmember)
StickerPackModule
PUT
GroupMember
(8)
/stickerpack/{id}
findStickerPackById(id)
StickerPackModule
GET
StickerPack
(9)
/stickerpack/{id}
updateStickerPackById(stickerpack)
StickerPackModule
PUT
StickerPack
(10)
/groupmember/useraccount/{id}
findAllGroupMemberOfUserAccount(id)
StickerPackModule
GET
UserAccount
GroupMember
(11)
/sticker
findAllSticker()
StickerPackModule
GET
Sticker
(12)
/groupmember
findAllGroupMember()
StickerPackModule
GET
GroupMember
(13)
/sticker
insertSticker(sticker)
StickerPackModule
POST
Sticker
(14)
/stickerpack/{id}
deleteStickerPackById(id)
StickerPackModule
DELETE
StickerPack
(15)
/groupmember/{id}
findGroupMemberById(id)
StickerPackModule
GET
GroupMember
(16)
/stickerpack
insertStickerPack(stickerpack)
StickerPackModule
POST
StickerPack
(17)
/groupmember/groupchat/{id}
findAllGroupMemberOfGroupChat(id)
StickerPackModule
GET
GroupChat
GroupMember
(18)
/sticker/{id}
updateStickerById(sticker)
StickerPackModule
PUT
Sticker
API 8: UserAccountService-API (25)
Remote Method
Local Method
Module
HTTP-Method
References
(1)
/encryptionkeybundle/{id}
findEncryptionKeyBundleById(id)
UserAccountModule
GET
EncryptionKeyBundle
(2)
/block/useraccount/{id}
findAllBlockOfUserAccount(id)
UserAccountModule
GET
UserAccount
Block
(3)
/useraccount/{id}
updateUserAccountById(useraccount)
UserAccountModule
PUT
UserAccount
(4)
/encryptionkeybundle/{id}
updateEncryptionKeyBundleById(encryptionkeybundle)
UserAccountModule
PUT
EncryptionKeyBundle
(5)
/encryptionkeybundle/useraccount/{id}
findAllEncryptionKeyBundleOfUserAccount(id)
UserAccountModule
GET
UserAccount
EncryptionKeyBundle
(6)
/phonenumber/{id}
deletePhoneNumberById(id)
UserAccountModule
DELETE
PhoneNumber
(7)
/useraccount
findAllUserAccount()
UserAccountModule
GET
UserAccount
(8)
/block
findAllBlock()
UserAccountModule
GET
Block
(9)
/block/{id}
findBlockById(id)
UserAccountModule
GET
Block
(10)
/encryptionkeybundle/device/{id}
findAllEncryptionKeyBundleOfDevice(id)
UserAccountModule
GET
Device
EncryptionKeyBundle
(11)
/useraccount
insertUserAccount(useraccount)
UserAccountModule
POST
UserAccount
(12)
/phonenumber/{id}
findPhoneNumberById(id)
UserAccountModule
GET
PhoneNumber
(13)
/phonenumber
insertPhoneNumber(phonenumber)
UserAccountModule
POST
PhoneNumber
(14)
/block/{id}
deleteBlockById(id)
UserAccountModule
DELETE
Block
(15)
/block
insertBlock(block)
UserAccountModule
POST
Block
(16)
/encryptionkeybundle
insertEncryptionKeyBundle(encryptionkeybundle)
UserAccountModule
POST
EncryptionKeyBundle
(17)
/useraccount/{id}
findUserAccountById(id)
UserAccountModule
GET
UserAccount
(18)
/encryptionkeybundle/identitykey/{id}
findAllEncryptionKeyBundleOfIdentityKey(id)
UserAccountModule
GET
IdentityKey
EncryptionKeyBundle
(19)
/encryptionkeybundle/{id}
deleteEncryptionKeyBundleById(id)
UserAccountModule
DELETE
EncryptionKeyBundle
(20)
/phonenumber
findAllPhoneNumber()
UserAccountModule
GET
PhoneNumber
(21)
/encryptionkeybundle
findAllEncryptionKeyBundle()
UserAccountModule
GET
EncryptionKeyBundle
(22)
/phonenumber/useraccount/{id}
findAllPhoneNumberOfUserAccount(id)
UserAccountModule
GET
UserAccount
PhoneNumber
(23)
/block/{id}
updateBlockById(block)
UserAccountModule
PUT
Block
(24)
/useraccount/{id}
deleteUserAccountById(id)
UserAccountModule
DELETE
UserAccount
(25)
/phonenumber/{id}
updatePhoneNumberById(phonenumber)
UserAccountModule
PUT
PhoneNumber
Overview
Summary
Contact
Donate
Imprint