Jump to main content

| Document Center Yeastar K2 PBX API

V1.1.0
V2.0.0

Support
Free Trial

Yeastar - API

Home
API Interfaces
Paging Group

API Overview
Yeastar K2 VoIP PBX provides API interfaces for you to integrate a 3rd party application server. After the integration, you can achieve variable call features on the 3rd party application server and the PBX will automatically send API reports to the 3rd party application server.
Getting Started
This section is applicable for users who are new to the Yeastar K2 VoIP PBX API. In this section, we introduces the pre-configurations before using the API, API communication methods and protocols, API request structure, and response result.
API Authentication
API Interfaces
- Query PBX Information
  Query PBX information, such as firmware version, system time, etc.
- Extension
- Trunk
- Inbound Routes
- Outbound Route
- IVR
- Queue
- Paging Group
  - Query Paging Group List
    Query the paging groups that has been created on the PBX.
  - Query Paging Group Settings
    Query the settings of a paging group, multiple paging groups, or all paging groups.
  - Add a Paging Group
    Add and configure a paging group.
  - Edit a Paging Group
    Edit the settings of a paging group.
  - Delete a Paging Group
  - Make an Announcement
    Through this interface, call to a paging group, and make a live announcement to the group members, or play a background music to the group members.
  - Stop Paging Group Music
    If the PBX is playing a background music to a paging group, you can stop the background music through this interface.
- Audio Calls
- Play Prompts
- Voicemail
- Download Recording Files
  Get a random string of the recording file, then combine the random string with other parameters to form a download link.
- Download CDR Files
  Get a random string of the CDR file, then combine the random string with other parameters to form a download link.
- Hotel Wake-up Service
API Reports
API Scenarios
Error Code
References of API error codes.

Paging Group