External Presence Interest

To get the presence state of external users, you must first register interest in those users using this endpoint.

Register interest in a user's presence status

post

Header parameters

sessionTokenstringRequired

Session authentication token.

Bodyinteger · int64[]

application/json

integer · int64[]OptionalExample: [7215545058313,7215545078461]

Responses

200

OK

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

404

Not Found: user id cannot be located.

application/json

500

Server error, see response body for further details.

application/json

post

/v1/user/presence/register

HTTPcURLJavaScriptPython

POST /pod/v1/user/presence/register HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 29

[
  7215545058313,
  7215545078461
]

{
  "format": "TEXT",
  "message": "Success"
}

Request Example

curl -X POST \
  https://acme.symphony.com/pod/v1/user/presence/register \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -H 'sessiontoken: SESSION_TOKEN' \
  -d '[7215545078541, 7215545078461]'

When calling this as an OBO-enabled endpoint, use the OBO User Authenticate token for sessionToken.

Querying Presence of External Users

📘 External Users Presence Visibility

Any user can see the presence of other users of the same company. For users of a different company, the two users must be connected to see presence.

To query the presence of external users:

1. Call this endpoint to register interest in the desired users.

2. Call the Get User Presence endpoint to query the presence of each user. To keep the registration active, call this endpoint every hour.

To query the presence of internal users, you do not need to register interest.

❗️ Rate Limit

Getting an external user’s presence is limited to one call every 5 minutes.

🚧 Roles and Privileges

Calling this endpoint requires the ADMIN_PRESENCE_UPDATE privilege. See Bot Permissions for a list of roles and associated privileges.