Company

Get company details

Retrieve information about this company. A company represents your Kaleyra Video instance and includes global configurations. See <a href="https://developers.kaleyra.io/reference/video-important-concepts#company">this page</a> for more information.

get/v2/company

Request

  • Base URL
    https://api.sandbox.eu.bandyer.com
  • URL
    https://api.sandbox.eu.bandyer.com/v2/company
  • Auth
    API key in header apikey

Response

namestring

Name of the company.

default_language'en' | 'it' | 'es' | 'pt'

Default language of the company and users created.

end_call_redirect_urlstring nullable

End call redirection URL.

end_call_redirect_timeout_msinteger

End call redirection timeout.

user_details_provider_urlstring nullable

Endpoint of the service that provides user details (display name and avatar) of users. See <a href='https://developers.kaleyra.io/reference/video-server-side-user-details-provider'>this page</a> for more information. The response body of this service is treated as PII/PHI

max_plus_usersinteger

The maximum number of plus users a company can have. A value of 0 indicates unlimited capacity for plus users.

current_month_plus_usersinteger

Currently enabled Plus Users for the ongoing month

Example response

{
  "name": "Kaleyra",
  "default_background": {
    "creation_date": "2023-01-01T00:00:00Z"
  },
  "end_call_redirect_timeout_ms": 5000
}

Changes

No recorded changes to this operation across all 1 revision of this API.