Web Call
Update Web Call Application
Update configuration settings of a web call application
Update
Details
| Description | The "Update" Endpoint enables users to update the configuration settings of a web call application. This functionality allows for adjustments to be made to various parameters and settings associated with the application. |
|---|---|
| HTTP Method | PUT |
| Endpoint URL | https://platform.innocalls.com/v1/api-gateway/web-call/:id |
| 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 Parameters
| Parameter | Description | Location | Constrains |
|---|---|---|---|
| id | The appId that obtained from the initiation process | Path | Required |
| iconText | Text displayed as the icon for the application | Body | Required |
| iconBackgroundColor | Background color of the application's icon | Body | Required Hexadecimal Color |
| iconBaseColor | Base color of the application's icon | Body | Required Hexadecimal Color |
| iconFontColor | Font color of the application's icon | Body | Required Hexadecimal Color |
| concurrentCalls | Maximum number of concurrent calls allowed for the application | Body | Required Integer Min: 1 |
| callerId | The phone number that will appear when the application makes calls | Body | Required Numeric Digits |
| destinationNumber | The phone number that receives incoming calls | Body | Required E.164 format |
Request Example
curl --request PUT 'https://platform.innocalls.com/api/v1/api-gateway/web-call/:id' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <base64-encoded string apiId:apiSecret>' \
--data '{
"callerId": "966xxxxxxxxx",
"iconText": "Call Us",
"iconBackgroundColor": "#fff",
"iconBaseColor": "#eee",
"iconFontColor": "#EEE",
"destinationNumber": "+2012xxxxxxxx",
"concurrentCalls": 1
}'Success Response Example
A successful response is indicated by the HTTP status code 204.
Possible Errors
| Error Code | Description |
|---|---|
| 401 Unauthorized | Invalid Credential |
| 403 Forbidden | Not Enough Permissions to access the resource |
| 400 BadRequest | This error occurs due to malformed or invalid request parameters |
| 429 Too Many Requests | This occurs when requests exceed the rate limit |
| 404 Not Found | This occurs when the web call application not found |
