REST API Documentation

How to use
VoIPstudio
VoIPstudio VoIP service manual

All you need to know about using our business phone system in one place

VoIPstudio VoIP service manual
Not already signed up?

Start a free 30 day trial now, no credit card details required!

Start my trial!
Not already signed up?

Start a free 30 day trial now, no credit card details required!

Start my trial!
VoIPstudio icon

Settings module

Endpoints for managing PBX settings such us Telephone Numbers configuration, Contacts, Ring Group, IVRs etc.

GET

/contacts Returns collection of Contact resources

POST

/contacts Creates new Contact resource

PATCH

/contacts [BULK] Updates folder of existing Contact resources

GET

/contacts/{id} Returns Contact resource for given Id

PATCH

/contacts/{id} Updates existing Contact resource

DELETE

/contacts/{ids} Deletes existing Contacts resources

GET

/conferences Returns collection of Conference resources

POST

/conferences Creates new Conference resource

GET

/conferences/{id} Returns Conference resource for given Id

PATCH

/conferences/{id} Updates existing Conference resource

DELETE

/conferences/{id} Deletes existing Conference resource

GET

/ddis Returns collection of Ddi resources

GET

/ddis/dictionaries Returns Dictionary for Ddi resource

GET

/ddis/{e164} Returns Ddi resource for given e164

GET

/queues Returns collection of Queue resources

POST

/queues Creates new Queue resource

GET

/queues/{id} Returns Queue resource for given Id

GET

/pickupgroups Returns collection of PickupGroup resources

GET

/pickupgroups/{id} Returns PickupGroup resource for given Id

GET

/routingrules Returns collection of RoutingRule resources

GET

/routingrules/{id} Returns routing rule resource for given ID

PATCH

/routingrules/{id} Updates existing routing rule resource

GET

/ivrs Returns collection of Ivr resources

POST

/ivrs Creates new Ivr resource

GET

/ivrs/{id} Returns Ivr resource for given Id

PATCH

/ivrs/{id} Updates existing Ivr resource

DELETE

/ivrs/{id} Deletes existing Ivr resource

GET

/mohs/{id} Returns Moh resource for given Id

Ready to get started with VoIPstudio?

Start a free 30 day trial now, no credit card details are needed!

Thousands of businesses across the world trust VoIPstudio for all of their most vital business communications. Why not be the next?

Thousands of businesses across the world trust VoIPstudio for all of their most vital business communications. Why not be the next?

Start my trial! Take a 30 day free trial

Start a free 30 day trial now, no credit card details are needed!

VoIPstudio icon