/
PO
portsip
/
PortSIP PBX Rest API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 18h ago · Updated 2w ago
View markdown
portsip
PortSIP PBX Rest API
post
Update IM server configuration
latest
OpenAPI 3.1.0
PortSIP
2026-08-10
558
111
2.6 MB
577415d4a3d5
Administration
61
get
Retrieve network configurations
post
Update network configurations
get
Retrieve current system status
post
Change system admin username
post
Reset system admin password
get
Retrieve system settings
post
Update system settings
get
Retrieve system notification settings
post
Update system notification settings
post
Test email
get
Retrieve SBC configuration
post
Update SBC configuration
get
Retrieve SBC token
post
Regenerate SBC token
post
Destroy SBC Token
get
Retrieve IM server configuration
post
Update IM server configuration
get
Retrieve IM Server token
post
Regenerate IM server token
post
Destroy IM server Token
get
List dealers
post
Create a dealer
get
Retrieve a dealer
post
Update a dealer
post
Reset dealer password
post
Delete a dealer
get
List IP rules
post
Create an IP rule
get
Retrieve an IP rule
post
Update an IP rule
post
Delete an IP rule
get
Export IP rules
get
List transports
post
Create a transport
get
Retrieve a transport
post
Update transport
post
Destroy transport
get
Query transport's status
get
List tenants
post
Create a tenant
get
Retrieve a tenant
post
Update a tenant
post
Switch between tenants
get
Retrieve dealer information the tenant belongs
post
Designate tenant to dealer
post
Remove tenant to dealer
post
Delete a tenant
get
Retrieve license information
post
Update license
get
Show certificate key
post
Update certificate key
post
Update brand information
get
Retrieve current dealer
post
Update current dealer
get
Retrieve current dealer status
post
Change current dealer username
post
Reset current dealer password
get
List provider assignees
get
Check provider assignee
post
Assign provider
post
Destroy a provider assignee
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
Virtual Receptionist
17
Voicemail
5
WhatsApp
5
Administration
Update IM server configuration
Update IM server configuration.
post
/im
Request body
object
required
private_ipv4
string
Host IPV4 address.
private_ipv6
string
Host IPV6 address.
public_ipv4
string
Host IPV4 address.
public_ipv6
string
Host IPV6 address.
Response
OK