Instant Messaging & Presence

Display system’s instant messaging & presence

GET /api/v1/system/services/instant_messaging_presence/

Retrieve the settings of the Instant Messaging & Presence service of the system.

Example request:

GET /api/v1/system/services/instant_messaging_presence/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
     "serviceDomain": "fooSystem",
     "servicePort": 5222,
     "addTenantInIMPUserId": false,
     "boshURL": "http://foo.com"
}
Response JSON Object:

  • serviceDomain (string) – the domain of service.

  • servicePort (integer) – the port of the domain of service.

  • addTenantInIMPUserId (boolean) – When true the tenant name will be included in the IM username for Integrated IM&P service.

  • boshURL (string) – The URL the client applications should use to communicate using BOSH with the XMPP server.

Status Codes:

Update system’s instant messaging & presence

PUT /api/v1/system/services/instant_messaging_presence/

Update the settings of the Instant Messaging & Presence service of the system.

Example request:

PUT /api/v1/system/services/instant_messaging_presence/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
     "serviceDomain": "fooSystem",
     "servicePort": 5222,
     "addTenantInIMPUserId": false,
     "boshURL": "http://foo.com"
}
Request JSON Object:

  • serviceDomain (string) – the domain of service.

  • servicePort (integer) – the port of the domain of service.

  • addTenantInIMPUserId (boolean) – When true the tenant name will be included in the IM username for Integrated IM&P service.

  • boshURL (string) – The URL the client applications should use to communicate using BOSH with the XMPP server.

Example response:

HTTP/1.1 200 OK
Status Codes: