-
Notifications
You must be signed in to change notification settings - Fork 49
Chat API (REST SSE) for Openfire Documentation
[ Jump to Models ]
get /restapi/v1/chat/contactspost /restapi/v1/chat/contactsdelete /restapi/v1/chat/contacts/{rosterJid}put /restapi/v1/chat/contacts/{rosterJid}get /restapi/v1/chat/messagespost /restapi/v1/chat/messages/{to}post /restapi/v1/chat/presenceget /restapi/v1/chat/roomsdelete /restapi/v1/chat/rooms/{roomName}get /restapi/v1/chat/rooms/{roomName}post /restapi/v1/chat/rooms/{roomName}/{invitedJid}get /restapi/v1/chat/rooms/{roomName}/occupantsget /restapi/v1/chat/rooms/{roomName}/participantspost /restapi/v1/chat/rooms/{roomName}put /restapi/v1/chat/rooms/{roomName}get /restapi/v1/chat/usersdelete /restapi/v1/chat/users/{propertyName}post /restapi/v1/chat/users/{propertyName}post /restapi/v1/chat/xmpp
get /restapi/v1/archive/messages/unread/{jid}delete /restapi/v1/bookmarks/{bookmarkID}get /restapi/v1/bookmarks/{bookmarkID}delete /restapi/v1/bookmarks/{bookmarkID}/propertyget /restapi/v1/bookmarks/{bookmarkID}/propertyput /restapi/v1/bookmarks/{bookmarkID}/propertyput /restapi/v1/bookmarks/{bookmarkID}get /restapi/v1/bookmarks/post /restapi/v1/bookmarksget /restapi/v1/bookmarks/user/{userID}get /restapi/v1/bookmarks/useridget /restapi/v1/chatroomspost /restapi/v1/chatroomsdelete /restapi/v1/chatrooms/{roomName}/admins/group/{groupname}post /restapi/v1/chatrooms/{roomName}/admins/group/{groupname}delete /restapi/v1/chatrooms/{roomName}/admins/{jid}post /restapi/v1/chatrooms/{roomName}/admins/{jid}delete /restapi/v1/chatrooms/{roomName}get /restapi/v1/chatrooms/{roomName}delete /restapi/v1/chatrooms/{roomName}/members/group/{groupname}post /restapi/v1/chatrooms/{roomName}/members/group/{groupname}delete /restapi/v1/chatrooms/{roomName}/members/{jid}post /restapi/v1/chatrooms/{roomName}/members/{jid}get /restapi/v1/chatrooms/{roomName}/occupantsdelete /restapi/v1/chatrooms/{roomName}/outcasts/group/{groupname}post /restapi/v1/chatrooms/{roomName}/outcasts/group/{groupname}delete /restapi/v1/chatrooms/{roomName}/outcasts/{jid}post /restapi/v1/chatrooms/{roomName}/outcasts/{jid}delete /restapi/v1/chatrooms/{roomName}/owners/group/{groupname}post /restapi/v1/chatrooms/{roomName}/owners/group/{groupname}delete /restapi/v1/chatrooms/{roomName}/owners/{jid}post /restapi/v1/chatrooms/{roomName}/owners/{jid}get /restapi/v1/chatrooms/{roomName}/participantsput /restapi/v1/chatrooms/{roomName}get /restapi/v1/groupsdelete /restapi/v1/groups/{groupName}get /restapi/v1/groups/{groupName}put /restapi/v1/groups/{groupName}post /restapi/v1/groupsdelete /restapi/v1/lockouts/{username}post /restapi/v1/lockouts/{username}post /restapi/v1/messages/usersget /restapi/v1/sessionsdelete /restapi/v1/sessions/{username}get /restapi/v1/sessions/{username}post /restapi/v1/sipaccounts/close/{username}get /restapi/v1/sipaccounts/extension/{extension}get /restapi/v1/sipaccountspost /restapi/v1/sipaccounts/open/{username}post /restapi/v1/sipaccountsdelete /restapi/v1/sipaccounts/{username}get /restapi/v1/sipaccounts/username/{username}get /restapi/v1/system/propertiespost /restapi/v1/system/propertiesdelete /restapi/v1/system/properties/{propertyKey}get /restapi/v1/system/properties/{propertyKey}put /restapi/v1/system/properties/{propertyKey}get /restapi/v1/system/statistics/sessionsget /restapi/v1/userspost /restapi/v1/usersdelete /restapi/v1/users/{username}get /restapi/v1/users/{username}delete /restapi/v1/users/{username}/groupsget /restapi/v1/users/{username}/groupsdelete /restapi/v1/users/{username}/groups/{groupName}post /restapi/v1/users/{username}/groups/{groupName}post /restapi/v1/users/{username}/groupsput /restapi/v1/users/{username}get /restapi/v1/users/{username}/rosterpost /restapi/v1/users/{username}/rosterdelete /restapi/v1/users/{username}/roster/{rosterJid}put /restapi/v1/users/{username}/roster/{rosterJid}get /restapi/v1/userservicepost /restapi/v1/userservice
get /restapi/v1/archive/messages/unread/{jid}
Retrieve all unread chat messages delivered offline (restapiV1ArchiveMessagesUnreadJidGet)
jid (required)
Path Parameter —
Content-Type: application/json
{
"jid" : "aeiou",
"count" : 123
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
delete /restapi/v1/bookmarks/{bookmarkID}
(restapiV1BookmarksBookmarkIDDelete)
bookmarkID (required)
Path Parameter —
get /restapi/v1/bookmarks/{bookmarkID}
(restapiV1BookmarksBookmarkIDGet)
bookmarkID (required)
Path Parameter —
Content-Type: application/json
{
"bookmarkID" : 123,
"globalBookmark" : true,
"propertyNames" : "{}",
"name" : "aeiou",
"property" : "aeiou",
"groups" : [ "aeiou" ],
"type" : "aeiou",
"value" : "aeiou",
"properties" : [ "aeiou" ],
"users" : [ "aeiou" ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
OK Bookmark
delete /restapi/v1/bookmarks/{bookmarkID}/property
(restapiV1BookmarksBookmarkIDPropertyDelete)
bookmarkID (required)
Path Parameter —
name (required)
Query Parameter —
Content-Type:
OK Bookmark
get /restapi/v1/bookmarks/{bookmarkID}/property
(restapiV1BookmarksBookmarkIDPropertyGet)
bookmarkID (required)
Path Parameter —
name (required)
Query Parameter —
String
Content-Type:
OK String
put /restapi/v1/bookmarks/{bookmarkID}/property
(restapiV1BookmarksBookmarkIDPropertyPut)
bookmarkID (required)
Path Parameter —
name (required)
Query Parameter —
value (required)
Query Parameter —
Content-Type:
OK Bookmark
put /restapi/v1/bookmarks/{bookmarkID}
(restapiV1BookmarksBookmarkIDPut)
bookmarkID (required)
Path Parameter —
body Bookmark (required)
Body Parameter —
Content-Type:
OK Bookmark
get /restapi/v1/bookmarks/
(restapiV1BookmarksGet)
Content-Type: application/json
{
"bookmarks" : [ {
"bookmarkID" : 123,
"globalBookmark" : true,
"propertyNames" : "{}",
"name" : "aeiou",
"property" : "aeiou",
"groups" : [ "aeiou" ],
"type" : "aeiou",
"value" : "aeiou",
"properties" : [ "aeiou" ],
"users" : [ "aeiou" ]
} ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
OK Bookmarks
post /restapi/v1/bookmarks
(restapiV1BookmarksPost)
body Bookmark (required)
Body Parameter —
Content-Type:
OK Bookmark
get /restapi/v1/bookmarks/user/{userID}
(restapiV1BookmarksUserUserIDGet)
userID (required)
Path Parameter —
Content-Type:
OK Bookmarks
get /restapi/v1/bookmarks/userid
(restapiV1BookmarksUseridGet)
userid (required)
Query Parameter —
String
Content-Type:
OK String
get /restapi/v1/chatrooms
(restapiV1ChatroomsGet)
expandGroups (optional)
Query Parameter —
search (required)
Query Parameter —
servicename (optional)
Query Parameter —
type (optional)
Query Parameter —
Content-Type: application/json
{
"mucRooms" : [ {
"registrationEnabled" : true,
"maxUsers" : 123,
"moderated" : true,
"subject" : "aeiou",
"description" : "aeiou",
"owners" : [ "aeiou" ],
"password" : "aeiou",
"outcastGroups" : [ "aeiou" ],
"ownerGroups" : [ "aeiou" ],
"logEnabled" : true,
"members" : [ "aeiou" ],
"canAnyoneDiscoverJID" : true,
"canOccupantsChangeSubject" : true,
"canChangeNickname" : true,
"memberGroups" : [ "aeiou" ],
"persistent" : true,
"adminGroups" : [ "aeiou" ],
"publicRoom" : true,
"outcasts" : [ "aeiou" ],
"broadcastPresenceRoles" : [ "aeiou" ],
"creationDate" : "{}",
"membersOnly" : true,
"canOccupantsInvite" : true,
"roomName" : "aeiou",
"loginRestrictedToNickname" : true,
"modificationDate" : "{}",
"naturalName" : "aeiou",
"admins" : [ "aeiou" ]
} ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
post /restapi/v1/chatrooms
(restapiV1ChatroomsPost)
body MUCRoomEntity (required)
Body Parameter —
servicename (optional)
Query Parameter —
delete /restapi/v1/chatrooms/{roomName}/admins/group/{groupname}
(restapiV1ChatroomsRoomNameAdminsGroupGroupnameDelete)
groupname (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
post /restapi/v1/chatrooms/{roomName}/admins/group/{groupname}
(restapiV1ChatroomsRoomNameAdminsGroupGroupnamePost)
groupname (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
delete /restapi/v1/chatrooms/{roomName}/admins/{jid}
(restapiV1ChatroomsRoomNameAdminsJidDelete)
jid (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
post /restapi/v1/chatrooms/{roomName}/admins/{jid}
(restapiV1ChatroomsRoomNameAdminsJidPost)
jid (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
delete /restapi/v1/chatrooms/{roomName}
(restapiV1ChatroomsRoomNameDelete)
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
get /restapi/v1/chatrooms/{roomName}
(restapiV1ChatroomsRoomNameGet)
roomName (required)
Path Parameter —
expandGroups (optional)
Query Parameter —
servicename (optional)
Query Parameter —
Content-Type: application/json
{
"registrationEnabled" : true,
"maxUsers" : 123,
"moderated" : true,
"subject" : "aeiou",
"description" : "aeiou",
"owners" : [ "aeiou" ],
"password" : "aeiou",
"outcastGroups" : [ "aeiou" ],
"ownerGroups" : [ "aeiou" ],
"logEnabled" : true,
"members" : [ "aeiou" ],
"canAnyoneDiscoverJID" : true,
"canOccupantsChangeSubject" : true,
"canChangeNickname" : true,
"memberGroups" : [ "aeiou" ],
"persistent" : true,
"adminGroups" : [ "aeiou" ],
"publicRoom" : true,
"outcasts" : [ "aeiou" ],
"broadcastPresenceRoles" : [ "aeiou" ],
"creationDate" : "{}",
"membersOnly" : true,
"canOccupantsInvite" : true,
"roomName" : "aeiou",
"loginRestrictedToNickname" : true,
"modificationDate" : "{}",
"naturalName" : "aeiou",
"admins" : [ "aeiou" ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
delete /restapi/v1/chatrooms/{roomName}/members/group/{groupname}
(restapiV1ChatroomsRoomNameMembersGroupGroupnameDelete)
groupname (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
post /restapi/v1/chatrooms/{roomName}/members/group/{groupname}
(restapiV1ChatroomsRoomNameMembersGroupGroupnamePost)
groupname (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
delete /restapi/v1/chatrooms/{roomName}/members/{jid}
(restapiV1ChatroomsRoomNameMembersJidDelete)
jid (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
post /restapi/v1/chatrooms/{roomName}/members/{jid}
(restapiV1ChatroomsRoomNameMembersJidPost)
jid (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
get /restapi/v1/chatrooms/{roomName}/occupants
(restapiV1ChatroomsRoomNameOccupantsGet)
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
Content-Type: application/json
{
"occupants" : [ {
"role" : "aeiou",
"jid" : "aeiou",
"affiliation" : "aeiou"
} ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
delete /restapi/v1/chatrooms/{roomName}/outcasts/group/{groupname}
(restapiV1ChatroomsRoomNameOutcastsGroupGroupnameDelete)
groupname (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
post /restapi/v1/chatrooms/{roomName}/outcasts/group/{groupname}
(restapiV1ChatroomsRoomNameOutcastsGroupGroupnamePost)
groupname (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
delete /restapi/v1/chatrooms/{roomName}/outcasts/{jid}
(restapiV1ChatroomsRoomNameOutcastsJidDelete)
jid (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
post /restapi/v1/chatrooms/{roomName}/outcasts/{jid}
(restapiV1ChatroomsRoomNameOutcastsJidPost)
jid (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
delete /restapi/v1/chatrooms/{roomName}/owners/group/{groupname}
(restapiV1ChatroomsRoomNameOwnersGroupGroupnameDelete)
groupname (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
post /restapi/v1/chatrooms/{roomName}/owners/group/{groupname}
(restapiV1ChatroomsRoomNameOwnersGroupGroupnamePost)
groupname (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
delete /restapi/v1/chatrooms/{roomName}/owners/{jid}
(restapiV1ChatroomsRoomNameOwnersJidDelete)
jid (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
post /restapi/v1/chatrooms/{roomName}/owners/{jid}
(restapiV1ChatroomsRoomNameOwnersJidPost)
jid (required)
Path Parameter —
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
get /restapi/v1/chatrooms/{roomName}/participants
(restapiV1ChatroomsRoomNameParticipantsGet)
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
Content-Type: application/json
{
"participants" : [ {
"role" : "aeiou",
"jid" : "aeiou",
"affiliation" : "aeiou"
} ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
put /restapi/v1/chatrooms/{roomName}
(restapiV1ChatroomsRoomNamePut)
roomName (required)
Path Parameter —
body MUCRoomEntity (required)
Body Parameter —
servicename (optional)
Query Parameter —
get /restapi/v1/groups
(restapiV1GroupsGet)
Content-Type: application/json
{
"groups" : [ {
"members" : [ "aeiou" ],
"name" : "aeiou",
"description" : "aeiou",
"admins" : [ "aeiou" ]
} ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
delete /restapi/v1/groups/{groupName}
(restapiV1GroupsGroupNameDelete)
groupName (required)
Path Parameter —
get /restapi/v1/groups/{groupName}
(restapiV1GroupsGroupNameGet)
groupName (required)
Path Parameter —
Content-Type: application/json
{
"members" : [ "aeiou" ],
"name" : "aeiou",
"description" : "aeiou",
"admins" : [ "aeiou" ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
OK GroupEntity
put /restapi/v1/groups/{groupName}
(restapiV1GroupsGroupNamePut)
groupName (required)
Path Parameter —
body GroupEntity (required)
Body Parameter —
post /restapi/v1/groups
(restapiV1GroupsPost)
body GroupEntity (required)
Body Parameter —
delete /restapi/v1/lockouts/{username}
(restapiV1LockoutsUsernameDelete)
username (required)
Path Parameter —
post /restapi/v1/lockouts/{username}
(restapiV1LockoutsUsernamePost)
username (required)
Path Parameter —
post /restapi/v1/messages/users
(restapiV1MessagesUsersPost)
body MessageEntity (required)
Body Parameter —
get /restapi/v1/sessions
(restapiV1SessionsGet)
Content-Type: application/json
{
"sessions" : [ {
"hostName" : "aeiou",
"sessionStatus" : "aeiou",
"lastActionDate" : "{}",
"sessionId" : "aeiou",
"creationDate" : "{}",
"priority" : 123,
"secure" : true,
"node" : "aeiou",
"ressource" : "aeiou",
"presenceMessage" : "aeiou",
"hostAddress" : "aeiou",
"presenceStatus" : "aeiou",
"username" : "aeiou"
} ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
delete /restapi/v1/sessions/{username}
(restapiV1SessionsUsernameDelete)
username (required)
Path Parameter —
get /restapi/v1/sessions/{username}
(restapiV1SessionsUsernameGet)
username (required)
Path Parameter —
Content-Type: application/json
{
"sessions" : [ {
"hostName" : "aeiou",
"sessionStatus" : "aeiou",
"lastActionDate" : "{}",
"sessionId" : "aeiou",
"creationDate" : "{}",
"priority" : 123,
"secure" : true,
"node" : "aeiou",
"ressource" : "aeiou",
"presenceMessage" : "aeiou",
"hostAddress" : "aeiou",
"presenceStatus" : "aeiou",
"username" : "aeiou"
} ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
post /restapi/v1/sipaccounts/close/{username}
(restapiV1SipaccountsCloseUsernamePost)
username (required)
Path Parameter —
get /restapi/v1/sipaccounts/extension/{extension}
(restapiV1SipaccountsExtensionExtensionGet)
extension (required)
Path Parameter —
Content-Type: application/json
{
"sipUsername" : "aeiou",
"server" : "aeiou",
"stunServer" : "aeiou",
"voiceMailNumber" : "aeiou",
"displayName" : "aeiou",
"useStun" : true,
"enabled" : true,
"stunPort" : "aeiou",
"cachedSize" : 123,
"password" : "aeiou",
"authUsername" : "aeiou",
"promptCredentials" : true,
"outboundproxy" : "aeiou",
"status" : "aeiou",
"username" : "aeiou"
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
OK SipAccount
get /restapi/v1/sipaccounts
(restapiV1SipaccountsGet)
count (optional)
Query Parameter —
start (optional)
Query Parameter —
Content-Type: application/json
{
"accounts" : [ {
"sipUsername" : "aeiou",
"server" : "aeiou",
"stunServer" : "aeiou",
"voiceMailNumber" : "aeiou",
"displayName" : "aeiou",
"useStun" : true,
"enabled" : true,
"stunPort" : "aeiou",
"cachedSize" : 123,
"password" : "aeiou",
"authUsername" : "aeiou",
"promptCredentials" : true,
"outboundproxy" : "aeiou",
"status" : "aeiou",
"username" : "aeiou"
} ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
OK SipAccounts
post /restapi/v1/sipaccounts/open/{username}
(restapiV1SipaccountsOpenUsernamePost)
username (required)
Path Parameter —
post /restapi/v1/sipaccounts
(restapiV1SipaccountsPost)
body SipAccount (required)
Body Parameter —
delete /restapi/v1/sipaccounts/{username}
(restapiV1SipaccountsUsernameDelete)
username (required)
Path Parameter —
get /restapi/v1/sipaccounts/username/{username}
(restapiV1SipaccountsUsernameUsernameGet)
username (required)
Path Parameter —
Content-Type: application/json
{
"sipUsername" : "aeiou",
"server" : "aeiou",
"stunServer" : "aeiou",
"voiceMailNumber" : "aeiou",
"displayName" : "aeiou",
"useStun" : true,
"enabled" : true,
"stunPort" : "aeiou",
"cachedSize" : 123,
"password" : "aeiou",
"authUsername" : "aeiou",
"promptCredentials" : true,
"outboundproxy" : "aeiou",
"status" : "aeiou",
"username" : "aeiou"
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
OK SipAccount
get /restapi/v1/system/properties
(restapiV1SystemPropertiesGet)
Content-Type: application/json
{
"properties" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
post /restapi/v1/system/properties
(restapiV1SystemPropertiesPost)
body SystemProperty (required)
Body Parameter —
delete /restapi/v1/system/properties/{propertyKey}
(restapiV1SystemPropertiesPropertyKeyDelete)
propertyKey (required)
Path Parameter —
get /restapi/v1/system/properties/{propertyKey}
(restapiV1SystemPropertiesPropertyKeyGet)
propertyKey (required)
Path Parameter —
Content-Type: application/json
{
"value" : "aeiou",
"key" : "aeiou"
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
put /restapi/v1/system/properties/{propertyKey}
(restapiV1SystemPropertiesPropertyKeyPut)
propertyKey (required)
Path Parameter —
body SystemProperty (required)
Body Parameter —
get /restapi/v1/system/statistics/sessions
(restapiV1SystemStatisticsSessionsGet)
Content-Type: application/json
{
"localSessions" : 123,
"clusterSessions" : 123
}
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
get /restapi/v1/users
(restapiV1UsersGet)
propertyKey (required)
Query Parameter —
propertyValue (required)
Query Parameter —
search (required)
Query Parameter —
Content-Type: application/json
{
"users" : [ {
"password" : "aeiou",
"name" : "aeiou",
"show" : "aeiou",
"email" : "aeiou",
"properties" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"status" : "aeiou",
"username" : "aeiou"
} ]
}
Content-Type: application/xml
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
OK UserEntities
post /restapi/v1/users
(restapiV1UsersPost)
body UserEntity (required)
Body Parameter —
delete /restapi/v1/users/{username}
(restapiV1UsersUsernameDelete)
username (required)
Path Parameter —
get /restapi/v1/users/{username}
(restapiV1UsersUsernameGet)
username (required)
Path Parameter —
Content-Type: application/json
{
"password" : "aeiou",
"name" : "aeiou",
"show" : "aeiou",
"email" : "aeiou",
"properties" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"status" : "aeiou",
"username" : "aeiou"
}
Content-Type: application/xml
string
string
string
string
string
string
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
OK UserEntity
delete /restapi/v1/users/{username}/groups
(restapiV1UsersUsernameGroupsDelete)
username (required)
Path Parameter —
body UserGroupsEntity (required)
Body Parameter —
get /restapi/v1/users/{username}/groups
(restapiV1UsersUsernameGroupsGet)
username (required)
Path Parameter —
Content-Type: application/json
{
"groupNames" : [ "aeiou" ]
}
Content-Type: application/xml
string
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
delete /restapi/v1/users/{username}/groups/{groupName}
(restapiV1UsersUsernameGroupsGroupNameDelete)
groupName (required)
Path Parameter —
username (required)
Path Parameter —
post /restapi/v1/users/{username}/groups/{groupName}
(restapiV1UsersUsernameGroupsGroupNamePost)
groupName (required)
Path Parameter —
username (required)
Path Parameter —
post /restapi/v1/users/{username}/groups
(restapiV1UsersUsernameGroupsPost)
username (required)
Path Parameter —
body UserGroupsEntity (required)
Body Parameter —
put /restapi/v1/users/{username}
(restapiV1UsersUsernamePut)
username (required)
Path Parameter —
body UserEntity (required)
Body Parameter —
get /restapi/v1/users/{username}/roster
(restapiV1UsersUsernameRosterGet)
username (required)
Path Parameter —
Content-Type: application/json
{
"roster" : [ {
"jid" : "aeiou",
"subscriptionType" : 123,
"nickname" : "aeiou",
"show" : "aeiou",
"groups" : [ "aeiou" ],
"status" : "aeiou"
} ]
}
Content-Type: application/xml
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
post /restapi/v1/users/{username}/roster
(restapiV1UsersUsernameRosterPost)
username (required)
Path Parameter —
body RosterItemEntity (required)
Body Parameter —
delete /restapi/v1/users/{username}/roster/{rosterJid}
(restapiV1UsersUsernameRosterRosterJidDelete)
rosterJid (required)
Path Parameter —
username (required)
Path Parameter —
put /restapi/v1/users/{username}/roster/{rosterJid}
(restapiV1UsersUsernameRosterRosterJidPut)
rosterJid (required)
Path Parameter —
username (required)
Path Parameter —
body RosterItemEntity (required)
Body Parameter —
get /restapi/v1/userservice
(restapiV1UserserviceGet)
post /restapi/v1/userservice
(restapiV1UserservicePost)
get /restapi/v1/chat/contacts
Retrieve roster contacts (restapiV1ChatContactsGet)
Content-Type: application/json
{
"roster" : [ {
"jid" : "aeiou",
"subscriptionType" : 123,
"nickname" : "aeiou",
"show" : "aeiou",
"groups" : [ "aeiou" ],
"status" : "aeiou"
} ]
}
Content-Type: application/xml
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
post /restapi/v1/chat/contacts
Add a new roster contact (restapiV1ChatContactsPost)
body RosterItemEntity (required)
Body Parameter —
delete /restapi/v1/chat/contacts/{rosterJid}
Remove contact from roster (restapiV1ChatContactsRosterJidDelete)
rosterJid (required)
Path Parameter —
put /restapi/v1/chat/contacts/{rosterJid}
Update existing roster contact (restapiV1ChatContactsRosterJidPut)
rosterJid (required)
Path Parameter —
body RosterItemEntity (required)
Body Parameter —
get /restapi/v1/chat/messages
Retrieve old archived mesages (restapiV1ChatMessagesGet)
This operation requires the monitoring plugin to work. It performs a database seaach using the supplied parameters or list of keywords
end (required)
Query Parameter —
keywords (required)
Query Parameter —
room (required)
Query Parameter —
service (required)
Query Parameter —
start (required)
Query Parameter —
to (required)
Query Parameter —
Content-Type: application/json
{
"conversations" : [ {
"participantList" : [ "aeiou" ],
"external" : true,
"participations" : [ {
"left" : "{}",
"joined" : "{}",
"nickname" : "aeiou"
} ],
"messageCount" : 123,
"conversationID" : 123,
"conversationParticipants" : [ "aeiou" ],
"messages" : [ {
"sentDate" : "{}",
"conversationID" : 123,
"stanza" : "aeiou",
"fromJID" : {
"node" : "aeiou",
"resource" : "aeiou",
"domain" : "aeiou"
},
"from" : "aeiou",
"to" : "aeiou",
"body" : "aeiou",
"roomEvent" : true,
"toJID" : ""
} ],
"lastActivity" : "{}",
"room" : "",
"startDate" : "{}",
"chatRoom" : "aeiou",
"participants" : [ "" ]
} ]
}
Content-Type: application/xml
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
post /restapi/v1/chat/messages/{to}
Post a chat or groupchat message (restapiV1ChatMessagesToPost)
to (required)
Path Parameter —
body string (required)
Body Parameter —
post /restapi/v1/chat/presence
Broadcast own presence to others (restapiV1ChatPresencePost)
show (required)
Query Parameter —
status (required)
Query Parameter —
get /restapi/v1/chat/rooms
Retrieve a list of groupchat/muc rooms (restapiV1ChatRoomsGet)
expandGroups (optional)
Query Parameter —
search (required)
Query Parameter —
servicename (optional)
Query Parameter —
type (optional)
Query Parameter —
Content-Type: application/json
{
"mucRooms" : [ {
"registrationEnabled" : true,
"maxUsers" : 123,
"moderated" : true,
"subject" : "aeiou",
"description" : "aeiou",
"owners" : [ "aeiou" ],
"password" : "aeiou",
"outcastGroups" : [ "aeiou" ],
"ownerGroups" : [ "aeiou" ],
"logEnabled" : true,
"members" : [ "aeiou" ],
"canAnyoneDiscoverJID" : true,
"canOccupantsChangeSubject" : true,
"canChangeNickname" : true,
"memberGroups" : [ "aeiou" ],
"persistent" : true,
"adminGroups" : [ "aeiou" ],
"publicRoom" : true,
"outcasts" : [ "aeiou" ],
"broadcastPresenceRoles" : [ "aeiou" ],
"creationDate" : "{}",
"membersOnly" : true,
"canOccupantsInvite" : true,
"roomName" : "aeiou",
"loginRestrictedToNickname" : true,
"modificationDate" : "{}",
"naturalName" : "aeiou",
"admins" : [ "aeiou" ]
} ]
}
Content-Type: application/xml
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
delete /restapi/v1/chat/rooms/{roomName}
Leave a groupchat/muc room (restapiV1ChatRoomsRoomNameDelete)
roomName (required)
Path Parameter —
service (optional)
Query Parameter —
get /restapi/v1/chat/rooms/{roomName}
Retrieve a specific groupchat/muc room (restapiV1ChatRoomsRoomNameGet)
roomName (required)
Path Parameter —
expandGroups (optional)
Query Parameter —
servicename (optional)
Query Parameter —
Content-Type: application/json
{
"registrationEnabled" : true,
"maxUsers" : 123,
"moderated" : true,
"subject" : "aeiou",
"description" : "aeiou",
"owners" : [ "aeiou" ],
"password" : "aeiou",
"outcastGroups" : [ "aeiou" ],
"ownerGroups" : [ "aeiou" ],
"logEnabled" : true,
"members" : [ "aeiou" ],
"canAnyoneDiscoverJID" : true,
"canOccupantsChangeSubject" : true,
"canChangeNickname" : true,
"memberGroups" : [ "aeiou" ],
"persistent" : true,
"adminGroups" : [ "aeiou" ],
"publicRoom" : true,
"outcasts" : [ "aeiou" ],
"broadcastPresenceRoles" : [ "aeiou" ],
"creationDate" : "{}",
"membersOnly" : true,
"canOccupantsInvite" : true,
"roomName" : "aeiou",
"loginRestrictedToNickname" : true,
"modificationDate" : "{}",
"naturalName" : "aeiou",
"admins" : [ "aeiou" ]
}
Content-Type: application/xml
string
string
string
true
true
true
true
not implemented io.swagger.models.properties.ObjectProperty@5e032f61
string
true
true
not implemented io.swagger.models.properties.BaseIntegerProperty@8cb7453e
string
string
true
true
not implemented io.swagger.models.properties.ObjectProperty@5e032f61
string
string
string
string
string
string
true
true
true
string
string
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
post /restapi/v1/chat/rooms/{roomName}/{invitedJid}
Invite someone else to a groupchat/muc room (restapiV1ChatRoomsRoomNameInvitedJidPost)
invitedJid (required)
Path Parameter —
roomName (required)
Path Parameter —
body string (required)
Body Parameter —
service (optional)
Query Parameter —
get /restapi/v1/chat/rooms/{roomName}/occupants
Retrieve a list of groupchat/muc room occupants (restapiV1ChatRoomsRoomNameOccupantsGet)
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
Content-Type: application/json
{
"occupants" : [ {
"role" : "aeiou",
"jid" : "aeiou",
"affiliation" : "aeiou"
} ]
}
Content-Type: application/xml
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
get /restapi/v1/chat/rooms/{roomName}/participants
Retrieve a list of groupchat/muc room participants (restapiV1ChatRoomsRoomNameParticipantsGet)
roomName (required)
Path Parameter —
servicename (optional)
Query Parameter —
Content-Type: application/json
{
"participants" : [ {
"role" : "aeiou",
"jid" : "aeiou",
"affiliation" : "aeiou"
} ]
}
Content-Type: application/xml
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
post /restapi/v1/chat/rooms/{roomName}
Post a message to a groupchat/muc room (restapiV1ChatRoomsRoomNamePost)
roomName (required)
Path Parameter —
body string (required)
Body Parameter —
service (optional)
Query Parameter —
put /restapi/v1/chat/rooms/{roomName}
Join a groupchat/muc room (restapiV1ChatRoomsRoomNamePut)
roomName (required)
Path Parameter —
service (optional)
Query Parameter —
get /restapi/v1/chat/users
Search the user directory (restapiV1ChatUsersGet)
search (required)
Query Parameter —
Content-Type: application/json
{
"users" : [ {
"password" : "aeiou",
"name" : "aeiou",
"show" : "aeiou",
"email" : "aeiou",
"properties" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ],
"status" : "aeiou",
"username" : "aeiou"
} ]
}
Content-Type: application/xml
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
application/jsonapplication/xml
OK UserEntities
delete /restapi/v1/chat/users/{propertyName}
Remove own user profile property (restapiV1ChatUsersPropertyNameDelete)
propertyName (required)
Path Parameter —
post /restapi/v1/chat/users/{propertyName}
Add or update own user profile property (restapiV1ChatUsersPropertyNamePost)
propertyName (required)
Path Parameter —
body string (required)
Body Parameter —
post /restapi/v1/chat/xmpp
send a raw XMPP message to any destination (restapiV1ChatXmppPost)
body string (required)
Body Parameter —
[ Jump to Methods ]
ArchivedMessageBookmarkBookmarksConversationConversationParticipationConversationsGroupEntitiesGroupEntityJIDMUCRoomEntitiesMUCRoomEntityMessageEntityMsgArchiveEntityOccupantEntitiesOccupantEntityParticipantEntitiesParticipantEntityRosterEntitiesRosterItemEntitySessionEntitiesSessionEntitySessionsCountSipAccountSipAccountsSystemPropertiesSystemPropertyUserEntitiesUserEntityUserGroupsEntityUserProperty
body (optional)
conversationID (optional)
from (optional)
fromJID (optional)
roomEvent (optional)
sentDate (optional)
stanza (optional)
to (optional)
toJID (optional)
bookmarkID (optional)
globalBookmark (optional)
groups (optional)
name (optional)
properties (optional)
property (optional)
propertyNames (optional)
type (optional)
Enum:
group_chat
url
users (optional)
value (optional)
bookmarks (optional)
chatRoom (optional)
conversationID (optional)
conversationParticipants (optional)
external (optional)
lastActivity (optional)
messageCount (optional)
messages (optional)
participantList (optional)
participants (optional)
participations (optional)
array[ConversationParticipation]
room (optional)
startDate (optional)
joined (optional)
left (optional)
nickname (optional)
conversations (optional)
groups (optional)
admins (optional)
description (optional)
members (optional)
name (optional)
domain (optional)
node (optional)
resource (optional)
mucRooms (optional)
adminGroups (optional)
admins (optional)
broadcastPresenceRoles (optional)
canAnyoneDiscoverJID (optional)
canChangeNickname (optional)
canOccupantsChangeSubject (optional)
canOccupantsInvite (optional)
creationDate (optional)
description (optional)
logEnabled (optional)
loginRestrictedToNickname (optional)
maxUsers (optional)
memberGroups (optional)
members (optional)
membersOnly (optional)
moderated (optional)
modificationDate (optional)
naturalName (optional)
outcastGroups (optional)
outcasts (optional)
ownerGroups (optional)
owners (optional)
password (optional)
persistent (optional)
publicRoom (optional)
registrationEnabled (optional)
roomName (optional)
subject (optional)
body (optional)
count (optional)
jid (optional)
occupants (optional)
affiliation (optional)
jid (optional)
role (optional)
participants (optional)
affiliation (optional)
jid (optional)
role (optional)
roster (optional)
groups (optional)
jid (optional)
nickname (optional)
show (optional)
status (optional)
subscriptionType (optional)
sessions (optional)
creationDate (optional)
hostAddress (optional)
hostName (optional)
lastActionDate (optional)
node (optional)
presenceMessage (optional)
presenceStatus (optional)
priority (optional)
ressource (optional)
secure (optional)
sessionId (optional)
sessionStatus (optional)
username (optional)
clusterSessions (optional)
localSessions (optional)
authUsername (optional)
cachedSize (optional)
displayName (optional)
enabled (optional)
outboundproxy (optional)
password (optional)
promptCredentials (optional)
server (optional)
sipUsername (optional)
status (optional)
Enum:
Registered
Registering
RegistrationFailed
Unregistered
Unregistering
stunPort (optional)
stunServer (optional)
useStun (optional)
username (optional)
voiceMailNumber (optional)
accounts (optional)
properties (optional)
key (optional)
value (optional)
users (optional)
email (optional)
name (optional)
password (optional)
properties (optional)
show (optional)
status (optional)
username (optional)
groupNames (optional)
key (optional)
value (optional)