API Explorer for RingCentral Glip Messaging API
Operation | Description |
---|---|
GET /persons/{personId} | Get Person by ID |
Operation | Description |
---|---|
GET /companies/{companyId} | Get Company Info |
Operation | Description |
---|---|
GET /groups | Return groups associated with current user |
GET /groups/{groupId} | Returns a group by id |
Operation | Description |
---|---|
GET /posts | Get User Posts |
POST /posts | Send New Message |
GET /posts/{postId} | Get Post By Id |
Returns a company by id
companyId | The id of the company being queried. Can be '~' for company the current user belongs to. |
path | string ~ |
Uses default content-types: application/json
a Company object.
"{\n \"id\": \"456789\",\n \"name\": \"Ringcentral\",\n \"domain\": \"mydomain.com\",\n \"creationTime\": \"2015-05-05T12:00:00Z\",\n \"lastModifiedTime\": \"2016-03-05T12:00:00Z\"\n}"
ID of company
Name of company
Domain name of company
Time of creation (ISO format)
Time of last modification (ISO format)
Return groups associated with current user
type | Type of groups to be fetched |
query | string , x ∈ { Group , Team } | |
pageToken | Pagination token |
query | string | |
recordCount | Max number of records to return. |
query | integer 250 |
Uses default content-types: application/json
a list of Group objects.
"{\n \"records\": [\n {\n \"id\":\"637468356\",\n \"type\": \"Group\",\n \"displayName\":\"John John\",\n \"email\": \"test@acme001.com\",\n \"members\": [\n \"12464564\",\n \"2344565255\"\n ],\n \"creationTime\":\"2015-05-05T12:00:00Z\",\n \"lastModifiedTime\":\"2016-03-05T12:00:00Z\"\n },\n {\n \"id\":\"637468356\",\n \"type\": \"Team\",\n \"displayName\":\"Some group\",\n \"isPublic\": true,\n \"description\":\"My team\",\n \"creationTime\":\"2015-05-05T12:00:00Z\",\n \"lastModifiedTime\":\"2016-03-05T12:00:00Z\",\n \"members\": [\n \"12464564\",\n \"2344565255\"\n ]\n }\n ],\n \"navigation\": {\n \"nextPageToken\": \"62hdfjhq87xjh\",\n \"prevPageToken\": \"fgghjsdgfsjf\"\n }\n}"
a list of post objects within a response envelope
Id of team
Type of group
Name of team
Short description
Array of group participants
Email of team
Shows if team is public or not
Time of creation (ISO format)
Time of last modification (ISO format)
prev page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens.
next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens.
Returns a group by id
groupId | Id of a group to be fetched |
path | string |
Uses default content-types: application/json
a list of Group objects.
"{\n \"id\":\"637468356\",\n \"type\": \"Team\",\n \"displayName\":\"Some group\",\n \"isPublic\": true,\n \"description\":\"My team\",\n \"creationTime\":\"2015-05-05T12:00:00Z\",\n \"lastModifiedTime\":\"2016-03-05T12:00:00Z\",\n \"members\": [\n \"12464564\",\n \"23445652\"\n ]\n}"
Id of team
Type of group
Name of team
Short description
Array of group participants
Email of team
Shows if team is public or not
Time of creation (ISO format)
Time of last modification (ISO format)
Returns a person by id. If the person cannot be accessed by current user, API must return HTTP 404.
personId | The personId being requested. Can be |
path | string |
Uses default content-types: application/json
a Person object.
"{\n \"id\":\"123456\",\n \"firstName\":\"John\",\n \"lastName\":\"Doe\",\n \"location\":\"Denver, CO\",\n \"email\":\"john.doe@acme.com\",\n \"companyId\": \"456789\",\n \"creationTime\":\"2015-05-05T12:00:00Z\",\n \"lastModifiedTime\":\"2016-03-05T12:00:00Z\"\n}"
ID of person
First name of person
Last name of person
Gender of person
Email of user
Current location of person
ID of company person belongs to
Time of creation (ISO format)
Time of last modification (ISO format)
Return posts which are available for current user. Not more than 250 records to be returned in one request. If posts cannot be viewed by current user (fro example, user is not member of group), API must return HTTP 404.
groupId | Id of a group to filter posts |
query | string | |
pageToken | Pagination token |
query | string | |
recordCount | Max number of records to return |
query | string |
Uses default content-types: application/json
a list of Group objects.
"{\n records: [{\n \"id\": \"637468356\",\n \"text\": \"Hi there!\",\n \"creatorId\": \"5574664564\",\n \"groupId\": \"456775\",\n \"creationTime\": \"2015-05-05T12:00:00Z\",\n \"lastModifiedTime\": \"2016-03-05T12:00:00Z\"\n },\n {\n \"id\": \"637468357\",\n \"text\": \"Hi!!\",\n \"creatorId\": \"5574664564\",\n \"groupId\": \"456775\",\n \"creationTime\": \"2015-05-05T12:00:00Z\",\n \"lastModifiedTime\": \"2016-03-05T12:00:00Z\"\n }],\n \"navigation\": {\n \"prevPage\": \"adsasdasdsdfsdf\"\n }\n}"
a list of post objects within a response envelope
Id of post
Id of person created post
Id of group oist belongs to
Text of message
Time of creation (ISO format)
Time of last modification (ISO format)
prev page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens.
next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens.
No content.
Creates post and send it to specified Group and returns it.
Uses default content-types: application/json
Create post JSON body
Id of a group to send post to
Text of a post,up to 10000 unicode characters. All text must be returned
Uses default content-types: application/json
Post or 404. If Group with groupId doesn't exists or user doesn't belong to the group, 404 should be returned.
"{\n \"id\": \"637468356\",\n \"text\": \"Hi there!\",\n \"creatorId\": \"5574664564\",\n \"groupId\": \"456775\",\n \"creationTime\": \"2015-05-05T12:00:00Z\",\n \"lastModifiedTime\": \"2016-03-05T12:00:00Z\"\n}"
Id of post
Id of person created post
Id of group oist belongs to
Text of message
Time of creation (ISO format)
Time of last modification (ISO format)
If Group with groupId doesn't exists or user doesn't belong to the group, 404 should be returned.
Returns post with given id. If a post cannot be viewed by current user, API must return HTTP 404.
postId | Id of a post to be fetched |
path | string |
Uses default content-types: application/json
a list of Group objects.
"{\n \"id\": \"637468356\",\n \"text\": \"Hi there!\",\n \"creatorId\": \"5574664564\",\n \"groupId\": \"456775\",\n \"creationTime\": \"2015-05-05T12:00:00Z\",\n \"lastModifiedTime\": \"2016-03-05T12:00:00Z\"\n}"
Id of post
Id of person created post
Id of group oist belongs to
Text of message
Time of creation (ISO format)
Time of last modification (ISO format)
No content.
ID of company
Name of company
Domain name of company
Time of creation (ISO format)
Time of last modification (ISO format)
Id of a group to send post to
Text of a post,up to 10000 unicode characters. All text must be returned
Id of group
Type of group. Must be set to 'Group'
Array of group participants
Group couldn't be public
Time of creation (ISO format)
Time of last modification (ISO format)
ID of person
First name of person
Last name of person
Gender of person
Email of user
Current location of person
ID of company person belongs to
Time of creation (ISO format)
Time of last modification (ISO format)
Id of post
Id of person created post
Id of group oist belongs to
Text of message
Time of creation (ISO format)
Time of last modification (ISO format)
a list of post objects within a response envelope
Id of team
Type of group
Name of team
Short description
Array of group participants
Email of team
Shows if team is public or not
Time of creation (ISO format)
Time of last modification (ISO format)
prev page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens.
next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens.
a list of post objects within a response envelope
Id of post
Id of person created post
Id of group oist belongs to
Text of message
Time of creation (ISO format)
Time of last modification (ISO format)
prev page token. To get previous page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens.
next page token. To get next page, user should pass one of returned token in next request and, in turn, required page will be returned with new tokens.
Id of team
Type of group
Name of team
Short description
Array of group participants
Email of team
Shows if team is public or not
Time of creation (ISO format)
Time of last modification (ISO format)