RingCentral Office API Reference Index
Welcome to a simple index of RingCentral Office API endpoints, provided as a convenience for those who need a quick way to find a specific endpoint. For a complete reference, check out RingCentral's complete and interactive Office API Reference.
API Info
Method | Description |
---|---|
Get API Versions | Returns current API version(s) and server info. |
|
|
Get Version Info | Returns current API version info by apiVersion. |
|
|
Get Service Status | Returns current PAS service status. |
|
Automatic Location Updates
Method | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get User List | Returns the list of users with their status of Automatic Location Updates feature. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-address-auto-update/users
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Enable Automatic Location Updates for Users | Enables or disables Automatic Location Updates feature for multiple account users. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/users/bulk-assign
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Wireless Point List | Returns account wireless points configured and used for Automatic Location Updates feature. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Create Wireless Point | Creates a new wireless point in network configuration with the emergency address assigned. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Wireless Point | Returns the specified wireless access point of a corporate map with the emergency address assigned. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Update Wireless Point | Updates the specified wireless access point of a corporate map by ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Delete Wireless Point | Deletes wireless point(s) of a corporate map by ID(s). |
||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Network Map | Returns corporate networks map with emergency addresses assigned to the current account. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks |
|||||||||||||||||||||||||||||||||||||||||||||||||||
Create Network | Creates a new network in corporate ethernet map for assignment of emergency addresses to network access points. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Network | Returns the specified network with emergency addresses assigned to the current account. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks/{networkId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Update Network | Updates network in corporate ethernet map for assignment of emergency addresses to network access points. |
||||||||||||||||||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks/{networkId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Delete Network | Deletes network(s) in corporate ethernet map for Automatic Location Updates feature. |
||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks/{networkId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Device List | Returns the list of common devices with their status of Automatic Location Updates feature. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-address-auto-update/devices
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Enable Automatic Location Updates for Devices | Enables or disables Automatic Location Updates feature for the specified common phones. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/devices/bulk-assign
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Account Switch List | Returns corporate map of configured network switches with the assigned emergency addresses for the logged-in account. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Create Switch | Creates a new switch in corporate map based on chassis ID and used for Automatic Locations Update feature. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Switch | Returns the specified switch with the assigned emergency address. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches/{switchId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Update Switch | Updates switch. Partial update is not supported, all switch parameters should be specified. If null value is received or parameter is missing, its value is removed. |
||||||||||||||||||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches/{switchId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Delete Switch | Deletes wireless switch(es) in network configuration for Automatic Location Updates feature. |
||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches/{switchId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Create Multiple Switches | Creates multiple switches in corporate map. The maximum number of switches per request is 10 000; limitation for account is 10 000. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-create
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Update Multiple Switches | Updates multiple switches in corporate map. The maximum number of switches per request is 10 000; limitation for account is 10 000. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-update
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Create Multiple Wireless Points | Creates multiple wireless points in corporate map. The maximum number of wireless points per request is 10 000; limitation for account is 70 000. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-create
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Update Multiple Wireless Points | Updates wireless points in corporate map. The maximum number of wireless points per request is 10 000; limitation for account is 70 000. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-update
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Validate Multiple Wireless Points | Validates wireless points before creation or update. The maximum number of wireless points per request is 10 000. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-validate
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Validate Multiple Switches | Validates switches before creation or update. The maximum number of switches per request is 10 000. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-validate
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Emergency Map Configuration Task | Returns results of the task created within the frame of Automatic Location Updates feature. Currently four task types are supported: 'Wireless Points Bulk Create', 'Wireless Points Bulk Update', 'Switches Bulk Create', 'Switches Bulk Update' |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-address-auto-update/tasks/{taskId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Add Emergency Location | |||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/emergency-locations
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Emergency Location List | Returns emergency response locations of the current account. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-locations
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Emergency Location | Returns emergency response location by ID |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/emergency-locations/{locationId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Update Emergency Location | Updates the specified emergency response location. |
||||||||||||||||||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/emergency-locations/{locationId}
|
Business Hours
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get User Business Hours | Returns the user hours when the call handling rules are applied. Please note: If user hours are set to 'Custom hours' then a particular schedule is returned; however if set to '24 hours/7 days a week' an empty schedule is returned. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours
|
|||||||||||||||||||||
Update User Business Hours | Updates the extension user hours when answering rules are to be applied. |
||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/business-hours
|
|||||||||||||||||||||
Get Company Business Hours | Returns company hours when answering rules are to be applied. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/business-hours |
|||||||||||||||||||||
Update Company Business Hours | Updates company hours when answering rules are to be applied. |
||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/business-hours
|
Calendar Events
Method | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get User Events List | Returns all calendar events created by the current user. |
|||||||||||||||
|
||||||||||||||||
Create Event | Creates a new calendar event. |
|||||||||||||||
POST /restapi/v1.0/glip/events |
||||||||||||||||
Get Event | Returns the specified calendar event(s) by ID(s). |
|||||||||||||||
GET /restapi/v1.0/glip/events/{eventId} |
||||||||||||||||
Update Event | Updates the specified calendar event. |
|||||||||||||||
PUT /restapi/v1.0/glip/events/{eventId}
|
||||||||||||||||
Delete Event | Deletes the specified calendar event. |
|||||||||||||||
DELETE /restapi/v1.0/glip/events/{eventId} |
||||||||||||||||
Create Event by Group ID | Creates a new calendar event within the specified group. |
|||||||||||||||
POST /restapi/v1.0/glip/groups/{groupId}/events
|
||||||||||||||||
Get Group Events | Returns a list of calendar events available for the current user within the specified group. Users can only see their personal tasks and public tasks. |
|||||||||||||||
GET /restapi/v1.0/glip/groups/{groupId}/events |
Call Blocking
Method | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Caller Blocking Settings | Returns the current caller blocking settings of a user. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking
|
|||||||||||||||||||||||||||||||
Update Caller Blocking Settings | Updates the current caller blocking settings of a user. |
||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking
|
|||||||||||||||||||||||||||||||
Get Blocked/Allowed Phone Numbers | Returns the lists of blocked and allowed phone numbers. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers
|
|||||||||||||||||||||||||||||||
Add Blocked/Allowed Number | Updates either blocked or allowed phone number list with a new phone number. |
||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers
|
|||||||||||||||||||||||||||||||
Get Blocked/Allowed Number | Returns blocked or allowed phone number(s) by their ID(s). Batch request is supported. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}
|
|||||||||||||||||||||||||||||||
Delete Blocked/Allowed Number | Deletes blocked or allowed phone number(s) by their ID(s). Batch request is supported. |
||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}
|
|||||||||||||||||||||||||||||||
Update Blocked/Allowed Number | Updates blocked or allowed phone number(s) by their ID(s). Batch request is supported. |
||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}
|
Call Control
Method | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Make CallOut | Creates a new outbound call out session. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/call-out
|
||||||||||||||||||||||||||||||||||||
Get Call Session Status | Returns the status of a call session by ID. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}
|
||||||||||||||||||||||||||||||||||||
Drop Call Session | Drops a call session. |
|||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}
|
||||||||||||||||||||||||||||||||||||
Hold Call Party | Puts the party to stand-alone mode and starts to play Hold Music according to configuration & state to peers. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/hold
|
||||||||||||||||||||||||||||||||||||
Unhold Call Party | Brings a party back into a call and stops to play Hold Music. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/unhold
|
||||||||||||||||||||||||||||||||||||
Reject Call Party | Rejects an inbound call in a "Setup" or "Proceeding" state |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/reject
|
||||||||||||||||||||||||||||||||||||
Ignore Call in Queue | Ignores a call to a call queue agent in |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/ignore
|
||||||||||||||||||||||||||||||||||||
Transfer Call Party | Transfers a party by placing a new call to the specified target |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/transfer
|
||||||||||||||||||||||||||||||||||||
Answer Call Party | Answers a call on a certain device using this device identifier. Currently it is possible to answer an incoming call via this method after the following actions: call forward, call transfer or call flip. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/answer
|
||||||||||||||||||||||||||||||||||||
Pickup Call | Picks up a call parked to the specified park location. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/pickup
|
||||||||||||||||||||||||||||||||||||
Forward Call Party | Distributes a non-answered call to the defined target. Applicable for "Setup" or "Proceeding" states |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/forward
|
||||||||||||||||||||||||||||||||||||
Reply with Text | Replies with text/pattern without picking up a call. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/reply
|
||||||||||||||||||||||||||||||||||||
Call Flip on Party | Performs call flip procedure by holding opposite party and calling to the specified target |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/flip
|
||||||||||||||||||||||||||||||||||||
Call Park | Parks a call to a virtual location from where it can further be retrieved by any user from any phone of the system. The call session and call party identifiers should be specified in path. Currently the users can park only their own incoming calls. Up to 50 calls can be parked simultaneously. Park location starts with asterisk (*) and ranges 801-899. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/park
|
||||||||||||||||||||||||||||||||||||
Get Call Party Status | Returns a party status of a call session by ID. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}
|
||||||||||||||||||||||||||||||||||||
Update Call Party | Modify the party of a call session by ID. There is a known limitation for Mute scenario - mute via REST API doesn't work with mute placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and Ringcentral Desktop app you need to unmute both endpoints to bring media back. |
|||||||||||||||||||||||||||||||||||
PATCH /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}
|
||||||||||||||||||||||||||||||||||||
Create Recording | Starts a new call recording for the party |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/recordings
|
||||||||||||||||||||||||||||||||||||
Pause/Resume Recording | Pause/resume recording |
|||||||||||||||||||||||||||||||||||
PATCH /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/recordings/{recordingId}
|
||||||||||||||||||||||||||||||||||||
Supervise Call Session | Allows to monitor a call session in 'Listen' mode. Input parameters should contain internal identifiers of a monitored user and a supervisor's device. Call session should be specified in path. Please note that this method supports single channel audio flow, which means that audio of both call participants is mixed and delivered to the supervisor in single audio channel. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/supervise
|
||||||||||||||||||||||||||||||||||||
Supervise Call Party | Allows to monitor a call party in 'Listen' mode. Input parameters are extension number of a monitored user and internal identifier of a supervisor's device. Call session and party identifiers should be specified in path. Please note that for this method dual channel audio flow is supported, which means that you need to make one more request for monitoring the second participant of a call. And as a result of each monitoring request the client recieves SIP invite with the following header |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/supervise
|
Call Forwarding
Method | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Forwarding Number List | Returns the list of extension phone numbers used for call forwarding and call flip. The returned list contains all the extension phone numbers used for call forwarding and call flip. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number
|
||||||||||||||||||||||||||
Create Forwarding Number | Adds a new forwarding number to the forwarding number list. |
|||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number
|
||||||||||||||||||||||||||
Get Forwarding Number | Returns a specific forwarding number. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}
|
||||||||||||||||||||||||||
Update Forwarding Number | Updates the existing forwarding number from the forwarding number list. |
|||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}
|
||||||||||||||||||||||||||
Delete Forwarding Number | Deletes a forwarding number from the forwarding number list by its ID. |
|||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}/forwarding-number/{forwardingNumberId}
|
Call Log
Method | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get User Call Log Records | Returns call log records filtered by parameters specified. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Delete User Call Log | Deletes filtered call log records. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sync User Call Log | Synchronizes call log records |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log-sync
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get User Call Record | Returns call log records by ID. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-log/{callRecordId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get User Active Calls | Returns records of all extension calls that are in progress, ordered by start time in descending order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/active-calls
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get Company Call Log Records | Returns call log records filtered by parameters specified. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/call-log
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sync Company Call Log | Synchronizes company call log records. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/call-log-sync
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get Company Call Log Record(s) | Returns individual call log record(s) by ID(s). Batch request is supported. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/call-log/{callRecordId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get Company Active Calls | Returns records of all calls that are in progress, ordered by start time in descending order. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/active-calls
|
Call Monitoring Groups
Method | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Call Monitoring Group | Creates a new call monitoring group. |
|||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/call-monitoring-groups
|
||||||||||||||||||||||||||
Get Call Monitoring Groups List | Returns call monitoring groups that can be filtered by some extension. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/call-monitoring-groups
|
||||||||||||||||||||||||||
Updates Call Monitoring Group | Updates call monitoring group name by ID. |
|||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}
|
||||||||||||||||||||||||||
Delete Call Monitoring Group | Remove infromation about the given call monitoring group. |
|||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}
|
||||||||||||||||||||||||||
Get Call Monitoring Group Member List | Returns call monitoring group members. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}/members
|
||||||||||||||||||||||||||
Update Call Monitoring Group List | Updates call monitoring groups. |
|||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}/bulk-assign
|
Call Queues
Method | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Call Queue List | Returns call queue group list. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/call-queues
|
||||||||||||||||||||||||||
Get Call Queue Members | Returns call queue group members. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/call-queues/{groupId}/members
|
||||||||||||||||||||||||||
Assign Multiple Call Queue Members | Updates a call queue group. |
|||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/call-queues/{groupId}/bulk-assign
|
||||||||||||||||||||||||||
Update User Call Queues | Updates the list of call queues where the user is an agent. This is a full update request, which means that if any queue where the user is an agent is not mentioned in request, then the user is automatically removed from this queue. |
|||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/call-queues
|
||||||||||||||||||||||||||
Get Department Member List | Viewing user account info (including name, business name, address and phone number/account number) |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/department/{departmentId}/members
|
||||||||||||||||||||||||||
Assign Multiple Department Members | Adds and/or removes multiple call queue members |
|||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/department/bulk-assign
|
Call Recordings
Method | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Call Recording | Returns call recordings by ID(s). |
|||||||||||||||
GET /restapi/v1.0/account/{accountId}/recording/{recordingId}
|
||||||||||||||||
Get Call Recordings Data | Returns media content of a call recording. |
|||||||||||||||
GET /restapi/v1.0/account/{accountId}/recording/{recordingId}/content
|
Call Routing
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create IVR Prompts | Creates an IVR prompt. |
||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/ivr-prompts
|
|||||||||||||||||||||
Get IVR Prompt List | Returns the list of IVR prompts. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/ivr-prompts |
|||||||||||||||||||||
Get IVR Prompt | Returns an IVR prompt by ID. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}
|
|||||||||||||||||||||
Delete IVR Prompt | Deletes an IVR prompt by ID. |
||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}
|
|||||||||||||||||||||
Update IVR Prompt | Updates an IVR prompt by ID |
||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}
|
|||||||||||||||||||||
Get IVR Prompt Content | Returns media content of an IVR prompt by ID. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/ivr-prompts/{promptId}/content
|
|||||||||||||||||||||
Create IVR Menu | Creates a company IVR menu. |
||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/ivr-menus
|
|||||||||||||||||||||
Get IVR Menu | Returns a company IVR menu by ID. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}
|
|||||||||||||||||||||
Update IVR Menu | Updates a company IVR menu by ID. |
||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/ivr-menus/{ivrMenuId}
|
Chats
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Chats | Returns the list of chats where the user is a member and also public teams that can be joined. All records in response are sorted by creation time of a chat in ascending order. |
||||||||||||||||||||
|
|||||||||||||||||||||
Get Chat | Returns information about a chat by ID. |
||||||||||||||||||||
GET /restapi/v1.0/glip/chats/{chatId} |
|||||||||||||||||||||
Get Recent Chats | Returns recent chats where the user is a member. All records in response are sorted by the |
||||||||||||||||||||
GET /restapi/v1.0/glip/recent/chats
|
|||||||||||||||||||||
Get Favorite Chats | Returns a list of the current user's favorite chats. |
||||||||||||||||||||
GET /restapi/v1.0/glip/favorites |
|||||||||||||||||||||
Add Chat to Favorites | Adds the specified chat to the users's list of favorites. |
||||||||||||||||||||
POST /restapi/v1.0/glip/chats/{chatId}/favorite |
|||||||||||||||||||||
Remove Chat from Favorites | Removes the specified chat from the users's list of favorites. |
||||||||||||||||||||
POST /restapi/v1.0/glip/chats/{chatId}/unfavorite |
|||||||||||||||||||||
Mark Chat as Read | Sets the specified chat status to 'Read' for the current user. |
||||||||||||||||||||
POST /restapi/v1.0/glip/chats/{chatId}/read |
|||||||||||||||||||||
Mark Chat as Unread | Sets the specified chat status to 'Unread' for the current user. |
||||||||||||||||||||
POST /restapi/v1.0/glip/chats/{chatId}/unread |
|||||||||||||||||||||
Get User Groups | Returns the list of groups where the user is a member. |
||||||||||||||||||||
|
|||||||||||||||||||||
Create Group | Creates a new private chat/team. |
||||||||||||||||||||
POST /restapi/v1.0/glip/groups |
|||||||||||||||||||||
Get Group | Returns information about a group or multiple groups by their ID(s). Batch request is supported. |
||||||||||||||||||||
GET /restapi/v1.0/glip/groups/{groupId} |
|||||||||||||||||||||
Edit Group Members | Updates group members. Please note: Only groups of 'Team' type can be updated. Currently only one operation at a time (either adding or removal) is supported. |
||||||||||||||||||||
POST /restapi/v1.0/glip/groups/{groupId}/bulk-assign
|
Company
Method | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Account Info | Returns basic information about a particular RingCentral customer account. |
|||||||||||||||
GET /restapi/v1.0/account/{accountId} |
||||||||||||||||
Get Account Business Address | Returns business address of a company. |
|||||||||||||||
GET /restapi/v1.0/account/{accountId}/business-address |
||||||||||||||||
Update Company Business Address | Updates the business address of a company that account is linked to. Batch request is supported. |
|||||||||||||||
PUT /restapi/v1.0/account/{accountId}/business-address
|
||||||||||||||||
Get Account Service Info | Returns the information about service plan, available features and limitations for a particular RingCentral customer account. |
|||||||||||||||
GET /restapi/v1.0/account/{accountId}/service-info |
Conversations
Method | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Conversations | Returns the list of conversations where the user is a member. All records in response are sorted by creation time of a chat in ascending order. |
|||||||||||||||
GET /restapi/v1.0/glip/conversations
|
||||||||||||||||
Create/Open Conversation | Creates a new conversation or opens the existing one. If the conversation already exists, then its ID will be returned in response. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description. If you add a person to the existing conversation, it creates a whole new conversation. |
|||||||||||||||
POST /restapi/v1.0/glip/conversations |
||||||||||||||||
Get Conversation | Returns information about the specified conversation, including the list of conversation participants. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description. If you add a person to the existing conversation, it creates a whole new conversation. |
|||||||||||||||
GET /restapi/v1.0/glip/conversations/{chatId} |
Custom Fields
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Custom Field | Creates custom field attached to the object. |
||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/custom-fields
|
|||||||||||||||||||||
Get Custom Field List | Returns the list of created custom fields. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/custom-fields |
|||||||||||||||||||||
Update Сustom Field | Updates custom field by ID specified in path. |
||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/custom-fields/{fieldId}
|
|||||||||||||||||||||
Delete Custom Field | Deletes custom field(s) by ID(s) with the corresponding values. |
||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/custom-fields/{fieldId}
|
Devices
Method | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Device | Returns account device(s) by their ID(s). |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/device/{deviceId}
|
||||||||||||||||||||||||||
Update Device | Updates account device(s) by their ID(s). |
|||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/device/{deviceId}
|
||||||||||||||||||||||||||
Get Extension Device List | Returns devices of the extension(s) by their ID(s). Batch request is supported |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/device
|
Extensions
Method | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Extension List | Returns the list of extensions created for a particular account. All types of extensions are included in this list. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension
|
|||||||||||||||||||||||||||||||||||||||||
Create Extension | Creates an extension. |
||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension
|
|||||||||||||||||||||||||||||||||||||||||
Get User Template List | Returns the list of user templates for the current account. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/templates
|
|||||||||||||||||||||||||||||||||||||||||
Get User Template | Returns the user template by ID. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/templates/{templateId}
|
External Contacts
Method | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Contact List | Returns user personal contacts. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact
|
|||||||||||||||||||||||||||||||||||||||||
Create Contact | Creates personal user contact. |
||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact
|
|||||||||||||||||||||||||||||||||||||||||
Get Contact | Returns contact(s) by ID(s). Batch request is supported. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
|
|||||||||||||||||||||||||||||||||||||||||
Update Contact | Updates personal contact information by contact ID(s). Batch request is supported |
||||||||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
|
|||||||||||||||||||||||||||||||||||||||||
Delete Contact | Deletes contact(s) by ID(s). Batch request is supported. |
||||||||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book/contact/{contactId}
|
|||||||||||||||||||||||||||||||||||||||||
Address Book Synchronization | Synchronizes user contacts. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/address-book-sync
|
|||||||||||||||||||||||||||||||||||||||||
Get Favorite Contact List | Returns the list of favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records). |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite
|
|||||||||||||||||||||||||||||||||||||||||
Update Favorite Contact List | Updates the list of favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records).Please note: currently personal address book size is limited to 10 000 contacts. |
||||||||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite
|
Fax
Method | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Fax Message | Creates and sends/resends a fax message. Resend can be implemented if sending has failed. Fax attachment size (both single and total) is limited to 50Mb. |
||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/fax
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
Get Fax Cover Page List | Returns fax cover pages available for the current extension. |
||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/fax-cover-page
|
Features
Method | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get User Features | Returns the list of supported features and information on their availability for the current extension. Specific feature(s) might be checked by providing Also, some feature may have some additional parameters, e.g., limits, which are returned in
|
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/features
|
Glip Compliance Exports
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Data Export Task | Creates a task for Glip data export and returns a link at which the exported data will be available in future once the task is implemented. The exported data can be downloaded by calling Get Data Export Task method with the specified task ID. Simultaneously no more than 2 tasks per company can be created. |
||||||||||||||||||||
POST /restapi/v1.0/glip/data-export |
|||||||||||||||||||||
Get Data Export Task List | Returns the list of Glip data export tasks. |
||||||||||||||||||||
GET /restapi/v1.0/glip/data-export
|
|||||||||||||||||||||
Get Data Export Task | Returns the links for downloading Glip data exported within the specified task. If the export task is still in progress, then only the task status will be returned. If the data is ready for downloading, then the list of URLs will be returned. |
||||||||||||||||||||
GET /restapi/v1.0/glip/data-export/{taskId} |
|||||||||||||||||||||
Get Data Export Task Dataset | Returns the specified dataset by ID. Each dataset is a ZIP archive the size of which is limited to 1 Gb. |
||||||||||||||||||||
GET /restapi/v1.0/glip/data-export/{taskId}/datasets/{datasetId}
|
Glip Profile
Glip Webhooks
Internal Contacts
Method | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Search Company Directory Entries | Returns contact information on corporate users of federated accounts according to the specified filtering and ordering. |
||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/directory/entries/search
|
|||||||||||||||||||||||||||||||||||||||||
Get Corporate Directory Entry | Returns contact information on a particular corporate user of a federated account. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/directory/entries/{entryId}
|
|||||||||||||||||||||||||||||||||||||||||
Get Company Directory Entries | Returns contact information on corporate users of federated accounts. Please note: 1. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/directory/entries
|
|||||||||||||||||||||||||||||||||||||||||
Get Account Federation | Returns information on a federation and associated accounts. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/directory/federation
|
Meeting Configuration
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Meeting Service Info | Returns information on dial-in numbers for meetings, support and international dial-in numbers URIs and meeting account information. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/service-info
|
|||||||||||||||||||||
Update Meeting Service Info | Updates personal meeting identifier. |
||||||||||||||||||||
PATCH /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/service-info
|
|||||||||||||||||||||
Get Assistants | Returns assistants information. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/meetings-configuration/assistants
|
|||||||||||||||||||||
Get Assisted Users | Returns assisted users information. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/meetings-configuration/assisted
|
Meeting Management
Method | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Scheduled Meetings | Returns a list of meetings for a particular extension. The list of meetings does not include meetings of 'Instant' type. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting
|
||||||||||||||||||||||||||
Create Meeting | Creates a new meeting. |
|||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting
|
||||||||||||||||||||||||||
Get Meeting Info | Returns a particular meetings details by ID. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}
|
||||||||||||||||||||||||||
Update Meeting | Modifies a particular meeting. |
|||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}
|
||||||||||||||||||||||||||
Delete Meeting | Deletes a scheduled meeting. |
|||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}
|
||||||||||||||||||||||||||
End Meeting | Ends a meetings which is in progress. |
|||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting/{meetingId}/end
|
Meeting Recordings
Method | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Account Meeting Recordings List | Returns the list of meeting recordings for the current account. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/meeting-recordings
|
|||||||||||||||||||||||||||||||||||||||||
Get User Meeting Recordings List | Returns the list of meetings recordings for the current user. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/meeting-recordings
|
Message Exports
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Message Store Report | Creates a task to collect all account messages for a specified time interval. |
||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/message-store-report
|
|||||||||||||||||||||
Get Message Store Report Task | Returns the current status of a task on report creation. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/message-store-report/{taskId}
|
|||||||||||||||||||||
Get Message Store Report Archive | Returns the created report with message data not including attachments. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/message-store-report/{taskId}/archive
|
|||||||||||||||||||||
Get Message Store Report Archive Content | Returns one of the report archives with message contents in application/zip format. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/message-store-report/{taskId}/archive/{archiveId}
|
Message Store
Method | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Message List | Returns the list of messages from an extension mailbox. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Delete Conversation | Deletes conversation(s) by conversation ID(s). Batch request is supported, max number of IDs passed as query/path parameters is 50. Alternative syntax is supported - user converations can be deleted by passing multiple IDs in request body as an array of string, max number of conversation IDs passed in request body is 100. In this case asterisk is used in the path instead of IDs |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get Message | Returns individual message record(s) by the given message ID(s). The length of inbound messages is unlimited. Batch request is supported. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Update Message List | Updates message(s) by ID(s). Currently only message read status can be updated. Batch request is supported, max number of IDs passed as query/path parameters is 50. Alternative syntax is supported - user messages can be updated by passing multiple IDs in request body as an array of string, max number of IDs passed in request body is 1000. In this case asterisk is used in the path instead of IDs |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Delete Message | Deletes message(s) by the given message ID(s). The first call of this method transfers the message to the 'Delete' status. The second call transfers the deleted message to the 'Purged' status. If it is required to make the message 'Purged' immediately (from the first call), then set the query parameter purge to 'True'. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get Message Content | Returns a specific message attachment data as media stream. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Sync Messages | Synchronizes messages. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-sync
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get Message Store Configuration | Returns message store settings. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/message-store-configuration |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Update Message Store Configuration | Updates message store settings. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/message-store-configuration
|
MMS
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create MMS Message | Creates and sends media messages. Sending MMS messages simultaneously to different recipients is limited up to 50 requests per minute; relevant for all client applications. |
||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/mms
|
Notes
Method | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Note | Creates a new note in the specified chat. |
||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/glip/chats/{chatId}/notes
|
|||||||||||||||||||||||||||||||||||||||||
Get Chat Notes | Returns the list of notes created in the specified chat. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/glip/chats/{chatId}/notes
|
|||||||||||||||||||||||||||||||||||||||||
Get Note | Returns the specified note(s). It is possible to fetch up to 50 notes per request. |
||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/glip/notes/{noteId} |
|||||||||||||||||||||||||||||||||||||||||
Update Note | Edits a note. Notes can be edited by any user if posted to a chat the user belongs to. |
||||||||||||||||||||||||||||||||||||||||
PATCH /restapi/v1.0/glip/notes/{noteId}
|
|||||||||||||||||||||||||||||||||||||||||
Delete Note | Deletes the specified note. |
||||||||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/glip/notes/{noteId} |
|||||||||||||||||||||||||||||||||||||||||
Lock Note | Locks a note providing the user with the unique write access for 5 hours. |
||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/glip/notes/{noteId}/lock |
|||||||||||||||||||||||||||||||||||||||||
Unlock Note | Unlocks a note letting other users edit this note. Once the note is locked (by another user) it cannot be unlocked during 5 hours since the lock datetime. |
||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/glip/notes/{noteId}/unlock |
|||||||||||||||||||||||||||||||||||||||||
Publish Note | Publishes a note making it visible to other users. |
||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/glip/notes/{noteId}/publish |
OAuth 2.0
Method | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Authorize | Returns a link to a login page location. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Revoke Token | Revokes access/refresh token. Requests to this endpoint must be authenticated with HTTP Basic scheme using the application key and application secret as login and password, correspondingly. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get Token | Returns access tokens for making API requests |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Pager Messages
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Create Internal Text Message | Creates and sends an internal text message. |
||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/company-pager
|
Paging Only Groups
Method | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Paging Group Users | Returns the list of users allowed to page this group. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/users
|
||||||||||||||||||||||||||
Get Paging Group Devices | Returns the list of paging devices assigned to this group. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/devices
|
||||||||||||||||||||||||||
Assign Paging Group Users and Devices | Adds and/or removes paging group users and devices. |
|||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/bulk-assign
|
Phone Numbers
Method | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Extension Phone Number List | Returns the list of phone numbers that are used by a particular extension, and can be filtered by the phone number type. The returned list contains all numbers which are directly mapped to a given extension plus the features and also company-level numbers which may be used when performing different operations on behalf of this extension. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/phone-number
|
||||||||||||||||||||||||||||||||||||
Get Company Phone Number List | Returns the list of phone numbers assigned to RingCentral customer account. Both company-level and extension-level numbers are returned. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/phone-number
|
||||||||||||||||||||||||||||||||||||
Get Phone Number | Returns the phone number(s) belonging to a certain account or extension by phoneNumberId(s). Batch request is supported. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/phone-number/{phoneNumberId}
|
||||||||||||||||||||||||||||||||||||
Parse Phone Number | Returns one or more parsed and/or formatted phone numbers that are passed as a string. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/number-parser/parse
|
Posts
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Post | Returns information about the specified post. |
||||||||||||||||||||
GET /restapi/v1.0/glip/chats/{chatId}/posts/{postId}
|
|||||||||||||||||||||
Update Post | Updates a specific post within a chat. |
||||||||||||||||||||
PATCH /restapi/v1.0/glip/chats/{chatId}/posts/{postId}
|
|||||||||||||||||||||
Delete Post | Deletes the specified post from the chat. |
||||||||||||||||||||
DELETE /restapi/v1.0/glip/chats/{chatId}/posts/{postId}
|
|||||||||||||||||||||
Get Posts | Returns a list of posts from the specified chat. |
||||||||||||||||||||
GET /restapi/v1.0/glip/chats/{chatId}/posts
|
|||||||||||||||||||||
Create Post | Creates a post within the specified chat. Attachments are supported. |
||||||||||||||||||||
POST /restapi/v1.0/glip/chats/{chatId}/posts
|
|||||||||||||||||||||
Get Group Posts | Returns posts which are available for the current user by group ID. |
||||||||||||||||||||
GET /restapi/v1.0/glip/groups/{groupId}/posts
|
|||||||||||||||||||||
Create Post in Group | Creates a new post in a group specified. |
||||||||||||||||||||
POST /restapi/v1.0/glip/groups/{groupId}/posts
|
|||||||||||||||||||||
Update Post | Modifies text of a post. |
||||||||||||||||||||
PUT /restapi/v1.0/glip/groups/{groupId}/posts/{postId}/text
|
|||||||||||||||||||||
Create Card | Creates a new message. |
||||||||||||||||||||
|
|||||||||||||||||||||
Get Card | Returns card(s) with given id(s). |
||||||||||||||||||||
GET /restapi/v1.0/glip/cards/{cardId} |
|||||||||||||||||||||
Update Card | Updates a card. |
||||||||||||||||||||
PUT /restapi/v1.0/glip/cards/{cardId}
|
|||||||||||||||||||||
Delete Card | Deletes a card by ID. |
||||||||||||||||||||
DELETE /restapi/v1.0/glip/cards/{cardId} |
|||||||||||||||||||||
Get Posts | Returns posts available for the current user by group ID. |
||||||||||||||||||||
|
|||||||||||||||||||||
Create Post | Creates a post. |
||||||||||||||||||||
|
Presence
Method | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get User Presence Status | Returns presence status of an extension or several extensions by their ID(s). Batch request is supported. The 'presenceStatus' is returned as Offline (the parameters 'telephonyStatus', 'message', 'userStatus' and 'dndStatus' are not returned at all) for the following extension types: Department/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location.If the user requests his/her own presence status, the response contains actual presence status even if the status publication is turned off. Batch request is supported. For batch requests the number of extensions in one request is limited to 30. If more extensions are included in the request, the error code 400 Bad Request is returned with the logical error code InvalidMultipartRequest and the corresponding message 'Extension Presence Info multipart request is limited to 30 extensions'. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence
|
|||||||||||||||||||||||||||||||
Update User Presence Status | Updates user-defined extension presence status, status message and DnD status by extension ID. Supported for regular User extensions only. The extension types listed do not support presence status: Department, Announcement Only, Take Messages Only (Voicemail), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension. |
||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/presence
|
|||||||||||||||||||||||||||||||
Get User Presence Status List | Returns presence status of all extensions of an account. Please note: The presenceStatus is returned as Offline (the parameters telephonyStatus, message, userStatus and dndStatus are not returned at all) for the following extension types: Department, Announcement Only, Voicemail (Take Messages Only), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/presence
|
|||||||||||||||||||||||||||||||
Get Unified Presence | Returns the unified presence status of the requested user(s). The set of parameters returned by this method differs whether you return the requester's presence or any other user presence. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/unified-presence
|
|||||||||||||||||||||||||||||||
Update Unified Presence | Updates the unified presence for the current user specified in path. |
||||||||||||||||||||||||||||||
PATCH /restapi/v1.0/account/{accountId}/extension/{extensionId}/unified-presence
|
Regional Settings
Method | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Language List | Returns the information about supported languages. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/language |
||||||||||||||||||||||||||||||||||||
Get Language | Returns language by ID. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/language/{languageId} |
||||||||||||||||||||||||||||||||||||
Get Country List | Returns all the countries available for calling. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/country
|
||||||||||||||||||||||||||||||||||||
Get Country | Returns the information on a specific country. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/country/{countryId} |
||||||||||||||||||||||||||||||||||||
Get Location List | Returns all available locations for a certain state. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/location
|
||||||||||||||||||||||||||||||||||||
Get States List | Returns all the states of a certain country |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/state
|
||||||||||||||||||||||||||||||||||||
Get State | Returns the information on a specific state. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/state/{stateId} |
||||||||||||||||||||||||||||||||||||
Get Timezone List | Returns all available timezones. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/timezone
|
||||||||||||||||||||||||||||||||||||
Get Timezone | Returns the information on a certain timezone. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/timezone/{timezoneId}
|
RingOut
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Make RingOut Call | Makes a 2-leg RingOut call. |
||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out
|
|||||||||||||||||||||
Get RingOut Call Status | Returns the status of a 2-leg RingOut call. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}
|
|||||||||||||||||||||
Cancel RingOut Call | Cancels a 2-leg RingOut call. |
||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}
|
|||||||||||||||||||||
Make RingOut Call | Makes a 2-leg RingOut call. |
||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout
|
|||||||||||||||||||||
Get RingOut Call Status | Returns status of a 2-leg RingOut call. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId}
|
|||||||||||||||||||||
Cancel RingOut Call | Cancels a 2-leg RingOut call. |
||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}/ringout/{ringoutId}
|
Rule Management
Method | Description | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Call Handling Rules | Returns the extension answering rules. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule
|
||||||||||||||||||||||||||||||||||||
Create Call Handling Rule | Creates a custom answering rule for a particular caller ID. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule
|
||||||||||||||||||||||||||||||||||||
Get Call Handling Rule | Returns an answering rule by ID. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
|
||||||||||||||||||||||||||||||||||||
Update Call Handling Rule | Updates a custom answering rule for a particular caller ID. |
|||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
|
||||||||||||||||||||||||||||||||||||
Delete Call Handling Rule | Deletes a custom answering rule by a particular ID. |
|||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
|
||||||||||||||||||||||||||||||||||||
Create Company Call Handling Rule | Creates a company answering rule for a particular caller ID. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/answering-rule
|
||||||||||||||||||||||||||||||||||||
Get Company Call Handling Rule List | Returns a list of company answering rules. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/answering-rule
|
||||||||||||||||||||||||||||||||||||
Get Company Call Handling Rule | Returns a company answering rule by ID. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/answering-rule/{ruleId}
|
||||||||||||||||||||||||||||||||||||
Update Company Call Handling Rule | Updates a company answering rule. |
|||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/answering-rule/{ruleId}
|
||||||||||||||||||||||||||||||||||||
Delete Company Call Handling Rule | Deletes a company custom answering rule by a particular ID. |
|||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/answering-rule/{ruleId}
|
||||||||||||||||||||||||||||||||||||
Get Standard Greeting List | Returns the list of predefined standard greetings. Custom greetings recorded by user are not returned in response to this request. See Get Extension Custom Greetings. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/greeting
|
||||||||||||||||||||||||||||||||||||
Get Standard Greeting | Returns a standard greeting by ID. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/dictionary/greeting/{greetingId} |
||||||||||||||||||||||||||||||||||||
Create Company Greeting | Creates a custom company greeting. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/greeting
|
||||||||||||||||||||||||||||||||||||
Create Custom User Greeting | Creates custom greeting for an extension user. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting
|
||||||||||||||||||||||||||||||||||||
Get Custom Greeting | Returns a custom user greeting by ID. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/greeting/{greetingId}
|
||||||||||||||||||||||||||||||||||||
Get Call Recording Settings | Returns call recording settings. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/call-recording |
||||||||||||||||||||||||||||||||||||
Update Call Recording Settings | Updates current call recording settings. |
|||||||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/call-recording
|
||||||||||||||||||||||||||||||||||||
Get Call Recording Extension List | Returns the list of extensions to be recorded. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/call-recording/extensions |
||||||||||||||||||||||||||||||||||||
Update Call Recording Extension List | Creates or updates the list of extensions to be recorded. |
|||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/call-recording/bulk-assign
|
||||||||||||||||||||||||||||||||||||
Get Call Recording Custom Greeting List | Returns call recording custom greetings. |
|||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/call-recording/custom-greetings
|
||||||||||||||||||||||||||||||||||||
Delete Call Recording Custom Greeting List | Deletes call recording custom greetings. |
|||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/call-recording/custom-greetings |
||||||||||||||||||||||||||||||||||||
Delete Call Recording Custom Greeting | Deletes call recording custom greeting(s). |
|||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/call-recording/custom-greetings/{greetingId}
|
SCIM
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Check Health | |||||||||||||||||||||
|
|||||||||||||||||||||
Check Health | |||||||||||||||||||||
|
|||||||||||||||||||||
Get Service Provider Config | |||||||||||||||||||||
GET /scim/v2/ServiceProviderConfig |
|||||||||||||||||||||
Get Service Provider Config | |||||||||||||||||||||
GET /scim/ServiceProviderConfig |
|||||||||||||||||||||
Search/List Users | |||||||||||||||||||||
|
|||||||||||||||||||||
Create User | |||||||||||||||||||||
|
|||||||||||||||||||||
Search/List Users | |||||||||||||||||||||
|
|||||||||||||||||||||
Create User | |||||||||||||||||||||
|
|||||||||||||||||||||
Search/List Users | |||||||||||||||||||||
|
|||||||||||||||||||||
Get User | |||||||||||||||||||||
|
|||||||||||||||||||||
Update/Replace User | |||||||||||||||||||||
|
|||||||||||||||||||||
Delete User | |||||||||||||||||||||
|
|||||||||||||||||||||
Update/Patch User | |||||||||||||||||||||
|
SIP
Method | Description |
---|---|
Register SIP Device | Creates SIP registration of a device/application (WebPhone, Mobile, softphone) |
POST /restapi/v1.0/client-info/sip-provision |
SMS
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Send SMS | Creates and sends a new text message. You can send SMS messages simultaneously to different recipients up to 40 requests per minute; this limitation is relevant for all client applications. Sending and receiving SMS is available for Toll-Free Numbers within the USA. You can send up to 10 attachments in one MMS message; the size of all attachments linked is limited to 1500000 bytes. |
||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/sms
|
Subscriptions
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Subscriptions | Returns a list of subscriptions created by a particular user on a particular client app. |
||||||||||||||||||||
GET /restapi/v1.0/subscription |
|||||||||||||||||||||
Create Subscription | Creates a new subscription. |
||||||||||||||||||||
POST /restapi/v1.0/subscription |
|||||||||||||||||||||
Get Subscription | Returns the requested subscription. |
||||||||||||||||||||
GET /restapi/v1.0/subscription/{subscriptionId} |
|||||||||||||||||||||
Renew Subscription / Update Event Filters | Renews the existent subscription if the request body is empty. If event filters are specified, calling this method modifies the event filters for the existing subscription. The client application can extend or narrow the events for which it receives notifications in the frame of one subscription. |
||||||||||||||||||||
PUT /restapi/v1.0/subscription/{subscriptionId}
|
|||||||||||||||||||||
Cancel Subscription | Cancels the existent subscription. |
||||||||||||||||||||
DELETE /restapi/v1.0/subscription/{subscriptionId} |
|||||||||||||||||||||
Renew Subscription | Renews an existent subscription by ID by posting request with an empty body. |
||||||||||||||||||||
POST /restapi/v1.0/subscription/{subscriptionId}/renew |
Tasks
Method | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Chat Tasks | Returns the list of tasks of the specified chat. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/glip/chats/{chatId}/tasks
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Create Task | Creates a task in the specified chat. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/glip/chats/{chatId}/tasks
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Get Task | Returns information about the specified task(s) by ID(s). |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
GET /restapi/v1.0/glip/tasks/{taskId} |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Patch Task | Updates the specified task by ID. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
PATCH /restapi/v1.0/glip/tasks/{taskId}
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Delete Task | Deletes the specified task. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/glip/tasks/{taskId} |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Complete Task | Completes a task in the specified chat. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
POST /restapi/v1.0/glip/tasks/{taskId}/complete
|
Teams
Method | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Teams | Returns the list of teams where the user is a member (both archived and active) combined with a list of public teams that can be joined by the current user. All records in response are sorted by creation time of a chat in ascending order. |
|||||||||||||||
|
||||||||||||||||
Create Team | Creates a team, and adds a list of people to the team. |
|||||||||||||||
|
||||||||||||||||
Get Team | Returns information about the specified team. |
|||||||||||||||
GET /restapi/v1.0/glip/teams/{chatId} |
||||||||||||||||
Update Team | Updates the name and description of the specified team. |
|||||||||||||||
PATCH /restapi/v1.0/glip/teams/{chatId}
|
||||||||||||||||
Delete Team | Deletes the specified team. |
|||||||||||||||
DELETE /restapi/v1.0/glip/teams/{chatId} |
||||||||||||||||
Join Team | Adds the current user to the specified team. |
|||||||||||||||
POST /restapi/v1.0/glip/teams/{chatId}/join |
||||||||||||||||
Leave Team | Removes the current user from the specified team. |
|||||||||||||||
POST /restapi/v1.0/glip/teams/{chatId}/leave |
||||||||||||||||
Add Team Members | Adds members to the specified team. |
|||||||||||||||
POST /restapi/v1.0/glip/teams/{chatId}/add
|
||||||||||||||||
Remove Team Members | Removes members from the specified team. |
|||||||||||||||
POST /restapi/v1.0/glip/teams/{chatId}/remove
|
||||||||||||||||
Archive Team | Changes the status of the specified team to 'Archived'. |
|||||||||||||||
POST /restapi/v1.0/glip/teams/{chatId}/archive |
||||||||||||||||
Unarchive Team | Changes the status of the specified team to 'Active'. |
|||||||||||||||
POST /restapi/v1.0/glip/teams/{chatId}/unarchive |
||||||||||||||||
Get Everyone Chat | Returns information about Everyone chat. |
|||||||||||||||
GET /restapi/v1.0/glip/everyone |
||||||||||||||||
Update Everyone Сhat | Updates Everyone chat information. |
|||||||||||||||
PATCH /restapi/v1.0/glip/everyone |
User Permissions
Method | Description | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Authorization Profile | Returns a list of user permissions granted at authorization procedure. Please note: Some permissions may be restricted by extension type. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile
|
||||||||||||||||||||||||||
Check User Permission | Checks if a certain user permission is activated for a particular extension. |
|||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/authz-profile/check
|
User Settings
Method | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get Extension | Returns basic information about a particular extension. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}
|
|||||||||||||||||||||||||||||||
Update Extension | Updates user settings. |
||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}
|
|||||||||||||||||||||||||||||||
Delete Extension | Deletes extension(s) by ID(s). |
||||||||||||||||||||||||||||||
DELETE /restapi/v1.0/account/{accountId}/extension/{extensionId}
|
|||||||||||||||||||||||||||||||
Get Extension Caller ID | Returns information on an outbound caller ID of an extension. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id
|
|||||||||||||||||||||||||||||||
Update Extension Caller ID | Updates outbound caller ID information of an extension. |
||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-id
|
|||||||||||||||||||||||||||||||
Get Extension Grant List | Returns the list of extensions with the information on grants given to the current extension regarding them. Currently the list of grants include: picking up a call, monitoring, calling or receiving a call on behalf of somebody, call delegation and calling paging groups. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/grant
|
|||||||||||||||||||||||||||||||
Get Notification Settings | Returns notification settings for the current extension. Knowledge Article: User Settings - Set up Message Notifications |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings
|
|||||||||||||||||||||||||||||||
Update Notification Settings | Updates notification settings for the current extension. Knowledge Article: User Settings - Set up Message Notifications |
||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/notification-settings
|
|||||||||||||||||||||||||||||||
Get User Profile Image | Returns a profile image of an extension. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image
|
|||||||||||||||||||||||||||||||
Upload User Profile Image | Uploads the extension profile image. |
||||||||||||||||||||||||||||||
POST /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image
|
|||||||||||||||||||||||||||||||
Update User Profile Image | Updates the extension profile image |
||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image
|
|||||||||||||||||||||||||||||||
Get Scaled User Profile Image | Returns scaled profile image of an extension. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/profile-image/{scaleSize}
|
|||||||||||||||||||||||||||||||
Get User Conferencing Settings | Returns the information on the Free Conference Calling (FCC) feature for a given extension. |
||||||||||||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing
|
|||||||||||||||||||||||||||||||
Update User Conferencing Settings | Updates the default conferencing number for the current extension. The number can be selected from conferencing numbers of the current extension. Updates the setting, allowing participants join the conference before host. |
||||||||||||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/conferencing
|
Video Configuration
Method | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get User Video Configuration | Returns information about video configuration of the current user. |
||||||||||||||||||||
GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/video-configuration
|
|||||||||||||||||||||
Update User Video Configuration | Allows to update user video settings, for example video provider. |
||||||||||||||||||||
PUT /restapi/v1.0/account/{accountId}/extension/{extensionId}/video-configuration
|