[ Jump to Models ]

• get /restapi/v1/chat/contacts
• post /restapi/v1/chat/contacts
• delete /restapi/v1/chat/contacts/{rosterJid}
• put /restapi/v1/chat/contacts/{rosterJid}
• get /restapi/v1/chat/messages
• post /restapi/v1/chat/messages/{to}
• post /restapi/v1/chat/presence
• get /restapi/v1/chat/rooms
• delete /restapi/v1/chat/rooms/{roomName}
• get /restapi/v1/chat/rooms/{roomName}
• post /restapi/v1/chat/rooms/{roomName}/{invitedJid}
• get /restapi/v1/chat/rooms/{roomName}/occupants
• get /restapi/v1/chat/rooms/{roomName}/participants
• post /restapi/v1/chat/rooms/{roomName}
• put /restapi/v1/chat/rooms/{roomName}
• get /restapi/v1/chat/users
• delete /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}/property
• get /restapi/v1/bookmarks/{bookmarkID}/property
• put /restapi/v1/bookmarks/{bookmarkID}/property
• put /restapi/v1/bookmarks/{bookmarkID}
• get /restapi/v1/bookmarks/
• post /restapi/v1/bookmarks
• get /restapi/v1/bookmarks/user/{userID}
• get /restapi/v1/bookmarks/userid
• get /restapi/v1/chatrooms
• post /restapi/v1/chatrooms
• delete /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}/occupants
• delete /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}/participants
• put /restapi/v1/chatrooms/{roomName}
• get /restapi/v1/groups
• delete /restapi/v1/groups/{groupName}
• get /restapi/v1/groups/{groupName}
• put /restapi/v1/groups/{groupName}
• post /restapi/v1/groups
• delete /restapi/v1/lockouts/{username}
• post /restapi/v1/lockouts/{username}
• post /restapi/v1/messages/users
• get /restapi/v1/sessions
• delete /restapi/v1/sessions/{username}
• get /restapi/v1/sessions/{username}
• post /restapi/v1/sipaccounts/close/{username}
• get /restapi/v1/sipaccounts/extension/{extension}
• get /restapi/v1/sipaccounts
• post /restapi/v1/sipaccounts/open/{username}
• post /restapi/v1/sipaccounts
• delete /restapi/v1/sipaccounts/{username}
• get /restapi/v1/sipaccounts/username/{username}
• get /restapi/v1/system/properties
• post /restapi/v1/system/properties
• delete /restapi/v1/system/properties/{propertyKey}
• get /restapi/v1/system/properties/{propertyKey}
• put /restapi/v1/system/properties/{propertyKey}
• get /restapi/v1/system/statistics/sessions
• get /restapi/v1/users
• post /restapi/v1/users
• delete /restapi/v1/users/{username}
• get /restapi/v1/users/{username}
• delete /restapi/v1/users/{username}/groups
• get /restapi/v1/users/{username}/groups
• delete /restapi/v1/users/{username}/groups/{groupName}
• post /restapi/v1/users/{username}/groups/{groupName}
• post /restapi/v1/users/{username}/groups
• put /restapi/v1/users/{username}
• get /restapi/v1/users/{username}/roster
• post /restapi/v1/users/{username}/roster
• delete /restapi/v1/users/{username}/roster/{rosterJid}
• put /restapi/v1/users/{username}/roster/{rosterJid}
• get /restapi/v1/userservice
• post /restapi/v1/userservice

get /restapi/v1/archive/messages/unread/{jid}

Retrieve all unread chat messages delivered offline (restapiV1ArchiveMessagesUnreadJidGet)

jid (required)

Path Parameter —

MsgArchiveEntity

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/json
• application/xml

OK MsgArchiveEntity

delete /restapi/v1/bookmarks/{bookmarkID}

(restapiV1BookmarksBookmarkIDDelete)

bookmarkID (required)

Path Parameter —

OK

get /restapi/v1/bookmarks/{bookmarkID}

(restapiV1BookmarksBookmarkIDGet)

bookmarkID (required)

Path Parameter —

Bookmark

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/json
• application/xml

OK Bookmark

delete /restapi/v1/bookmarks/{bookmarkID}/property

(restapiV1BookmarksBookmarkIDPropertyDelete)

bookmarkID (required)

Path Parameter —

name (required)

Query Parameter —

Bookmark

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 —

Bookmark

Content-Type:

OK Bookmark

put /restapi/v1/bookmarks/{bookmarkID}

(restapiV1BookmarksBookmarkIDPut)

bookmarkID (required)

Path Parameter —

body Bookmark (required)

Body Parameter —

Bookmark

Content-Type:

OK Bookmark

get /restapi/v1/bookmarks/

(restapiV1BookmarksGet)

Bookmarks

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/json
• application/xml

OK Bookmarks

post /restapi/v1/bookmarks

(restapiV1BookmarksPost)

body Bookmark (required)

Body Parameter —

Bookmark

Content-Type:

OK Bookmark

get /restapi/v1/bookmarks/user/{userID}

(restapiV1BookmarksUserUserIDGet)

userID (required)

Path Parameter —

Bookmarks

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 —

MUCRoomEntities

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/json
• application/xml

OK MUCRoomEntities

post /restapi/v1/chatrooms

(restapiV1ChatroomsPost)

body MUCRoomEntity (required)

Body Parameter —

servicename (optional)

Query Parameter —

Created

delete /restapi/v1/chatrooms/{roomName}/admins/group/{groupname}

(restapiV1ChatroomsRoomNameAdminsGroupGroupnameDelete)

groupname (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OK

post /restapi/v1/chatrooms/{roomName}/admins/group/{groupname}

(restapiV1ChatroomsRoomNameAdminsGroupGroupnamePost)

groupname (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

Created

delete /restapi/v1/chatrooms/{roomName}/admins/{jid}

(restapiV1ChatroomsRoomNameAdminsJidDelete)

jid (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OK

post /restapi/v1/chatrooms/{roomName}/admins/{jid}

(restapiV1ChatroomsRoomNameAdminsJidPost)

jid (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

Created

delete /restapi/v1/chatrooms/{roomName}

(restapiV1ChatroomsRoomNameDelete)

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OK

get /restapi/v1/chatrooms/{roomName}

(restapiV1ChatroomsRoomNameGet)

roomName (required)

Path Parameter —

expandGroups (optional)

Query Parameter —

servicename (optional)

Query Parameter —

MUCRoomEntity

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/json
• application/xml

OK MUCRoomEntity

delete /restapi/v1/chatrooms/{roomName}/members/group/{groupname}

(restapiV1ChatroomsRoomNameMembersGroupGroupnameDelete)

groupname (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OK

post /restapi/v1/chatrooms/{roomName}/members/group/{groupname}

(restapiV1ChatroomsRoomNameMembersGroupGroupnamePost)

groupname (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

Created

delete /restapi/v1/chatrooms/{roomName}/members/{jid}

(restapiV1ChatroomsRoomNameMembersJidDelete)

jid (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OK

post /restapi/v1/chatrooms/{roomName}/members/{jid}

(restapiV1ChatroomsRoomNameMembersJidPost)

jid (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

Created

get /restapi/v1/chatrooms/{roomName}/occupants

(restapiV1ChatroomsRoomNameOccupantsGet)

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OccupantEntities

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/json
• application/xml

OK OccupantEntities

delete /restapi/v1/chatrooms/{roomName}/outcasts/group/{groupname}

(restapiV1ChatroomsRoomNameOutcastsGroupGroupnameDelete)

groupname (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OK

post /restapi/v1/chatrooms/{roomName}/outcasts/group/{groupname}

(restapiV1ChatroomsRoomNameOutcastsGroupGroupnamePost)

groupname (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

Created

delete /restapi/v1/chatrooms/{roomName}/outcasts/{jid}

(restapiV1ChatroomsRoomNameOutcastsJidDelete)

jid (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OK

post /restapi/v1/chatrooms/{roomName}/outcasts/{jid}

(restapiV1ChatroomsRoomNameOutcastsJidPost)

jid (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

Created

delete /restapi/v1/chatrooms/{roomName}/owners/group/{groupname}

(restapiV1ChatroomsRoomNameOwnersGroupGroupnameDelete)

groupname (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OK

post /restapi/v1/chatrooms/{roomName}/owners/group/{groupname}

(restapiV1ChatroomsRoomNameOwnersGroupGroupnamePost)

groupname (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

Created

delete /restapi/v1/chatrooms/{roomName}/owners/{jid}

(restapiV1ChatroomsRoomNameOwnersJidDelete)

jid (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OK

post /restapi/v1/chatrooms/{roomName}/owners/{jid}

(restapiV1ChatroomsRoomNameOwnersJidPost)

jid (required)

Path Parameter —

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

Created

get /restapi/v1/chatrooms/{roomName}/participants

(restapiV1ChatroomsRoomNameParticipantsGet)

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

ParticipantEntities

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/json
• application/xml

OK ParticipantEntities

put /restapi/v1/chatrooms/{roomName}

(restapiV1ChatroomsRoomNamePut)

roomName (required)

Path Parameter —

body MUCRoomEntity (required)

Body Parameter —

servicename (optional)

Query Parameter —

OK

get /restapi/v1/groups

(restapiV1GroupsGet)

GroupEntities

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/json
• application/xml

OK GroupEntities

delete /restapi/v1/groups/{groupName}

(restapiV1GroupsGroupNameDelete)

groupName (required)

Path Parameter —

OK

get /restapi/v1/groups/{groupName}

(restapiV1GroupsGroupNameGet)

groupName (required)

Path Parameter —

GroupEntity

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/json
• application/xml

OK GroupEntity

put /restapi/v1/groups/{groupName}

(restapiV1GroupsGroupNamePut)

groupName (required)

Path Parameter —

body GroupEntity (required)

Body Parameter —

OK

post /restapi/v1/groups

(restapiV1GroupsPost)

body GroupEntity (required)

Body Parameter —

Created

delete /restapi/v1/lockouts/{username}

(restapiV1LockoutsUsernameDelete)

username (required)

Path Parameter —

OK

post /restapi/v1/lockouts/{username}

(restapiV1LockoutsUsernamePost)

username (required)

Path Parameter —

Created

post /restapi/v1/messages/users

(restapiV1MessagesUsersPost)

body MessageEntity (required)

Body Parameter —

Created

get /restapi/v1/sessions

(restapiV1SessionsGet)

SessionEntities

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/json
• application/xml

OK SessionEntities

delete /restapi/v1/sessions/{username}

(restapiV1SessionsUsernameDelete)

username (required)

Path Parameter —

OK

get /restapi/v1/sessions/{username}

(restapiV1SessionsUsernameGet)

username (required)

Path Parameter —

SessionEntities

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/json
• application/xml

OK SessionEntities

post /restapi/v1/sipaccounts/close/{username}

(restapiV1SipaccountsCloseUsernamePost)

username (required)

Path Parameter —

OK

Bad Request

get /restapi/v1/sipaccounts/extension/{extension}

(restapiV1SipaccountsExtensionExtensionGet)

extension (required)

Path Parameter —

SipAccount

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/json
• application/xml

OK SipAccount

get /restapi/v1/sipaccounts

(restapiV1SipaccountsGet)

count (optional)

Query Parameter —

start (optional)

Query Parameter —

SipAccounts

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/json
• application/xml

OK SipAccounts

post /restapi/v1/sipaccounts/open/{username}

(restapiV1SipaccountsOpenUsernamePost)

username (required)

Path Parameter —

OK

Bad Request

post /restapi/v1/sipaccounts

(restapiV1SipaccountsPost)

body SipAccount (required)

Body Parameter —

OK

Created

delete /restapi/v1/sipaccounts/{username}

(restapiV1SipaccountsUsernameDelete)

username (required)

Path Parameter —

OK

Bad Request

get /restapi/v1/sipaccounts/username/{username}

(restapiV1SipaccountsUsernameUsernameGet)

username (required)

Path Parameter —

SipAccount

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/json
• application/xml

OK SipAccount

get /restapi/v1/system/properties

(restapiV1SystemPropertiesGet)

SystemProperties

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/json
• application/xml

OK SystemProperties

post /restapi/v1/system/properties

(restapiV1SystemPropertiesPost)

body SystemProperty (required)

Body Parameter —

Created

delete /restapi/v1/system/properties/{propertyKey}

(restapiV1SystemPropertiesPropertyKeyDelete)

propertyKey (required)

Path Parameter —

OK

get /restapi/v1/system/properties/{propertyKey}

(restapiV1SystemPropertiesPropertyKeyGet)

propertyKey (required)

Path Parameter —

SystemProperty

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/json
• application/xml

OK SystemProperty

put /restapi/v1/system/properties/{propertyKey}

(restapiV1SystemPropertiesPropertyKeyPut)

propertyKey (required)

Path Parameter —

body SystemProperty (required)

Body Parameter —

OK

get /restapi/v1/system/statistics/sessions

(restapiV1SystemStatisticsSessionsGet)

SessionsCount

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/json
• application/xml

OK SessionsCount

get /restapi/v1/users

(restapiV1UsersGet)

propertyKey (required)

Query Parameter —

propertyValue (required)

Query Parameter —

search (required)

Query Parameter —

UserEntities

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/json
• application/xml

OK UserEntities

post /restapi/v1/users

(restapiV1UsersPost)

body UserEntity (required)

Body Parameter —

Created

delete /restapi/v1/users/{username}

(restapiV1UsersUsernameDelete)

username (required)

Path Parameter —

OK

get /restapi/v1/users/{username}

(restapiV1UsersUsernameGet)

username (required)

Path Parameter —

UserEntity

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/json
• application/xml

OK UserEntity

delete /restapi/v1/users/{username}/groups

(restapiV1UsersUsernameGroupsDelete)

username (required)

Path Parameter —

body UserGroupsEntity (required)

Body Parameter —

OK

get /restapi/v1/users/{username}/groups

(restapiV1UsersUsernameGroupsGet)

username (required)

Path Parameter —

UserGroupsEntity

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/json
• application/xml

OK UserGroupsEntity

delete /restapi/v1/users/{username}/groups/{groupName}

(restapiV1UsersUsernameGroupsGroupNameDelete)

groupName (required)

Path Parameter —

username (required)

Path Parameter —

OK

post /restapi/v1/users/{username}/groups/{groupName}

(restapiV1UsersUsernameGroupsGroupNamePost)

groupName (required)

Path Parameter —

username (required)

Path Parameter —

Created

post /restapi/v1/users/{username}/groups

(restapiV1UsersUsernameGroupsPost)

username (required)

Path Parameter —

body UserGroupsEntity (required)

Body Parameter —

Created

put /restapi/v1/users/{username}

(restapiV1UsersUsernamePut)

username (required)

Path Parameter —

body UserEntity (required)

Body Parameter —

OK

get /restapi/v1/users/{username}/roster

(restapiV1UsersUsernameRosterGet)

username (required)

Path Parameter —

RosterEntities

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/json
• application/xml

OK RosterEntities

post /restapi/v1/users/{username}/roster

(restapiV1UsersUsernameRosterPost)

username (required)

Path Parameter —

body RosterItemEntity (required)

Body Parameter —

Created

delete /restapi/v1/users/{username}/roster/{rosterJid}

(restapiV1UsersUsernameRosterRosterJidDelete)

rosterJid (required)

Path Parameter —

username (required)

Path Parameter —

OK

put /restapi/v1/users/{username}/roster/{rosterJid}

(restapiV1UsersUsernameRosterRosterJidPut)

rosterJid (required)

Path Parameter —

username (required)

Path Parameter —

body RosterItemEntity (required)

Body Parameter —

OK

get /restapi/v1/userservice

(restapiV1UserserviceGet)

OK

post /restapi/v1/userservice

(restapiV1UserservicePost)

No Content

get /restapi/v1/chat/contacts

Retrieve roster contacts (restapiV1ChatContactsGet)

RosterEntities

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/json
• application/xml

OK RosterEntities

post /restapi/v1/chat/contacts

Add a new roster contact (restapiV1ChatContactsPost)

body RosterItemEntity (required)

Body Parameter —

Created

delete /restapi/v1/chat/contacts/{rosterJid}

Remove contact from roster (restapiV1ChatContactsRosterJidDelete)

rosterJid (required)

Path Parameter —

Created

put /restapi/v1/chat/contacts/{rosterJid}

Update existing roster contact (restapiV1ChatContactsRosterJidPut)

rosterJid (required)

Path Parameter —

body RosterItemEntity (required)

Body Parameter —

Created

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 —

Conversations

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/json
• application/xml

OK Conversations

post /restapi/v1/chat/messages/{to}

Post a chat or groupchat message (restapiV1ChatMessagesToPost)

to (required)

Path Parameter —

body string (required)

Body Parameter —

OK

post /restapi/v1/chat/presence

Broadcast own presence to others (restapiV1ChatPresencePost)

show (required)

Query Parameter —

status (required)

Query Parameter —

OK

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 —

MUCRoomEntities

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/json
• application/xml

OK MUCRoomEntities

delete /restapi/v1/chat/rooms/{roomName}

Leave a groupchat/muc room (restapiV1ChatRoomsRoomNameDelete)

roomName (required)

Path Parameter —

service (optional)

Query Parameter —

OK

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 —

MUCRoomEntity

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/json
• application/xml

OK MUCRoomEntity

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 —

OK

get /restapi/v1/chat/rooms/{roomName}/occupants

Retrieve a list of groupchat/muc room occupants (restapiV1ChatRoomsRoomNameOccupantsGet)

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

OccupantEntities

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/json
• application/xml

OK OccupantEntities

get /restapi/v1/chat/rooms/{roomName}/participants

Retrieve a list of groupchat/muc room participants (restapiV1ChatRoomsRoomNameParticipantsGet)

roomName (required)

Path Parameter —

servicename (optional)

Query Parameter —

ParticipantEntities

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/json
• application/xml

OK ParticipantEntities

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 —

OK

put /restapi/v1/chat/rooms/{roomName}

Join a groupchat/muc room (restapiV1ChatRoomsRoomNamePut)

roomName (required)

Path Parameter —

service (optional)

Query Parameter —

OK

get /restapi/v1/chat/users

Search the user directory (restapiV1ChatUsersGet)

search (required)

Query Parameter —

UserEntities

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/json
• application/xml

OK UserEntities

delete /restapi/v1/chat/users/{propertyName}

Remove own user profile property (restapiV1ChatUsersPropertyNameDelete)

propertyName (required)

Path Parameter —

OK

post /restapi/v1/chat/users/{propertyName}

Add or update own user profile property (restapiV1ChatUsersPropertyNamePost)

propertyName (required)

Path Parameter —

body string (required)

Body Parameter —

OK

post /restapi/v1/chat/xmpp

send a raw XMPP message to any destination (restapiV1ChatXmppPost)

body string (required)

Body Parameter —

OK

[ Jump to Methods ]

1. ArchivedMessage
2. Bookmark
3. Bookmarks
4. Conversation
5. ConversationParticipation
6. Conversations
7. GroupEntities
8. GroupEntity
9. JID
10. MUCRoomEntities
11. MUCRoomEntity
12. MessageEntity
13. MsgArchiveEntity
14. OccupantEntities
15. OccupantEntity
16. ParticipantEntities
17. ParticipantEntity
18. RosterEntities
19. RosterItemEntity
20. SessionEntities
21. SessionEntity
22. SessionsCount
23. SipAccount
24. SipAccounts
25. SystemProperties
26. SystemProperty
27. UserEntities
28. UserEntity
29. UserGroupsEntity
30. UserProperty

body (optional)

String

conversationID (optional)

Integer

from (optional)

String

fromJID (optional)

JID

roomEvent (optional)

Boolean

sentDate (optional)

Object

stanza (optional)

String

to (optional)

String

toJID (optional)

JID

bookmarkID (optional)

Integer

globalBookmark (optional)

Boolean

groups (optional)

array[String]

name (optional)

String

properties (optional)

array[String]

property (optional)

String

propertyNames (optional)

Object

type (optional)

String

Enum:

group_chat

url

users (optional)

array[String]

value (optional)

String

bookmarks (optional)

array[Bookmark]

chatRoom (optional)

String

conversationID (optional)

Integer

conversationParticipants (optional)

array[String]

external (optional)

Boolean

lastActivity (optional)

Object

messageCount (optional)

Integer

messages (optional)

array[ArchivedMessage]

participantList (optional)

array[String]

participants (optional)

array[JID]

participations (optional)

array[ConversationParticipation]

room (optional)

JID

startDate (optional)

Object

joined (optional)

Object

left (optional)

Object

nickname (optional)

String

conversations (optional)

array[Conversation]

groups (optional)

array[GroupEntity]

admins (optional)

array[String]

description (optional)

String

members (optional)

array[String]

name (optional)

String

domain (optional)

String

node (optional)

String

resource (optional)

String

mucRooms (optional)

array[MUCRoomEntity]

adminGroups (optional)

array[String]

admins (optional)

array[String]

broadcastPresenceRoles (optional)

array[String]

canAnyoneDiscoverJID (optional)

Boolean

canChangeNickname (optional)

Boolean

canOccupantsChangeSubject (optional)

Boolean

canOccupantsInvite (optional)

Boolean

creationDate (optional)

Object

description (optional)

String

logEnabled (optional)

Boolean

loginRestrictedToNickname (optional)

Boolean

maxUsers (optional)

Integer

memberGroups (optional)

array[String]

members (optional)

array[String]

membersOnly (optional)

Boolean

moderated (optional)

Boolean

modificationDate (optional)

Object

naturalName (optional)

String

outcastGroups (optional)

array[String]

outcasts (optional)

array[String]

ownerGroups (optional)

array[String]

owners (optional)

array[String]

password (optional)

String

persistent (optional)

Boolean

publicRoom (optional)

Boolean

registrationEnabled (optional)

Boolean

roomName (optional)

String

subject (optional)

String

body (optional)

String

count (optional)

Integer

jid (optional)

String

occupants (optional)

array[OccupantEntity]

affiliation (optional)

String

jid (optional)

String

role (optional)

String

participants (optional)

array[ParticipantEntity]

affiliation (optional)

String

jid (optional)

String

role (optional)

String

roster (optional)

array[RosterItemEntity]

groups (optional)

array[String]

jid (optional)

String

nickname (optional)

String

show (optional)

String

status (optional)

String

subscriptionType (optional)

Integer

sessions (optional)

array[SessionEntity]

creationDate (optional)

Object

hostAddress (optional)

String

hostName (optional)

String

lastActionDate (optional)

Object

node (optional)

String

presenceMessage (optional)

String

presenceStatus (optional)

String

priority (optional)

Integer

ressource (optional)

String

secure (optional)

Boolean

sessionId (optional)

String

sessionStatus (optional)

String

username (optional)

String

clusterSessions (optional)

Integer

localSessions (optional)

Integer

authUsername (optional)

String

cachedSize (optional)

Integer

displayName (optional)

String

enabled (optional)

Boolean

outboundproxy (optional)

String

password (optional)

String

promptCredentials (optional)

Boolean

server (optional)

String

sipUsername (optional)

String

status (optional)

String

Enum:

Registered

Registering

RegistrationFailed

Unregistered

Unregistering

stunPort (optional)

String

stunServer (optional)

String

useStun (optional)

Boolean

username (optional)

String

voiceMailNumber (optional)

String

accounts (optional)

array[SipAccount]

properties (optional)

array[SystemProperty]

key (optional)

String

value (optional)

String

users (optional)

array[UserEntity]

email (optional)

String

name (optional)

String

password (optional)

String

properties (optional)

array[UserProperty]

show (optional)

String

status (optional)

String

username (optional)

String

groupNames (optional)

array[String]

key (optional)

String

value (optional)

String