Use Collaboration APIs

The Collaboration APIs enable developers to integrate and manage real-time communication features within Oracle Fusion Field Service Collaboration. These APIs support key operations such as starting new chats, sending and retrieving messages, managing participants, and accessing address book information. Together, they provide a comprehensive interface for building and maintaining chat-based collaboration between users, helpdesk teams, and field resources. You can perform the following core actions in Collaboration using APIs:

• Get Address Book: Retrieves a paginated list of contacts from the address book in Collaboration. The response is returned in JSON format and includes contact details, pagination links, limit, offset, and total results. Query parameters can be used to control the number of items retrieved and the starting index for the response.

  HTTP Method: GET

  Endpoint: /rest/ofscCollaboration/v1/addressBook

  For more information, see Address Book REST Endpoints and Get address book.

• Get Messages: Retrieves all messages for a specified chat ID in Collaboration. It returns message details in JSON format, including direction, limit, offset, pagination links, and total results. The API supports sorting messages in ascending or descending order.

  HTTP Method: GET

  Endpoint: /rest/ofscCollaboration/v1/chats/{chatId}/messages

  For more information, see Chats REST Endpoints and Get messages.

• Get Participants: Retrieves a list of participants for a specified chat in Collaboration. The response, returned in JSON format, includes participant details such as name, login, presence, and invitation information. The API supports pagination through limit and offset parameters, with a maximum of 100 participants returned per request.

  HTTP Method: GET

  Endpoint: /rest/ofscCollaboration/v1/chats/{chatId}/participants

  For more information, see Chats REST Endpoints and Get participants .

• Invite a Participant: Adds a user to an existing chat in Collaboration. This operation allows users to extend a one-on-one chat into a group or conference chat by inviting additional participants. The request requires the chat ID and the login of the participant to be invited, and a successful operation returns an HTTP 204 response indicating completion without content.

  HTTP Method: POST

  Endpoint: /rest/ofscCollaboration/v1/chats/{chatId}/participants/invite

  For more information, see Chats REST Endpoints and Invite a participant .

• Leave a Chat: Allows a user to exit an existing chat in Collaboration. The request requires the chat ID and an empty JSON object as the body. A successful operation returns an HTTP 204 response, indicating that the user has left the chat successfully.

  HTTP Method: POST

  Endpoint: rest/ofscCollaboration/v1/chats/{chatId}/leave

  For more information, see Chats REST Endpoints and Leave a chat.

• Send a Message: Sends a text message or attachment to an existing chat in Collaboration. The request requires the chat ID and message content in JSON format. A successful operation returns an HTTP 201 response with message details, including the author, message ID, sequence number, and timestamp.

  HTTP Method: POST

  Endpoint: /rest/ofscCollaboration/v1/chats/{chatId}/messages

  For more information, see Chats REST Endpoints and Send a message.

• Start a New Chat: Creates a new chat in Collaboration. This operation allows users to start a one-on-one chat, initiate a helpdesk chat, or create a conference chat with multiple participants. The request includes the message content, recipients, and optional attachments. A successful operation returns an HTTP 201 response with the details of the newly created chat, including the chat ID, type, participants, and start time.

  HTTP Method: POST

  Endpoint: /rest/ofscCollaboration/v1/chats

  For more information, see Chats REST Endpoints and Start a new chat.