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

Create

Developing
POST
/api/groups
You Can use Statuses to Manage Workflow on the system.
We support the following Statuses types:
"available" - Agent is available and able to get calls
"on_break" - Agent is on Break
"logged_out" - Logged out
Please note each status change is logged in the system , we can use it forther for statistics etc

Request

Header Params
Authorization
string 
optional
Example:
{{auth}}
Body Params multipart/form-data
name
string 
required
Example:
NumberGr332123132113o11up31321
type
enum<string> 
required
Allowed values:
on_breakavailablelogged_out
Example:
number
notes 
string 
optional
Example:
Internal Notes
resources[]
string 
optional
Example:
97254523458531
environment_uuid
string 
optional
Example:
050a5648-2471-4722-a9d1-34ecec12714d

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/groups' \
--header 'Authorization: {{auth}}' \
--form 'name="NumberGr332123132113o11up31321"' \
--form 'type="number"' \
--form 'notes="Internal Notes"' \
--form 'resources[]="97254523458531"' \
--form 'environment_uuid="050a5648-2471-4722-a9d1-34ecec12714d"'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2025-05-07 15:43:30
Previous
Types
Next
Update
Built with