Skip to main content
Tools Reference

Yeastar P-Series PBX Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Yeastar P-Series PBX Tools

yeastar_ · 297 tools · Free 158 · Pro 139 Phone-system management for Yeastar P-Series across its Cloud, Appliance and Software editions. Every customer runs their own PBX, so the instance address is required, must be HTTPS, and keeps a non-default port. The credential is a client id and secret created on the PBX; give StackJack its own client, because the PBX keeps only eight valid tokens per application at a time. Every response is HTTP 200 - the real outcome is the error code the body carries. The HTTP method does not tell a read from a write either: some deletes are GETs and several searches are POSTs. Paging is a one-based page with page_size, capped at 500 and at 1000 for call detail records and call reports. Those tools take an apiVersion because v1.0 and v2.0 coexist behind a firmware gate; leaving it out selects v2.0. Downloads come back as a URL to fetch. Testing a webhook makes the customer's PBX send a request to an address you choose, which leaves their network.

All connector tools · Yeastar P-Series PBX setup guide

Yeastar P-Series PBX tool groups

Contacts

ToolPlanAccessSummary
yeastar_create_company_contactProWriteAdd a company contact.
yeastar_delete_company_contactProDestructiveDESTRUCTIVE.
yeastar_get_company_contactFreeRead-onlyQuery the information of a company contact.
yeastar_list_company_contactsFreeRead-onlyQuery the company contacts list.
yeastar_query_company_contactsFreeRead-onlyQuery the information of multiple company contacts.
yeastar_search_company_contactsFreeRead-onlySearch specific company contacts.
yeastar_update_company_contactProWriteEdit a company contact.

[Yeastar P-Series PBX] Add a company contact. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: first_name (String, required): First name. last_name (String): Last name. company (String): Company. email (String): Email address. phonebook_id_list (Array<Integer>): The ID(s) of the phonebook to which the contact belongs.Note: You can query the phonebook's ID using Search Specific Phonebooks. Use a comma to separate multiple IDs. organization (String): Department. job_title (String): Job title. position (String): Position. industry (String): Industry. supervisor (String): Supervisor. remark (String): Remark. number_list (Array<Number_List>, required): The list of company contact's numbers. zip_code (String): ZIP code. street (String): Street. city (String): City. state (String): State. country (String): Country.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a company contact. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of a company contact. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the company contacts list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple company contacts. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific company contacts. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Edit a company contact. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of the company contact.Note: You can query the company contact's ID using Search Specific Company Contacts. first_name (String): First name. last_name (String): Last name. company (String): Company. email (String): Email address. phonebook_id_list (Array<Integer>): The id(s) of the phonebook to which the contact belongs.Note: You can query the phonebook's ID suing Search Specific Phonebooks. Use a comma to separate multiple IDs. organization (String): Department. job_title (String): Job title. position (String): Position. industry (String): Industry. supervisor (String): Supervisor. remark (String): Remark. number_list (Array<Number_List>): The list of company contact's numbers. zip_code (String): ZIP code. street (String): Street. city (String): City. state (String): State. country (String): Country.

Extension

ToolPlanAccessSummary
yeastar_create_extensionProWriteAdd an extension.
yeastar_delete_extensionProDestructiveDESTRUCTIVE.
yeastar_get_extensionFreeRead-onlyQuery the information of an extension.
yeastar_get_extension_passwordFreeRead-onlyQuery the registration password and voicemail access PIN of an extension.
yeastar_list_extensionsFreeRead-onlyQuery the extension list.
yeastar_query_extensionsFreeRead-onlyQuery the information of multiple extensions.
yeastar_search_extensionsFreeRead-onlySearch specific extensions.
yeastar_send_welcome_email_extensionProDestructiveDESTRUCTIVE.
yeastar_update_extensionProDestructiveDESTRUCTIVE: this can reset the extension's user or voicemail password and change the user's role, which locks the person out or changes what they can do on the PBX.

[Yeastar P-Series PBX] Add an extension. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: type (String, required): Extension type.Valid value: SIP avatar (String): The file ID of the extension's avatar.Note: You need to first upload the avatar file to the PBX, then pass the returned file ID in this parameter. If this parameter is omitted, the extension will use the system default avatar. first_name (String): First name. last_name (String): Last name. email_addr (String): Email address. mobile_number (String): Mobile number. user_password (String, required): User password.Note: Must contain numbers, uppercase, and lowercase letters. Do not allow four consecutive digits, four same digits, extension number, first name, or last name. role_id (Integer): The ID of a user role.Note: You can query user role's ID using Get Menu Options. organization_list (Array <Organization_Info>): The organization(s) to which the extension belongs. Note: This parameter is required if the Organization Management feature is enabled. title (String): The job title of the extension user. (Showing 10 of 53 documented fields; the rest are on the vendor reference page named in this tool's title.)

[Yeastar P-Series PBX] DESTRUCTIVE. Delete an extension. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of an extension. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the registration password and voicemail access PIN of an extension. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.
typestringyestype — String, required.

[Yeastar P-Series PBX] Query the extension list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple extensions. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific extensions. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — String, optional.
pageSizeintegernonullpage_size — String, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Send Linkus welcome emails to specified extensions. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id_list (Array<Integer>, required): The unique ID(s) of extension(s).Note: You can query the extension's ID using Search Specific Extensions. Use a comma to separate multiple IDs.

[Yeastar P-Series PBX] DESTRUCTIVE: this can reset the extension's user or voicemail password and change the user's role, which locks the person out or changes what they can do on the PBX. Edit an extension. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of an extension.Note: You can query extension's ID using Search Specific Extensions. avatar (String): The file ID of the extension's avatar.Note: You need to first upload the avatar file to the PBX, then pass the returned file ID in this parameter. If this parameter is omitted, the extension will use the system default avatar. first_name (String): First name. last_name (String): Last name. email_addr (String): Email address. mobile_number (String): Mobile number. user_password (String): User password.Note: Must contain numbers, uppercase, and lowercase letters. Do not allow four consecutive digits, four same digits, extension number, first name, or last name. role_id (Integer): The ID of a user role.Note: You can query user role's ID using Get Menu Options. organization_list (Array <Organization_Info>): The organization(s) to which the extension belongs. Note: This parameter is required if the Organization Management feature is enabled. title (String): The job title of the extension user. (Showing 10 of 52 documented fields; the rest are on the vendor reference page named in this tool's title.)

Extension Group

ToolPlanAccessSummary
yeastar_create_extensiongroupProWriteAdd an extension group.
yeastar_delete_extensiongroupProDestructiveDESTRUCTIVE.
yeastar_get_extensiongroupFreeRead-onlyQuery the information of an extension group.
yeastar_list_extension_groupsFreeRead-onlyQuery the extension group list.
yeastar_query_extension_groupsFreeRead-onlyQuery the information of multiple extension groups.
yeastar_search_extension_groupsFreeRead-onlySearch specific extension groups.
yeastar_update_extensiongroupProWriteEdit an extension group.

[Yeastar P-Series PBX] Add an extension group. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): Extension group name. member_select (String, required): How extensions are added to the group.Valid value: sel_all_ext: Select all extensions. sel_specific: Select specific extensions. members (Array<Member_info>): The information of the member extensions. Note: This parameter is required when member_select is set to sel_specific. mgr_enb_chg_presence (Integer): Whether managers can change group members' presence status on Operator Panel.Valid value: 0: Disabled 1: Enabled mgr_enb_call_distribution (Integer): Whether managers can distribute incoming calls on Operator Panel, including redirect, transfer, and drag-and-drop operations.Valid value: 0: Disabled 1: Enabled mgr_enb_call_conn (Integer): Whether managers can pick up or hang up other extensions' calls on Operator Panel.Valid value: 0: Disabled 1: Enabled mgr_enb_monitor (Integer): Whether managers can monitor calls on Operator Panel.Valid value: 0: Disabled 1: Enabled mgr_enb_call_park (Integer): Whether managers can park and retrieve calls on Operator Panel.Valid value: 0: Disabled 1: Enabled (Showing 8 of 37 documented fields; the rest are on the vendor reference page named in this tool's title.)

[Yeastar P-Series PBX] DESTRUCTIVE. Delete an extension group. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of an extension group. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the extension group list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple extension groups. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific extension groups. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Edit an extension group. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of an extension group.Note: You can query extension group's ID using Search Specific Extension Groups. member_select (String): How extensions are added to the group.Valid value: sel_all_ext: Select all extensions. sel_specific: Select specific extensions. members (Array<Member_info>): The information of the member extensions. Note: This parameter is required when member_select is set to sel_specific. mgr_enb_chg_presence (Integer): Whether managers can change group members' presence status on Operator Panel.Valid value: 0: Disabled 1: Enabled mgr_enb_call_distribution (Integer): Whether managers can distribute incoming calls on Operator Panel, including redirect, transfer, and drag-and-drop operations.Valid value: 0: Disabled 1: Enabled mgr_enb_call_conn (Integer): Whether managers can pick up or hang up other extensions' calls on Operator Panel.Valid value: 0: Disabled 1: Enabled mgr_enb_monitor (Integer): Whether managers can monitor calls on Operator Panel.Valid value: 0: Disabled 1: Enabled mgr_enb_call_park (Integer): Whether managers can park and retrieve calls on Operator Panel.Valid value: 0: Disabled 1: Enabled (Showing 8 of 37 documented fields; the rest are on the vendor reference page named in this tool's title.)

Organization

ToolPlanAccessSummary
yeastar_create_organizationProWriteAdd an organization.
yeastar_delete_organizationProDestructiveDESTRUCTIVE.
yeastar_get_organizationFreeRead-onlyQuery the information of an organization.
yeastar_list_organizationsFreeRead-onlyQuery the organization list.
yeastar_query_organizationsFreeRead-onlyQuery the information of multiple organizations.
yeastar_search_organizationsFreeRead-onlySearch specific organizations.
yeastar_update_organizationProWriteEdit an organization.

[Yeastar P-Series PBX] Add an organization. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): Organization name. parent_id (Integer, required): Parent organization ID.Note: You can query the organization's ID using Search Specific Organizations.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete an organization. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of an organization. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the organization list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
isAllintegernonullis_all — Integer, optional.
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — String, optional.
pageSizeintegernonullpage_size — String, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple organizations. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific organizations. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
isAllintegernonullis_all — Integer, optional.
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — String, optional.
pageSizeintegernonullpage_size — String, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Edit an organization. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of the organization. Note: You can query the organization's ID using Search Specific Organizations. name (String): Organization name. parent_id (Integer): Parent organization ID.Note: You can query the organization's ID using Search Specific Organizations.

Phonebook

ToolPlanAccessSummary
yeastar_create_phonebookProWriteAdd a phonebook.
yeastar_delete_phonebookProDestructiveDESTRUCTIVE.
yeastar_get_phonebookFreeRead-onlyQuery the information of a phonebook.
yeastar_list_phonebooksFreeRead-onlyQuery the phonebook list.
yeastar_query_phonebooksFreeRead-onlyQuery the information of multiple phonebooks.
yeastar_search_phonebooksFreeRead-onlySearch specific phonebooks.
yeastar_update_phonebookProWriteEdit a phonebook.

[Yeastar P-Series PBX] Add a phonebook. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): Phonebook name. member_select (String): Member selection method.Valid value: sel_all: Select all company contacts. sel_specific: Select specific company contacts. add_contacts_id_list (Array<Integer>): The ID(s) of the company contact(s) to be added into the phonebook.Note: You can query the company contact's ID using Search Specific Company Contacts. Use a comma to separate multiple IDs.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a phonebook. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of a phonebook. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the phonebook list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple phonebooks. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific phonebooks. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Edit a phonebook. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of the phonebook.Note: You can query the phonebook's ID using Search Specific Phonebooks. name (String): The name of the phonebook. member_select (String): Member selection method.Valid value: sel_all: Select all company contacts. sel_specific: Select specific company contacts. add_contacts_id_list (Array<Integer>): The unique ID(s) of the contact(s) to be added into the phonebook.Note: You can query the contact's ID using Search Specific Company Contacts. Use a comma to separate multiple IDs. del_contacts_id_list (Array<Integer>): The unique ID(s) of the contact(s) to be removed from the phonebook.Note: You can query the contact's ID using Search Specific Company Contacts. Use a comma to separate multiple IDs.

API Feature Settings

ToolPlanAccessSummary
yeastar_list_extension_status_monitorsFreeRead-onlyQuery extension status monitoring settings for the API feature.
yeastar_list_trunk_status_monitorsFreeRead-onlyQuery trunk status monitoring settings for the API feature.
yeastar_query_webhooksFreeRead-onlyQuery Webhook event push settings.
yeastar_test_webhookProDestructiveDESTRUCTIVE.
yeastar_update_extension_status_monitorProDestructiveDESTRUCTIVE.
yeastar_update_trunk_status_monitorProDestructiveDESTRUCTIVE.
yeastar_update_webhookProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] Query extension status monitoring settings for the API feature. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query trunk status monitoring settings for the API feature. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query Webhook event push settings. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

[Yeastar P-Series PBX] DESTRUCTIVE. Make the customer's PBX send an HTTP request to a caller-supplied Webhook URL, signed with a caller-supplied secret, to test Webhook connectivity. The outbound call leaves the customer network and reaches whatever host that address resolves to; the PBX does not restrict it to the Webhooks already configured on it. Pass an address the customer already trusts. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
requestMethodstringyesrequest_method — String, required.
secretstringyessecret — String, required.
urlstringyesurl — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Update extension status monitoring settings for the API feature. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: ext_monitor_list (Array<Monitoring_Settings>): The status monitoring settings of extensions.

[Yeastar P-Series PBX] DESTRUCTIVE. Update trunk status monitoring settings for the API feature. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: trunk_monitor_list (Array<Monitoring_Settings>): The status monitoring settings of trunks.

[Yeastar P-Series PBX] DESTRUCTIVE. Update Webhook event push settings. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: webhook_event_push_list (Array<Webhook_Entry>): The list of Webhook configuration entries. webhook_event_push_timeout (Integer): Specify the maximum time to wait for an HTTP response from the third-party application.Valid value: 3 - 10 webhook_event_push_retry_count (Integer): Specify the number of times a request can be retried when delivery fails or no successful response is received.Valid value：1 - 5

Auto Provisioning

ToolPlanAccessSummary
yeastar_bulk_create_phonesProWriteBulk add IP phones of the same vendor and model.
yeastar_bulk_delete_phonesProDestructiveDESTRUCTIVE.
yeastar_bulk_reboot_phonesProDestructiveDESTRUCTIVE.
yeastar_bulk_reprovision_phonesProDestructiveDESTRUCTIVE.
yeastar_bulk_update_phonesProDestructiveDESTRUCTIVE.
yeastar_get_auto_provisioning_optionsFreeRead-onlyQuery the information of configuration options required when adding IP phone(s) for auto provisioning.
yeastar_get_phoneFreeRead-onlyQuery the information of an IP phone.
yeastar_search_phonesFreeRead-onlySearch specific IP phones.

[Yeastar P-Series PBX] Bulk add IP phones of the same vendor and model. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: vendor (String, required): Phone vendor.Note: You can query the available options using Query Configuration Options for Auto Provisioning. model (String, required): Phone model. Note: You can query the available options using Query Configuration Options for Auto Provisioning. phone_list (Array<Ext_Assign>, required): The extension assignment of the phones. template_name (String, required): The name of the provisioning template to be applied to the phones. Note: You can query the available options using Query Configuration Options for Auto Provisioning. provisioning_method (String, required): Provisioning method for the IP phone(s).Valid value: rps pnp_via_onsite_proxy dhcp_via_onsite_proxy onsite_proxy_uuid (String): The UUID of an Onsite Proxy instance used for auto provisioning.Note: The parameter is available only when the provisioning_method filed is set to pnp_via_onsite_proxy or dhcp_via_onsite_proxy. enb_rps_auth (Integer): Whether to enable authentication for the first-time Auto Provisioning .Valid value: 0: Disable (default) 1: Enable

[Yeastar P-Series PBX] DESTRUCTIVE. Bulk delete IP phones. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: batch_id_list (Array<Integer>, required): The unique IDs of the auto provisioning IP phones. Note: You can query the IP phone's ID usingSearch Specific IP Phones. Use a comma to separate multiple IDs.

[Yeastar P-Series PBX] DESTRUCTIVE. Bulk reboot IP phones. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: batch_id_list (Array<Integer>, required): The unique IDs of the auto provisioning IP phones. Note: You can query the IP phone's ID usingSearch Specific IP Phones. Use a comma to separate multiple IDs.

[Yeastar P-Series PBX] DESTRUCTIVE. Bulk reprovision IP phones. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: batch_id_list (Array<Integer>, required): The unique IDs of the auto provisioning IP phones. Note: You can query the IP phone's ID usingSearch Specific IP Phones. Use a comma to separate multiple IDs.

[Yeastar P-Series PBX] DESTRUCTIVE. Bulk edit IP phones of the same model that use the same template. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: batch_id_list (Array<Integer>, required): The unique IDs of the auto provisioning IP phones. Note: You can query the IP phone's ID usingSearch Specific IP Phones. Use a comma to separate multiple IDs. phone_list (Array<Ext_Assign>, required): The extension assignment for the phones.

[Yeastar P-Series PBX] Query the information of configuration options required when adding IP phone(s) for auto provisioning. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
menustringyesmenu — String, required.
modelstringnonullmodel — String, optional.
vendorstringnonullvendor — String, optional.

[Yeastar P-Series PBX] Query the information of an IP phone. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Search specific IP phones. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

Auto Recording Setting

ToolPlanAccessSummary
yeastar_get_autorecordFreeRead-onlyQuery the auto recording settings.
yeastar_update_autorecordProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] Query the auto recording settings. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit the auto recording settings. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: enb_internal (Integer): Whether to record internal calls.Valid value: 0: Disabled 1: Enabled internal_prompt (String): The prompt that will be played when internal calls are being recorded.Note: You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt"). outbound_prompt (String): The prompt that will be played when outbound calls are being recorded. Note: You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt"). inbound_prompt (String): The prompt that will be played when inbound calls are being recorded. Note: You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt"). start_prompt (String): The prompt that will be played when recording starts during a call. Note: This prompt is triggered when authorized extension users start recording by pressing recording button on Linkus UC Clients or dialing the recording feature code (default *1). You can query the available custom prompts using Get Menu Options ("menu":"custom_prompt"). (Showing 5 of 14 documented fields; the rest are on the vendor reference page named in this tool's title.)

Backup

ToolPlanAccessSummary
yeastar_create_backupProWriteAdd a backup file.
yeastar_delete_backupProDestructiveDESTRUCTIVE.
yeastar_download_backupFreeRead-onlyGet the download URL to download a backup file.
yeastar_get_backupFreeRead-onlyQuery the information of a backup file.
yeastar_get_backup_statusFreeRead-onlyGet the backup status of a backup file.
yeastar_list_backupsFreeRead-onlyQuery the backup file list.
yeastar_query_backupsFreeRead-onlyQuery the information of multiple backup files.
yeastar_search_backupsFreeRead-onlySearch specific backup files.

[Yeastar P-Series PBX] Add a backup file. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: file_name (String, required): The name of the backup file. memo (String): Comments for the backup file. storage_location (Integer): The ID of the storage device for the backup file. Note: You can query storage devices' ID using Query Storage Device List. sound_backup (Integer): Whether to back up custom prompts.Valid value: 0: Disable 1: Enable cdr_backup (Integer): Whether to back up call logs.Valid value: 0: Disable 1: Enable contact_backup (Integer): Whether to back up company contacts and phonebooks settings.Valid value: 0: Disable 1: Enable message_backup (Integer): Whether to back up chat data for external chat.Valid value: 0: Disable 1: Enable fax_backup (Integer): Whether to back up fax logs.Valid value: 0: Disable 1: Enable

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a backup file. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
fileNamestringyesfile_name — String, required.

[Yeastar P-Series PBX] Get the download URL to download a backup file. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
fileNameintegeryesfile_name — Integer, required.

[Yeastar P-Series PBX] Query the information of a backup file. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
fileNamestringyesfile_name — String, required.

[Yeastar P-Series PBX] Get the backup status of a backup file. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
fileNameintegeryesfile_name — Integer, required.

[Yeastar P-Series PBX] Query the backup file list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple backup files. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
fileNamesstringyesfile_names — String, required.

[Yeastar P-Series PBX] Search specific backup files. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

Onsite Proxy

ToolPlanAccessSummary
yeastar_create_onsiteproxyProWriteAdd an Onsite Proxy instance.
yeastar_delete_onsiteproxyProDestructiveDESTRUCTIVE.
yeastar_get_onsiteproxyFreeRead-onlyQuery the information of an Onsite Proxy instance.
yeastar_get_password_onsiteproxyFreeRead-onlyQuery the secret key of an Onsite Proxy instance.
yeastar_list_onsite_proxiesFreeRead-onlyQuery the list of Onsite Proxy instances.
yeastar_query_onsite_proxiesFreeRead-onlyQuery the information of multiple Onsite Proxy instances.
yeastar_reset_onsite_proxy_keyProDestructiveDESTRUCTIVE.
yeastar_search_onsite_proxiesFreeRead-onlySearch specific Onsite Proxy instances.
yeastar_update_onsiteproxyProWriteEdit an Onsite Proxy instance.

[Yeastar P-Series PBX] Add an Onsite Proxy instance. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): The name of Onsite Proxy instance. platform (String, required): The operating system where the instance is deployed.Valid value: linux audio_rtp_passthrough (Integer): Whether to enable the Audio RTP Passthrough feature.When enabled, audio streams between phones registered via the same Onsite Proxy are transmitted directly (peer-to-peer), bypassing both the PBX and the Onsite Proxy. Note: If omitted or left blank, the parameter is filled with 0. Valid value: 0: Disable 1: Enable

[Yeastar P-Series PBX] DESTRUCTIVE. Delete an Onsite Proxy instance. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of an Onsite Proxy instance. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the secret key of an Onsite Proxy instance. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.
typestringyestype — String, required.

[Yeastar P-Series PBX] Query the list of Onsite Proxy instances. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple Onsite Proxy instances. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Reset secret key of an Onsite Proxy instance. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of an Onsite Proxy instance. Note: You can query instance ID using Search Specific Onsite Proxy Instances.

[Yeastar P-Series PBX] Search specific Onsite Proxy instances. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
intranetIpstringnonullintranet_ip — String, optional.
namestringnonullname — String, optional.
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Edit an Onsite Proxy instance. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of an Onsite Proxy instance. Note: You can query instance ID using Search Specific Onsite Proxy Instances. name (String): The name of Onsite Proxy instance. audio_rtp_passthrough (Integer): Whether to enable the Audio RTP Passthrough feature.When enabled, audio streams between phones registered via the same Onsite Proxy are transmitted directly (peer-to-peer), bypassing both the PBX and the Onsite Proxy. Note: If omitted or left blank, the parameter is filled with 0. Valid value: 0: Disable 1: Enable

Storage

ToolPlanAccessSummary
yeastar_list_storageFreeRead-onlyQuery the storage device list.

[Yeastar P-Series PBX] Query the storage device list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

System

ToolPlanAccessSummary
yeastar_get_system_capacityFreeRead-onlyQuery PBX capacity, including the number of extensions and concurrent calls, and both the total and used capacity for AI transcription and AI receptionist .
yeastar_get_system_informationFreeRead-onlyQuery PBX information.
yeastar_get_system_menu_optionsFreeRead-onlyQuery the menu option information when creating and updating features.
yeastar_send_system_emailProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] Query PBX capacity, including the number of extensions and concurrent calls, and both the total and used capacity for AI transcription and AI receptionist . Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

[Yeastar P-Series PBX] Query PBX information. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

[Yeastar P-Series PBX] Query the menu option information when creating and updating features. Note: The interface supports to query the option information (ID, name, or type) of specific features including extension, extension group, organization, trunk, user role, phonebook, group voicemail, IVR, call flow, ring group, queue, queue agent, conference, PIN list, system prompt, custom prompt, etc. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegernonullid — Integer, optional.
menustringyesmenu — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Send an email to the specified email address. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: email_server (String, required): The email server to send emails.Valid values: follow_system: Follow System ys: Yeastar SMTP Server custom: Custom Email Server recipient (Array<String>): Recipient email address. cc (Array<String>): Carbon Copy (CC) email address. bcc (Array<String>): Blind Carbon Copy (BCC) email address. subject (String): The subject of the email. body (String): The body content of the email. attachments (Array<String>): Email attachments.Valid value: Absolute path to the files stored in the PBX's local storage. E.g. /ysdisk/syslog/pbxlog.log. force_attach (Integer): Whether emails should be sent only when an attachment is included. Valid value: 0: Disable 1: Enable

System Log

ToolPlanAccessSummary
yeastar_download_system_logFreeRead-onlyGet the download URL to download one or multiple system log file(s).
yeastar_list_system_logsFreeRead-onlyQuery the system log list.

[Yeastar P-Series PBX] Get the download URL to download one or multiple system log file(s). Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
filesstringyesfiles — String, required.

[Yeastar P-Series PBX] Query the system log list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

Time Zone

ToolPlanAccessSummary
yeastar_list_timezonesFreeRead-onlyQuery the time zone list.

[Yeastar P-Series PBX] Query the time zone list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.
timezoneTypestringnonulltimezone_type — String, optional.

Blocked/Allowed Numbers

ToolPlanAccessSummary
yeastar_create_allow_numbersProDestructiveDESTRUCTIVE.
yeastar_create_block_numbersProDestructiveDESTRUCTIVE.
yeastar_delete_allow_numbersProDestructiveDESTRUCTIVE.
yeastar_delete_block_numbersProDestructiveDESTRUCTIVE.
yeastar_get_allow_numbersFreeRead-onlyQuery the information of a call allowlist rule.
yeastar_get_block_numbersFreeRead-onlyQuery the information of a call blocklist rule.
yeastar_list_allow_number_rulesFreeRead-onlyQuery the call allowlists.
yeastar_list_block_number_rulesFreeRead-onlyQuery the call blocklists.
yeastar_query_allow_number_rulesFreeRead-onlyQuery the information of multiple call allowlist rules.
yeastar_query_block_number_rulesFreeRead-onlyQuery the information of multiple call blocklist rules.
yeastar_search_allow_number_rulesFreeRead-onlySearch specific call allowlist rules.
yeastar_search_block_number_rulesFreeRead-onlySearch specific call blocklist rules.
yeastar_update_allow_numbersProDestructiveDESTRUCTIVE.
yeastar_update_block_numbersProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] DESTRUCTIVE. Add a call allowlist rule. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): The name of the call allowlist rule. limit_type (String, required): The communication type that will be applied to the call allowlist rule.Valid value: inbound: Allow the number(s) to call into the PBX. outbound: Allow PBX extensions to call the number(s). both: Allow the number(s) to call into the PBX and allow PBX extensions to call the number(s). number_list (String, required): The numbers that will be allowed by the system.Note: Use & to separate multiple numbers.

[Yeastar P-Series PBX] DESTRUCTIVE. Add a call blocklist rule. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): The name of the call blocklist rule. limit_type (String, required): The communication type that will be applied to the call blocklist rule.Valid value: inbound: Block the number(s) from calling into the PBX. outbound: Block PBX extensions from calling the number(s). both: Block the number(s) from calling into the PBX and block the PBX extensions from calling the number(s). number_list (String, required): The numbers that will be blocked by the system.Note: Use & to separate multiple numbers.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a call allowlist rule. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a call blocklist rule. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of a call allowlist rule. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of a call blocklist rule. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the call allowlists. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the call blocklists. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple call allowlist rules. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Query the information of multiple call blocklist rules. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific call allowlist rules. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Search specific call blocklist rules. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit a call allowlist rule. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of a call allowlist rule.Note: You can query call allowlist rule's ID using Search Specific Allowed Numbers Rules. name (String): The name of the call allowlist rule. limit_type (String): The communication type that will be applied to the call allowlist rule.Valid value: inbound: Allow the number(s) to call into the PBX. outbound: Allow PBX extensions to call the number(s). both: Allow the number(s) to call into the PBX and allow PBX extensions to call the number(s). number_list (String): The numbers that will be allowed by the system.Note: Use & to separate multiple numbers.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit a call blocklist rule. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of a call blocklist rule.Note: You can query call blocklist rule's ID using Search Specific Blocked Numbers Rules. name (String): The name of the call blocklist rule. limit_type (String): The communication type that will be applied to the call blocklist rule.Valid value: inbound: Block the number(s) from calling into the PBX. outbound: Block PBX extensions from calling the number(s). both: Block the number(s) from calling into the PBX and block the PBX extensions from calling the number(s). number_list (String): The numbers that will be blocked by the system.Note: Use & to separate multiple numbers.

Inbound Route

ToolPlanAccessSummary
yeastar_create_inbound_routeProWriteAdd an inbound route.
yeastar_delete_inbound_routeProDestructiveDESTRUCTIVE.
yeastar_get_inbound_routeFreeRead-onlyQuery the information of an inbound route.
yeastar_list_inbound_routesFreeRead-onlyQuery the inbound route list.
yeastar_query_inbound_routesFreeRead-onlyQuery the information of multiple inbound routes.
yeastar_search_inbound_routesFreeRead-onlySearch specific inbound routes.
yeastar_update_inbound_routeProWriteEdit an inbound route.

[Yeastar P-Series PBX] Add an inbound route. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): The name of the inbound route. alert_info (String): Inbound alert info. did_option (String): DID matching mode.Valid value: patterns: Match DID patterns. (Default) pattern_to_ext: Match DID pattern to extensions. range_to_ext: Match DID range to extension range. pattern_to_ext_list: Match DID number(s) to extension(s) in one-to-one correspondence. did_pattern_list (Array<DID_Pattern_List>): The DID matching pattern list.Note: This parameter is required when the did_option is patterns. did_pattern_to_ext (String): The DID pattern matching to extensions.Note: This parameter is required when the did_option is pattern_to_ext. did_to_ext_start (String): The start number of the DID matching pattern range.Note: This parameter is required when the did_option is range_to_ext. did_to_ext_end (String): The end number of the DID matching pattern range.Note: This parameter is required when the did_option is range_to_ext. did_pattern_to_ext_list (Array<DID_Pattern_Ext_List>): The list of DID numbers and the corresponding extensions.Note: This parameter is required when the did_option is pattern_to_ext_list. (Showing 8 of 29 documented fields; the rest are on the vendor reference page named in this tool's title.)

[Yeastar P-Series PBX] DESTRUCTIVE. Delete an inbound route. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of an inbound route. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the inbound route list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple inbound routes. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific inbound routes. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Edit an inbound route. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of the inbound route.Note: You can query the inbound route's ID using Search Specific Inbound Routes. name (String): The name of the inbound route. alert_info (String): Inbound alert info. did_option (String): DID matching mode.Valid value: patterns: Match DID patterns. pattern_to_ext: Match DID pattern to extensions. range_to_ext: Match DID range to extension range. pattern_to_ext_list: Match DID number(s) to extension(s) in one-to-one correspondence. did_pattern_list (Array<DID_Pattern_List>): The DID matching pattern list.Note: This parameter is required when the did_option is patterns. did_pattern_to_ext (String): The DID pattern matching to extensions.Note: This parameter is required when the did_option is pattern_to_ext. did_to_ext_start (String): The start number of the DID matching pattern range.Note: This parameter is required when the did_option is range_to_ext. did_to_ext_end (String): The end number of the DID matching pattern range.Note: This parameter is required when the did_option is range_to_ext. (Showing 8 of 30 documented fields; the rest are on the vendor reference page named in this tool's title.)

Outbound Route

ToolPlanAccessSummary
yeastar_create_outbound_routeProDestructiveDESTRUCTIVE.
yeastar_delete_outbound_routeProDestructiveDESTRUCTIVE.
yeastar_get_outbound_routeFreeRead-onlyQuery the information of an outbound route.
yeastar_list_outbound_routesFreeRead-onlyQuery the outbound route list.
yeastar_query_outbound_routesFreeRead-onlyQuery the information of multiple outbound routes.
yeastar_search_outbound_routesFreeRead-onlySearch specific outbound routes.
yeastar_update_outbound_routeProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] DESTRUCTIVE. Add an outbound route. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): Outbound route name. outbound_cid (String): Outbound caller ID. dial_pattern_list (Array<Dial_Pattern_List>): The dial pattern of the outbound route. trunk_list (Array<Trunk_List>): The selected trunk in the outbound route. ext_list (Array<Ext_List>): The selected extensions in the outbound route. pin_protect (String, required): Outbound route password.Valid value: disable single_pin pin_list pin (String): Single PIN code.Note: This parameter is required when the value of pin_protect is set to single_pin. pin_list (Integer): The unique ID of the selected PIN list.Note: This parameter is required when the value of pin_protect is set to pin_list. You can query the PIN list ID using Get Menu Options.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete an outbound route. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of an outbound route. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the outbound route list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple outbound routes. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific outbound routes. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit an outbound route. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of the outbound route.Note: To obtain the outbound route's ID, see Search Specific Outbound Routes. name (String): Outbound route name. outbound_cid (String): Outbound caller ID. dial_pattern_list (Array<Dial_Pattern_List>): The dial pattern of the outbound route. trunk_list (Array<Trunk_List>): The selected trunk in the outbound route. ext_list (Array<Ext_List>): The selected extensions in the outbound route. pin_protect (String): Outbound route password.Valid value: disable single_pin pin_list pin (String): Single PIN code.Note: This parameter is required when the value of pin_protect is set to single_pin. pin_list (Integer): The unique ID of the selected PIN list.Note: This parameter is required when the value of pin_protect is set to pin_list. You can query the PIN list ID using Get Menu Options.

PIN List

ToolPlanAccessSummary
yeastar_create_pin_listProDestructiveDESTRUCTIVE.
yeastar_delete_pin_listProDestructiveDESTRUCTIVE.
yeastar_get_pin_listFreeRead-onlyQuery the information of a PIN list.
yeastar_list_pin_listsFreeRead-onlyQuery the PIN list.
yeastar_query_pin_listsFreeRead-onlyQuery the information of multiple PIN lists.
yeastar_search_pin_listsFreeRead-onlySearch specific PIN lists.
yeastar_update_pin_listProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] DESTRUCTIVE. Add a PIN list. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): The name of the PIN list. pin_list (String, required): The PIN codes.Note: Use a comma to separate multiple PIN codes. enb_record_cdr (Integer): Whether to record the PIN code in CDR when the PIN code has been used.Valid value: 0: No 1: Yes

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a PIN list. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of a PIN list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the PIN list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.

[Yeastar P-Series PBX] Query the information of multiple PIN lists. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific PIN lists. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit a PIN list. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of a PIN list.Note: You can query PIN list's ID using Search Specific PIN Lists. name (String): The name of the PIN list. pin_list (String): The PIN codes.Note: Use a comma to separate multiple PIN codes. enb_record_cdr (Integer): Whether to record the PIN code in CDR when the PIN code has been used.Valid value: 0: No 1: Yes

Trunk

ToolPlanAccessSummary
yeastar_create_trunkProDestructiveDESTRUCTIVE.
yeastar_delete_trunkProDestructiveDESTRUCTIVE.
yeastar_get_trunkFreeRead-onlyQuery the information of a trunk.
yeastar_list_trunk_itspFreeRead-onlyQuery the ITSP list of SIP trunks.
yeastar_list_trunksFreeRead-onlyQuery the trunk list.
yeastar_query_trunksFreeRead-onlyQuery the information of multiple trunks.
yeastar_search_trunksFreeRead-onlySearch specific trunks.
yeastar_update_trunkProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] DESTRUCTIVE. Add a SIP trunk. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): Trunk name. enable (Integer): Whether to enable the trunk.Valid value: 0: Disable 1: Enable country (String, required): The country of the ITSP.Note: You can query the desired ITSP using Query ITSP of SIP Trunks. itsp (String): The name of the ITSP.Note: You can query the desired ITSP using Query ITSP of SIP Trunks. type (String, required): Trunk type.Valid value: register transport (String, required): Transport protocol.Valid value: udp tcp tls dnsnaptr hostname (String, required): The domain or IP address of the ITSP. port (Integer, required): The registration port of the SIP trunk. domain (String, required): The domain or IP address of the ITSP. username (String, required): The username of the SIP account that is provided by the ITSP. password (String, required): The password of the SIP account. auth_name (String, required): The authentication name that is provided by the ITSP. enb_outbound_proxy (Integer): Whether to enable an outbound proxy.Valid value: 0: Disable 1: Enable outbound_proxy_server (String): The domain name or IP address of the outbound proxy server. outbound_proxy_port (Integer): The port of the outbound proxy server. (Showing 15 of 32 documented fields; the rest are on the vendor reference page named in this tool's title.)

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a SIP trunk. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of a trunk. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the ITSP list of SIP trunks. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

[Yeastar P-Series PBX] Query the trunk list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple trunks. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific trunks. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit a SIP trunk. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of a trunk.Note: You can query trunk's ID using Search Specific Trunks. name (String): Trunk name. enable (Integer): Whether to enable or disable the trunk.Valid value: 0: Disabled 1: Enabled transport (String): Transport protocol.Valid value: udp tcp tls dnsnaptr hostname (String): The domain or IP address of the ITSP. port (Integer): The registration port of the SIP trunk. domain (String): The domain or IP address of the ITSP. username (String): The username of the SIP account that is provided by the ITSP. password (String): The password of the SIP account. auth_name (String): The authentication name that is provided by the ITSP. enb_outbound_proxy (Integer): Whether to enable an outbound proxy.Valid value: 0: Disable 1: Enable outbound_proxy_server (String): The domain name or IP address of the outbound proxy server. outbound_proxy_port (Integer): The port of the outbound proxy server. codec_sel (String): Codec settings of the trunk.Valid value: ulaw alaw g729 gsm h264 h263 h263p ilbc g722 g726 speex adpcm mpeg4 vp8 opus def_outbound_cid (String): Default outbound caller ID. def_outbound_cid_name (String): Default outbound caller ID name. (Showing 16 of 31 documented fields; the rest are on the vendor reference page named in this tool's title.)

IVR

ToolPlanAccessSummary
yeastar_create_ivrProWriteAdd an IVR.
yeastar_delete_ivrProDestructiveDESTRUCTIVE.
yeastar_get_ivrFreeRead-onlyQuery the information of an IVR.
yeastar_list_ivrsFreeRead-onlyQuery the IVR list.
yeastar_query_ivrsFreeRead-onlyQuery the information of multiple IVRs.
yeastar_search_ivrsFreeRead-onlySearch specific IVRs.
yeastar_update_ivrProWriteEdit an IVR.

[Yeastar P-Series PBX] Add an IVR. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: number (String, required): IVR number. name (String, required): IVR name. prompt (String, required): The name of the IVR prompt.Valid value: default: The default prompt. Name of the existing custom prompt file on PBX (Path: PBX Settings > Voice Prompt > Custom Prompt). Note: Up to 5 prompts are supported. Use a comma to separate multiple custom prompt file names. E.g. default,IVR.wav. prompt_repeat (Integer, required): The maximum number of times the IVR prompt will be repeated.Valid value: 1 - 5. resp_timeout (Integer, required): The timeout duration for callers to input keys after playing the IVR prompt (Unit: Second).Valid value: 1 - 10. Note: If no input is received after the timeout, the system will repeat the IVR prompt until the maximum number of times is reached. If there is still no input after the timeout, the call will be routed to the Timeout Destination. digit_timeout (Integer, required): The timeout duration between the caller inputting a key and the next key (Unit: Second).Valid value: 1 - 10. alert_info (String): The "Alert-info" Header in the INVITE request to trigger the IP phone to play distinctive ringtones when receiving an incoming call from this IVR. (Showing 7 of 44 documented fields; the rest are on the vendor reference page named in this tool's title.)

[Yeastar P-Series PBX] DESTRUCTIVE. Delete an IVR. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of an IVR. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the IVR list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple IVRs. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific IVRs. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Edit an IVR. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of the IVR. Note: You can query IVR's ID using Search Specific IVRs. number (String): IVR number. name (String): IVR name. prompt (String): The name of the IVR prompt.Valid value: default: The default prompt. Name of the existing custom prompt file on PBX (Path: PBX Settings > Voice Prompt > Custom Prompt). Note: Up to 5 prompts are supported. Use a comma to separate multiple custom prompt file names. E.g. default,IVR.wav. prompt_repeat (Integer): The maximum number of times the IVR prompt will be repeated.Valid value: 1 - 5. resp_timeout (Integer): The timeout duration for callers to input keys after playing the IVR prompt (Unit: Second).Valid value: 1 - 10. Note: If no input is received after the timeout, the system will repeat the IVR prompt until the maximum number of times is reached. If there is still no input after the timeout, the call will be routed to the Timeout Destination. digit_timeout (Integer): The timeout duration between the caller inputting a key and the next key (Unit: Second).Valid value: 1 - 10. (Showing 7 of 45 documented fields; the rest are on the vendor reference page named in this tool's title.)

Paging

ToolPlanAccessSummary
yeastar_create_pagingProWriteAdd a paging group.
yeastar_delete_pagingProDestructiveDESTRUCTIVE.
yeastar_get_pagingFreeRead-onlyQuery the information of a paging group.
yeastar_list_paging_groupsFreeRead-onlyQuery the paging group list.
yeastar_query_paging_groupsFreeRead-onlyQuery the information of multiple paging groups.
yeastar_search_paging_groupsFreeRead-onlySearch specific paging groups.
yeastar_update_pagingProWriteEdit a paging group.

[Yeastar P-Series PBX] Add a paging group. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: number (String, required): Paging group number. name (String, required): Paging group name. type (String, required): Paging group type.Valid value: 1_way_paging 1_way_multicast_paging 2_way_intercom prompt (String): The prompt to be played before making an announcement. Note: You can query available custom prompts using the Get Menu Options interface. prompt_play_times (Integer, required): How many times the prompt will be played and repeated.Valid value: 0-100, where 0 indicates playing the prompt in a loop. broadcast (Array<Broadcast>): Broadcasters who initiate the paging. broadcast_client (String, required): Clients to receive broadcast.Valid value: exten: Extension Endpoint linkus: Linkus Mobile Client pc: Linkus Desktop Client web: Linkus Web Client pad: Linkus Pad Client (SDK) Note: Use & to separate multiple clients. dial_star_to_answer (Integer): Whether members can dial * to talk to the broadcaster privately.Valid value: 0: Disabled 1: Enabled dial_hash_to_stop_prompt (Integer): Whether broadcaster can dial # during playback to stop playing prompt.Valid value: 0: Disabled 1: Enabled (Showing 9 of 12 documented fields; the rest are on the vendor reference page named in this tool's title.)

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a paging group. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of a paging group. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the paging group list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegeryespage — Integer, required.
pageSizeintegeryespage_size — Integer, required.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple paging groups. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific paging groups. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegeryespage — Integer, required.
pageSizeintegeryespage_size — Integer, required.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Edit a paging group. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of a paging group.Note: You can query paging group's ID using Search Specific Paging Groups interface. name (String): Paging group name. type (String): Paging group type.Valid value: 1_way_paging 1_way_multicast_paging 2_way_intercom prompt (String): The prompt to be played before making an announcement. Note: You can query available custom prompts using the Get Menu Options interface. prompt_play_times (Integer): How many times the prompt will be played and repeated.Valid value: 0-100, where 0 indicates playing the prompt in a loop. broadcast (Array<Broadcast>): Broadcasters who initiate the paging. broadcast_client (String): Clients to receive broadcast.Valid value: exten: Extension Endpoint linkus: Linkus Mobile Client pc: Linkus Desktop Client web: Linkus Web Client pad: Linkus Pad Client (SDK) Note: Use & to separate multiple clients. dial_star_to_answer (Integer): Whether members can dial * to talk to the broadcaster privately.Valid value: 0: Disabled 1: Enabled dial_hash_to_stop_prompt (Integer): Whether broadcaster can dial # during playback to stop playing prompt.Valid value: 0: Disabled 1: Enabled (Showing 9 of 12 documented fields; the rest are on the vendor reference page named in this tool's title.)

Queue

ToolPlanAccessSummary
yeastar_agent_loginProDestructiveDESTRUCTIVE.
yeastar_agent_pauseProDestructiveDESTRUCTIVE.
yeastar_agent_status_queueFreeRead-onlyQuery agent status of a queue.
yeastar_call_status_queueFreeRead-onlyQuery call status of a queue.
yeastar_create_queueProWriteAdd a queue.
yeastar_delete_queueProDestructiveDESTRUCTIVE.
yeastar_get_queueFreeRead-onlyQuery the information of a queue.
yeastar_get_queue_optionFreeRead-onlyQuery global queue settings.
yeastar_list_queue_pause_reasonsFreeRead-onlyQuery queue pause reason list.
yeastar_list_queuesFreeRead-onlyQuery the queue list.
yeastar_query_queuesFreeRead-onlyQuery the information of multiple queues.
yeastar_queue_agent_loginProDestructiveDESTRUCTIVE.
yeastar_queue_agent_pauseProDestructiveDESTRUCTIVE.
yeastar_search_queuesFreeRead-onlySearch specific queues.
yeastar_set_honor_wrapup_time_queueProDestructiveDESTRUCTIVE.
yeastar_update_queueProWriteEdit a queue.
yeastar_update_queue_optionProDestructiveDESTRUCTIVE.
yeastar_update_queue_pause_reasonProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] DESTRUCTIVE. Agent management - Log in to or log out of queues. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
extIdintegeryesext_id — Integer, required.
isLoginLastintegernonullis_login_last — Integer, optional.
isPausedintegernonullis_paused — Integer, optional.
maxThresholdForLogoutTimeintegernonullmax_threshold_for_logout_time — Integer, optional.
maxThresholdForPauseTimeintegernonullmax_threshold_for_pause_time — Integer, optional.
operationstringyesoperation — String, required.
queueIdsstringnonullqueue_ids — String, optional.
reasonstringnonullreason — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Agent management - Pause or unpause queue service. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
extIdintegeryesext_id — Integer, required.
maxThresholdForPauseTimeintegernonullmax_threshold_for_pause_time — Integer, optional.
operationstringyesoperation — String, required.
queueIdsstringnonullqueue_ids — String, optional.
reasonstringnonullreason — String, optional.

[Yeastar P-Series PBX] Query agent status of a queue. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query call status of a queue. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Add a queue. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: number (String, required): Queue number. name (String, required): Queue name. enb_queue_skill_based_routing (Integer): Whether to route queue calls based on agents' skill levels.Valid value: 0: Disable. 1: Enable. ring_strategy (String, required): The ring strategy of the queue.Valid value: ring_all: Ring all available agents simultaneously until someone answers. least_recent: Ring the available agent that was least recently called. fewest_calls: Ring the available agent with the fewest completed calls. random: Ring the agents randomly. rrmemory: Round robin with memory. linear: Ring the available agent in specific order based on the type of agents in the queue. Note: If enb_queue_skill_based_routing is set to 1, queue calls will be routed in descending order of the agents' skill levels, and the ring strategy will only apply to agents with the same skill level. (Showing 4 of 70 documented fields; the rest are on the vendor reference page named in this tool's title.)

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a queue. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the information of a queue. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query global queue settings. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

[Yeastar P-Series PBX] Query queue pause reason list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.

[Yeastar P-Series PBX] Query the queue list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the information of multiple queues. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Queue management - Log in or log out agents. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
extIdsstringyesext_ids — String, required.
isPausedintegernonullis_paused — Integer, optional.
maxThresholdForLogoutTimeintegernonullmax_threshold_for_logout_time — Integer, optional.
maxThresholdForPauseTimeintegernonullmax_threshold_for_pause_time — Integer, optional.
operationstringyesoperation — String, required.
queueIdintegeryesqueue_id — Integer, required.
reasonstringnonullreason — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Queue management - Pause or unpause agents. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
extIdsstringyesext_ids — String, required.
maxThresholdForPauseTimeintegernonullmax_threshold_for_pause_time — Integer, optional.
operationstringyesoperation — String, required.
queueIdintegeryesqueue_id — Integer, required.
reasonstringnonullreason — String, optional.

[Yeastar P-Series PBX] Search specific queues. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Enable or disable shared wrap-up time among queues. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: enb_honor_wrapup_time (Integer, required): Whether to share break time among queues when an agent belongs to multiple queues. Valid value: 0: Disable. The break time is only valid for current queue, the agent will still receive calls from other queues during the break time. 1: Enable. After an agent finishes a queue call, the break time of the queue will be shared across all queues, the agent will not receive calls from other queues during this break time.

[Yeastar P-Series PBX] Edit a queue. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of the queue. number (String): Queue number. name (String): Queue name. enb_queue_skill_based_routing (Integer): Whether to route queue calls based on agents' skill levels.Valid value: 0: Disable. 1: Enable. ring_strategy (String): The ring strategy of the queue.Valid value: ring_all: Ring all available agents simultaneously until someone answers. least_recent: Ring the available agent that was least recently called. fewest_calls: Ring the available agent with the fewest completed calls. random: Ring the agents randomly. rrmemory: Round robin with memory. linear: Ring the available agent in specific order based on the type of agents in the queue. Note: If enb_queue_skill_based_routing is set to 1, queue calls will be routed in descending order of the agents' skill levels, and the ring strategy will only apply to agents with the same skill level. (Showing 5 of 71 documented fields; the rest are on the vendor reference page named in this tool's title.)

[Yeastar P-Series PBX] DESTRUCTIVE. Edit global queue settings. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: dynamic_agent_default_status (String): The default status assigned to dynamic agents when they are newly added to a queue.Valid value: login: Logged in. logout: Logged out. enb_honor_wrapup_time (Integer): Whether to share break time among queues when an agent belongs to multiple queues.Valid value: 0: Disable. The break time is only valid for current queue, the agent will still receive calls from other queues during the break time. 1: Enable. After an agent finishes a queue call, the break time of the queue will be shared across all queues, the agent will not receive calls from other queues during this break time. enb_process_result_sync (Integer): Whether to enable automatic synchronization for processing results of repeat calls from the same callers to the same queue within a specified time range. time_range (Integer): The time range (in hours) within which the processing result of repeat calls from the same callers to the same queue will synchronized.Note: This window is defined as the period of hours leading up to the time when the call processing result is updated. All records within this period will be updated accordingly. (Showing 4 of 5 documented fields; the rest are on the vendor reference page named in this tool's title.)

[Yeastar P-Series PBX] DESTRUCTIVE. Edit queue pause reason list. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: pause_reason_list (Array <Pause_Reason_List>, required): Queue pause reason list.Important: The queue pause reason list on PBX will be directly updated to the list set in this parameter.

Ring Group

ToolPlanAccessSummary
yeastar_create_ringgroupProWriteAdd a ring group.
yeastar_delete_ringgroupProDestructiveDESTRUCTIVE.
yeastar_get_ring_group_optionsFreeRead-onlyQuery the global ring group settings.
yeastar_get_ringgroupFreeRead-onlyQuery the detailed information of a ring group.
yeastar_list_ring_groupsFreeRead-onlyQuery the list of ring groups.
yeastar_query_ring_groupsFreeRead-onlyQuery the detailed information of multiple ring groups.
yeastar_search_ring_groupsFreeRead-onlySearch specific ring groups from the ring group list.
yeastar_update_ring_group_optionsProDestructiveDESTRUCTIVE.
yeastar_update_ringgroupProWriteEdit a ring group.

[Yeastar P-Series PBX] Add a ring group. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: number (String, required): The ring group number.Note: The maximum character length is 7. name (String, required): The ring group name.Note: The maximum character length is 127. ring_strategy (String, required): The ring strategy of the ring group.Valid value: ring_all: Ring all available extensions simultaneously. sequentially: Ring all available extensions sequentially. memory_hunt: Ring the first available extension in the member list. If no answer within the ring time, progressively ring the next available extension, until all the available extensions in the list rang. custom: Ring extensions according to their individual ring delays and stop ringing after their individual ring timeouts. ring_timeout (Integer): The waiting time (in seconds) before ringing the next member or routing the call to Failover Destination. Note: This parameter is required only when ring_strategy is set to ring_all, sequentially or memory_hunt. (Showing 4 of 30 documented fields; the rest are on the vendor reference page named in this tool's title.)

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a ring group. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the global ring group settings. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

[Yeastar P-Series PBX] Query the detailed information of a ring group. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Query the list of ring groups. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the detailed information of multiple ring groups. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Search specific ring groups from the ring group list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit the global ring group settings. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: enb_transfer_to_voicemail (Integer, required): Whether to allow the extensions in the member list with their extension voicemail enabled to forward incoming ring group calls to their own extension voicemail directly from the incoming call window.Valid value: 0: Disallow. 1: Allow.

[Yeastar P-Series PBX] Edit a ring group. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of the ring group. Note: You can query the ring group's ID using Search Specific Ring Groups. name (String): The ring group name.Note: The maximum character length is 127. ring_strategy (String): The ring strategy of the ring group.Valid value: ring_all: Ring all available extensions simultaneously. sequentially: Ring all available extensions sequentially. memory_hunt: Ring the first available extension in the member list. If no answer within the ring time, progressively ring the next available extension, until all the available extensions in the list rang. custom: Ring extensions according to their individual ring delays and stop ringing after their individual ring timeouts. ring_timeout (Integer): The waiting time (in seconds) before ringing the next member or routing the call to Failover Destination. Note: This parameter is required only when ring_strategy is set to ring_all, sequentially or memory_hunt. (Showing 4 of 30 documented fields; the rest are on the vendor reference page named in this tool's title.)

Voice Prompt

ToolPlanAccessSummary
yeastar_create_play_listProWriteCreate a music-on-hold playlist from prompts already on the PBX.
yeastar_get_play_listFreeRead-onlyRead one music-on-hold playlist by ID, with the prompts it holds.
yeastar_list_custom_ringtonesFreeRead-onlyList the custom ringtones uploaded to the PBX, which extensions and inbound routes can then select.
yeastar_list_play_listsFreeRead-onlyList the music-on-hold playlists on the PBX.
yeastar_query_play_listsFreeRead-onlyRead several music-on-hold playlists in one call.

[Yeastar P-Series PBX] Create a music-on-hold playlist from prompts already on the PBX. Callers only hear it once a queue, an extension or a trunk is pointed at the playlist. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: list_name (String, required): The name of the MoH playlist. list_type (Integer, required): The type of the MoH playlist.Valid value: 1: Local audio. 2: Streaming music. play_order (String): Playback order of the MoH in the playlist.Valid value: random: Randomly. alphabetical: Alphabetically. Note: This parameter is required when list_type is set to 1. stream_url (String): The URL of the streaming music.Note: This parameter is required when list_type is set to 2.

[Yeastar P-Series PBX] Read one music-on-hold playlist by ID, with the prompts it holds. Get the ID from yeastar_list_play_lists. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] List the custom ringtones uploaded to the PBX, which extensions and inbound routes can then select. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.

[Yeastar P-Series PBX] List the music-on-hold playlists on the PBX. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.

[Yeastar P-Series PBX] Read several music-on-hold playlists in one call. Pass ids as a comma-separated list of playlist IDs from yeastar_list_play_lists. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

Voicemail

ToolPlanAccessSummary
yeastar_create_voicemailProDestructiveDESTRUCTIVE.
yeastar_delete_all_extension_voicemailsProDestructiveDESTRUCTIVE.
yeastar_delete_voicemailProDestructiveDESTRUCTIVE.
yeastar_download_voicemailFreeRead-onlyGet a download URL for one voicemail recording.
yeastar_get_voicemailsFreeRead-onlyList the voicemail messages held for one extension or one group voicemail, with the ID, caller, time and read status of each.
yeastar_list_voicemail_groupsFreeRead-onlyList the group voicemail boxes on the PBX with the number and mode of each.
yeastar_query_voicemailsFreeRead-onlyList the voicemail messages of several extensions or group voicemails in one call.
yeastar_update_voicemail_read_statusProWriteMark a voicemail message as read.

[Yeastar P-Series PBX] DESTRUCTIVE. Add a voicemail message to an extension mailbox, from vm_from_number to the vm_to_number extension. It shows up as a new voicemail and the mailbox owner is notified the way the PBX is set to notify them, so this reaches a person. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: vm_from_number (String, required): The number that leaves the voicemail message. Note: Numbers 0-9 and characters *, #, +, [, ], (, ), -, . are allowed. The maximum character length is 31. vm_to_number (String, required): The extension number to which the voicemail message was left.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete EVERY voicemail message held for an extension, read and unread alike, in one call. Pass vm_to_number as the extension number. It is not per message and it cannot be undone: use yeastar_delete_voicemail for a single message. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
vmToNumberstringyesvm_to_number — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete one voicemail message permanently. Pass either id or uid, both from yeastar_get_voicemails, and confirm the message there first: the recording cannot be recovered. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idstringnonullid — String, optional.
uidstringnonulluid — String, optional.

[Yeastar P-Series PBX] Get a download URL for one voicemail recording. Pass either msg_id or uid, both from yeastar_get_voicemails. It returns a URL and not audio, and that URL only resolves with an access token appended, which StackJack does not hand out, so the recording cannot be fetched from this response. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
msgIdstringnonullmsg_id — String, optional.
uidstringnonulluid — String, optional.

[Yeastar P-Series PBX] List the voicemail messages held for one extension or one group voicemail, with the ID, caller, time and read status of each. Pass number as the extension number or the group voicemail number. A group voicemail is readable only when its mode is Shared by Members. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
numberintegeryesnumber — Integer, required.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.

[Yeastar P-Series PBX] List the group voicemail boxes on the PBX with the number and mode of each. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] List the voicemail messages of several extensions or group voicemails in one call. Pass number as a comma-separated list of extension or group voicemail numbers. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
numberstringyesnumber — String, required.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.

[Yeastar P-Series PBX] Mark a voicemail message as read. The vendor documents vm_status with the single value 1 (Read), so this does not un-read a message. Pass either id or uid, both from yeastar_get_voicemails. It changes the read flag only and never touches the recording. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (String): The unique ID of the voicemail message.Note: You can query the voicemail message ID using Query Voicemail Messages of an Extension or a Group Voicemail. Either id or uid is required for updating read status of a voicemail message. uid (String): The unique ID of CDR. Note: You can query the ID using Query Voicemail Messages of an Extension or a Group Voicemail. Either id or uid is required for updating read status of a voicemail message. vm_status (String, required): Specify the read status of the voicemail message.Valid value: 1 (Read).

Voicemail Greeting

ToolPlanAccessSummary
yeastar_delete_extension_voicemail_greetingProDestructiveDESTRUCTIVE.
yeastar_delete_group_voicemail_greetingProDestructiveDESTRUCTIVE.
yeastar_download_extension_voicemail_greetingFreeRead-onlyGet a download URL for one extension voicemail greeting.
yeastar_download_group_voicemail_greetingFreeRead-onlyGet a download URL for one group voicemail greeting.
yeastar_list_extension_voicemail_greetingsFreeRead-onlyList the voicemail greetings recorded for one extension, with the file name of each.
yeastar_list_global_voicemail_greetingsFreeRead-onlyList the global voicemail greetings on the PBX, the ones callers hear when an extension has no greeting of its own.
yeastar_list_group_voicemail_greetingsFreeRead-onlyList the greetings recorded for a group voicemail, with the file name of each.
yeastar_play_extension_voicemail_greetingProDestructiveDESTRUCTIVE.
yeastar_play_group_voicemail_greetingProDestructiveDESTRUCTIVE.
yeastar_record_extension_voicemail_greetingProDestructiveDESTRUCTIVE.
yeastar_record_group_voicemail_greetingProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete one extension voicemail greeting permanently. Callers then hear that extension next greeting, or the global one. Confirm the file name with yeastar_list_extension_voicemail_greetings first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
extensionstringyesextension — String, required.
filestringyesfile — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete one group voicemail greeting permanently. Callers then hear the global greeting instead. Confirm the file name with yeastar_list_group_voicemail_greetings first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
extensionstringyesextension — String, required.
filestringyesfile — String, required.

[Yeastar P-Series PBX] Get a download URL for one extension voicemail greeting. Pass the file name from yeastar_list_extension_voicemail_greetings. It returns a URL and not audio, and that URL only resolves with an access token appended, which StackJack does not hand out. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
extensionstringyesextension — String, required.
filestringyesfile — String, required.

[Yeastar P-Series PBX] Get a download URL for one group voicemail greeting. Pass the file name from yeastar_list_group_voicemail_greetings. It returns a URL and not audio, and that URL only resolves with an access token appended, which StackJack does not hand out. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
extensionstringyesextension — String, required.
filestringyesfile — String, required.

[Yeastar P-Series PBX] List the voicemail greetings recorded for one extension, with the file name of each. Pass extension as the extension number. The file name is what the play, download and delete greeting tools take. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
extensionstringyesextension — String, required.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.

[Yeastar P-Series PBX] List the global voicemail greetings on the PBX, the ones callers hear when an extension has no greeting of its own. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

[Yeastar P-Series PBX] List the greetings recorded for a group voicemail, with the file name of each. Pass extension as the group voicemail number. The file name is what the play, download and delete greeting tools take. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
extensionstringyesextension — String, required.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.

[Yeastar P-Series PBX] DESTRUCTIVE. Play an extension voicemail greeting back over the phone: the PBX RINGS that extension and plays the greeting to whoever answers. Pass the file name from yeastar_list_extension_voicemail_greetings. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
extensionstringyesextension — String, required.
filestringyesfile — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Play a group voicemail greeting back over the phone: the PBX RINGS the extension you name and plays the greeting to whoever answers. Pass the file name from yeastar_list_group_voicemail_greetings. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
extensionstringyesextension — String, required.
filestringyesfile — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Record a new extension voicemail greeting: the PBX RINGS the recorder extension and records what the answerer says as the greeting for the owner extension, replacing any greeting of that file name. Whoever is at the recorder desk is put on the spot, so tell them first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
filestringyesfile — String, required.
ownerstringyesowner — String, required.
recorderstringyesrecorder — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Record a new group voicemail greeting: the PBX RINGS the recorder extension and records what the answerer says as the greeting for the owner group voicemail, replacing any greeting of that file name. Whoever is at the recorder desk is put on the spot, so tell them first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
filestringyesfile — String, required.
ownerstringyesowner — String, required.
recorderstringyesrecorder — String, required.

Call Note

ToolPlanAccessSummary
yeastar_get_callnotesFreeRead-onlyGet the call notes of a specific call.
yeastar_update_callnotesProWriteUpdate the call notes of a specific call.

[Yeastar P-Series PBX] Get the call notes of a specific call. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
groupIdintegeryesgroup_id — Integer, required.
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Update the call notes of a specific call. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (String, required): The unique ID of the call note.Note: You can get the group ID from the (30028) Call Note Status Updated event report. group_id (String): The group ID of the call note.Note: The group ID is REQUIRED when modifying call notes during a call (update_entry is in_call) or in the wrap-up time (update_entry is queue_agent). You can get the group ID from the (30028) Call Note Status Updated event report. disposition_code_ids (String): The unique ID(s) of call disposition code(s).Note: You can query the disposition code ID using the Get Menu Options interface. Use comma to separate multiple disposition code IDs. remark (String): Remark of the call note. update_entry (String, required): The scenario in which the call note is updated.Valid value: in_call: Update call notes during a call. cdr: Update call notes after a call in the call log (Available for CDRs generated before version 84.21.0.117). new_cdr: Update call notes after a call in the call log (Available for CDRs generated in version 84.21.0.117 or later). queue_agent: Update call notes during wrap-up time.Note: This scenario is available for queue agents.

Call report

ToolPlanAccessSummary
yeastar_detail_call_reportFreeRead-onlyQuery call details in specific IVR/Queue/Agent report.
yeastar_download_call_reportFreeRead-onlyGet the download URL to download an instant call report.
yeastar_download_call_schedule_reportFreeRead-onlyGet the download URL to download a scheduled call report.
yeastar_list_call_reportsFreeRead-onlyQuery call statistics for a specific call report.
yeastar_list_call_schedule_reportsFreeRead-onlyQuery the scheduled call report list.
yeastar_list_myreportsFreeRead-onlyQuery the custom call report list.

[Yeastar P-Series PBX] Query call details in specific IVR/Queue/Agent report. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number. Pass rarely-used documented parameters through the filters object.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
filtersJsonstringnonullAdditional documented query parameters as a flat JSON object of scalar values, passed as a JSON string. This endpoint documents more parameters than fit a tool signature.

[Yeastar P-Series PBX] Get the download URL to download an instant call report. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number. Pass rarely-used documented parameters through the filters object.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
filtersJsonstringnonullAdditional documented query parameters as a flat JSON object of scalar values, passed as a JSON string. This endpoint documents more parameters than fit a tool signature.

[Yeastar P-Series PBX] Get the download URL to download a scheduled call report. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
idstringnonullid — Yes, optional.
isAsyncstringnonullis_async — No, optional.
needDetailstringnonullneed_detail — No, optional.

[Yeastar P-Series PBX] Query call statistics for a specific call report. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number. Pass rarely-used documented parameters through the filters object.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
filtersJsonstringnonullAdditional documented query parameters as a flat JSON object of scalar values, passed as a JSON string. This endpoint documents more parameters than fit a tool signature.

[Yeastar P-Series PBX] Query the scheduled call report list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 1000.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query the custom call report list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 1000.
sortBystringnonullsort_by — String, optional.

CDR

ToolPlanAccessSummary
yeastar_detail_cdrFreeRead-onlyQuery the CDR detail.
yeastar_download_ai_transcript_cdrFreeRead-onlyGet the download URL for the JSON file containing the desired AI call transcription data (including the call transcript and call summary).
yeastar_download_cdrFreeRead-onlyGet the download URL to download a CDR file.
yeastar_get_cdr_download_optionFreeRead-onlyQuery CDR download settings.
yeastar_get_cdr_optionFreeRead-onlyGet CDR options.
yeastar_getaicontext_cdrFreeRead-onlyRetrieve the AI call transcript of the specified CDR, which may include multiple call legs.
yeastar_getaisummary_cdrFreeRead-onlyRetrieve the AI-generated call summary of a specific call leg.
yeastar_list_cdrFreeRead-onlyQuery the CDR list.
yeastar_search_cdrFreeRead-onlySearch specific CDR.
yeastar_update_cdr_download_optionProWriteEdit CDR download settings.
yeastar_update_cdr_optionProWriteEdit CDR options.

[Yeastar P-Series PBX] Query the CDR detail. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
uidstringyesuid — String, required.

[Yeastar P-Series PBX] Get the download URL for the JSON file containing the desired AI call transcription data (including the call transcript and call summary). Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
callFromstringnonullcall_from — String, optional.
callTostringnonullcall_to — String, optional.
callTypestringnonullcall_type — String, optional.
endTimestringnonullend_time — String, optional.
lastStatusstringnonulllast_status — String, optional.
startTimestringnonullstart_time — String, optional.

[Yeastar P-Series PBX] Get the download URL to download a CDR file. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number. Pass rarely-used documented parameters through the filters object.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
filtersJsonstringnonullAdditional documented query parameters as a flat JSON object of scalar values, passed as a JSON string. This endpoint documents more parameters than fit a tool signature. The parameters this tool already takes by name are not accepted here.
orderBystringnonullorder_by — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Query CDR download settings. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.

[Yeastar P-Series PBX] Get CDR options. Note: The interface supports to query the enablement status of CDR options, such as fuzzy search. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.

[Yeastar P-Series PBX] Retrieve the AI call transcript of the specified CDR, which may include multiple call legs. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
cdrIdsstringyescdr_ids — String, required.
limitintegernonulllimit — Integer, optional.
offsetintegernonulloffset — Integer, optional.
searchValuestringnonullsearch_value — String, optional.

[Yeastar P-Series PBX] Retrieve the AI-generated call summary of a specific call leg. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
cdrIdstringyescdr_id — String, required.
dstExtIdintegernonulldst_ext_id — Integer, optional.
srcExtIdintegernonullsrc_ext_id — Integer, optional.

[Yeastar P-Series PBX] Query the CDR list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
callFromstringnonullcall_from — String, optional.
callTostringnonullcall_to — String, optional.
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 1000.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Search specific CDR. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number. Pass rarely-used documented parameters through the filters object.

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
filtersJsonstringnonullAdditional documented query parameters as a flat JSON object of scalar values, passed as a JSON string. This endpoint documents more parameters than fit a tool signature. The parameters this tool already takes by name are not accepted here.
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 1000.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] Edit CDR download settings. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: range (String): The download range for CDR.Valid values: list: Only list data. transaction: Only call leg data. list_transaction: List and call leg data. all: List, call leg, and timeline data. format (String): The download format for CDR.Valid values: csv xls pdf html duration_format (String): The display format for all duration-related fields.Valid values: seconds hhmmss export_column (String): The fields to export.Valid values: all selected

[Yeastar P-Series PBX] Edit CDR options. Note: The interface supports to change the enablement status of CDR options, such as fuzzy search. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
apiVersionstringnonullPBX firmware api path: omit (or pass v2.0) for firmware 84.21.0.117 and later; pass v1.0 for 84.21.0.66 and earlier. Both remain live — this is a firmware gate, not a deprecation.
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: enb_new_cdr_fuzzy_search (Integer, required): Whether to search for the fuzzy equivalent for the phone number when querying CDRs generated on 84.21.0.117 or later.Valid value: 0: Disable 1: Enable

Recording

ToolPlanAccessSummary
yeastar_download_recordingFreeRead-onlyGet the download URL to download a recording file.
yeastar_list_recordingsFreeRead-onlyQuery the recording file list.
yeastar_play_recording_to_extensionProDestructiveDESTRUCTIVE.
yeastar_search_recordingsFreeRead-onlySearch specific recording files.

[Yeastar P-Series PBX] Get the download URL to download a recording file. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
filestringnonullfile — String, optional.
idintegernonullid — Integer, optional.

[Yeastar P-Series PBX] Query the recording file list. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Play a recording to a specified extension. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
filestringnonullfile — String, optional.
idintegernonullid — Integer, optional.
playToExtensionstringyesplay_to_extension — String, required.

[Yeastar P-Series PBX] Search specific recording files. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
calleestringnonullcallee — String, optional.
callerstringnonullcaller — String, optional.
endTimestringnonullend_time — String, optional.
idsstringnonullids — String, optional.
orderBystringnonullorder_by — String, optional.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
sortBystringnonullsort_by — String, optional.
startTimestringnonullstart_time — String, optional.

Messaging

ToolPlanAccessSummary
yeastar_archive_message_sessionProWriteArchive a message session so it leaves the agent active list.
yeastar_close_message_sessionProDestructiveDESTRUCTIVE.
yeastar_create_livechat_channelProWriteCreate a Live Chat channel: the website widget, where its chats land, its welcome messages, its pre-chat form and its data-privacy statement.
yeastar_create_message_campaignProDestructiveDESTRUCTIVE.
yeastar_create_message_channelProWriteCreate a message channel over SMS, WhatsApp or Facebook.
yeastar_create_message_queueProWriteCreate a message queue and its agent list.
yeastar_delete_message_campaignProDestructiveDESTRUCTIVE.
yeastar_delete_message_channelProDestructiveDESTRUCTIVE.
yeastar_delete_message_queueProDestructiveDESTRUCTIVE.
yeastar_delete_message_sessionProDestructiveDESTRUCTIVE.
yeastar_email_livechat_embed_codeProDestructiveDESTRUCTIVE.
yeastar_get_livechat_channelFreeRead-onlyRead one Live Chat channel by ID: the website widget appearance, its welcome messages, its pre-chat form and its data-privacy statement.
yeastar_get_livechat_embed_codeFreeRead-onlyGet the HTML embed code that puts a Live Chat widget on a website.
yeastar_get_message_campaignFreeRead-onlyRead one message campaign by ID: its recipients, content, schedule and send mode.
yeastar_get_message_channelFreeRead-onlyRead one message channel by ID: its service provider, its numbers and its session settings.
yeastar_get_message_queueFreeRead-onlyRead one message queue by ID, with its assignment mode and its agents.
yeastar_get_message_sessionFreeRead-onlyRead one message session by ID: its channel, contact, assigned agent and state.
yeastar_list_message_campaignsFreeRead-onlyList the bulk messaging campaigns on the PBX with the status and schedule of each.
yeastar_list_message_channelsFreeRead-onlyList the message channels, the SMS, WhatsApp and Facebook connections the PBX sends and receives on, with each channel message counts over time_range.
yeastar_list_message_queuesFreeRead-onlyList the message queues, the agent groups that chat sessions are routed to, with the assignment mode of each.
yeastar_list_message_sessionsFreeRead-onlyList message sessions, the SMS, WhatsApp, Facebook and Live Chat conversations the PBX holds, for one extension or for the analytics platform.
yeastar_list_session_messagesFreeRead-onlyRead the messages inside one message session.
yeastar_list_whatsapp_templatesFreeRead-onlyList the approved WhatsApp message templates on a WhatsApp channel, with the placeholders each template takes.
yeastar_query_message_campaignsFreeRead-onlyRead several message campaigns in one call.
yeastar_query_message_channelsFreeRead-onlyRead several message channels in one call.
yeastar_query_message_queuesFreeRead-onlyRead several message queues in one call.
yeastar_query_message_sessionsFreeRead-onlyRead several message sessions in one call.
yeastar_query_messagesFreeRead-onlyRead the messages inside several message sessions in one call.
yeastar_react_to_messageProDestructiveDESTRUCTIVE.
yeastar_retry_message_campaignProDestructiveDESTRUCTIVE.
yeastar_search_message_campaignsFreeRead-onlySearch message campaigns and get each match ID.
yeastar_search_message_channelsFreeRead-onlySearch message channels and get each match ID.
yeastar_search_message_queuesFreeRead-onlySearch message queues and get each match ID.
yeastar_search_message_sessionsFreeRead-onlySearch message sessions and get each match session ID.
yeastar_send_messageProDestructiveDESTRUCTIVE.
yeastar_transfer_message_sessionProDestructiveDESTRUCTIVE.
yeastar_unarchive_message_sessionProWriteMove an archived message session back into the agent active list.
yeastar_update_livechat_channelProDestructiveDESTRUCTIVE.
yeastar_update_message_campaignProDestructiveDESTRUCTIVE.
yeastar_update_message_channelProDestructiveDESTRUCTIVE.
yeastar_update_message_queueProWriteEdit a message queue.

[Yeastar P-Series PBX] Archive a message session so it leaves the agent active list. It is reversible with yeastar_unarchive_message_session, and the conversation and its history are kept. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: session_id (Integer, required): The unique ID of the message session.Note: You can query the message session ID using Search Specific Message Sessions. user_type (Integer, required): The type of the operator who archives the message session.Valid value: 1: Extension user. 9: Third-party message analytics platform. user_no (String): The unique ID of the operator who archives the message session.Valid value: If user_type is set to 1, this parameter is REQUIRED and is used to specify the corresponding ID of the extension user.Note: You can query the extension ID using Search Specific Extensions. If user_type is set to 9, set the value to api or leave it empty.

[Yeastar P-Series PBX] DESTRUCTIVE. Close a message session: the conversation ends for the contact, who is sent the channel session-closed message, and the agent session is finished. This API documents no interface to reopen a closed session. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: session_id (Integer, required): The unique ID of the message session.Note: You can query the message session ID using Search Specific Message Sessions.

[Yeastar P-Series PBX] Create a Live Chat channel: the website widget, where its chats land, its welcome messages, its pre-chat form and its data-privacy statement. Nobody sees it until the embed code from yeastar_get_livechat_embed_code is placed on a site. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: name (String) max 63; website_domain (String) the site the widget is embedded on; communication_method (Integer) 1 chat only or 2 phone call and chat; destination_type (String) extension, queue or api, with destination_id (Integer) for extension or queue from yeastar_search_extensions or yeastar_search_message_queues; max_concurrent_call (Integer) 1 to 10; message_type (Integer) 1 text and emojis or 2 with images; theme_mode light or dark; theme_color a 6-digit hex RGB; minimize_style round or bar; chat_icon 1 to 6; default_agent_name (String); language (String) BROWSER_LANGUAGE or a language code; online_welcome_message, offline_welcome_message and session_closed_message (String) max 255 each. OPTIONAL: the enable_webrtc_inbound_call trio, auto_close_session trio, pre-chat form and data-privacy fields.

[Yeastar P-Series PBX] DESTRUCTIVE. Create a bulk messaging campaign. send_type immediately starts messaging EVERY recipient the moment the campaign is saved, schedule sends at send_time, and draft sends nothing. Every message is billable on the channel provider. Save a draft first and read it back with yeastar_get_message_campaign before you release it. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: name (String); channel_type (String) sms or whatsapp; omnichannel_id (Integer) the channel ID and sender (Integer) the number ID on it, both from yeastar_search_message_channels; recipient_type (String) input or phonebook; content_type (String) text, document or template; send_type (String) immediately, schedule or draft; send_mode (String) new_session or direct. CONDITIONAL: number_list (Array) when recipient_type is input, numbers in E.164; recipient_id (Integer) from yeastar_search_phonebooks plus recipient_num_type (String) when it is phonebook; content (String) for text or document; msg_param (String) for template, built from yeastar_list_whatsapp_templates; send_time (Integer) a Unix timestamp in seconds when scheduled; assign_to_type and assign_to_id when send_mode is new_session.

[Yeastar P-Series PBX] Create a message channel over SMS, WhatsApp or Facebook. account_data carries the service provider connection credentials, so once an extension or a campaign uses the channel it sends billable messages. Creating one sends nothing by itself. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: name (String) max 127 characters; webhook_url_type (String) fqdn or nat; channel (String) the service provider - general, alhambra, apidaze, aspsms, athena, bandwidth, clearfly, flowroute, ixica, iztcloudvoice, netplanet, siptrunk, skyetel, telnyx, twilio, vetta, voicemeup, voipms or voxtelesys; account_data (Array of Auth_Info) the provider connection credentials. OPTIONAL: send_rate (Integer) messages per second; auto_close_session (Integer) and session_expired_time (Integer) close an idle session after so many days; enb_duplicate_active_session (Integer) 0 disallows a second active session for the same pair (default), 1 allows it and moves the whole history to the new creator; accompanying_msg (String) required for an Apidaze SMS channel; dids (Array) the numbers bound to the channel. See the vendor page Add a Message Channel for the Auth_Info shape.

[Yeastar P-Series PBX] Create a message queue and its agent list. Chat sessions only reach those agents once a channel or a campaign is pointed at the queue, so creating one messages nobody. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: name (String, required): The name of the message queue. assignment_mode (String, required): The assignment mode of chat sessions sent to the message queue.Valid value: none: Agents cannot pick up sessions. auto: The first agent to respond will automatically pick up the session. manual: Agents can take over the session by clicking the Pick Up button. members (Array<Members>, required): The agents in the message queue.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a message campaign permanently, with its recipient list and its content. Messages it already sent cannot be unsent. Read the campaign with yeastar_get_message_campaign first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a message channel permanently. Every session on it stops and the PBX can no longer send or receive on its numbers. Read the channel with yeastar_get_message_channel first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a message queue permanently. Sessions routed to it stop reaching its agents. Read the queue with yeastar_get_message_queue first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a message session and its whole conversation history permanently. The contact messages go with it and there is no undo. Use yeastar_archive_message_session instead when you only want the session out of the agent list. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
sessionIdintegeryessession_id — Integer, required.
userNostringnonulluser_no — String, optional.
userTypeintegeryesuser_type — Integer, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Have the PBX EMAIL a Live Chat widget embed code and its installation instructions to an address. The mail reaches a person, so check the address before you send it. Pass the channel ID from yeastar_search_message_channels. yeastar_get_livechat_embed_code returns the same code and emails nobody. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
emailstringyesemail — String, required.
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Read one Live Chat channel by ID: the website widget appearance, its welcome messages, its pre-chat form and its data-privacy statement. Get the ID from yeastar_search_message_channels. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Get the HTML embed code that puts a Live Chat widget on a website. Pass the channel ID from yeastar_search_message_channels. This read emails nobody; yeastar_email_livechat_embed_code is the tool that has the PBX mail the code and its install instructions to an address. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Read one message campaign by ID: its recipients, content, schedule and send mode. Read a campaign with this before you edit, release or retry it. Get the ID from yeastar_search_message_campaigns. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Read one message channel by ID: its service provider, its numbers and its session settings. Get the ID from yeastar_search_message_channels. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Read one message queue by ID, with its assignment mode and its agents. Get the ID from yeastar_search_message_queues. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Read one message session by ID: its channel, contact, assigned agent and state. Get the ID from yeastar_search_message_sessions. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] List the bulk messaging campaigns on the PBX with the status and schedule of each. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegeryespage — Integer, required.
pageSizeintegeryespage_size — Integer, required.

[Yeastar P-Series PBX] List the message channels, the SMS, WhatsApp and Facebook connections the PBX sends and receives on, with each channel message counts over time_range. page, page_size and time_range are all required; time_range is today, yesterday, last_7_days, last_30_days, this_month or all. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegeryespage — Integer, required.
pageSizeintegeryespage_size — Integer, required.
timeRangestringyestime_range — String, required.

[Yeastar P-Series PBX] List the message queues, the agent groups that chat sessions are routed to, with the assignment mode of each. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegeryespage — Integer, required.
pageSizeintegeryespage_size — Integer, required.

[Yeastar P-Series PBX] List message sessions, the SMS, WhatsApp, Facebook and Live Chat conversations the PBX holds, for one extension or for the analytics platform. user_type 1 is an extension user and then user_no is that extension number; user_type 9 is a third-party analytics platform. Narrow with is_archived, is_closed and is_pickup. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
collectionstringnonullcollection — String, optional.
firstMsgIdintegernonullfirst_msg_id — Integer, optional.
isArchivedintegernonullis_archived — Integer, optional.
isClosedintegernonullis_closed — Integer, optional.
isPickupintegernonullis_pickup — Integer, optional.
pageSizeintegeryespage_size — Integer, required.
userNostringnonulluser_no — String, optional.
userTypeintegeryesuser_type — Integer, required.

[Yeastar P-Series PBX] Read the messages inside one message session. Pass id as the session ID from yeastar_search_message_sessions, and last_msg_id to page back through older messages. Read the conversation with this before you reply to it. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.
lastMsgIdintegernonulllast_msg_id — Integer, optional.
pageSizeintegeryespage_size — Integer, required.

[Yeastar P-Series PBX] List the approved WhatsApp message templates on a WhatsApp channel, with the placeholders each template takes. A campaign whose content_type is template needs a template from here. Pass omnichannel_id as the channel ID from yeastar_search_message_channels. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
categorystringnonullcategory — String, optional.
languagestringnonulllanguage — String, optional.
omnichannelIdintegeryesomnichannel_id — Integer, required.
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.
searchValuestringnonullsearch_value — String, optional.

[Yeastar P-Series PBX] Read several message campaigns in one call. Pass ids as a comma-separated list of campaign IDs from yeastar_search_message_campaigns. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Read several message channels in one call. Pass ids as a comma-separated list of channel IDs from yeastar_search_message_channels. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Read several message queues in one call. Pass ids as a comma-separated list of queue IDs from yeastar_search_message_queues. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Read several message sessions in one call. Pass ids as a comma-separated list of session IDs from yeastar_search_message_sessions. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.

[Yeastar P-Series PBX] Read the messages inside several message sessions in one call. Pass ids as a comma-separated list of session IDs from yeastar_search_message_sessions. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — String, required.
pageSizeintegeryespage_size — Integer, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Add an emoji reaction to a message. The reaction is visible to the contact in the conversation, so it reaches a person. Get msg_id from yeastar_list_session_messages, and the emoji characters the PBX accepts from yeastar_get_system_menu_options with menu emoji. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: emoji (String, required): The emoji character to be added.Note: You can query the available emojis using Get Menu Options (menu=emoji). msg_id (Integer, required): The ID of the message to which you want to reply with an emoji.Note: You can query the message ID using Query Messages in a Message Session. sender_type (Integer, required): The type of the sender.Valid value: 1: Extension user. 9: Third-party message analytics platform (transmitted via API) sender_no (String): The identifier of the sender.Valid value: If sender_type is set to 1, this parameter is REQUIRED, which can be used to specify the extension number. If sender_type is set to 9, enter api or leave it blank.

[Yeastar P-Series PBX] DESTRUCTIVE. Retry a message campaign: the PBX sends again to the recipients that failed, and every retry is a real billable message reaching a real person. Read the failure counts with yeastar_get_message_campaign before you retry. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Search message campaigns and get each match ID. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegeryespage — Integer, required.
pageSizeintegeryespage_size — Integer, required.
searchValuestringnonullsearch_value — String, optional.

[Yeastar P-Series PBX] Search message channels and get each match ID. time_range is required and sets the window the message counts cover. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegeryespage — Integer, required.
pageSizeintegeryespage_size — Integer, required.
searchValuestringnonullsearch_value — String, optional.
timeRangestringyestime_range — String, required.

[Yeastar P-Series PBX] Search message queues and get each match ID. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegeryespage — Integer, required.
pageSizeintegeryespage_size — Integer, required.
searchValuestringnonullsearch_value — String, optional.

[Yeastar P-Series PBX] Search message sessions and get each match session ID. This is the read to start from when you know a conversation only by the contact or the number. The user_type and user_no rules are the same as on yeastar_list_message_sessions. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
collectionstringnonullcollection — String, optional.
firstMsgIdintegernonullfirst_msg_id — Integer, optional.
isArchivedintegernonullis_archived — Integer, optional.
isClosedintegernonullis_closed — Integer, optional.
isPickupintegernonullis_pickup — Integer, optional.
pageSizeintegeryespage_size — Integer, required.
searchValuestringnonullsearch_value — String, optional.
userNostringnonulluser_no — String, optional.
userTypeintegeryesuser_type — Integer, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Send a message into a message session: the contact on the other side, over SMS, WhatsApp, Facebook or Live Chat, receives it at once and it cannot be recalled. Get the session ID from yeastar_search_message_sessions and read the conversation with yeastar_list_session_messages first. Text only: sending a file needs the vendor upload interface, which StackJack does not expose. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: session_id (Integer): the session to send into, from yeastar_search_message_sessions. Omit it to start a session, and then channel, did_number and to are all REQUIRED - channel is general, whatsapp, facebook, livechat or a named SMS provider, did_number is the channel DID from yeastar_search_message_channels, to is the external number. msg_kind (Integer): 0 normal, 1 WhatsApp template. msg_type (Integer): 0 user message. msg_body (String): the text. whatsapp_msg_param (String): template values as a JSON string, REQUIRED when msg_kind is 1, from yeastar_list_whatsapp_templates. quote_msg_id (Integer): the quoted message. tag (String): the Facebook message tag.

[Yeastar P-Series PBX] DESTRUCTIVE. Hand a LIVE message session to another extension, to a message queue or to the analytics platform. The current agent loses it at once and the contact is answered by whoever picks it up next. Get the session ID from yeastar_search_message_sessions, and the destination ID from yeastar_search_extensions or yeastar_search_message_queues. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: session_id (Integer, required): The unique ID of the message session.Note: You can query the message session ID using Search Specific Message Sessions. destination_type (String, required): The type of the destination to which the session will be transferred.Valid value: extension: Extension user. queue: Message queue. api: Third-party message analytics platform. destination_id (Integer): The unique ID of the destination to which the session will be transferred.Valid value: If destination_type is set to extension or queue, this parameter is REQUIRED and is used to specify the corresponding ID of the destination.Note: You can query the extension ID using Search Specific Extensions, and query the message queue ID using Search Specific Message Queues. If destination_type is set to api, you can set the value to 0 or leave it empty.

[Yeastar P-Series PBX] Move an archived message session back into the agent active list. The conversation and its history are unchanged. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: session_id (Integer, required): The unique ID of the message session.Note: You can query the message session ID using Search Specific Message Sessions. user_type (Integer, required): The type of the operator who unarchives the message session.Valid value: 1: Extension user. 9: Third-party message analytics platform. user_no (String): The unique ID of the operator who unarchives the message session.Valid value: If user_type is set to 1, this parameter is REQUIRED and is used to specify the corresponding ID of the extension user.Note: You can query the extension ID using Search Specific Extensions. If user_type is set to 9, set the value to api or leave it empty.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit a LIVE Live Chat channel: the widget on the customer website changes at once, including the welcome messages visitors are sent, the pre-chat form, the data-privacy statement, and the WebRTC trunk and inbound route that carry web calls. Read the channel with yeastar_get_livechat_channel first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: id (Integer) the Live Chat channel ID, from yeastar_search_message_channels. Every other field is the same as on yeastar_create_livechat_channel and is optional here: name, website_domain, communication_method, destination_type with destination_id, max_concurrent_call 1 to 10, message_type 1 or 2, theme_mode light or dark, theme_color as 6-digit hex RGB, minimize_style round or bar, chat_icon 1 to 6, default_avatar, default_agent_name, show_agent_info, hide_provider_info, language, the enable_webrtc_inbound_call trio, the auto_close_session trio, the pre-chat form fields, enable_data_privacy with data_privacy_content and require_data_privacy_consent, and the online_welcome_message, offline_welcome_message, first_reply_message and session_closed_message texts, max 255 each. See the vendor page Edit a Live Chat Channel.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit a message campaign. Setting send_type to immediately releases it and EVERY recipient is messaged at once; changing the recipients or the content changes what they receive. Read the campaign with yeastar_get_message_campaign first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: id (Integer) the campaign ID, from yeastar_search_message_campaigns. The remaining fields are the same as on yeastar_create_message_campaign: name; channel_type sms or whatsapp; omnichannel_id and sender from yeastar_search_message_channels; recipient_type input or phonebook, with number_list in E.164 or recipient_id plus recipient_num_type; content_type text, document or template, with content or msg_param; send_type immediately, schedule or draft, with send_time as a Unix timestamp in seconds when scheduled; send_mode new_session or direct, with assign_to_type and assign_to_id when new_session. A campaign that has already sent cannot be unsent by editing it.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit a LIVE message channel. account_data carries the provider connection credentials and dids the numbers bound to the channel: passing either one replaces that connection material, and a wrong value silently breaks every message the channel carries. Read the channel with yeastar_get_message_channel first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: id (Integer) the channel ID, from yeastar_search_message_channels. Everything else is optional and replaces what is there: name (String) max 127 characters; webhook_url_type (String) fqdn or nat; account_data (Array of Auth_Info) the provider connection credentials; send_rate (Integer) messages per second; auto_close_session (Integer) and session_expired_time (Integer) close an idle session after so many days; enb_duplicate_active_session (Integer) 0 disallows a second active session for the same pair, 1 allows it and moves the whole history to the new creator; accompanying_msg (String) required for an Apidaze SMS channel; dids (Array) the numbers bound to the channel. See the vendor page Edit a Message Channel for the Auth_Info shape.

[Yeastar P-Series PBX] Edit a message queue. The vendor documents a patch by id, so a field you omit is left alone, but members is a list: pass it only when you mean to set the complete agent list, because the vendor does not document it as merging. An agent you drop stops receiving chats. Get the id from yeastar_search_message_queues. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: id (Integer, required): The unique ID of the message queue.Note: You can query the message queue ID using Search Specific Message Queues. name (String): The name of the message queue. assignment_mode (String): The assignment mode of chat sessions sent to the message queue.Valid value: none: Agents cannot pick up sessions. auto: The first agent to respond will automatically pick up the session. manual: Agents can take over the session by clicking the Pick Up button. members (Array<Members>): The agents in the message queue.

Conference

ToolPlanAccessSummary
yeastar_create_conferenceProWriteCreate a scheduled conference room with its number, name and participant and moderator passwords.
yeastar_delete_conferenceProDestructiveDESTRUCTIVE.
yeastar_get_conferenceFreeRead-onlyRead one scheduled conference by id: its number, name, moderators and join settings.
yeastar_get_conference_passwordFreeRead-onlyRead the participant password or the moderator password of a scheduled conference.
yeastar_invite_conference_membersProDestructiveDESTRUCTIVE.
yeastar_kick_conference_membersProDestructiveDESTRUCTIVE.
yeastar_list_conferencesFreeRead-onlyList the scheduled conference rooms, whether they were created on the PBX web portal or through the API.
yeastar_mute_conference_membersProDestructiveDESTRUCTIVE.
yeastar_query_conferencesFreeRead-onlyRead several scheduled conferences in one call.
yeastar_query_instant_conferencesFreeRead-onlyRead the instant, ad-hoc conferences that were started through the API.
yeastar_query_ongoing_conferencesFreeRead-onlyRead the conferences that are in progress right now, scheduled and instant alike, with their current members.
yeastar_search_conferencesFreeRead-onlySearch the scheduled conference list and get each match id.
yeastar_start_instant_conferenceProDestructiveDESTRUCTIVE.
yeastar_unmute_conference_membersProDestructiveDESTRUCTIVE.
yeastar_update_conferenceProWriteEdit a scheduled conference by id from yeastar_search_conferences.

[Yeastar P-Series PBX] Create a scheduled conference room with its number, name and participant and moderator passwords. Creating one dials nobody: members join by dialing the conference number, or you add them with yeastar_invite_conference_members. The moderator_list field sets the room's whole moderator list, and yeastar_update_conference later replaces that list wholesale rather than merging into it. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: number (String) the conference number, numeric only and under 7 characters; name (String) under 127 characters. OPTIONAL: partic_password (String) the password participants need, under 15 characters; moderator_password (String) the password to join as a moderator, under 15; sound_prompt (String) default for a tone or ext_number to announce the extension number when someone joins or leaves; enb_custom_language (Integer) 0 or 1; prompt_language (String) a language present in the PBX system prompts, listed by yeastar_get_system_menu_options with menu system_prompt; enb_wait_moderator (Integer) 1 holds the conference until a moderator joins; allow_partic_invite (Integer) 1 lets participants press # to invite others; moderator_list (Array of String) the moderator IDs, extensions or extension groups, from yeastar_get_system_menu_options.

[Yeastar P-Series PBX] DESTRUCTIVE. Delete a scheduled conference room permanently, with its passwords and its moderator list. Any call in progress in that room ends. Read the room with yeastar_get_conference first, because deletion cannot be undone. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Read one scheduled conference by id: its number, name, moderators and join settings. Get the id from yeastar_search_conferences or yeastar_list_conferences. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.

[Yeastar P-Series PBX] Read the participant password or the moderator password of a scheduled conference. Pass type as partic_password or moderator_password, and the id from yeastar_search_conferences. The password comes back in clear text, so treat the result as a secret and never copy it into a ticket or a chat. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idintegeryesid — Integer, required.
typestringyestype — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Dial extra members into a conference: every listed number rings at once. An external number needs a dialpermission extension that holds outbound call permission, and the invite call is billed on the trunk it takes. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: invitemembers (Array <String>, required): The numbers of the members to be invited.Note: Use commas to separate multiple numbers. E.g. "invitemembers":["995000","1003"]. dialpermission (String, required): Specify the extension whose call permission is used to place calls inviting members to join the conference.Note: If invited members includes external numbers, dialpermission must be the extension which has outbound call permission. number (String, required): Conference number.

[Yeastar P-Series PBX] DESTRUCTIVE. Drop members out of a conference in progress: their call ends at once and they are given no warning. Read who is in the room with yeastar_query_ongoing_conferences first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: member_channel_id (String, required): The channel ID(s) of the member(s).Valid value: To kick a member, pass the channel ID of the member. To kick multiple members, pass the channel IDs of the members, and use commas to separate multiple IDs. To kick all members, pass the value all. Note: You can query the member's channel ID using Query Ongoing Conferences. number (String, required): Conference number.

[Yeastar P-Series PBX] List the scheduled conference rooms, whether they were created on the PBX web portal or through the API. page and page_size are both required, and StackJack caps page_size at 500. Order the list with sort_by and order_by. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegeryespage — Integer, required.
pageSizeintegeryespage_size — Integer, required.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Mute members of a conference in progress: their audio stops reaching the room at once. Reverse it with yeastar_unmute_conference_members. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: member_channel_id (String, required): The channel ID(s) of the member(s) to mute.Valid value: To mute a member, pass the channel ID of the member. To mute multiple members, pass the channel IDs of the members, and use commas to separate multiple IDs. To mute all members, pass the value all. Note: You can query the member's channel ID using Query Ongoing Conferences. number (String, required): Conference number.

[Yeastar P-Series PBX] Read several scheduled conferences in one call. Pass ids as a comma-separated list of conference IDs from yeastar_search_conferences. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
idsstringyesids — comma-separated conference IDs, required.

[Yeastar P-Series PBX] Read the instant, ad-hoc conferences that were started through the API. Pass one conference number, several numbers separated by commas, or the value all for every instant conference. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
numberstringyesnumber — String, required.

[Yeastar P-Series PBX] Read the conferences that are in progress right now, scheduled and instant alike, with their current members. Pass one conference number, several separated by commas, or the value all. Use this before you mute or kick anybody. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
numberstringyesnumber — String, required.

[Yeastar P-Series PBX] Search the scheduled conference list and get each match id. This is the read to start from when you know a conference only by its name or number. page and page_size are both required, and StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
orderBystringnonullorder_by — String, optional.
pageintegeryespage — Integer, required.
pageSizeintegeryespage_size — Integer, required.
searchValuestringnonullsearch_value — String, optional.
sortBystringnonullsort_by — String, optional.

[Yeastar P-Series PBX] DESTRUCTIVE. Start an instant conference and dial its members: every listed number rings at once, and an external number is billed on the trunk it takes. It creates no scheduled room; use yeastar_create_conference for a room that persists. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: number (String) the instant conference number - it must be idle and outside the extension number range set under PBX Settings, Preferences, Extension Preferences, and not in use by a scheduled conference, another instant conference or a system feature; name (String) the conference name; members (Array of String) the member numbers, extension or external, separated by commas; moderators (Array of String) the moderator numbers, extension users only, separated by commas; dialpermission (String) the extension whose call permission places the invite calls - it must hold outbound call permission when members includes an external number.

[Yeastar P-Series PBX] DESTRUCTIVE. Unmute members of a conference in progress so their audio reaches the room again. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: member_channel_id (String, required): The channel ID(s) of the member(s) to unmute.Valid value: To unmute a member, pass the channel ID of the member. To unmute multiple members, pass the channel IDs of the members, and use commas to separate multiple IDs. To unmute all members, pass the value all. Note: You can query the member's channel ID using Query Ongoing Conferences. number (String, required): Conference number.

[Yeastar P-Series PBX] Edit a scheduled conference by id from yeastar_search_conferences. A field you omit is left alone, but moderator_list REPLACES the room's whole moderator list: the vendor documents no merge, and nothing else removes a moderator. To add one, read the room with yeastar_get_conference and re-send every existing moderator id plus the new one. That read returns moderator objects; send their ids. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: id (Integer) the conference ID, from yeastar_search_conferences. Every other field is the same as on yeastar_create_conference and is optional here: name (String) under 127 characters; partic_password and moderator_password (String) under 15 characters each; sound_prompt (String) default or ext_number; enb_custom_language (Integer) 0 or 1; prompt_language (String) a language present in the PBX system prompts; enb_wait_moderator (Integer) 1 holds the conference until a moderator joins; allow_partic_invite (Integer) 1 lets participants press # to invite others; moderator_list (Array of String) the moderator IDs, extensions or extension groups, from yeastar_get_system_menu_options.

Call control

ToolPlanAccessSummary
yeastar_accept_inbound_callProDestructiveDESTRUCTIVE.
yeastar_add_member_callProDestructiveDESTRUCTIVE.
yeastar_dial_callProDestructiveDESTRUCTIVE.
yeastar_forward_call_to_voicemailProDestructiveDESTRUCTIVE.
yeastar_get_call_park_statusFreeRead-onlyList the calls parked on the PBX right now and the parking slot each one holds.
yeastar_hangup_callProDestructiveDESTRUCTIVE.
yeastar_hold_callProDestructiveDESTRUCTIVE.
yeastar_listen_callProDestructiveDESTRUCTIVE.
yeastar_mute_callProDestructiveDESTRUCTIVE.
yeastar_park_callProDestructiveDESTRUCTIVE.
yeastar_play_prompt_callProDestructiveDESTRUCTIVE.
yeastar_query_callsFreeRead-onlyRead a LIVE call by its call ID, or the calls of a given call type.
yeastar_record_pause_callProDestructiveDESTRUCTIVE.
yeastar_record_start_callProDestructiveDESTRUCTIVE.
yeastar_record_unpause_callProDestructiveDESTRUCTIVE.
yeastar_refuse_inbound_callProDestructiveDESTRUCTIVE.
yeastar_transfer_callProDestructiveDESTRUCTIVE.
yeastar_unhold_callProDestructiveDESTRUCTIVE.
yeastar_unmute_callProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] DESTRUCTIVE. Answer a LIVE inbound call for an extension: the call connects at once and the caller is talking to that extension. Pass the channel ID from the PBX (30011) Call State Changed push event. StackJack receives no PBX events, so the caller must supply the ID. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the inbound call.Note: You can obtain the call channel ID in the (30016) Incoming Call Request event.

[Yeastar P-Series PBX] DESTRUCTIVE. Dial an extra party into a LIVE call: the invited number rings at once and joins the conversation, and an external number is billed on the trunk it takes. Pass the channel ID from the PBX (30011) Call State Changed push event, which StackJack does not receive. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the member that wants to invite another member.Note: You can obtain the call channel ID in the (30011) Call State Changed event. number (String, required): The number of the invited party.Note: Only one member can be invited every time the API interface is called. dial_permission (String): Enter an extension number that has the desired dial permission. Note: If the number is an extension number, and you want the API interface to follow the extension visibility permission set by Client Permission on the PBX, you must enter an extension number that can view the number. If the number is an external number, and the member that initiates the invitation has no outbound call permission, you should enter an extension number that has the outbound call permission.

[Yeastar P-Series PBX] DESTRUCTIVE. Place a LIVE outbound call: the caller extension and the destination both ring at once, and an external destination is billed on the trunk the call takes. Check the caller and the destination before you call this; there is no undo once the phones ring. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: caller (String, required): The caller number. callee (String, required): The callee number. dial_permission (String): Enter an extension number that has the desired dial permission.Note: If the callee is an extension invisible to the caller, you should enter an extension number that can view the callee. If the callee is an external number, and the caller has no outbound call permission, you should enter an extension number that has the outbound call permission. auto_answer (String): If caller is an extension number, you can decide whether to auto answer the call to callee.Note: This setting only takes effect on the IP phones that support auto answer feature. Valid value: yes no (Default)

[Yeastar P-Series PBX] DESTRUCTIVE. Send a ringing inbound call straight to the callee voicemail: the extension stops ringing and the caller hears the greeting. Pass the channel ID from the PBX (30011) Call State Changed push event, which StackJack does not receive. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: callee_channel (String, required): The call channel ID of the callee.Note: You can obtain the call channel ID in the (30011) Call State Changed event. number (String, required): The target extension number. The call will be forward to the extension's voicemail.

[Yeastar P-Series PBX] List the calls parked on the PBX right now and the parking slot each one holds. This is the one call-control read that needs no ID from a push event, so start here when you are looking for a call that someone parked. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

[Yeastar P-Series PBX] DESTRUCTIVE. Hang up a leg of a LIVE call: the party on that channel is disconnected at once, mid-sentence. Pass channel_id from the PBX (30011) Call State Changed push event, or paging_number to end a paging or intercom call. StackJack receives no PBX events, so the ID must come from the customer's own event consumer. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String): The call channel ID of the member to be hung up.Note: You can obtain the call channel ID in the (30011) Call State Changed event. paging_number (String): The paging number to be hung up.Note: This parameter is required when the third-party application wants to hang up a paging call or an intercom call.

[Yeastar P-Series PBX] DESTRUCTIVE. Put a party on a LIVE call on hold: they hear music on hold at once and stop hearing the other party. Release it with yeastar_unhold_call. Pass the channel ID from the PBX (30011) Call State Changed push event, which StackJack does not receive. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the member that wants to hold the call.Note: You can obtain the call channel ID in the (30011) Call State Changed event.

[Yeastar P-Series PBX] DESTRUCTIVE. Silently monitor a LIVE call: a supervisor extension hears both parties and neither party is told. Call monitoring is regulated in many places, so confirm the customer consent and notification policy before you use it. Pass the channel ID from the PBX (30011) Call State Changed push event. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: monitor (String, required): The monitor's extension number. channel_id (String, required): The call channel ID of the monitored extension during a call.Note: You can obtain the call channel ID in the (30011) Call State Changed event. type (String, required): Monitor mode.Valid value: listen whisper barge

[Yeastar P-Series PBX] DESTRUCTIVE. Mute a party on a LIVE call: their audio stops reaching the other party at once, with no tone to tell them. Reverse it with yeastar_unmute_call. Pass the channel ID from the PBX (30011) Call State Changed push event. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the member to be muted.Note: You can obtain the call channel ID in the (30011) Call State Changed event.

[Yeastar P-Series PBX] DESTRUCTIVE. Park a LIVE call: the caller is moved into a parking slot and hears hold music until somebody retrieves the call or the park timeout returns it. Read the slots with yeastar_get_call_park_status. Pass the channel ID from the PBX (30011) Call State Changed push event. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the parked party.Note: You can obtain the call channel ID in the (30011) Call State Changed event. parking_slot (String): Specify a parking slot number to park the call.Note: If this parameter is left blank, the system will automatically assign an idle parking slot number.

[Yeastar P-Series PBX] DESTRUCTIVE. Play an audio prompt into a LIVE call: the parties hear it at once. The prompt has to exist on the PBX as a custom prompt already. Pass the channel ID from the PBX (30011) Call State Changed push event, which StackJack does not receive. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: number (String, required): The target number that will receive the prompt. prompts (Array<String>, required): The name of audio file(s) that will be played.Note: Only supports to play the audio files in the Custom Prompt. Do NOT include the file extension .wav, .mp3, or .gsm; Use a comma to separate multiple audio files.Example: ["test_prompt1","test_prompt2"]. count (Integer): The frequency of playing audio files. dial_permission (String): If the number is an external number, you should enter an extension number that has outbound call permission. auto_answer (String): Decide whether the phone would auto answer the call. Note: This setting only takes effect on the IP phones that support auto answer feature. Valid value: yes no (Default) volume (Integer): The playback volume.Valid value: 0-20

[Yeastar P-Series PBX] Read a LIVE call by its call ID, or the calls of a given call type. Call IDs come from the PBX (30011) Call State Changed push event; StackJack receives no PBX events, so the ID has to come from the customer's own webhook or WebSocket consumer. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
callIdstringyescall_id — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Pause the recording of a LIVE call: audio stops being written until yeastar_record_unpause_call resumes it. Pausing a call that a compliance policy requires to be recorded leaves a gap nobody is told about. Pass the channel ID from the PBX (30011) Call State Changed push event. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the member that want to pause the call recording.Note: You can obtain the call channel ID in the (30011) Call State Changed event.

[Yeastar P-Series PBX] DESTRUCTIVE. Start recording a LIVE call. Recording is regulated in many places, so confirm the customer consent and announcement policy before you start one. Pause it with yeastar_record_pause_call. Pass the channel ID from the PBX (30011) Call State Changed push event. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the member that wants to record the call.Note: You can obtain the call channel ID in the (30011) Call State Changed event.

[Yeastar P-Series PBX] DESTRUCTIVE. Resume a paused recording on a LIVE call: audio is written again from this point on. Pass the channel ID from the PBX (30011) Call State Changed push event, which StackJack does not receive. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the member that wants to resume the call recording.Note: You can obtain the call channel ID in the (30011) Call State Changed event.

[Yeastar P-Series PBX] DESTRUCTIVE. Reject a ringing inbound call: the extension stops ringing and the caller is released or sent to the busy destination. Pass the channel ID from the PBX (30011) Call State Changed push event, which StackJack does not receive. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the inbound call.Note: You can obtain the call channel ID in the (30016) Incoming Call Request event.

[Yeastar P-Series PBX] DESTRUCTIVE. Move a LIVE call to another destination: the two parties are separated at once and the new destination rings. A wrong destination drops a customer into the wrong queue or into voicemail. Pass the channel ID from the PBX (30011) Call State Changed push event, which StackJack does not receive. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: type (String) blind or attended; channel_id (String) the call channel ID from the (30011) Call State Changed event - for a blind transfer the channel of the member being transferred, for an attended transfer the channel of the transferor. REQUIRED for a blind transfer and for initiating an attended transfer: number (String) the target number; dial_permission (String) the extension number of the transferor, which must hold the dial permission the target needs - an external target needs an extension with outbound call permission, and an extension target needs one that can see the number under Client Permission. Attended transfer also documents cancel and answer steps on the same interface. See the vendor page Transfer a Call for the full field list.

[Yeastar P-Series PBX] DESTRUCTIVE. Take a LIVE call off hold and reconnect the two parties. Pass the channel ID from the PBX (30011) Call State Changed push event, which StackJack does not receive. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the member that holds the call.Note: You can obtain the call channel ID in the (30011) Call State Changed event.

[Yeastar P-Series PBX] DESTRUCTIVE. Unmute a party on a LIVE call so their audio reaches the other party again. Pass the channel ID from the PBX (30011) Call State Changed push event, which StackJack does not receive. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: channel_id (String, required): The call channel ID of the member that is muted.Note: You can obtain the call channel ID in the (30011) Call State Changed event.

uaCSTA call control

ToolPlanAccessSummary
yeastar_accept_uacsta_callProDestructiveDESTRUCTIVE.
yeastar_hangup_uacsta_callProDestructiveDESTRUCTIVE.
yeastar_refuse_uacsta_callProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] DESTRUCTIVE. Answer the ringing call on a uaCSTA-controlled desk phone: the phone goes off-hook by itself and the call connects, whoever is standing at it. uaCSTA control works only on phones the PBX provisions for it. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: extension (String, required): The extension that you want to control. call_id (String, required): The unique ID of each uaCSTA call.Note: You can obtain the call ID of a uaCSTA call from (30020) uaCSTA Call Report event. ip_address (String, required): The IP address and SIP port of the IP phone where the extension is registered.E.g: 192.168.5.2:5060.

[Yeastar P-Series PBX] DESTRUCTIVE. Hang up the call on a uaCSTA-controlled desk phone: the phone disconnects at once, whoever is talking on it. uaCSTA control works only on phones the PBX provisions for it. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: extension (String, required): The extension that you want to control. call_id (String, required): The unique ID of each uaCSTA call.Note: You can obtain the call ID of a uaCSTA call from (30020) uaCSTA Call Report event. ip_address (String, required): The IP address and SIP port of the IP phone where the extension is registered.E.g: 192.168.5.2:5060.

[Yeastar P-Series PBX] DESTRUCTIVE. Reject the ringing call on a uaCSTA-controlled desk phone. uaCSTA control works only on phones the PBX provisions for it. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: extension (String, required): The extension that you want to control. call_id (String, required): The unique ID of each uaCSTA call.Note: You can obtain the call ID of a uaCSTA call from (30020) uaCSTA Call Report event. ip_address (String, required): The IP address and SIP port of the IP phone where the extension is registered.E.g: 192.168.5.2:5060.

WebSocket Audio Streaming

ToolPlanAccessSummary
yeastar_get_websocketaudiostreamFreeRead-onlyRead the WebSocket audio streaming setting: whether the PBX streams live call audio off the box, where it streams to, and which extensions, trunks or DID numbers are subscribed.
yeastar_update_websocketaudiostreamProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] Read the WebSocket audio streaming setting: whether the PBX streams live call audio off the box, where it streams to, and which extensions, trunks or DID numbers are subscribed. Treat the result as sensitive, because it describes a live audio tap. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

[Yeastar P-Series PBX] DESTRUCTIVE. Turn live call audio streaming off the PBX on or off and set where it streams to. Enabling it taps the audio of every subscribed extension, trunk or DID number, which is regulated in many places. Read the current setting with yeastar_get_websocketaudiostream first, because subscribe_list is a list rather than a merge. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: enable (Integer): 0 disabled, 1 enabled. websocket_url (String): the WebSocket server address that receives the audio, for example ws://docs.example.cloud.com:8080, max 255 characters. auth_key (String): the name of the authentication field the third-party platform requires, max 63. auth_value (String): the authentication value, max 255. sample_rate (Integer): 0 for 8000Hz, 1 for 16000Hz. enable_ext (Integer): 0 or 1, subscribe to specific extensions. enable_trunk (Integer): 0 or 1, subscribe to specific trunks. enable_did (Integer): 0 or 1, subscribe to specific DID numbers. subscribe_list (Array of Subscribe_List): the subscribed objects. Note: an object is only added when the matching enable_ext, enable_trunk or enable_did is set to 1.

Hotel

ToolPlanAccessSummary
yeastar_checkout_hotelProDestructiveDESTRUCTIVE.
yeastar_create_wakeup_callProDestructiveDESTRUCTIVE.
yeastar_delete_wakeup_callsProDestructiveDESTRUCTIVE.
yeastar_get_wakeup_callFreeRead-onlyRead the wake-up calls set on one room extension, with each alarm time, repeat schedule and ID.
yeastar_list_wakeup_callsFreeRead-onlyList the wake-up calls set across the PBX, with the extension each one belongs to.
yeastar_query_wakeup_callsFreeRead-onlyRead the wake-up calls of several room extensions in one call.
yeastar_update_wakeup_callProDestructiveDESTRUCTIVE.

[Yeastar P-Series PBX] DESTRUCTIVE. Check a hotel guest out of a room extension. Checkout resets that room guest state on the PBX and cannot be undone, so run it only against the room you mean. Get ext_id from yeastar_search_extensions. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: ext_id (Integer, required): The unique ID of an extension.Note: You can query extension's ID using Search Specific Extensions.

[Yeastar P-Series PBX] DESTRUCTIVE. Schedule a wake-up call for a room extension: the phone in that room RINGS the guest at alarm_time, and rings again for each snooze. Get ext_id from yeastar_search_extensions. alarm_time is the 24-hour clock, for example 07:30, and alarm_day is YYYY/MM/DD. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: ext_id (Integer) the extension ID, from yeastar_search_extensions; alarm_time (String) the alarm time on the 24-hour clock, for example 07:30. OPTIONAL: alarm_day (String) the date as YYYY/MM/DD; repeat_option (String) never, every_day, every_week or every_month; repeat_type (String) never (default) or every_monday through every_sunday, comma separated - with never the PBX deletes the alarm once it has repeated the designated times; number_of_snoozes (Integer) 0 (default) to 3; snooze_duration (Integer) minutes between repeats, default 10; ring_timeout (Integer) seconds the alarm rings before timeout; alarm_prompt (String) the name of a custom prompt under PBX Settings, Voice Prompt, Custom Prompt - without it the guest hears the music on hold; fail_dest_type (String) hangup, ext or ringgroup with fail_dest_data (Integer); remark (String).

[Yeastar P-Series PBX] DESTRUCTIVE. Delete wake-up calls on a room extension: pass wakeup_call_id to delete one alarm, or leave it out to delete every alarm on that extension. The guest is not woken and is not told. Read the alarms with yeastar_get_wakeup_call first. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
extIdintegeryesext_id — Integer, required.
wakeupCallIdintegernonullwakeup_call_id — Integer, optional.

[Yeastar P-Series PBX] Read the wake-up calls set on one room extension, with each alarm time, repeat schedule and ID. Get ext_id from yeastar_search_extensions. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
extIdintegeryesext_id — Integer, required.

[Yeastar P-Series PBX] List the wake-up calls set across the PBX, with the extension each one belongs to. StackJack caps page_size at 500. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
pageintegernonullpage — Integer, optional.
pageSizeintegernonullpage_size — Integer, optional. StackJack caps this at 500.

[Yeastar P-Series PBX] Read the wake-up calls of several room extensions in one call. Pass ext_id as a comma-separated list of extension IDs from yeastar_search_extensions. Returns the PBX response verbatim, including the errcode/errmsg envelope and total_number.

ParamTypeRequiredDefaultDescription
extIdstringyesext_id — String, required.

[Yeastar P-Series PBX] DESTRUCTIVE. Edit a scheduled wake-up call, which changes when a guest room phone RINGS. Pass id as the alarm ID from yeastar_list_wakeup_calls or yeastar_get_wakeup_call, and read the current alarm before you change it. The PBX answers HTTP 200 even on failure: check errcode in the response (0 = success, 1 = partial success, 2 = still processing).

ParamTypeRequiredDefaultDescription
bodyJsonstringyesJSON object carrying the request fields, as a JSON string. Documented fields: REQUIRED: id (Integer) the alarm ID, from yeastar_list_wakeup_calls or yeastar_get_wakeup_call. Everything else is optional and matches yeastar_create_wakeup_call: alarm_time (String) 24-hour clock, for example 07:30; alarm_day (String) YYYY/MM/DD; repeat_option (String) never, every_day, every_week or every_month; repeat_type (String) never or every_monday through every_sunday, comma separated; number_of_snoozes (Integer) 0 to 3; snooze_duration (Integer) minutes between repeats; ring_timeout (Integer) seconds before timeout; alarm_prompt (String) the name of a custom prompt on the PBX; fail_dest_type (String) hangup, ext or ringgroup with fail_dest_data (Integer); remark (String).

Still need help? Ask the team