List Web Call Applications

List

Details

Request Example

curl 'https://platform.innocalls.com/api/v1/api-gateway/web-call/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <base64-encoded string  apiId:apiSecret>'

Success Response Example

{
  "data": {
    "apps": [
      {
        "id": "APP_UNIQUE_IDENTIFIER",
        "iconText": "ICON_TEXT_OF_APP",
        "iconBackgroundColor": "ICON_BACKGROUND_COLOR_OF_APP",
        "iconBaseColor": "ICON_BASE_COLOR_OF_APP",
        "iconFontColor": "ICON_FONT_COLOR_OF_APP",
        "destinationNumber": "DESTINATION_NUMBER",
        "concurrentCalls": "CONCURRENT_CALLS_THAT_ALLOWED_OF_APP",
        "serviceEnabled": "APP_SERVICE_ENABLE_OR_NOT",
        "domains": ["ALLOWED_ORIGINS"],
        "callerId": "CALLER_ID_THAT_WILL_APPEAR"
      }
    ]
  }
}

Description

This JSON response signifies a successful retrieval of app details. It contains an array of objects, where each object represents a web call application along with its associated attributes. Here's a breakdown of the key attributes:

• id: Unique identifier for the application.
• iconText: Text displayed as the icon for the application.
• iconBackgroundColor: Background color of the application's icon.
• iconBaseColor: Base color of the application's icon.
• iconFontColor: Font color of the application's icon.
• destinationNumber: The phone number that receives incoming calls.
• concurrentCalls: Maximum number of concurrent calls allowed for the application.
• serviceEnabled: Indicates whether the service of the application is enabled or not.
• domains: List of allowed origins or domains for the application.
• callerId: The phone number that will appear when the application makes calls.

Possible Errors