All URIs are relative to https://platform.devtest.ringcentral.com
| Method | HTTP request | Description |
|---|---|---|
| CreateSipRegistration | Post /restapi/v1.0/client-info/sip-provision | Register SIP Device |
| DeleteCustomData | Delete /restapi/v1.0/client-info/custom-data/{key} | Delete Custom Data |
| GetAttachment | Get /restapi/v1.0/client-info/custom-data/{key}/content | Get Custom Data Attachment |
| GetCustomData | Get /restapi/v1.0/client-info/custom-data/{key} | Get Custom Data |
| GetInProductMessage | Get /restapi/v1.0/client-info/banners | Get In Product Message List |
| GetSpecialNumberRules | Get /restapi/v1.0/client-info/special-number-rule | Get Special Numbers Calling Limitation |
| LoadClientInfo | Get /restapi/v1.0/client-info | Get App Settings |
| LoadPhoneData | Get /restapi/v1.0/number-parser/phonedata.xml | Get Phonedata |
| UpdateCustomData | Put /restapi/v1.0/client-info/custom-data/{key} | Create/Update Custom Data |
CreateSipRegistrationResponse CreateSipRegistration(ctx, createSipRegistrationRequest) Register SIP Device
Since 1.0.16 (Release 7.1)
Creates SIP registration of a device/application (WebPhone, Mobile, softphone)
| Permission | Description |
|---|---|
| VoipCalling | Registering as VoIP device and making VoIP calls |
Heavy
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| createSipRegistrationRequest | CreateSipRegistrationRequest | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteCustomData(ctx, key) Delete Custom Data
Since 1.0.14 (Release 6.6)
Deletes custom data by its ID.| Permission | Description |
|---|---|
| EditCustomData | Viewing and updating client custom data (key-value) |
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| key | int32 | Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetAttachment(ctx, key, optional) Get Custom Data Attachment
Since 1.0.14 (Release 6.6)
Returns custom data attachment by ID.| Permission | Description |
|---|---|
| EditCustomData | Viewing and updating client custom data (key-value) |
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| key | string | ||
| optional | *GetAttachmentOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetAttachmentOpts struct
| Name | Type | Description | Notes |
|---|
range_ | optional.String| |
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CustomDataResource GetCustomData(ctx, key) Get Custom Data
Since 1.0.14 (Release 6.6)
Returns custom data of a logged-in extension.| Permission | Description |
|---|---|
| EditCustomData | Viewing and updating client custom data (key-value) |
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| key | int32 | Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
InProductMessages GetInProductMessage(ctx, bannerType) Get In Product Message List
Since 1.0.28 (Release 8.4)
Returns list of in-product messages: learderboards, announcements, etc. Please note: Banners are set on Marketing/Messages tab in Admin Web.
| Permission | Description |
|---|---|
| ReadClientInfo | Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.) |
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| bannerType | string | [default to LeaderBoard] |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NavigationInfo GetSpecialNumberRules(ctx, optional) Get Special Numbers Calling Limitation
Since 1.0.12 (Release 6.4)
Returns available special numbers and rules of processing, depending on account brand and application type (mobile/softphone/web/other). A special number rule for each number includes limitations on the options: VoIP, RingOut, outgoing SMS and Fax. If the option is disallowed, the server returns the reason code and text description.
| Permission | Description |
|---|---|
| ReadClientInfo | Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.) |
Light
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetSpecialNumberRulesOpts | optional parameters | nil if no parameters |
Optional parameters are passed through a pointer to a GetSpecialNumberRulesOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| countryId | optional.Int32 | Internal identifier of a country. If not specified, the response is returned for the brand country |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ClientApiResponse LoadClientInfo(ctx, ) Get App Settings
Since 1.0.11 (Release 6.3)
Returns client application data: general info, specific provisioning parameters, hints, etc.
| Permission | Description |
|---|---|
| ReadClientInfo | Viewing of client application registered attributes and additional helper information (external URLs, hints, etc.) |
This endpoint does not need any parameter.
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
LoadPhoneData(ctx, ) Get Phonedata
Since 1.0.12 (Release 6.4)
Returns configuration settings for phone number parser in a phonedata.xml file.
Medium
This endpoint does not need any parameter.
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CustomDataApiResponse UpdateCustomData(ctx, key, customDataRequest) Create/Update Custom Data
Since 1.0.14 (Release 6.6)
Creates or updates custom data for the extension that is currently logged in.
| Permission | Description |
|---|---|
| EditCustomData | Viewing and updating client custom data (key-value) |
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| key | int32 | Custom data access key. The number of unique custom data keys is limited to 100 keys per extension, summarized for all the applications. For example, if you have created 50 custom data keys under the Android mobile client application for the particular extension, then logged in the iOS application and created another 50 keys, the web client application won't be allowed to create any custom data key for that extension | |
| customDataRequest | CustomDataRequest | JSON body |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]