Checking Whether the Current Tenant Space Supports the Click-to-dial Function (checkClickToCallSupport)
Scenario
This interface is invoked to check whether the click-to-dial function is supported.
Method
GET
URI
https://Domain name/apiaccess/ccmessaging/v1/checkClickToCallSupport (For example, the domain name is service.besclouds.com.)
Request Description
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
channel |
String |
Yes |
Recipient channel type (WEB) |
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1 |
ccmessaging-token |
String |
Yes |
Value of ccmessaging-token generated by the applyToken interface |
2 |
x-app-key |
String |
Yes |
App key, which is the user ID and is configured on the API Fabric |
3 |
Authorization |
String |
Yes |
Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.) |
Response Description
- Status code: 200
No. |
Parameter |
Type |
Mandatory or Not |
Description |
---|---|---|---|---|
1.1 |
webRTCSupported |
Boolean |
No |
Whether WebRTC is supported |
1.2 |
clickToCallSupported |
Boolean |
No |
Whether the click-to-dial function is supported |
1.3 |
resultCode |
String |
No |
Response result code |
1.4 |
resultDesc |
String |
No |
Response result description |
- Status code: 400
Incorrect request. Check the request path and parameters.
- Status code: 401
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.
- Status code: 404
The requested content is not found. Check the request path.
- Status code: 500
Business failure. Check the values of parameters in the request.
Error Codes
None
Example
- Scenario: Check whether the click-to-dial function is supported.
URL: https://Domain name/apiaccess/ccmessaging/v1/checkClickToCallSupport
Request header:
ccmessaging-token: XXXXXXXXX x-app-key: XXXXXXXXX Authorization: XXXXXXXXX
Request parameters:
{ "channel": "WEB" }
Response parameters:
{ "resultCode": "0", "resultDesc": "", "webRTCSupported": true, "clickToCallSupported": true }
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot