All URIs are relative to https://platform.devtest.ringcentral.com
| Method | HTTP request | Description |
|---|---|---|
| CreateSubscription | Post /restapi/v1.0/subscription | Create Subscription |
| DeleteSubscription | Delete /restapi/v1.0/subscription/{subscriptionId} | Cancel Subscription |
| GetSubscriptions | Get /restapi/v1.0/subscription | Get Subscriptions |
| LoadSubscription | Get /restapi/v1.0/subscription/{subscriptionId} | Get Subscription |
| RenewSubscription | Post /restapi/v1.0/subscription/{subscriptionId}/renew | Renew Subscription |
| UpdateSubscription | Put /restapi/v1.0/subscription/{subscriptionId} | Renew Subscription / Update Event Filters |
SubscriptionInfo CreateSubscription(ctx, createSubscriptionRequest) Create Subscription
Since 1.0.6 (Release 5.15)
Creates a new subscription.
Medium
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createSubscriptionRequest | CreateSubscriptionRequest | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteSubscription(ctx, subscriptionId) Cancel Subscription
Cancels the existent subscription.
Medium
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| subscriptionId | string | Internal identifier of a subscription |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RecordsCollectionResourceSubscriptionResponse GetSubscriptions(ctx, ) Get Subscriptions
This endpoint does not need any parameter.
RecordsCollectionResourceSubscriptionResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SubscriptionInfo LoadSubscription(ctx, subscriptionId) Get Subscription
Since 1.0.6 (Release 5.15)
Returns the requested subscription.
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| subscriptionId | int32 | Internal identifier of a subscription |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SubscriptionInfo RenewSubscription(ctx, subscriptionId) Renew Subscription
Since 1.0.26 (Release 8.12)
Renews an existent subscription by ID by posting request with an empty body..
Medium
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| subscriptionId | string |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
SubscriptionInfo UpdateSubscription(ctx, subscriptionId, modifySubscriptionRequest, optional) Renew Subscription / Update Event Filters
Since 1.0.6 (Release 5.15)
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.
Medium
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| subscriptionId | string | Internal identifier of a subscription | |
| modifySubscriptionRequest | ModifySubscriptionRequest | JSON body | |
| optional | *UpdateSubscriptionOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a UpdateSubscriptionOpts struct
| Name | Type | Description | Notes |
|---|
aggregated | optional.Bool| If 'True' then aggregated presence status is returned in a notification payload |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]