voipappz
  1. Schema
voipappz
  • Account
    • Create
      POST
    • Update
      PATCH
    • Get By ID
      GET
    • Get All
      GET
  • Conferences
    • Create
      POST
    • Get By ID
      GET
    • Get All
      GET
  • Statuses
    • Create
      POST
    • Update
      PATCH
    • Get By ID
      GET
    • Get All
      GET
  • Dids
    • Types
      GET
    • Create
      POST
    • Update
      PATCH
    • Get By ID
      GET
    • Get All
      GET
  • Groups
    • Types
      GET
    • Create
      POST
    • Update
      PATCH
    • Get By ID
      GET
    • Get All
      GET
  • Segments
    • Create
    • Update
    • Get By ID
    • Get All
  • Workflows
    • Create
    • Update
    • Get By ID
    • Get All
  • Call
    • Make a Call
    • Click2Dial
    • Call Control
    • 3 way call (Conf) - add a number to exsiting Call
    • Call Broadcast - Make a Call and Play it an audio file
    • 3 way call (Conf) - add an extension to exsiting Call
    • Hold A Call
    • Spy call - Create A new Call That will preform spy
    • Whisper To Customer (Leg A)
    • Whisper to an Agent (Leg A)
    • Hangup Call
    • Get Call Data
    • Send DTMF keys - Leg A
    • Update Call Meta
    • Get Calls - Free Text
    • Get Calls By Search Params
    • Make a call and play file
  • Environment
    • Create
    • Get By ID
    • Get All
    • Update
    • Set Provider Stategy
    • Get By ID
    • Set Services
  • Customer
    • Create
  • Campaign
    • Create
    • Get By ID
    • Get All
    • Update
    • Delete
  • Campaign Number
    • Create
    • Create By Group
    • Get By ID
    • Get All
    • Delete
    • Update
  • Provider
    • Create
    • Get By ID
    • Get All
    • Update
    • Get By ID
  • Usage
    • Get By ID
    • Update
    • Get All
    • Get By ID
    • Update Status
    • Create
  • Voicemail
    • Get By ID
    • Update
    • Get All
    • Create
  • User
    • Logout
    • Break
    • Login
    • Get All
    • Create User
    • Update User
    • Status
    • Number
    • Extension
    • State
    • Tier
    • Agents
  • Service
    • Create
    • Create Caller ID Service
    • Get
    • Get By ID
    • Update Service
    • Delete
    • Create Items (Destination)
    • Create Items (Destination)
    • Update item
    • Delete item
    • Get Items
  • Tariff
    • Create
    • Get
    • Get By ID
    • Update Tariff
    • Delete
    • Upload Rate
    • Update item
    • Delete item
    • Get Items
  • Tracing
    • Get By ID
    • disk
  • Announcement
    • Create
  • IVR
    • Create
  • Message
    • Create and Send a Message
  • Route
    • Create
  • Subscriptions
    • Get
    • Get All Active
    • Set Balance
    • Create
  • Skill
    • Update Skill
    • Get Skills
    • Create Skill
  • Schema
    • Create PBX - Example #0
      POST
    • Create PBX - Example #1
      POST
    • Create PBX - Example #2
      POST
    • Import
      POST
  • Login Token
    POST
  • Forgot Password
    POST
  1. Schema

Create PBX - Example #2

Developing
POST
/api/schemas

Request

Header Params
Authorization
string 
optional
Example:
{{auth}}
Body Params multipart/form-data
type
string 
optional
Example:
environment
environment_name
string 
optional
Example:
1MonthEx321ample132111
did[0][name]
string 
optional
Example:
New Route
did[0][src]
string 
optional
Example:
3213132113122321
did[0][bridge_type]
string 
optional
Example:
vml
did[0][bridge_uuid]
string 
optional
Example:
0bf413d3-9df0-44f5-906b-a96876c6d16e
did[0][type]
array[string]
optional
Example:
["src"]
account[0][fullname]
string 
optional
Example:
customer Name
account[0][email]
string 
optional
Example:
customer@example.com
account[0][password]
string 
optional
Example:
pass
extension[0][name]
string 
optional
Example:
231312
extension[0][caller_id_number]
string 
optional
Example:
432432
extension[0][username]
string 
optional
Example:
username
extension[0][password]
string 
optional
Example:
password

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/api/schemas' \
--header 'Authorization: {{auth}}' \
--form 'type="environment"' \
--form 'environment_name="1MonthEx321ample132111"' \
--form 'did[0][name]="New Route"' \
--form 'did[0][src]="3213132113122321"' \
--form 'did[0][bridge_type]="vml"' \
--form 'did[0][bridge_uuid]="0bf413d3-9df0-44f5-906b-a96876c6d16e"' \
--form 'did[0][type]="src"' \
--form 'account[0][fullname]="customer Name"' \
--form 'account[0][email]="customer@example.com"' \
--form 'account[0][password]="pass"' \
--form 'extension[0][name]="231312"' \
--form 'extension[0][caller_id_number]="432432"' \
--form 'extension[0][username]="username"' \
--form 'extension[0][password]="password"'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2025-06-10 08:17:59
Previous
Create PBX - Example #1
Next
Import
Built with