Dispatching System APIs

Connect Dispatching System and Yeastar Cloud PBX via API to dispatch tasks by one-way paging, one-way multicast paging, or two-way intercom via phone terminals.

Scenario

Dispatching System is one of the most important communication method of a company's production and operation, widely used in industrial production, mining operation, railways, airports, and hotels. With Yeastar Cloud PBX API, you can integrate Dispatching System and PBX. The grouping ability allows you to quickly and accurately make announcements to corresponding groups. It not only serves for daily communication, but also improves work efficiency and emergency management.

Take industrial production as an example, the work flow in production line is closely connected and tends to be complex. You can set various paging groups for production lines so that production lines can efficiently deliver messages and deal with emergencies. It not only improves communication between production lines and plant management, but also helps your business run more efficiently.

Add a paging group

Dispatcher can group extensions in the same department into different paging groups, and set different paging group types according to different responsibilities those staffs take.

  1. The dispatcher adds line1 and line2 to an 2-way intercom group. The Dispatching System sends a request to API interface to add a paging group.
  2. After receiving the request, PBX creates a paging group, adds line1 and line2 to the group, and responds result to Dispatching System.

For API interface, refer to Add a Paging Group.

Query a paging group

Dispatcher can check paging groups on Dispatching System when broadcasting.
  1. When dispatcher checks paging groups on Dispatching System, the system sends a quest to API interface to query extension list.
  2. After receiving the request, PBX sends information of extension list to Dispatching System.

For API interface, refer to Query Paging Group List.

Update settings of a paging group

When members or departments change, dispatcher can add or delete members in a paging group, or change paging group type.

  1. When dispatcher adds a member to a specific paging group on Dispatching System, the system sends a request to API interface to change paging group settings.
  2. After receiving the request, PBX updates settings for the specified paging group, and responds result to Dispatching System.

For API interface, refer to Edit a Paging Group.

Make an announcement

Dispatcher can make an announcement to members via Dispatching System; In case of any emergencies, dispatcher can initiate an intercom call to give correct instructions to staffs; In spare time, dispatcher can play recorded voice announcement like safety instructions to staffs.
  1. When dispatcher plays a voice announcement to a paging group on Dispatching System, the system sends a request to API interface to play voice announcement.
  2. After receiving the request, PBX makes a paging call to the specified extension, plays the pre-configured voice messages, and responds result to Dispatching System.

For API interface, refer to Make an Announcement.

Customize paging prompts
  1. Log in PBX web page, go to PBX > Voice Prompts > Custom Prompts, upload an audio file.

Stop paging group music

If Dispatching System is playing a voice prompt to members, the dispatcher can stop paging group music.
  1. When dispatcher ends paging on Dispatching System, the system sends a request to API interface to stop paging group music.
  2. After receiving the request, PBX hangs up the call on specified extension, and responds result to Dispatching System.

For API interface, refer to Stop Paging Group Music.