WebrtcCredentials
WebRTC Extensions Credentials
Retrieve extension credentials for InnoCallsRTC usage
Extension Retrieval
To access the resources necessary for utilizing InnoCallsRTC, you'll need to interact with the "Extensions" endpoint. This endpoint provides essential information required for InnoCallsRTC functionalities.
Details
| Description | The "Extensions" endpoint allows you to retrieve extensions information necessary for InnoCallsRTC usage. |
|---|---|
| HTTP Method | GET |
| Endpoint URL | https://platform.innocalls.com/api/v1/api-gateway/web-rtc/extensions |
| Authorization | To access the API endpoints, you need to authenticate using API keys and API secrets. The API supports Basic Authentication for authorization. You need to include your API ID as the username and your API secret as the password in the HTTP header when making requests. Replace API_ID with your API ID and API_SECRET with your API secret, separated by a colon (:). The value after Basic is the Base64 encoding of your API key and API secret concatenated with a colon. |
| Rate Limit | 3 requests per second |
Request Example
curl 'https://platform.innocalls.com/api/v1/api-gateway/web-rtc/extensions' \
--header 'Authorization: Basic <base64-encoded string apiId:apiSecret>'Success Response Example
{
"data": {
"extensions": [
{
"extensionNumber": "EXTENSION_NUMBER",
"webRTCSecret": "WEB_RTC_SECRET",
"status": "EXTENSION_STATUS"
}
]
}
}Description
This response indicates a successful retrieval of extension details.
extensions: array contains information about each extension record.extensionNumber: The extension number required for logging into WebRTC.status: The status of the extension (enabled, disabled, or pending).webRTCSecret: The extension secret required in WebRTC.
Possible Errors
| Error Code | Description |
|---|---|
| 401 Unauthorized | Invalid Credential |
| 403 Forbidden | Not Enough Permissions to access the resource |
| 429 Too Many Requests | This occurs when requests exceed the rate limit |
| 400 BadRequest | This error occurs due to malformed or invalid request parameters |
