Before You Start

Updated on 2025-02-11 GMT+08:00

View PDF

Based on smart engine scheduling and device-cloud collaboration, KooPhone provides efficient cloud phone interaction and rich applications running the cloud OS, builds a prosperous application ecosystem, and delivers a satisfactory user experience with low costs.

This document describes how to use application programming interfaces (APIs) to perform operations on KooPhone. For example, video settings and batch reset. For details about all supported operations, see API Overview.

If you plan to access KooPhone through an API, ensure that you are familiar with KooPhone concepts. For details, see KooPhone Service Overview. Furthermore, KooPhone supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

Endpoints

An endpoint is the request address for calling an API. Endpoints vary depending on services and regions.

Concepts

Account
An account is created upon successful registration with the cloud system. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity, which should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them the appropriate permissions for routine management.
User
A user is created using an account to use cloud services. Each user has its own identity credentials (password and access keys).

The account name, username, and password will be required for API authentication.
Region
Regions are divided based on geographical location and network latency. Public services, such as Elastic Cloud Server (ECS), Elastic Volume Service (EVS), Object Storage Service (OBS), Virtual Private Cloud (VPC), Elastic IP (EIP), and Image Management Service (IMS), are shared within the same region. Regions are classified into universal regions and dedicated regions. A universal region provides universal cloud services for common tenants. A dedicated region provides specific services for specific tenants.

For details, see Region and AZ.
AZ
An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.