Yeastar P-Series Software Edition

https://help.yeastar.com/en/p-series-software-edition/
Admin
Yeastar P-Series Software Edition is a PBX phone system that provides call management, unified...
Tokens:1,041,556
Snippets:10,431
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Onsite Proxy

Source: https://help.yeastar.com/en/p-series-software-edition/onsite-proxy-guide/install-onsite-proxy.html

Run this command to start the Onsite Proxy installation process. Follow the on-screen prompts to complete the setup.

```bash
onsite-proxy-install
```

--------------------------------

### Execute Yeastar P-Series Software Edition Installation Script

Source: https://help.yeastar.com/en/p-series-software-edition/software-installation-guide/install-yeastar-p-series-software-edition-on-ovhcloud.html

Run this command to start the installation of Yeastar P-Series Software Edition on your OVHcloud instance. The script will perform all necessary setup steps.

```bash
./ovh-install-pse.sh
```

--------------------------------

### Example GET Request for Global Queue Settings

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-global-queue-settings.html

This is an example of a GET request to query global queue settings, including the host and port.

```http
GET /openapi/v1.0/queue_option/get?access_token=kiRFn8ugKJwIArRL9Uq1ly4svdRSDM2Y HTTP/1.1
Host: 192.168.5.150:8088
```

--------------------------------

### Example GET Request to Query Backup File

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-information-of-a-backup-file.html

An example of a GET request to retrieve details for a specific backup file. Ensure the 'file_name' and 'access_token' are correctly provided.

```http
GET /openapi/v1.0/backup/get?access_token=xFMEN8G2cyy6fB38estExBybyguJTOGS9p&file_name=Backup-X.18.0.89-20250313132238-local.bak HTTP/1.1
Host: 192.168.5.150:8088
```

--------------------------------

### Example GET Request for Extension Status Monitoring

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-extension-status-monitoring-settings.html

This example demonstrates a GET request to retrieve extension status monitoring settings, including pagination and sorting parameters.

```http
GET /openapi/v1.0/extension_status_monitor/list?access_token=bZDofvFsZ6oMkZgII195h1BzLa0co5o4&page=1&page_size=4&sort_by=ext_id&order_by=asc HTTP/1.1
Host: 192.168.5.150:8088
```

--------------------------------

### Example Download and Unzip Onsite Proxy

Source: https://help.yeastar.com/en/p-series-software-edition/onsite-proxy-guide/install-onsite-proxy.html

This example demonstrates downloading the x86_64 package to a specific directory and then unzipping it to the root directory.

```bash
wget https://help.yeastar.com/download/docs/onsite-proxy/onsiteproxy-x86_64.tar.gz -O /home/user/Desktop/onsiteproxy.tar.gz
```

```bash
tar -xzf /home/user/Desktop/onsiteproxy.tar.gz -C /
```

--------------------------------

### Example Outbound Route GET Request

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-information-of-an-outbound-route.html

An example of a GET request to query a specific outbound route by its ID.

```http
GET /openapi/v1.0/outbound_route/get?id=11&access_token=nIAuSgDUim0uZgrNuha8hfzwbvY41NWR HTTP/1.1
Host: 192.168.5.150:8088
```

--------------------------------

### Access PBX via Web GUI

Source: https://help.yeastar.com/en/p-series-software-edition/software-installation-guide/install-yeastar-p-series-software-edition-on-vmware-esxi.html

Open a web browser and navigate to the PBX's IP address and port to begin the setup wizard.

```bash
https://192.168.28.45:8088
```

--------------------------------

### Example GET Request for Certificate Information

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-information-of-a-certificate.html

An example of a GET request to retrieve information for a certificate with ID 4.

```http
GET /openapi/v1.0/certificate/get?access_token=mqVLmho7rAPjcXnKSFlv1k3IUhkgKwHH&id=4 HTTP/1.1
Host: 192.168.5.150:8088
```

--------------------------------

### Initiate Onsite Proxy Upgrade

Source: https://help.yeastar.com/en/p-series-software-edition/onsite-proxy-guide/upgrade-onsite-proxy.html

Run this command to start the upgrade process after downloading the new package. Replace `<your_package_path>` with the actual path to the downloaded .tar.gz file.

```bash
onsite-proxy-upgrade <your_package_path>/onsiteproxy.tar.gz
```

--------------------------------

### Example GET Request for Conference List

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-scheduled-conference-list.html

An example of a GET request to retrieve a list of scheduled conferences, specifying page and page size.

```http
GET /openapi/v1.0/conference/list?access_token=4mZxlzE08rl3g7rE7wjoMIowMoVkMvUr&page=1&page_size=5 HTTP/1.1
Host: 192.168.5.150:8088
```

--------------------------------

### Switch to Root Account (Custom/Manual Install ISO)

Source: https://help.yeastar.com/en/p-series-software-edition/software-installation-guide/activate-and-set-up-yeastar-p-series-se-using-xml-configuration-file.html

After logging in with your user account, use these commands to switch to the root account for manual or custom ISO installations.

```bash
sudo -i
```

--------------------------------

### Query Onsite Proxy Instance Information

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-information-of-an-onsite-proxy-instance.html

This example demonstrates how to query the detailed information for a specific Onsite Proxy instance by its ID. Ensure you have the correct instance ID and an access token.

```bash
GET /openapi/v1.0/onsiteproxy/get?id=47&access_token=q0GyBcsgO8FsXWxPpzAJVW33vd0OpnUz HTTP/1.1
Host: 192.168.5.150:8088
```

--------------------------------

### Example GET Request for Company Contact

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-information-of-a-company-contact.html

An example of a GET request to retrieve company contact information, including the host and specific parameters.

```HTTP
GET /openapi/v1.0/company_contact/get?id=4&access_token=6pAmpgdKOOCr1BtI9tCRJpjVXZPdgLYf HTTP/1.1
Host: 192.168.5.150:8088
```

--------------------------------

### Example Query Parameter Key Configuration

Source: https://help.yeastar.com/en/p-series-software-edition/call-flow-designer-guide/http-request.html

This example demonstrates how to dynamically generate a query parameter key using session variables. It's recommended to keep the number of parameters within limits.

```Expression
FX_CONCATENATE("call_to_", $Session.did)
```

--------------------------------

### Start Call Recording Request Example

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/start-call-recording.html

Example of a request to start call recording for extension 2002. The channel_id is crucial for identifying the specific call.

```http
POST /openapi/v1.0/call/record_start?access_token=FOSUNQ8t3J24xiCgszfPRG0PxjUfsb8p HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "channel_id": "PJSIP/2002-00000076"
}
```

--------------------------------

### Example URI Configuration

Source: https://help.yeastar.com/en/p-series-software-edition/call-flow-designer-guide/http-request.html

This example shows how to construct a dynamic URI for an HTTP request, incorporating session variables. Ensure to use the FX_CONCATENATE function for string concatenation.

```Expression
FX_CONCATENATE("https://crm.example.com/check-caller?callernum=",$Session.ani)
```

--------------------------------

### Example Scope Configuration

Source: https://help.yeastar.com/en/p-series-software-edition/integrations/custom-helpdesk-integration/add-a-helpdesk-integration-template.html

This is an example of how to configure the scope for accessing data in the Helpdesk. Multiple fields can be separated by commas.

```text
contacts.read,contacts.write,calls.read,calls.write,user.read,user.write
```

--------------------------------

### Example GET Request to Search Phonebooks

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/search-specific-phonebooks.html

This example demonstrates a GET request to search for phonebooks containing the keyword 'vendor'. It includes the Host header for the request.

```HTTP
GET /openapi/v1.0/phonebook/search?search_value=vendor&access_token=go18MODkNUAOReyKCnKzm6HEr6qTD1Pq HTTP/1.1 
Host: 192.168.5.150:8088
```

--------------------------------

### Example GET Request for Blocked Numbers Search

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/search-specific-blocked-numbers-rules.html

An example of a GET request to search for blocked numbers with a specific search value. This includes the Host header.

```http
GET /openapi/v1.0/block_numbers/search?access_token=iQbvOlCrG2LgsXxDm5nl8vSEhlkogu6p&search_value=ad HTTP/1.1
Host: 192.168.5.150:8088
```

--------------------------------

### Run Yeastar P-Series Software Edition Installation Script

Source: https://help.yeastar.com/en/p-series-software-edition/software-installation-guide/install-yeastar-p-series-software-edition-on-binarylane.html

Execute the installation script to begin the setup of Yeastar P-Series Software Edition. The server may reboot during this process.

```bash
./binarylane-install-pse.sh
```

--------------------------------

### Example GET Request for Outbound Route List

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-outbound-route-list.html

An example of a GET request to the outbound route list API, including query parameters for pagination and sorting.

```http
GET /openapi/v1.0/outbound_route/list?page=1&page_size=20&sort_by=outb_cid&order_by=asc&access_token=nIAuSgDUim0uZgrNuha8hfzwbvY41NWR HTTP/1.1
Host: 192.168.5.150:8088
```

--------------------------------

### Queue Configuration Example

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-information-of-multiple-queues.html

This snippet shows a detailed configuration for a queue, including agent lists, callback settings, and service level agreement (SLA) parameters. It is useful for understanding the full scope of queue settings available.

```json
{
    "id": 3,
    "number": "6402",
    "name": "Tech Support",
    "ring_strategy": "ring_all",
    "moh": "default",
    "max_wait_time": 1800,
    "fail_dest": "end_call",
    "fail_dest_prefix": "",
    "fail_dest_value": "",
    "agent_timeout": 30,
    "retry_time": 30,
    "wrap_up_time": 30,
    "enb_ring_in_use": 0,
    "agent_prompt": "",
    "enb_auto_pause": 0,
    "max_pause_miss_call": 0,
    "enb_email_miss_call": 1,
    "enb_email_abandon_call": 1,
    "enb_email_sla_alarm": 1,
    "callback_enb_request_email": 1,
    "callback_enb_failed_email": 1,
    "max_calls": 3,
    "alert_info": "",
    "enb_leave_empty": 0,
    "enb_disallow_to_join_when_empty": 0,
    "enb_callback": 1,
    "callback_timeout": "queue_max_wait_time",
    "callback_timeout_num": 180,
    "callback_method": "digit",
    "callback_press_key": "1",
    "callback_outbound_prefix": "",
    "callback_trigger_timeout": 0,
    "sla_time": 60,
    "sla_interval": 30,
    "sla_alarm_threshold": 80,
    "join_prompt": "",
    "play_full_join_prompt": 0,
    "ringback_tone": "",
    "enb_announce_agent_id": 0,
    "enb_announce_default_prompt": 1,
    "enb_announce_pos": 1,
    "enb_announce_hold_time": 1,
    "caller_announce_freq": 30,
    "sys_announce_prompt": "",
    "sys_announce_freq": 60,
    "satisfa_survey_prompt": "",
    "press_key": "",
    "key_dest": "end_call",
    "key_dest_prefix": "",
    "key_dest_value": "",
    "dynamic_agent_list": [
        {
            "text": "Leo Ball",
            "text2": "1000",
            "value": "73",
            "type": "extension"
        },
        {
            "text": "Phillip Huff",
            "text2": "1001",
            "value": "85",
            "type": "extension"
        }
    ],
    "static_agent_list": [
        {
            "text": "Madison Cooper",
            "text2": "1004",
            "value": "96",
            "type": "extension"
        },
        {
            "text": "Kevin Connor",
            "text2": "1005",
            "value": "97",
            "type": "extension"
        },
        {
            "text": "Kristin Hale",
            "text2": "1006",
            "value": "92",
            "type": "extension"
        }
    ],
    "manager_list": [
        {
            "text": "Leo Ball",
            "text2": "1000",
            "value": "73",
            "type": "extension"
        }
    ],
    "satisfaction_survey_point_list": [
        {
            "k": "0",
            "p": -5
        },
        {
            "k": "1",
            "p": -2
        },
        {
            "k": "2",
            "p": 0
        },
        {
            "k": "3",
            "p": 2
        },
        {
            "k": "4",
            "p": 5
        },
        {
            "k": "5",
            "p": 1
        },
        {
            "k": "6",
            "p": 1
        },
        {
            "k": "7",
            "p": 1
        },
        {
            "k": "8",
            "p": 1
        },
        {
            "k": "9",
            "p": 1
        },
        {
            "k": "*",
            "p": 1
        }
    ],
    "enb_priority_queue": 0,
    "weight": 0,
    "enb_acceleration_weight": 0,
    "acceleration": 30
}
```

--------------------------------

### Example Request for Backup File List

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-backup-file-list.html

This example demonstrates a GET request to the backup list endpoint with specified query parameters for pagination and sorting.

```http
GET /openapi/v1.0/backup/list?access_token=sTxrM4A46DKnXvmC7MgudkEgPEJABBQ6&page=1&page_size=2&sort_by=file_name&order_by=asc HTTP/1.1 
Host: 192.168.5.150:8088
```

--------------------------------

### Example Request to Get Phonebook Information

Source: https://help.yeastar.com/en/p-series-software-edition/developer-guide/query-information-of-a-phonebook.html

This example demonstrates how to construct a GET request to retrieve phonebook details, including the phonebook ID and access token.

```http
GET /openapi/v1.0/phonebook/get?id=5&access_token=go18MODkNUAOReyKCnKzm6HEr6qTD1Pq HTTP/1.1 
Host: 192.168.5.150:8088
```

--------------------------------

### Make Installation Script Executable

Source: https://help.yeastar.com/en/p-series-software-edition/software-installation-guide/install-yeastar-p-series-software-edition-on-aruba-in-ubuntu.html

Grant execute permissions to the downloaded installation script.

```bash
chmod +x aruba-install-pse.sh
```
Tokens:
Raw