Home
API Catalog
About
Back to System
Alcatel-Lucent Rainbow API
1.0.0
OAS 3.0
Servers
https://sandbox.openrainbow.com
Authorize
Admin - Users
GET
/api
/rainbow
/admin
/v1.0
/users
List all users
POST
/api
/rainbow
/admin
/v1.0
/users
Create a new user
GET
/api
/rainbow
/admin
/v1.0
/users
/{userId}
Get user by ID
PUT
/api
/rainbow
/admin
/v1.0
/users
/{userId}
Update a user
DELETE
/api
/rainbow
/admin
/v1.0
/users
/{userId}
Delete a user
Files
POST
/api
/rainbow
/enduser
/v1.0
/files
Upload a file
GET
/api
/rainbow
/enduser
/v1.0
/files
/{fileId}
Get file metadata
GET
/api
/rainbow
/enduser
/v1.0
/files
/{fileId}
/download
Download a file
GET
/api
/rainbow
/enduser
/v1.0
/conversations
/{conversationId}
/files
List files in a conversation
Groups
GET
/api
/rainbow
/enduser
/v1.0
/groups
List my groups
POST
/api
/rainbow
/enduser
/v1.0
/groups
Create a group
GET
/api
/rainbow
/enduser
/v1.0
/groups
/{groupId}
Get group details
PUT
/api
/rainbow
/enduser
/v1.0
/groups
/{groupId}
Update a group
DELETE
/api
/rainbow
/enduser
/v1.0
/groups
/{groupId}
Delete a group
GET
/api
/rainbow
/enduser
/v1.0
/groups
/{groupId}
/members
List group members
POST
/api
/rainbow
/enduser
/v1.0
/groups
/{groupId}
/members
Add a member to a group
DELETE
/api
/rainbow
/enduser
/v1.0
/groups
/{groupId}
/members
/{userId}
Remove a member from a group
Users
GET
/api
/rainbow
/enduser
/v1.0
/users
/me
Get my profile
PUT
/api
/rainbow
/enduser
/v1.0
/users
/me
Update my profile
GET
/api
/rainbow
/enduser
/v1.0
/users
/{userId}
Get a user's profile
Conversations
GET
/api
/rainbow
/enduser
/v1.0
/conversations
List my conversations
POST
/api
/rainbow
/enduser
/v1.0
/conversations
Create a conversation
GET
/api
/rainbow
/enduser
/v1.0
/conversations
/{conversationId}
Get conversation details
DELETE
/api
/rainbow
/enduser
/v1.0
/conversations
/{conversationId}
Delete or leave a conversation
Contacts
GET
/api
/rainbow
/enduser
/v1.0
/users
/me
/contacts
List my contacts
POST
/api
/rainbow
/enduser
/v1.0
/users
/me
/contacts
Add a contact
GET
/api
/rainbow
/enduser
/v1.0
/users
/me
/contacts
/{contactId}
Get a specific contact
DELETE
/api
/rainbow
/enduser
/v1.0
/users
/me
/contacts
/{contactId}
Remove a contact
Presence
GET
/api
/rainbow
/enduser
/v1.0
/users
/me
/presence
Get my presence
PUT
/api
/rainbow
/enduser
/v1.0
/users
/me
/presence
Update my presence
GET
/api
/rainbow
/enduser
/v1.0
/users
/{userId}
/presence
Get a user's presence
Admin - Companies
GET
/api
/rainbow
/admin
/v1.0
/companies
/{companyId}
Get company by ID
PUT
/api
/rainbow
/admin
/v1.0
/companies
/{companyId}
Update a company
Telephony
GET
/api
/rainbow
/enduser
/v1.0
/telephony
/v1.0
/users
/me
/callslog
Get my call log
DELETE
/api
/rainbow
/enduser
/v1.0
/telephony
/v1.0
/users
/me
/callslog
Clear my call log
GET
/api
/rainbow
/enduser
/v1.0
/telephony
/v1.0
/users
/me
/callslog
/{callId}
Get call log entry details
Messages
GET
/api
/rainbow
/enduser
/v1.0
/conversations
/{conversationId}
/messages
List messages in a conversation
POST
/api
/rainbow
/enduser
/v1.0
/conversations
/{conversationId}
/messages
Send a message
GET
/api
/rainbow
/enduser
/v1.0
/conversations
/{conversationId}
/messages
/{messageId}
Get a specific message
PUT
/api
/rainbow
/enduser
/v1.0
/conversations
/{conversationId}
/messages
/{messageId}
Update a message
DELETE
/api
/rainbow
/enduser
/v1.0
/conversations
/{conversationId}
/messages
/{messageId}
Delete a message
Schemas
Call
File
User
Error
Group
Company
Contact
Message
Presence
UserCreate
UserUpdate
GroupCreate
GroupUpdate
Conversation
CompanyUpdate
ContactCreate
MessageCreate
MessageUpdate
GroupMemberAdd
PresenceUpdate
ConversationCreate
