RingCentral Glip REST API

API Explorer for RingCentral Glip Messaging API

Default request content-types: application/json
Default response content-types: application/json
Schemes: https

Summary

Tag: person

Operation Description
GET /persons/{personId}

Get Person by ID

Tag: company

Operation Description
GET /companies/{companyId}

Get Company Info

Tag: group

Operation Description
GET /groups

Return groups associated with current user

GET /groups/{groupId}

Returns a group by id

Tag: post

Operation Description
GET /posts

Get User Posts

POST /posts

Send New Message

GET /posts/{postId}

Get Post By Id

Security

OauthSecurity

flow: accessCode
authorizationUrl: https://platform.devtest.ringcentral.com/restapi/oauth/authorize
tokenUrl: https://platform.devtest.ringcentral.com/restapi/oauth/token
scopes: [object Object]

Paths

Get Company Info

GET /companies/{companyId}

Tags: company

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

200 OK

a Company object.

Example for application/json
"{\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: string

ID of company

name: string

Name of company

domain: string

Domain name of company

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

Return groups associated with current user

GET /groups

Tags: group

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

200 OK

a list of Group objects.

Example for application/json
"{\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}"
                                            
records: object[]

a list of post objects within a response envelope

object
id: string

Id of team

type: string , x ∈ { Group , Team }

Type of group

displayName: string

Name of team

description: string

Short description

members: string[]

Array of group participants

string
email: string

Email of team

isPublic: boolean

Shows if team is public or not

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

navigation: object
prevPage: string

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.

nextPage: string

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

GET /groups/{groupId}

Tags: group

Returns a group by id

groupId

Id of a group to be fetched

path string

Uses default content-types: application/json

200 OK

a list of Group objects.

Example for application/json
"{\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: string

Id of team

type: string , x ∈ { Group , Team }

Type of group

displayName: string

Name of team

description: string

Short description

members: string[]

Array of group participants

string
email: string

Email of team

isPublic: boolean

Shows if team is public or not

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

Get Person by ID

GET /persons/{personId}

Tags: person

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 ~ for current user.

path string

Uses default content-types: application/json

200 OK

a Person object.

Example for application/json
"{\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: string

ID of person

firstName: string

First name of person

lastName: string

Last name of person

gender: string

Gender of person

email: string

Email of user

location: string

Current location of person

companyId: string

ID of company person belongs to

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

Get User Posts

GET /posts

Tags: post

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

200 OK

a list of Group objects.

Example for application/json
"{\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}"
                                            
records: object[]

a list of post objects within a response envelope

object
id: string

Id of post

creatorId: string

Id of person created post

groupId: string

Id of group oist belongs to

text: boolean

Text of message

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

navigation: object
prevPage: string

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.

nextPage: string

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.

404 Not Found

No content.

Send New Message

POST /posts

Tags: post

Creates post and send it to specified Group and returns it.

Uses default content-types: application/json

Create post JSON body

groupId: string

Id of a group to send post to

text: string

Text of a post,up to 10000 unicode characters. All text must be returned

Uses default content-types: application/json

200 OK

Post or 404. If Group with groupId doesn't exists or user doesn't belong to the group, 404 should be returned.

Example for application/json
"{\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: string

Id of post

creatorId: string

Id of person created post

groupId: string

Id of group oist belongs to

text: boolean

Text of message

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

404 Not Found

If Group with groupId doesn't exists or user doesn't belong to the group, 404 should be returned.

Get Post By Id

GET /posts/{postId}

Tags: post

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

200 OK

a list of Group objects.

Example for application/json
"{\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: string

Id of post

creatorId: string

Id of person created post

groupId: string

Id of group oist belongs to

text: boolean

Text of message

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

404 Not Found

No content.

Schema definitions

Company: object

id: string

ID of company

name: string

Name of company

domain: string

Domain name of company

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

CreatePostRequest: object

groupId: string

Id of a group to send post to

text: string

Text of a post,up to 10000 unicode characters. All text must be returned

Group: object

id: string

Id of group

type: string , x ∈ { Group }

Type of group. Must be set to 'Group'

members: string[]

Array of group participants

string
isPublic: boolean

Group couldn't be public

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

Navigation: object

prevPage: string

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.

nextPage: string

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.

Person: object

id: string

ID of person

firstName: string

First name of person

lastName: string

Last name of person

gender: string

Gender of person

email: string

Email of user

location: string

Current location of person

companyId: string

ID of company person belongs to

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

Post: object

id: string

Id of post

creatorId: string

Id of person created post

groupId: string

Id of group oist belongs to

text: boolean

Text of message

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

ReadGroupsResponse: object

records: object[]

a list of post objects within a response envelope

object
id: string

Id of team

type: string , x ∈ { Group , Team }

Type of group

displayName: string

Name of team

description: string

Short description

members: string[]

Array of group participants

string
email: string

Email of team

isPublic: boolean

Shows if team is public or not

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

navigation: object
prevPage: string

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.

nextPage: string

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.

ReadPostsResponse: object

records: object[]

a list of post objects within a response envelope

object
id: string

Id of post

creatorId: string

Id of person created post

groupId: string

Id of group oist belongs to

text: boolean

Text of message

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)

navigation: object
prevPage: string

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.

nextPage: string

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.

Team: object

id: string

Id of team

type: string , x ∈ { Group , Team }

Type of group

displayName: string

Name of team

description: string

Short description

members: string[]

Array of group participants

string
email: string

Email of team

isPublic: boolean

Shows if team is public or not

creationTime: string

Time of creation (ISO format)

lastModifiedTime: string

Time of last modification (ISO format)