Rocket Matter Communicator API
The Communicator API from Rocket Matter — 18 operation(s) for communicator.
The Communicator API from Rocket Matter — 18 operation(s) for communicator.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/rocket-matter:rocket-matter-communicator-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
description: Welcome to the Rocket Matter API.
version: '2.0'
title: Rocket Matter Communicator API
termsOfService: www.rocketmatter.com
contact:
email: developer@rocketmatter.com
license:
name: Rocket Matter
url: www.rocketmatter.com
x-logo:
url: https://support.rocketmatter.com/wp-content/themes/rm-support/img/rm-logo.png
servers:
- url: https://<DOMAIN>/<INSTALL>/API_V2
tags:
- name: Communicator
paths:
/Communicator.svc/json/DeleteChannel:
post:
tags:
- Communicator
description: Delete a previously created communicator channel. The account used to delete must have admin rights to delete the channel.
operationId: DeleteChannel
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteChannelRequest'
required: true
summary: Delete channel
x-summary-source: derived
/Communicator.svc/json/SetEmailAlertReminder:
post:
tags:
- Communicator
description: Notify users of new messages over email. ** This method is now obsolete DO NOT USE.
operationId: SetEmailAlertReminder
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SetEmailAlertReminderRequest'
required: true
summary: Set email alert reminder
x-summary-source: derived
/Communicator.svc/json/DeleteMessage:
post:
tags:
- Communicator
description: Delete direct or channel messages by specifying the message Id. Only messages generated by the requester account can be deleted.
operationId: DeleteMessage
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteMessageRequest'
required: true
summary: Delete message
x-summary-source: derived
/Communicator.svc/json/EditMessage:
post:
tags:
- Communicator
description: Alter the message text of a previously generated message.
operationId: EditMessage
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EditMessageRequest'
required: true
summary: Edit message
x-summary-source: derived
/Communicator.svc/json/MatterChannelSubscription:
post:
tags:
- Communicator
description: Subscribe or un-subscribe to matter channels.
operationId: MatterChannelSubscription
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/BaseResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MatterChannelSubscriptionRequest'
required: true
summary: Matter channel subscription
x-summary-source: derived
/Communicator.svc/json/GeFileUploadUrl:
post:
tags:
- Communicator
description: Get URLs to use for updating from JavaScript client.
operationId: GeFileUploadUrl
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/GeFileUploadUrlResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GeFileUploadUrlRequest'
required: true
summary: Ge file upload url
x-summary-source: derived
/Communicator.svc/json/GetChannelInfo:
post:
tags:
- Communicator
description: Get summary information about specific communicator channel.
operationId: GetChannelInfo
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/GetChannelInfoResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetChannelInfoRequest'
required: true
summary: Get channel info
x-summary-source: derived
/Communicator.svc/json/GetChannelsIBelongTo:
post:
tags:
- Communicator
description: Get a list of channels the request has is a member of.
operationId: GetChannelsIBelongTo
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/GetChannelsIBelongToResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetChannelsIBelongToRequest'
required: true
summary: Get channels IBelong to
x-summary-source: derived
/Communicator.svc/json/SaveChannel:
post:
tags:
- Communicator
description: Use for creating and editing communicator channels.
operationId: SaveChannel
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/SaveChannelResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SaveChannelRequest'
required: true
summary: Save channel
x-summary-source: derived
/Communicator.svc/json/ReadAllMessagesFromSomeone:
post:
tags:
- Communicator
description: Mark all messages for the requestor from a specific person as read.
operationId: ReadAllMessagesFromSomeone
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/ReadAllMessagesFromSomeoneResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReadAllMessagesFromSomeoneRequest'
required: true
summary: Read all messages from someone
x-summary-source: derived
/Communicator.svc/json/ReadAllMessagesFromChannel:
post:
tags:
- Communicator
description: Mark all messages for the requestor from a specific channel as read.
operationId: ReadAllMessagesFromChannel
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/ReadAllMessagesFromChannelResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReadAllMessagesFromChannelRequest'
required: true
summary: Read all messages from channel
x-summary-source: derived
/Communicator.svc/json/GetUnreadChannelMessages:
post:
tags:
- Communicator
description: Get a list of all channels\counts for the requestor with unread messages.
operationId: GetUnreadChannelMessages
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/GetUnreadChannelMessagesResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
summary: Get unread channel messages
x-summary-source: derived
/Communicator.svc/json/GetUnreadDirectMessages:
post:
tags:
- Communicator
description: Get a list of all user\counts for the requestor with unread messages.
operationId: GetUnreadDirectMessages
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/GetUnreadDirectMessagesResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
summary: Get unread direct messages
x-summary-source: derived
/Communicator.svc/json/GetDirectChat:
post:
tags:
- Communicator
description: Get chat details for a direct chat user to user.
operationId: GetDirectChat
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/GetDirectChatResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetDirectChatRequest'
required: true
summary: Get direct chat
x-summary-source: derived
/Communicator.svc/json/GetChannelChat:
post:
tags:
- Communicator
description: Get chat details for a channel chat.
operationId: GetChannelChat
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/GetChannelChatResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetChannelChatRequest'
required: true
summary: Get channel chat
x-summary-source: derived
/Communicator.svc/json/SendDirectMessage:
post:
tags:
- Communicator
description: Send chat message to a direct user.
operationId: SendDirectMessage
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/SendDirectMessageResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SendDirectMessageRequest'
required: true
summary: Send direct message
x-summary-source: derived
/Communicator.svc/json/SendChannelMessage:
post:
tags:
- Communicator
description: Send chat message to a channel.
operationId: SendChannelMessage
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/SendChannelMessageResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SendChannelMessageRequest'
required: true
summary: Send channel message
x-summary-source: derived
/Communicator.svc/json/GetUsers:
post:
tags:
- Communicator
description: Get list of users available for chat.
operationId: GetUsers
responses:
'200':
description: Successfully processed request
content:
application/json:
schema:
$ref: '#/components/schemas/GetUsersResponse'
'400':
description: Internal server error
'401':
description: Unauthorized
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetUsersRequest'
required: true
summary: Get users
x-summary-source: derived
components:
schemas:
GetChannelChatResponse:
type: object
properties:
ChatLog:
type: array
items:
$ref: '#/components/schemas/ChatLog'
ChatLogGroups:
type: array
items:
$ref: '#/components/schemas/ChatLogGroup'
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
GetChannelsIBelongToRequest:
type: object
properties:
Filter:
type: string
EditMessageRequest:
type: object
properties:
Id:
type: string
NewMessage:
type: string
IsDirectMessage:
type: boolean
GetChannelInfoRequest:
type: object
properties:
Id:
type: string
MatterId:
type: integer
format: int32
SendDirectMessageResponse:
type: object
properties:
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
GetUnreadChannelMessagesResponse:
type: object
properties:
UnreadMessageInfo:
type: array
items:
$ref: '#/components/schemas/UnreadChannelMessageInfo'
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
ChatLog:
type: object
properties:
FromUserDisplayName:
type: string
ToUserDisplayName:
type: string
Date:
type: string
format: date-time
Message:
type: string
FromUserId:
type: integer
format: int32
FromUserColor:
type: string
ProfileImage:
type: boolean
Id:
type: string
WasEdited:
type: boolean
CanEdit:
type: boolean
IsActivity:
type: boolean
ChatLogGroup:
type: object
properties:
Date:
type: string
format: date-time
ChatLog:
type: array
items:
$ref: '#/components/schemas/ChatLog'
GetChannelInfoResponse:
type: object
properties:
Channel:
type: object
$ref: '#/components/schemas/Channel'
IsRequestorChannelAdmin:
type: boolean
IsMember:
type: boolean
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
DeleteChannelRequest:
type: object
properties:
Id:
type: string
CharacterValidationRule:
type: object
properties:
ShouldMatch:
type: boolean
Message:
type: string
Regex:
type: string
GetUnreadDirectMessagesResponse:
type: object
properties:
UnreadMessageInfo:
type: array
items:
$ref: '#/components/schemas/UnreadDirectMessageInfo'
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
GeFileUploadUrlRequest:
type: object
properties:
Files:
type: array
items:
$ref: '#/components/schemas/RMFile'
Directories:
type: array
items:
$ref: '#/components/schemas/RMDirectory'
ToUserID:
type: integer
format: int32
ToChannelId:
type: string
PostToMatterDocuments:
type: boolean
MatterId:
type: integer
format: int32
ValidationResult:
type: object
properties:
MinValue:
type: boolean
MaxValue:
type: boolean
MinLength:
type: boolean
MaxLength:
type: boolean
Required:
type: boolean
PropertyDisplayName:
type: string
Precision:
type: boolean
ValueEntered:
type: object
Name:
type: string
ObjectName:
type: string
ExternalID:
type: string
MinValueMessage:
type: string
MaxValueMessage:
type: string
MinLengthMessage:
type: string
MaxLengthMessage:
type: string
RequiredMessage:
type: string
RequiredPrecisionMessage:
type: string
BaseFailureMessage:
type: string
FailedValidationMessages:
type: array
items:
type: string
FailedCharacterValidations:
type: array
items:
$ref: '#/components/schemas/CharacterValidationRule'
IsValid:
type: boolean
RMFile:
type: object
properties:
ContentType:
type: string
FileName:
type: string
FileContents:
type: object
ParentDirectory:
type: string
ParentPath:
type: string
FullPath:
type: string
FileUUId:
type: string
MatterChannelSubscriptionRequest:
type: object
properties:
MatterId:
type: integer
format: int32
Remove:
type: boolean
GetUsersResponse:
type: object
properties:
Users:
type: array
items:
$ref: '#/components/schemas/User'
CurrentUser:
type: object
$ref: '#/components/schemas/User'
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
UnreadDirectMessageInfo:
type: object
properties:
FromUserId:
type: integer
format: int32
Count:
type: integer
format: int32
DocumentUploadUrl:
type: object
properties:
Url:
type: string
FileUUId:
type: string
FullPath:
type: string
SourceFileUUId:
type: string
SendChannelMessageResponse:
type: object
properties:
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
ReadAllMessagesFromChannelResponse:
type: object
properties:
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
GetChannelChatRequest:
type: object
properties:
BeforeDate:
type: string
format: date-time
AfterDate:
type: string
format: date-time
ChannelId:
type: string
MatterId:
type: integer
format: int32
FeedType:
type: string
GetChannelsIBelongToResponse:
type: object
properties:
Channels:
type: array
items:
$ref: '#/components/schemas/Channel'
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
GetUsersRequest:
type: object
properties:
Filter:
type: string
DeleteMessageRequest:
type: object
properties:
Id:
type: string
IsDirectMessage:
type: boolean
ReadAllMessagesFromSomeoneRequest:
type: object
properties:
FromUserID:
type: integer
format: int32
SaveChannelResponse:
type: object
properties:
Channel:
type: object
$ref: '#/components/schemas/Channel'
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
UnreadChannelMessageInfo:
type: object
properties:
ChannelId:
type: string
Count:
type: integer
format: int32
SendDirectMessageRequest:
type: object
properties:
UserId:
type: integer
format: int32
Message:
type: string
BaseResponse:
type: object
properties:
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
SetEmailAlertReminderRequest:
type: object
properties:
Value:
type: boolean
GetDirectChatResponse:
type: object
properties:
ChatLog:
type: array
items:
$ref: '#/components/schemas/ChatLog'
ChatLogGroups:
type: array
items:
$ref: '#/components/schemas/ChatLogGroup'
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
User:
type: object
properties:
FullName:
type: string
FirstName:
type: string
LastName:
type: string
MiddleName:
type: string
ContactId:
type: integer
format: int32
Initials:
type: string
ID:
type: integer
format: int32
RMDirectory:
type: object
properties:
Name:
type: string
ParentDirectory:
type: string
ParentPath:
type: string
FullPath:
type: string
Files:
type: array
items:
$ref: '#/components/schemas/RMFile'
Directories:
type: array
items:
$ref: '#/components/schemas/RMDirectory'
FileUUId:
type: string
ReadAllMessagesFromSomeoneResponse:
type: object
properties:
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
GeFileUploadUrlResponse:
type: object
properties:
UploadUrls:
type: array
items:
$ref: '#/components/schemas/DocumentUploadUrl'
Success:
type: boolean
Message:
type: string
ErrorMessage:
type: string
ErrorNumber:
type: integer
format: int32
FailedValidations:
type: array
items:
$ref: '#/components/schemas/ValidationResult'
Errors:
type: array
items:
type: string
SendChannelMessageRequest:
type: object
properties:
Id:
type: string
Message:
type: string
GetDirectChatRequest:
type: object
properties:
UserId:
type: integer
format: int32
BeforeDate:
type: string
format: date-time
AfterDate:
type: string
format: date-time
ReadAllMessagesFromChannelRequest:
type: object
properties:
Id:
type: string
Channel:
type: object
properties:
Id:
type: string
Name:
type: string
Description:
type: string
Members:
type: array
items:
$ref: '#/components/schemas/ChannelMember'
DateCreated:
type: string
format: date-time
DateModified:
type: string
format: date-time
IsMatterChannel:
type: boolean
MatterId:
type: integer
format: int32
SaveChannelRequest:
type: object
properties:
Channel:
type: object
$ref: '#/components/schemas/Channel'
ChannelMember:
type: object
properties:
Id:
type: string
ChannelId:
type: object
DateCreated:
type: string
format: date-time
DateModified:
type: string
format: date-time
FullName:
type: string
IsAdmin:
type: boolean
SecondSinceLastActive:
type: number
format: double
UserId:
type: integer
format: int32
ProfileImage:
type: string