voipappz
  1. Provider
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
      POST
    • Get By ID
      GET
    • Get All
      GET
    • Update
      PATCH
    • Get By ID
      GET
  • 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
    • Create PBX - Example #1
    • Create PBX - Example #2
    • Import
  • Login Token
    POST
  • Forgot Password
    POST
  1. Provider

Create

Developing
POST
/api/providers

Request

Query Params
name
string 
optional
A Valid Name for The Environment
Example:
MyFirstEnvironment
Body Params multipart/form-data
name
string 
optional
name
profile[address]
string 
optional
IP Address / Domain of Provider
Example:
10.1.1.1
type
enum<string> 
optional
Allowed values:
sipsms
Example:
sip
resources[0][name]
string 
optional
Example:
resources
resources[0][type]
array[string]
optional
Example:
["destination"]
resources[0][val]
string 
optional
Example:
10.4.4.10

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/providers?name=MyFirstEnvironment' \
--form 'name=""' \
--form 'profile[address]="10.1.1.1"' \
--form 'type="sip"' \
--form 'resources[0][name]="resources"' \
--form 'resources[0][type]="destination"' \
--form 'resources[0][val]="10.4.4.10"'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2025-04-28 07:51:21
Previous
Update
Next
Get By ID
Built with