/
PO
portsip
/
PortSIP PBX Rest API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 5h ago · Updated 2w ago
View markdown
portsip
PortSIP PBX Rest API
get
Retrieve current user balance.
latest
OpenAPI 3.1.0
PortSIP
2026-08-10
558
111
2.6 MB
577415d4a3d5
Administration
61
Authentication
5
Auto Provisioning
24
Automatic Callback
2
Billing
8
Blobs
6
Call Park
10
Call Pickup
8
Call Queue
18
Call Session
9
CDR
12
Conference
31
Contact
6
CTI
37
Emergency Number
5
Extension
1
External Message
2
Feature Access Code
2
File
3
Google
4
Hot Desking
7
Inbound Rule
6
Media Server
6
Microsoft 365
9
MOH
6
Notification
9
Outbound Rule
10
Push Notification
5
Recording
3
Ring Group
8
Security
14
Shared Voicemail
15
SMS/MMS
5
Tenant
16
Troubleshooting
2
Trunk
7
User
149
get
List roles
post
Create a role
get
Retrieve a role
post
Update a role
post
Delete a role
get
Retrieve current user
post
Update current user properties.
post
Reset current user password
post
Reset current user extension password
post
Reset current user profile
get
Retrieves current user status
post
Set current extension user presence
get
Retrieve current user balance.
get
List current user voicemail greetings
post
Create voicemail greeting for current user
post
Enable one of current user's greetings.
post
Disable current user greeting
post
Delete voicemail greeting
get
List current user's IP phones
post
Assign phone to current user
get
Retrieve current user phone details
post
Update a phone of current user
post
Remove a phone of current user
get
List user call detail records
get
Retrieve user call detail record
post
Create new personal cdr sync token
post
List personal cdr changes
get
List user external messages
get
Retrieve user external message
get
List user call recordings
get
Retrieve an user call recording
post
Delete user call recording
get
List speed dial 8
post
Add new speed dial 8
get
Retrieve details of speed dial 8
post
Update speed dial 8
post
Delete speed dial 8
get
List speed dial 100
post
Add new speed dial 100
get
Retrieve details of speed dial 100
post
Update speed dial 100
post
Delete speed dial 100
get
List user meetings
post
Create a Meeting
get
Retrieve a meeting
post
Update a meeting
post
Delete meeting
get
Get meeting status
post
Mute meeting
post
Unmute meeting
post
Lock meeting
post
Unlock meeting
post
Start meeting
post
Stop meeting
post
Start recording in meeting
post
Stop recording in meeting
get
List meeting participants
post
Update meeting participants layout
get
Get meeting participant details
post
Invite meeting participant
post
Mute meeting participant
post
Unmute meeting participant
post
Transfer meeting ownership
post
Set meeting participant position
post
Kick out meeting participant
get
List current user's holidays
post
Create a new holiday for current user
get
Retrieve a holiday of current user
post
Update a holiday of current user
post
Destroy a holiday of current user
get
List current user's global holidays
post
Update current user's global holidays
get
List personal contact
post
Add a new personal contact
get
Retrieve personal contact details
post
Update a personal contact
post
Favorite a personal contact
post
Unfavorite a personal contact
post
Delete a personal contact
post
Create new personal contact sync token
post
List personal contact changes
post
Favorite a business contact
post
Unfavorite a business contact
post
Create a business contact sync token
post
List business contact changes
post
Favorite an extension contact
post
Unfavorite an extension contact
post
Create a extension contact sync token
post
List extension contact changes
get
Retrieve the call queues which current user belongs
get
Retrieve call queue agent
post
Set call queue agent status
get
Retrieve a collection of outbound caller ids
get
Retrieve the ring groups which current user belongs
get
List users
post
Create a user
post
Reset all user profiles
get
Retrieve a user
post
Update a user
post
Reset user password
post
Reset user extension password
post
Change user role
post
Reset user profile
post
Bind user to ms365 account
post
Unbind user from ms365 account
post
Delete a user
get
Retrieves user current status
post
Delete user registration
get
Retrieve balance
post
Update balance
get
List voicemail greetings
post
Create voicemail greeting
post
Enable greeting
post
Disable greeting
post
Delete voicemail greeting
get
List user's IP phones
post
Assign phone to user
get
Retrieve user phone details
post
Update a phone of user
post
Remove a user phone
get
List user's holidays
post
Create a new holiday for user
get
Retrieve a holiday of a user
post
Update a holiday for a user
post
Destroy a holiday of user
get
List user's global holidays
post
Update user's global holidays
get
Retrieve the call queues which the user belongs
get
Retrieve call queue agent
post
Set call queue agent status
get
List speed dial 8
post
Add new speed dial 8
get
Retrieve details of speed dial 8
post
Update speed dial 8
post
Delete speed dial 8
get
List speed dial 100
post
Add new speed dial 100
get
Retrieve details of speed dial 100
post
Update speed dial 100
post
Delete speed dial 100
get
List user groups
post
Create an user group
get
Retrieve an user group
post
Update an user group.
post
Delete an user group
get
List user group members
get
Check user group member
post
Add user group member
post
Delete group member
Virtual Receptionist
17
Voicemail
5
WhatsApp
5
User
Retrieve current user balance.
Retrieve current user's balance.
get
/user/balance
Response
OK
object
required
balance
number
double
User balance. Precision is five digits.