Skip to content
CCS Chat Docs

Overview

CCS Chat API 1.0

Section titled “CCS Chat API 1.0”

REST API of chat.centralcodestation.com. Every route is under /api/v1; routes are kebab-case and every field is snake_case.

Authentication: a bearer access token issued by the CCS Identity Server for the Chat API resource (aud = chat-api).

  • User tokens need the chat:access scope. What the user may do comes from their Chat permissions in the tenant/application context. A token issued to a tenant application’s own client works only in that application.
  • Machine tokens (client_credentials) need chat:sync or a granular scope (chat:conversations.read, chat:conversations.manage, chat:groups.manage, chat:channels.manage, chat:messages.send, chat:users.lookup) and work only in their own tenant and TENANT application.

Errors are { status_code, error, message, path, timestamp }; error is a stable snake_case code. Lists page with ?before=<next_cursor>&limit= (max 100).

Information

  • OpenAPI version: 3.0.0

Operations

Section titled “Operations”
GET
/api/v1/me
GET
/api/v1/me/tenants
GET
/api/v1/tenants/{tenant_id}/applications
GET
/api/v1/tenants/{tenant_id}/me/capabilities
GET
/api/v1/tenants/{tenant_id}/applications/{application_id}/me/capabilities
GET
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations
POST
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations
GET
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}
DELETE
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}
PATCH
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}
GET
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/members
POST
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/members
DELETE
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/members/{user_id}
GET
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/messages
POST
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/messages
DELETE
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/messages/{message_id}
PATCH
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/messages/{message_id}
POST
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/messages/{message_id}/reactions
DELETE
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/messages/{message_id}/reactions/{emoji}
POST
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/read
POST
/api/v1/tenants/{tenant_id}/applications/{application_id}/conversations/{conversation_id}/typing
GET
/api/v1/tenants/{tenant_id}/applications/{application_id}/users/lookup
POST
/api/v1/tenants/{tenant_id}/presence/heartbeat
POST
/api/v1/tenants/{tenant_id}/presence/offline
GET
/api/v1/tenants/{tenant_id}/presence
GET
/api/v1/notifications/vapid-public-key
POST
/api/v1/tenants/{tenant_id}/notifications/push/devices
DELETE
/api/v1/tenants/{tenant_id}/notifications/push/devices
GET
/api/v1/tenants/{tenant_id}/applications/{application_id}/notifications/realtime-token
GET
/api/v1/tenants/{tenant_id}/admin/overview
GET
/api/v1/tenants/{tenant_id}/admin/role-permissions
PUT
/api/v1/tenants/{tenant_id}/admin/role-permissions/{role_id}
GET
/api/v1/tenants/{tenant_id}/admin/members
GET
/api/v1/tenants/{tenant_id}/admin/applications
GET
/api/v1/tenants/{tenant_id}/admin/settings
PATCH
/api/v1/tenants/{tenant_id}/admin/settings
POST
/api/v1/tenants/{tenant_id}/admin/identity-refresh
GET
/api/v1/tenants/{tenant_id}/admin/conversations
DELETE
/api/v1/tenants/{tenant_id}/admin/conversations/{conversation_id}
DELETE
/api/v1/tenants/{tenant_id}/admin/conversations/{conversation_id}/members/{user_id}
GET
/api/v1/tenants/{tenant_id}/admin/audit-logs

Authentication

Section titled “Authentication”

bearer

Section titled “bearer”

Security scheme type: http

Bearer format: JWT