Yeastar P-Series API

🇹🇭 ภาษาไทย

ภาพรวม

Yeastar P-Series มี REST API (Application Programming Interface) สำหรับ integrate กับ third-party applications เช่น Call Center, Hotel PMS, CRM และระบบอื่นๆ ใน enterprise

ข้อจำกัด: API รองรับเฉพาะรุ่น P550, P560, P570 เท่านั้น (ไม่รองรับ P520)
Firmware ขั้นต่ำ: 37.7.0.16 ขึ้นไป

ความต้องการก่อนใช้งาน

เปิดใช้งาน API บน PBX: Integrations > API > เปิด Toggle API
(ไม่บังคับ) เปิด IP Restriction — กำหนด IP ที่อนุญาตเข้าถึง API
ตั้งค่า Extension/Trunk Status Monitor ตามต้องการ
บันทึก Client ID และ Client Secret จาก PBX web portal

รูปแบบการสื่อสาร

API รองรับ 2 รูปแบบ:

รูปแบบ	คำอธิบาย
API Request/Response	Application ส่ง HTTP request → PBX ตอบ response ทันที
Event Subscription	Application subscribe event → PBX push notification แบบ real-time

Protocol: HTTP (port 80) หรือ HTTPS (port 8088, แนะนำ)
Methods: GET และ POST
ทุก request ต้องใส่ header: User-Agent: OpenAPI

Authentication Flow

1. POST /openapi/v1.0/get_token
   → ส่ง username (Client ID) + password (Client Secret)
   → รับ access_token (หมดอายุ 30 นาที) + refresh_token (หมดอายุ 24 ชั่วโมง)

2. ใช้ access_token ใน URL ทุก request:
   GET /openapi/v1.0/{endpoint}?access_token={token}

3. ก่อน token หมดอายุ → POST /openapi/v1.0/refresh_token

4. เสร็จแล้ว → GET /openapi/v1.0/del_token

ข้อจำกัด: แต่ละ application มี valid token พร้อมกันได้สูงสุด 8 tokens

ตัวอย่าง — ขอ Access Token

POST /openapi/v1.0/get_token
Host: 192.168.5.150:8088
Content-Type: application/json
User-Agent: OpenAPI
{
    "username": "UEnH9Dmv6uBJEXsYcag1trNfQThYXXXX",
    "password": "ZLcXl63S9EtMnYoHUnjbVo6sA8CbXXXX"
}

{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "access_token_expire_time": 1800,
    "access_token": "EXZMpZAO86mbrKm6rFtgeb3rfcpC9uqS",
    "refresh_token_expire_time": 86400,
    "refresh_token": "SCduGecwbG9jIusiS8FxFUVn3kf0Q9R8"
}

รูปแบบ URL

{base_url}/{api_path}/{endpoint}?access_token={access_token}

ส่วน	รายละเอียด
`base_url`	`https://{pbx_ip}:8088` หรือ `http://{pbx_ip}:80` หรือ FQDN
`api_path`	`openapi/v1.0` (Call Report ใหม่: `openapi/v2.0`)
`endpoint`	ชื่อ endpoint เช่น `extension/list`
`access_token`	Token ที่ได้จาก get_token

สรุป Endpoints ทั้งหมด

Authentication

Method	Endpoint	คำอธิบาย
POST	`get_token`	ขอ access token
POST	`refresh_token`	ต่ออายุ token
GET	`del_token`	ยกเลิก token

System

Method	Endpoint	คำอธิบาย
GET	`system/information`	ข้อมูล PBX (model, firmware, uptime)
GET	`system/capacity`	ความจุ (จำนวน extension, concurrent calls, AI transcription)
GET	`system/get_menuoptions`	ดึง option values สำหรับสร้าง/แก้ไข features
POST	`system/sendemail`	ส่ง email

system/information — Response fields (data object):

Field	Type	คำอธิบาย
`device_name`	String	ชื่อ device
`model_name`	String	รุ่น PBX
`sn`	String	Serial number
`hardware_version`	String	Hardware version
`firmware_version`	String	Firmware version
`system_time`	String	เวลาระบบ
`up_time`	Integer	Uptime (วินาที)
`system_date_format`	String	รูปแบบวันที่
`system_time_format`	String	รูปแบบเวลา
`timestamp`	Integer	Unix timestamp (วินาที)

system/capacity — Response fields (data object):

Field	Type	คำอธิบาย
`extension_capacity`	Integer	จำนวน extension สูงสุด
`extension_used`	Integer	จำนวน extension ที่ใช้อยู่
`cc_capacity`	Integer	Concurrent calls สูงสุด
`cc_used`	Integer	Concurrent calls ที่ใช้อยู่
`ai_transcription_onetime_capacity`	Integer	AI transcription quota รวม (วินาที)
`ai_transcription_onetime_used`	Integer	AI transcription ที่ใช้แล้ว (วินาที)

Extension (จัดการผู้ใช้ภายใน)

Method	Endpoint	คำอธิบาย
GET	`extension/list`	รายการ extension ทั้งหมด
GET	`extension/search`	ค้นหา extension
GET	`extension/get`	ดึงข้อมูล extension เดียว
GET	`extension/query`	ดึงข้อมูลหลาย extension พร้อมกัน
GET	`extension/getpassword`	ดึง registration password + voicemail PIN
POST	`extension/create`	เพิ่ม SIP extension
POST	`extension/send_welcome_email`	ส่ง Linkus welcome email
POST	`extension/update`	แก้ไข extension
GET	`extension/delete`	ลบ extension

extension/create — Key request parameters:

Parameter	Required	คำอธิบาย
`type`	Yes	ประเภท extension — ต้องเป็น `"SIP"`
`number`	Yes	หมายเลข extension (ตัวเลขเท่านั้น สูงสุด 8 หลัก)
`user_password`	Yes	รหัสผ่านผู้ใช้ (ต้องมีตัวเลข + ตัวพิมพ์ใหญ่ + ตัวพิมพ์เล็ก)
`reg_name`	Yes	Registration name (สูงสุด 63 ตัวอักษร)
`reg_password`	Yes	Registration password
`concurrent_registrations`	Yes	จำนวน IP phone ที่ลงทะเบียนพร้อมกันได้ (1–5)
`presence_status`	Yes	Presence status เริ่มต้น
`first_name`	No	ชื่อ
`last_name`	No	นามสกุล
`email_addr`	No	อีเมล
`mobile_number`	No	เบอร์มือถือ
`role_id`	No	ID ของ user role (ดูจาก `system/get_menuoptions`)
`organization_list`	No*	องค์กรที่ extension สังกัด — required ถ้าเปิด Organization Management

Organization

Method	Endpoint	คำอธิบาย
GET/POST	`organization/list	search

Trunk (SIP Trunk)

Method	Endpoint	คำอธิบาย
GET/POST	`trunk/list	search

Contacts & Phonebook

Method	Endpoint	คำอธิบาย
GET/POST	`company_contact/list	search
GET/POST	`phonebook/list	search

company_contact/create — Key request parameters:

Parameter	Required	คำอธิบาย
`first_name`	Yes	ชื่อ
`number_list`	Yes	Array ของหมายเลขโทรศัพท์; แต่ละ entry มี `num_type` (`business_number`, `mobile_number`, `home_number` ฯลฯ) และ `number`
`last_name`	No	นามสกุล
`company`	No	ชื่อบริษัท
`email`	No	อีเมล
`phonebook_id_list`	No	Array ของ phonebook ID ที่ต้องการเพิ่ม contact นี้เข้าไป
`organization`	No	แผนก
`job_title`	No	ตำแหน่งงาน

phonebook/create — Key request parameters:

Parameter	Required	คำอธิบาย
`name`	Yes	ชื่อ phonebook
`member_select`	No	วิธีเลือกสมาชิก: `sel_all` (เลือก company contacts ทั้งหมด) หรือ `sel_specific` (เลือกเฉพาะ)
`add_contacts_id_list`	No	Array ของ company contact ID ที่จะเพิ่มเข้า phonebook (ใช้เมื่อ `member_select=sel_specific`)

Auto Provisioning (จัดการ IP Phone)

Method	Endpoint	คำอธิบาย
GET	`phone/search`, `phone/get`	ค้นหาและดูข้อมูล IP phone
GET	`auto_provisioning/compatibility`	ดู config options สำหรับ provisioning
POST	`phone/batchcreate	batchupdate

phone/batchcreate — Key request parameters:

Parameter	Required	คำอธิบาย
`vendor`	Yes	ผู้ผลิต IP phone (ดู options จาก `auto_provisioning/compatibility`)
`model`	Yes	รุ่น IP phone
`phone_list`	Yes	Array ของ `{mac, ext_id}` — MAC address + extension ID ที่ต้องการผูก
`template_name`	Yes	ชื่อ provisioning template
`provisioning_method`	Yes	วิธี provisioning: `pnp`, `dhcp`, `rps`, หรือ `rps_fqdn`

phone/get — Response fields (data object):

Field	Type	คำอธิบาย
`mac`	String	MAC address ของ IP phone
`vendor`	String	ผู้ผลิต
`model`	String	รุ่น
`template_name`	String	ชื่อ provisioning template ที่ใช้อยู่
`provisioning_method`	String	วิธี provisioning (`pnp`, `dhcp`, `rps`, `rps_fqdn`)
`provisioning_link`	String	ลิงก์ provisioning สำหรับ phone
`assigned_extension`	String	ID ของ extension ที่ผูกกับ phone นี้
`id`	Integer	ID เฉพาะของ IP phone ในระบบ

Routing

Method	Endpoint	คำอธิบาย
GET/POST	`inbound_route/list	search
GET/POST	`outbound_route/list	search

inbound_route/create — Key request parameters:

Parameter	Required	คำอธิบาย
`name`	Yes	ชื่อ inbound route
`trunk_list`	Yes	Array ของ trunk ID ที่กำหนดให้ route นี้
`def_dest`	Yes	ปลายทางเริ่มต้น: `extension`, `ivr`, `queue`, `ring_group`, `ext_vm`, `end_call`, `external_num`, `range_to_ext`, `pattern_to_ext`, `call_flow` ฯลฯ
`def_dest_value`	No	ID หรือค่าของปลายทาง (required สำหรับ `def_dest` ส่วนใหญ่)
`did_option`	No	โหมด DID matching: `patterns` (default), `pattern_to_ext`, `range_to_ext`, `pattern_to_ext_list`
`did_pattern_list`	No	Array ของ DID patterns (required เมื่อ `did_option=patterns`)
`did_to_ext_start/end`	No	DID range start/end (required เมื่อ `did_option=range_to_ext`)
`cid_option`	No	CID matching: `patterns` หรือ `phonebook`

outbound_route/create — Key request parameters:

Parameter	Required	คำอธิบาย
`name`	Yes	ชื่อ outbound route
`pin_protect`	Yes	รหัสผ่าน route: `disable`, `single_pin`, `pin_list`
`trunk_list`	No	Array ของ trunk ที่ใช้ออกสาย (แต่ละ entry มี `id` ของ trunk)
`dial_pattern_list`	No	Array ของ dial patterns; แต่ละ entry มี `pattern`, `strip` (ตัดหลักหน้า), `prepend` (เติมหลักหน้า)
`ext_list`	No	Extension/กลุ่ม/organization ที่อนุญาตใช้ route นี้; แต่ละ entry มี `id` + `type` (`extension`, `ext_group`, `organization`)
`outbound_cid`	No	Caller ID เมื่อโทรออกผ่าน route นี้
`pin`	No	Single PIN code (required เมื่อ `pin_protect=single_pin`)
`pin_list`	No	ID ของ PIN list (required เมื่อ `pin_protect=pin_list`)

Voicemail

Method	Endpoint	คำอธิบาย
GET/POST	`vm/query	get

IVR / Queue / Conference / Paging

Method	Endpoint	คำอธิบาย
GET/POST	`ivr/list	search
GET/POST	`queue/list	…`+`queue/call_status
GET/POST	`conference/list	…`+`conference/start_interim
GET/POST	`paging/list	search

Recording & CDR

Method	Endpoint	คำอธิบาย
GET	`recording/list	search
GET/POST	`cdr/list	search
GET	`call_report/list	detail

Settings

Method	Endpoint	คำอธิบาย
GET/POST	`auto_recording/get	update`
GET/POST	`pin_list/...`	CRUD PIN list
GET/POST	`blocked_number/...`, `allowed_number/...`	Blocked/Allowed numbers
GET/POST	`call_note/get	update`
GET/POST	`web_server/get	update`
GET	`storage/list`	Storage list
GET/POST	`certificate/...`	CRUD certificates
GET/POST	`backup/...` + `backup/download	getstatus`
GET	`system_log/list	download`

Messaging (SMS/WhatsApp/Facebook/LiveChat)

Method	Endpoint	คำอธิบาย
GET/POST	`message/channel/...`, `message/queue/...`	Message channels + queues
GET/POST	`message/campaign/...`, `message/session/...`, `message/message/...`	Campaigns, sessions, messages
POST	`sms/create`	ส่ง SMS ผ่าน GSM/3G/4G trunk

API Feature Settings

Method	Endpoint	คำอธิบาย
GET/POST	`extension_status_monitor/...`	ตั้งค่า extension status monitoring
GET/POST	`trunk_status_monitor/...`	ตั้งค่า trunk status monitoring
GET/POST	`webhook/query	update

Hotel

Method	Endpoint	คำอธิบาย
GET/POST	`wakeupcall/list	get
POST	`hotel/checkout`	เช็คเอาท์แขก hotel

Call Control (สำคัญมาก)

Method	Endpoint	คำอธิบาย
GET	`call/query`	ดูสถานะสายที่กำลัง active
POST	`call/dial`	โทรออก (หลายประเภท)
POST	`call/accept_inbound`	รับสายเข้าในโหมด inbound control
POST	`call/refuse_inbound`	ปฏิเสธสายเข้า
POST	`call/listen`	Monitoring สาย (ดักฟัง)
POST	`call/hold`	พักสาย
POST	`call/unhold`	รับสายคืน
POST	`call/mute`	ปิดเสียง
POST	`call/unmute`	เปิดเสียง
POST	`call/park`	Park สาย
GET	`call/park_status`	ดูสายที่ park อยู่
POST	`call/directly_forward_to_voicemail`	โอนสายไป voicemail
POST	`call/transfer`	โอนสาย (blind/attended)
POST	`call/add_member`	เพิ่มคนในสาย
POST	`call/play_prompt`	เล่น audio prompt
POST	`call/hangup`	วางสาย
POST	`call/record_start	record_pause

uaCSTA Call Control

Method	Endpoint	คำอธิบาย
POST	`uacsta_call/accept	refuse

Event Monitoring

WebSocket vs Webhook

	WebSocket	Webhook
รูปแบบ	Long-lived connection	HTTP callback (push)
URL	`wss://{pbx}:{port}/openapi/v1.0/subscribe?access_token=...`	URL ที่กำหนดใน PBX settings
Subscribe	ส่ง `{"topic_list":[30011,30012]}`	Auto push ทุก subscribed event
Heartbeat	ต้องส่งทุก 60 วินาที	ไม่ต้องการ
เหมาะกับ	Real-time dashboard, call center	Webhook integration, CRM

รายการ Events ทั้งหมด

Event ID	ชื่อ	คำอธิบาย
30005	Organization Status Switch State Changed	สถานะ organization feature เปลี่ยน
30006	Organization Structure Changed	โครงสร้าง organization เปลี่ยน
30007	Extension Registration Status Changed	สถานะการลงทะเบียน extension เปลี่ยน (SIP/Linkus)
30008	Extension Call State Changed	สถานะสาย extension เปลี่ยน
30009	Extension Presence State Changed	Presence status extension เปลี่ยน
30010	Trunk Registration State Changed	สถานะ trunk เปลี่ยน
30011	Call State Changed	สถานะสายโทรศัพท์เปลี่ยน (real-time)
30012	Call End Details Notification	สายวาง → ส่ง CDR ใหม่
30013	Call Transfer Report	มีการโอนสาย
30014	Call Forwarding Report	มีการ forward สาย
30015	Call Failure Report	สายล้มเหลว
30016	Incoming Call Request	สายเข้าจาก monitored trunk
30017	DTMF Digit Report	กดปุ่มระหว่างสาย
30018	Prompt Playback Completed Report	เล่น audio prompt เสร็จ
30019	Satisfaction Survey Feedback	แขกกด DTMF ประเมินความพึงพอใจ
30020	uaCSTA Call Report	สถานะ uaCSTA call เปลี่ยน
30022	Extension Information Updated	Extension ถูกสร้าง/แก้ไข/ลบ
30023	Trunk Information Updated	Trunk ถูกสร้าง/แก้ไข/ลบ
30024	No-hosted Conference	Host ออกจาก conference
30025	Agent Automatic Pause	Agent ถูก pause อัตโนมัติ (missed calls เกิน limit)
30026	Agent Ringing Timeout	Agent พลาดสายเพราะ ringing timeout
30027	Call Report Download Result	ดาวน์โหลด report แบบ async เสร็จ
30028	Call Note Status Updated	สถานะ call note เปลี่ยน
30029	Agent Status Changed	สถานะ agent เปลี่ยน
30030	Bulk Message Sending Failed	ส่ง bulk message บางส่วนล้มเหลว
30031	New Message Notification	ได้รับ inbound message ใหม่
30032	Message Sending Result	ผลลัพธ์การส่ง message
30033	Recording Download Completed	ดาวน์โหลด recording แบบ async เสร็จ
30034	System Event Notification (Information)	System event ระดับ info
30035	System Event Notification (Warning)	System event ระดับ warning

Use Cases สำหรับออฟฟิค

Scenario	Endpoint/Event ที่ใช้
CRM popup เมื่อมีสายเข้า	Event 30016 + `call/query`
Click-to-call จาก CRM	`call/dial`
Dashboard live call status	Event 30011 + `call/query`
Auto provisioning Yealink T31G	`phone/batchcreate` + `phone/batchreprovision`
Hotel wake-up call	`wakeupcall/create` + `hotel/checkout`
Export CDR ไป database	`cdr/list` + Event 30012
Queue monitoring	`queue/agent_status` + Event 30029

ความเชื่อมโยง

Yeastar P-Series — parent system; API ต้องการรุ่น P550/P560/P570
Yeastar P-Series Features — Contact Center, Hotel Management ที่ API รองรับ
Yeastar P-Series Admin Guide — Extension, Trunk, IVR, Queue ที่ API จัดการได้
Yealink T31G — IP phone ที่ใช้ auto provisioning API + uaCSTA event
Dahua.Api — pattern เดียวกัน: C# wrapper → REST API → integration

🇬🇧 English

Overview

Yeastar P-Series provides a RESTful API for integration with third-party applications such as call centers, hotel PMS systems, CRM platforms, and other enterprise software.

Supported models: P550, P560, P570 only (P520 is NOT supported)
Minimum firmware: 37.7.0.16

Prerequisites

Enable API on the PBX: Integrations > API > Toggle API On
(Optional) Enable IP Restriction to whitelist permitted IP addresses
Configure Extension/Trunk Status Monitors as needed
Note down the Client ID and Client Secret from the PBX web portal

Communication Methods

Mode	Description
API Request/Response	Application sends HTTP request → PBX returns response immediately
Event Subscription	Application subscribes to events → PBX pushes real-time notifications

Protocol: HTTP (port 80) or HTTPS (port 8088, recommended)
HTTP Methods: GET and POST only
Required header on every request: User-Agent: OpenAPI

Authentication Flow

1. POST /openapi/v1.0/get_token
   → Send username (Client ID) + password (Client Secret)
   → Receive access_token (expires in 30 min) + refresh_token (expires in 24 h)

2. Include access_token in every subsequent request URL:
   GET /openapi/v1.0/{endpoint}?access_token={token}

3. Before token expires → POST /openapi/v1.0/refresh_token

4. When done → GET /openapi/v1.0/del_token

Limit: Maximum 8 simultaneous valid tokens per application.

Example — Get Access Token

POST /openapi/v1.0/get_token
Host: 192.168.5.150:8088
Content-Type: application/json
User-Agent: OpenAPI
{
    "username": "UEnH9Dmv6uBJEXsYcag1trNfQThYXXXX",
    "password": "ZLcXl63S9EtMnYoHUnjbVo6sA8CbXXXX"
}

{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "access_token_expire_time": 1800,
    "access_token": "EXZMpZAO86mbrKm6rFtgeb3rfcpC9uqS",
    "refresh_token_expire_time": 86400,
    "refresh_token": "SCduGecwbG9jIusiS8FxFUVn3kf0Q9R8"
}

URL Format

{base_url}/{api_path}/{endpoint}?access_token={access_token}

Component	Details
`base_url`	`https://{pbx_ip}:8088` or `http://{pbx_ip}:80` or FQDN
`api_path`	`openapi/v1.0` (Call Report v2: `openapi/v2.0`)
`endpoint`	Specific endpoint e.g. `extension/list`
`access_token`	Token obtained from get_token

API Endpoint Reference

Authentication

Method	Endpoint	Description
POST	`get_token`	Get API access token
POST	`refresh_token`	Refresh API access token
GET	`del_token`	Revoke API access token

System

Method	Endpoint	Description
GET	`system/information`	Query PBX info (model, firmware, uptime)
GET	`system/capacity`	Query capacity (extensions, concurrent calls, AI transcription quota)
GET	`system/get_menuoptions`	Query option values for creating/updating features
POST	`system/sendemail`	Send an email

system/information — Response fields (data object):

Field	Type	Description
`device_name`	String	Device name
`model_name`	String	Product model
`sn`	String	Serial number
`hardware_version`	String	Hardware version
`firmware_version`	String	Firmware version
`system_time`	String	System time
`up_time`	Integer	System uptime (seconds)
`system_date_format`	String	Date display format
`system_time_format`	String	Time display format
`timestamp`	Integer	Current system timestamp (seconds)

system/capacity — Response fields (data object):

Field	Type	Description
`extension_capacity`	Integer	Maximum number of extensions
`extension_used`	Integer	Number of extensions in use
`cc_capacity`	Integer	Maximum concurrent calls
`cc_used`	Integer	Concurrent calls in use
`ai_transcription_onetime_capacity`	Integer	Total one-time AI transcription quota (seconds)
`ai_transcription_onetime_used`	Integer	Used AI transcription quota (seconds)

Extension Management

Method	Endpoint	Description
GET	`extension/list`	List all extensions
GET	`extension/search`	Search extensions
GET	`extension/get`	Get single extension details
GET	`extension/query`	Get multiple extensions at once
GET	`extension/getpassword`	Get registration password + voicemail PIN
POST	`extension/create`	Create a SIP extension
POST	`extension/send_welcome_email`	Send Linkus welcome email
POST	`extension/update`	Edit an extension
GET	`extension/delete`	Delete an extension

extension/create — Key request parameters:

Parameter	Required	Description
`type`	Yes	Extension type — must be `"SIP"`
`number`	Yes	Extension number (digits only, max 8 chars)
`user_password`	Yes	User password (must contain numbers + uppercase + lowercase)
`reg_name`	Yes	Registration name (max 63 chars)
`reg_password`	Yes	Registration password
`concurrent_registrations`	Yes	IP phone simultaneous registrations (1–5)
`presence_status`	Yes	Initial presence status
`first_name`	No	First name
`last_name`	No	Last name
`email_addr`	No	Email address
`mobile_number`	No	Mobile number
`role_id`	No	User role ID (query via `system/get_menuoptions`)
`organization_list`	No*	Organizations the extension belongs to — required if Organization Management is enabled

Organization

Method	Endpoint	Description
GET/POST	`organization/list\|search\|get\|query\|create\|update\|delete`	Full CRUD for organizations

Trunk (SIP Trunks)

Method	Endpoint	Description
GET/POST	`trunk/list\|search\|get\|query\|itsp_list\|create\|update\|delete`	CRUD SIP trunks + query ITSP list

Contacts & Phonebook

Method	Endpoint	Description
GET/POST	`company_contact/...`	CRUD company contacts
GET/POST	`phonebook/...`	CRUD phonebooks

company_contact/create — Key request parameters:

Parameter	Required	Description
`first_name`	Yes	First name
`number_list`	Yes	Array of phone numbers; each entry has `num_type` (`business_number`, `mobile_number`, `home_number`, etc.) and `number`
`last_name`	No	Last name
`company`	No	Company name
`email`	No	Email address
`phonebook_id_list`	No	Array of phonebook IDs to assign this contact to
`organization`	No	Department
`job_title`	No	Job title

phonebook/create — Key request parameters:

Parameter	Required	Description
`name`	Yes	Phonebook name
`member_select`	No	Member selection method: `sel_all` (all company contacts) or `sel_specific` (specific contacts)
`add_contacts_id_list`	No	Array of company contact IDs to add (used when `member_select=sel_specific`)

Auto Provisioning

Method	Endpoint	Description
GET	`phone/search`, `phone/get`	Search/view IP phone details
GET	`auto_provisioning/compatibility`	Query config options for provisioning
POST	`phone/batchcreate\|batchupdate\|batchreprovision\|batchreboot\|batchdelete`	Bulk IP phone management

phone/batchcreate — Key request parameters:

Parameter	Required	Description
`vendor`	Yes	Phone vendor (query available options via `auto_provisioning/compatibility`)
`model`	Yes	Phone model
`phone_list`	Yes	Array of `{mac, ext_id}` — MAC address + extension ID to assign
`template_name`	Yes	Provisioning template name
`provisioning_method`	Yes	Provisioning method: `pnp`, `dhcp`, `rps`, or `rps_fqdn`

phone/get — Response fields (data object):

Field	Type	Description
`mac`	String	MAC address of the IP phone
`vendor`	String	Phone vendor
`model`	String	Phone model
`template_name`	String	Provisioning template currently applied
`provisioning_method`	String	Provisioning method (`pnp`, `dhcp`, `rps`, `rps_fqdn`)
`provisioning_link`	String	Provisioning URL for the phone
`assigned_extension`	String	ID of the extension assigned to this phone
`id`	Integer	Unique phone ID in the system

Routing

Method	Endpoint	Description
GET/POST	`inbound_route/...`	CRUD inbound routes
GET/POST	`outbound_route/...`	CRUD outbound routes

inbound_route/create — Key request parameters:

Parameter	Required	Description
`name`	Yes	Route name
`trunk_list`	Yes	Array of trunk IDs assigned to this route
`def_dest`	Yes	Default destination: `extension`, `ivr`, `queue`, `ring_group`, `ext_vm`, `end_call`, `external_num`, `range_to_ext`, `pattern_to_ext`, `call_flow`, etc.
`def_dest_value`	No	ID or value of the destination (required for most `def_dest` types)
`did_option`	No	DID matching mode: `patterns` (default), `pattern_to_ext`, `range_to_ext`, `pattern_to_ext_list`
`did_pattern_list`	No	Array of DID patterns (required when `did_option=patterns`)
`did_to_ext_start/end`	No	DID range start/end (required when `did_option=range_to_ext`)
`cid_option`	No	CID matching: `patterns` or `phonebook`

outbound_route/create — Key request parameters:

Parameter	Required	Description
`name`	Yes	Route name
`pin_protect`	Yes	Route PIN protection: `disable`, `single_pin`, `pin_list`
`trunk_list`	No	Array of trunks for outbound calls; each entry requires trunk `id`
`dial_pattern_list`	No	Array of dial patterns; each entry has `pattern`, `strip` (digits to strip from front), `prepend` (digits to prepend)
`ext_list`	No	Extensions/groups/organizations permitted to use this route; each entry has `id` + `type` (`extension`, `ext_group`, `organization`)
`outbound_cid`	No	Caller ID override for calls through this route
`pin`	No	Single PIN code (required when `pin_protect=single_pin`)
`pin_list`	No	ID of the PIN list (required when `pin_protect=pin_list`)

Voicemail

Method	Endpoint	Description
GET/POST	`vm/query\|get\|download\|create\|update\|delete\|delete_extension_vm`	Voicemail message management

IVR / Queue / Conference / Paging

Method	Endpoint	Description
GET/POST	`ivr/...`	CRUD IVR menus
GET/POST	`queue/...` + agent controls	CRUD queues + agent login/pause/status
GET/POST	`conference/...` + real-time controls	CRUD conferences + invite/kick/mute members
GET/POST	`paging/...`	CRUD paging groups

Recording & CDR & Reports

Method	Endpoint	Description
GET	`recording/list\|search\|download\|playtoextension`	Recording file management
GET/POST	`cdr/list\|search\|download\|getoption\|updateoption`	CDR queries + options
GET	`call_report/list\|detail\|download`	Call statistics reports
GET	`call_schedule_report/list\|download`	Scheduled report management

Call Control (Core Integration)

Method	Endpoint	Description
GET	`call/query`	Query active call details
POST	`call/dial`	Initiate a call (multiple types)
POST	`call/accept_inbound`	Accept inbound call (inbound control mode)
POST	`call/refuse_inbound`	Refuse inbound call
POST	`call/listen`	Monitor/spy a call
POST	`call/hold` / `call/unhold`	Hold/resume a call
POST	`call/mute` / `call/unmute`	Mute/unmute a call member
POST	`call/park` / GET `call/park_status`	Park a call / query parked calls
POST	`call/directly_forward_to_voicemail`	Forward to voicemail
POST	`call/transfer`	Blind or attended transfer
POST	`call/add_member`	Invite member to active call
POST	`call/play_prompt`	Play audio prompt to a number
POST	`call/hangup`	Hang up a call
POST	`call/record_start\|record_pause\|record_unpause`	Control call recording

uaCSTA Call Control

Method	Endpoint	Description
POST	`uacsta_call/accept\|refuse\|hangup`	Control calls via uaCSTA (IP phones)

Hotel

Method	Endpoint	Description
GET/POST	`wakeupcall/list\|get\|query\|create\|update\|delete`	Wake-up call (alarm) management
POST	`hotel/checkout`	Perform hotel guest checkout

Messaging

Method	Endpoint	Description
GET/POST	`message/channel\|queue\|campaign\|session\|message/...`	Messaging (SMS/WhatsApp/Facebook/LiveChat)
POST	`sms/create`	Send SMS via GSM/3G/4G trunk

Event Monitoring

WebSocket vs Webhook Comparison

	WebSocket	Webhook
Connection	Persistent long-lived connection	HTTP callback (no persistent connection)
URL	`wss://{pbx}:{port}/openapi/v1.0/subscribe?access_token=...`	User-defined URL in PBX settings
Subscribe	Send `{"topic_list":[30011,30012]}`	Auto-push on subscribed events
Heartbeat	Required every 60 seconds	Not required
Best for	Real-time dashboard, call control	CRM webhook, automation triggers

Complete Events List

Event ID	Name	Trigger
30005	Organization Status Switch State Changed	Organization feature enabled/disabled
30006	Organization Structure Changed	Organization config modified
30007	Extension Registration Status Changed	SIP/Linkus registration state change
30008	Extension Call State Changed	Extension call status change
30009	Extension Presence State Changed	Extension presence (DND/available/etc.) changes
30010	Trunk Registration State Changed	Trunk registration state change
30011	Call State Changed	Any call status change (real-time)
30012	Call End Details Notification	Call ends — CDR sent
30013	Call Transfer Report	Call transferred
30014	Call Forwarding Report	Call forwarded
30015	Call Failure Report	Call initiation failed
30016	Incoming Call Request	Inbound call on monitored trunk
30017	DTMF Digit Report	Key pressed during a call
30018	Prompt Playback Completed Report	Audio prompt finished playing
30019	Satisfaction Survey Feedback	Caller completed DTMF satisfaction survey
30020	uaCSTA Call Report	uaCSTA-controlled call state change
30022	Extension Information Updated	Extension created/edited/deleted
30023	Trunk Information Updated	Trunk created/edited/deleted
30024	No-hosted Conference	Conference host left
30025	Agent Automatic Pause	Agent auto-paused (max missed calls reached)
30026	Agent Ringing Timeout	Agent missed call due to ringing timeout
30027	Call Report Download Result	Async report download URL ready
30028	Call Note Status Updated	Call note availability changed
30029	Agent Status Changed	Agent status change
30030	Bulk Message Sending Failed	Message campaign partial/total failure
30031	New Message Notification	Inbound message received via API channel
30032	Message Sending Result	Outbound message delivery status changed
30033	Recording Download Completed	Async recording download complete
30034	System Event Notification (Information)	Info-level system event
30035	System Event Notification (Warning)	Warning-level system event

Common Use Cases

Scenario	Endpoints / Events
CRM screen pop on inbound call	Event 30016 + `call/query`
Click-to-call from CRM	`call/dial`
Live call dashboard	Event 30011 + `call/query`
Auto-provision Yealink T31G phones	`phone/batchcreate` + `phone/batchreprovision`
Hotel wake-up calls	`wakeupcall/create` + `hotel/checkout`
CDR export to database	`cdr/list` + Event 30012
Queue agent monitoring	`queue/agent_status` + Event 30029
Call recording on demand	`call/record_start` + `recording/download`

Yeastar P-Series — Parent system; API requires P550/P560/P570
Yeastar P-Series Features — Contact Center, Hotel Management supported via API
Yeastar P-Series Admin Guide — Extensions, Trunks, IVR, Queue manageable via API
Yealink T31G — IP phone; auto-provisioning via API + uaCSTA events
VoIP Phone System — SIP/PBX ecosystem context
Dahua.Api — Similar pattern: REST API wrapper for enterprise hardware integration

PrasitN Wiki

รายการหน้า

Yeastar P-Series API

Yeastar P-Series API

🇹🇭 ภาษาไทย

ภาพรวม

ความต้องการก่อนใช้งาน

รูปแบบการสื่อสาร

Authentication Flow

ตัวอย่าง — ขอ Access Token

รูปแบบ URL

สรุป Endpoints ทั้งหมด

Authentication

System

Extension (จัดการผู้ใช้ภายใน)

Organization

Trunk (SIP Trunk)

Contacts & Phonebook

Auto Provisioning (จัดการ IP Phone)

Routing

Voicemail

IVR / Queue / Conference / Paging

Recording & CDR

Settings

Messaging (SMS/WhatsApp/Facebook/LiveChat)

API Feature Settings

Hotel

Call Control (สำคัญมาก)

uaCSTA Call Control

Event Monitoring

WebSocket vs Webhook

รายการ Events ทั้งหมด

Use Cases สำหรับออฟฟิค

ความเชื่อมโยง

🇬🇧 English

Overview

Prerequisites

Communication Methods

Authentication Flow

Example — Get Access Token

URL Format

API Endpoint Reference

Authentication

System

Extension Management

Organization

Trunk (SIP Trunks)

Contacts & Phonebook

Auto Provisioning

Routing

Voicemail

IVR / Queue / Conference / Paging

Recording & CDR & Reports

Call Control (Core Integration)

uaCSTA Call Control

Hotel

Messaging

Event Monitoring

WebSocket vs Webhook Comparison

Complete Events List

Common Use Cases

Related Pages

มุมมองกราฟ

สารบัญ