Yeastar P-Series Cloud Edition

https://help.yeastar.com/en/p-series-cloud-edition/
Admin
Yeastar P-Series Cloud Edition is a cloud-based PBX system that provides unified communications with...
Tokens:943,436
Snippets:6,312
Trust Score:10
Update:8 months ago
Show doc for...
Tokens:
Raw
### Example GET Request for Backup File List

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

An example of a complete GET request to retrieve a list of backup files. This example demonstrates how to include parameters like access token, page number, page size, sort by field, and order.

```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: yeastardocs.example.yeastarcloud.com
```

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

### Example: Query User Role Menu Options (API)

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/get-menu-options

This example demonstrates how to query the menu options for user roles using the GET /system/get_menuoptions API. It shows a sample request with the 'menu' parameter set to 'role' and the corresponding successful HTTP response.

```HTTP
GET /openapi/v1.0/system/get_menuoptions?access_token=ImvFJSbT9DUi9iQpssHgIlQgC2pb5ZHB&menu=role 

Host: yeastardocs.example.yeastarcloud.com
```

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

### GET Request Example for Auto-Record Configuration

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/get-recording-setting

This snippet demonstrates a GET request to the /openapi/v1.0/autorecord/get endpoint. It includes the necessary access token and host information to retrieve the auto-record settings from the P-Series Cloud Edition.

```http
GET /openapi/v1.0/autorecord/get?access_token=HaRtYPeUXp2otAUzEqUQ4KvISuDOCYBl HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

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

### Example: Query Organization List Menu Options (API)

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/get-menu-options

This example illustrates how to query the menu options for organization lists using the GET /system/get_menuoptions API. It includes a sample request with the 'menu' parameter set to 'org_list' and the expected HTTP response, which may contain nested sub-organization details.

```HTTP
GET /openapi/v1.0/system/get_menuoptions?access_token=sIqNaNz22Ph0HKLp25m1aYJJVUbhHyOP&menu=org_list HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

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

### Request Example: Get Recording Download URL

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/download-a-recording-file

This example demonstrates how to make a GET request to the API to obtain the download URL for a call recording file using its ID. It includes the necessary parameters like ID and access token.

```HTTP
GET /openapi/v1.0/recording/download?id=1727&access_token=WQMR0cuirhX264oZMa9pV03T9li924NS HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

```

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

### Example Helpdesk API Request URL for Getting Users

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

This example demonstrates the format of an API request URL used to retrieve a list of Helpdesk users. It includes a base URL and a query parameter to filter for active users.

```text
https://www.api.example.com/v1/users?type=ActiveUsers
```

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

### Get WebSocket Audio Streaming Setting (API Request Example)

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/get-websocket-audio-streaming-setting

An example of a GET request to the WebSocket audio streaming endpoint. This shows the structure of the request, including the host header.

```HTTP
GET /openapi/v1.0/websocketaudiostream/get?access_token=HaRtYPeUXp2otAUzEqUQ4KvISuDOCYBl HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

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

### GET Message Campaign Example

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/query-information-of-a-message-campaign

This snippet shows an example HTTP GET request to retrieve details of a specific message campaign using the P-Series Cloud Edition API. It includes the endpoint, access token, and campaign ID as parameters. The response example illustrates a successful retrieval with detailed campaign information.

```http
GET /openapi/v1.0/message_campaign/get?access_token=3pLZ96FkWJxfYsOEIMokkGjWMMWT6g4g&id=5 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

```json
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 255,
        "name": "WhatsAPP Message Campaign",
        "channel_type": "whatsapp",
        "omnichannel_id": 1,
        "sender": 1,
        "recipient_type": "input",
        "send_type": "schedule",
        "send_time": 1753898766,
        "send_mode": "new_session",
        "assign_to_type": "extension",
        "assign_to_id": 2,
        "content_type": "template",
        "content": "{\"id\":1773,\"template_id\":\"1293546285747227\",\"name\":\"docstest\",\"parameter_format\":\"NAMED\",\"components\":[{\"type\":\"HEADER\",\"format\":\"IMAGE\"},{\"type\":\"BODY\",\"text\":\"Hello! 👋\\n\\nAs a valued  {{customer_tier}} member, we’re excited to share a special {{offer_type}} with you! 🎁\\nEnjoy {{offer_details}}—available until {{expiry_date}}.\\n\\nIf you have any questions or want to redeem your offer, simply reply to this message or contact our team.\\n\\nThank you for choosing {{company_name}}! 💙\"},{\"type\":\"BUTTONS\",\"buttons\":[{\"type\":\"FLOW\",\"text\":\"Redeem Offer\",\"flow_id\":657693363952373,\"flow_action\":\"NAVIGATE\",\"navigate_screen\":\"SIGN_UP\"},{\"type\":\"URL\",\"text\":\"Visit website\",\"url\":\"https://test.com/\"},{\"type\":\"VOICE_CALL\",\"text\":\"Contact us\"}]}],\"language\":\"en\",\"category\":\"MARKETING\",\"sub_category\":\"CUSTOM\",\"omnichannel_id\":1}",
        "number_list": [
            {
                "id": 8007,
                "number": "+12025550101"
            },
            {
                "id": 8006,
                "number": "+12025550102"
            },
            {
                "id": 8005,
                "number": "+12025550103"
            },
            {
                "id": 8004,
                "number": "+12025550104"
            },
            {
                "id": 8003,
                "number": "+12025550105"
            },
            {
                "id": 8002,
                "number": "+12025550106"
            },
            {
                "id": 8001,
                "number": "+12025550107"
            },
            {
                "id": 8000,
                "number": "+12025550108"
            },
            {
                "id": 7999,
                "number": "+12025550109"
            },
            {
                "id": 7998,
                "number": "+12025550110"
            }
        ],
        "msg_param": "{\"id\":1773,\"template_id\":\"1293546285747227\",\"name\":\"docstest\",\"language\":{\"code\":\"en\"},\"components\":[{\"type\":\"HEADER\",\"parameters\":[{\"type\":\"IMAGE\",\"file_list\":[{\"id\":\"d8b23d56d9974cdb90d6c2d6927861b9\",\"name\":\"pexels-photo-5632382.jpeg\",\"uri\":\"20250725/d8b23d56d9974cdb90d6c2d6927861b9\",\"type\":\"image/jpeg\",\"size\":88555}]}]},{\"type\":\"BODY\",\"parameters\":[{\"type\":\"TEXT\",\"text\":\"\",\"parameter_name\":\"customer_tier\"},{\"type\":\"TEXT\",\"text\":\"\",\"parameter_name\":\"offer_type\"},{\"type\":\"TEXT\",\"text\":\"\",\"parameter_name\":\"offer_details\"},{\"type\":\"TEXT\",\"text\":\"\",\"parameter_name\":\"expiry_date\"},{\"type\":\"TEXT\",\"text\":\"SmartMal\",\"parameter_name\":\"company_name\"}]},{\"type\":\"BUTTONS\",\"parameters\":[{\"type\":\"FLOW\",\"text\":\"\"},{\"type\":\"URL\",\"text\":\"\"},{\"type\":\"VOICE_CALL\",\"text\":\"\"}]}],\"parameter_format\":\"NAMED\"}"
    }
}
```

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

### Download Link Format and Example

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/download-a-call-report

This section provides the format for constructing the complete URL to download a call report. It involves combining the base URL of the PBX, the `download_resource_url` obtained from the API response, and the `access_token`. An example illustrates the final downloadable link.

```url
{base_url}/{download_resource_url}?access_token={access_token}
```

```url
https://yeastardocs.example.yeastarcloud.com/api/download/QueueSatisfaction-x.7.0.7-download-20220608094753-ejP6Z6htIfhsCQbP.csv?access_token=MB1OklPar5hnDfhi4srZa8FrZ4znFSzr
```

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

### Get Queue Agent Configuration Example (Expression)

Source: https://help.yeastar.com/en/p-series-cloud-edition/call-flow-designer-guide/get-queue-agent

This example demonstrates how to dynamically specify a target queue using an expression in the Get Queue Agent component configuration. It utilizes the '$UserInput1.userInput' variable to retrieve the queue number entered by the caller.

```text
$UserInput1.userInput
```

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

### Example Request for WhatsApp Message Templates

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/get-whatsapp-message-templates

An example HTTP GET request to retrieve WhatsApp message templates. This request specifies the omnichannel_id and includes a search value to filter for templates related to 'store'.

```HTTP
GET /openapi/v1.0/message_channel/whatsapp_template?omnichannel_id=1&access_token=FOgrNFKY6xVQcUxw3pfMTFqCAG6lBulV&search_value=store HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

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

### Request Example: Queue Satisfaction Report Download

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/download-a-call-report

This example demonstrates how to request the download URL for a queue satisfaction survey report. It specifies the report type, time range, queue ID, and access token. Note the importance of matching the date/time format to the PBX settings and choosing the correct API version (v1.0 or v2.0) based on the PBX software version.

```http
GET /openapi/v1.0/call_report/download?type=queuesatisfaction&start_time=04/01/2022 00:00:00&end_time=05/31/2022 23:59:59&queue_id=1&access_token=MB1OklPar5hnDfhi4srZa8FrZ4znFSzr HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

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

### Get Access Token Request Example

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/get-access-token

This example demonstrates how to construct a POST request to obtain an access token. It includes the necessary headers and the JSON payload with username and password.

```http
POST /openapi/v1.0/get_token

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
User-Agent: OpenAPI
{
	"username": "UEnH9Dmv6uBJEXsYcag1trNfQThYXXXX",
	"password": "ZLcXl63S9EtMnYoHUnjbVo6sA8CbXXXX"
}
```

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

### Query Queue Details using HTTP GET Request

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/query-information-of-a-queue

This example demonstrates how to query the detailed information of a specific queue using an HTTP GET request. It requires the queue ID and an access token. The response is a JSON object containing all queue configuration parameters.

```HTTP
GET /openapi/v1.0/queue/get?access_token=mlF8b3omcSD822Sosdc6kyiFkdYkC8UG&id=3 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

```JSON
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "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": 1,
        "empty_defined_for_leave_empty": [
            "1",
            "2",
            "3"
        ],
        "enb_disallow_to_join_when_empty": 1,
        "empty_defined_for_disallow_to_join_when_empty": [
            "1",
            "2"
        ],
        "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": "",
        "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",
                "number_value": 1
            },
            {
                "text": "Phillip Huff",
                "text2": "1001",
                "value": "85",
                "type": "extension",
                "number_value": 1
            }
        ],
        "static_agent_list": [
            {
                "text": "Madison Cooper",
                "text2": "1004",
                "value": "96",
                "type": "extension",
                "number_value": 1
            },
            {
                "text": "Kevin Connor",
                "text2": "1005",
                "value": "97",
                "type": "extension",
                "number_value": 1
            },
            {
                "text": "Kristin Hale",
                "text2": "1006",
                "value": "92",
                "type": "extension",
                "number_value": 1
            }
        ],
        "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": 0
            },
            {
                "k": "6",
                "p": 0
            },
            {
                "k": "7",
                "p": 0
            },
            {
                "k": "8",
                "p": 0
            },
            {
                "k": "9",
                "p": 0
            },
            {
                "k": "*",
                "p": 0
            }
        ],
        "enb_priority_queue": 0,
        "weight": 0,
        "enb_acceleration_weight": 0,
        "acceleration": 30,
        "enb_ip_phone_missed_call_display":1,
        "enb_custom_language": 1,
        "prompt_language": "sound-de",
        "client_unique_ringtone": "example-1.wav"
    }
}
```

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

### Example Download Link

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/download-a-recording-file

This is a concrete example of a complete download link for a call recording file. It illustrates how to combine the base URL, the resource URL, and the access token to form a functional download URL.

```URL
https://yeastardocs.example.yeastarcloud.com/api/download/Recording-X.7.0.6-1-download-20220412175901-M8zB66xYUNTNMr2D.wav?access_token=WQMR0cuirhX264oZMa9pV03T9li924NS

```

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

### Example GET Request for PIN List - HTTP

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/query-pin-list

An example of an HTTP GET request to retrieve the PIN list. This includes the request line and host header, demonstrating how to format the request for the API.

```http
GET /openapi/v1.0/pin_list/list?access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

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

### Get CDR Options API Request Example

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/get-cdr-options

This example demonstrates how to make a GET request to the CDR options endpoint. It includes the necessary URL structure and headers for the request. The response indicates the success or failure of the operation and provides the status of CDR options like fuzzy search.

```http
GET /openapi/v1.0/cdr/getoption?access_token=Kf8nDCJfhqYjMOlUdmiqcnezn1NP7xzn HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

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

### Download Link Example: System Log File

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/download-system-log-files

An example of a complete URL used to download a compressed system log file. This link is valid for 30 minutes.

```http
https://yeastardocs.example.yeastarcloud.com/api/download/PBX-SystemLog-x.15.0.x-download-20240422102614-RThAqlK33pk0d0Ya.tar?access_token=MB1OklPar5hnDfhi4srZa8FrZ4znFSzr
```

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

### Example GET Request for Allow Numbers List

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/query-allowed-numbers-list

An example of a GET request to the allow numbers list endpoint, including the necessary access token and host information. This illustrates the format for querying the API.

```HTTP
GET /openapi/v1.0/allow_numbers/list?access_token=DfwoCmAqPuexIOQH1NY7j8l8U391niHD HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

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

### OAuth2 Additional Query String Example

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

Provides an example of additional query parameters for authentication if the Helpdesk system uses them instead of scope.

```text
client_id={{.client_id}}&redirect_uri={{.redirect_uri}}
```

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

### Get WebSocket Audio Streaming Setting (API Response Example)

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/get-websocket-audio-streaming-setting

An example of a successful HTTP response when querying WebSocket audio streaming settings. It includes error codes, messages, and detailed configuration and subscription data.

```JSON
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "config": {
        "enable": 1,
        "websocket_url": "wss://docs.example.cloud.com",
        "auth_key": "Secret",
        "auth_value": "Standardpassword111",
        "sample_rate": 0,
        "enable_ext": 1,
        "enable_trunk": 0,
        "enable_did": 0
    },
    "subscribe_list": [
        {
            "id": 3,
            "subscribe_type": "organization",
            "subscribe_id": 2
        },
        {
            "id": 4,
            "subscribe_type": "organization",
            "subscribe_id": 3
        }
    ]
}
```

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

### Test Webhook Connectivity - GET Request Example

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/test-webhook-connectivity

This example demonstrates how to test Webhook connectivity using an HTTP GET request. It includes the necessary query parameters such as access token, request method, secret key, and the Webhook URL.

```http
GET /openapi/v1.0/webhook/test?access_token=DEfChNyQmVMUZip90i8PqCfotJL7kIQB&request_method=POST&secret=qnIdTBxyGgn2LckZrFw7IVeTRMJf3XfM&url=https://webhook.site/38e9dea1-be68-4381-8a8c-f0623517f513 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
```

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

### Get Access Token Response Example

Source: https://help.yeastar.com/en/p-series-cloud-edition/developer-guide/get-access-token

This example shows a successful response from the API after requesting an access token. It includes the HTTP status code and a JSON object containing the access token, refresh token, and their expiration times.

```http
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "access_token_expire_time": 1800,
    "access_token": "EXZMpZAO86mbrKm6rFtgeb3rfcpC9uqS",
    "refresh_token_expire_time": 86400,
    "refresh_token": "SCduGecwbG9jIusiS8FxFUVn3kf0Q9R8"
}
```
Tokens:
Raw