Chat API (1)
Download OpenAPI specification:Download
License: Property of FACEIT LTD
This API provide an access to the FACEIT's chat rooms
Retrieve details of a room.
It returns the list of members, roles and details of a chat room
Authorizations:
accessToken
path Parameters
| room_id required | string The id of the chat room |
Responses
Response samples
- 200
Content type
application/json
{- "members": [
- {
- "is_online": true,
- "member_id": "string",
- "nickname": "string",
- "photo": "string",
- "roles": [
- "string"
], - "status": "string"
}
], - "name": "string",
- "roles": [
- {
- "color": "string",
- "displayed": true,
- "mentionable": true,
- "name": "string",
- "permissions": [
- "string"
], - "ranking": 0,
- "role_id": "string"
}
]
}Retrieve the messages posted in a chat room.
It returns the list of messages
Authorizations:
accessToken
path Parameters
| room_id required | string The id of the chat room |
query Parameters
| before | string The timestamp of the last message. If empty, current timestamp will be used |
| limit | integer [ 1 .. 50 ] The maximum number of messages to be returned |
Responses
Response samples
- 200
Content type
application/json
{- "is_last_page": true,
- "messages": [
- {
- "avatar": "string",
- "body": "string",
- "from": "string",
- "id": "string",
- "nickname": "string",
- "timestamp": "string"
}
]
}Post a message in a chat room.
It returns the id of the processed message
Authorizations:
accessToken
path Parameters
| room_id required | string The id of the chat room |
Request Body schema:
The body of the message to post. Max length is 10000 characters.
| body | string |
Responses
Request samples
- Payload
Content type
{- "body": "string"
}Response samples
- 200
Content type
application/json
{- "id": "string"
}