voipappz
  1. Workflows
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
      POST
    • Update
      PATCH
    • Get By ID
      GET
    • Get All
      GET
  • 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. Workflows

Create

Developing
POST
/api/workflows
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 application/x-www-form-urlencoded
actions[0][field]
string 
optional
Example:
weight
actions[0][operator]
string 
optional
Example:
BT
actions[0][value]
string 
optional
Example:
10
conditions_all[0][field]
string 
optional
Example:
status.uuid
conditions_all[0][operator]
string 
optional
Example:
IS
conditions_all[0][value][]
array[string]
optional
Example:
[" 3db8f636-f544-4133-89e3-1c32915899b5"," 9ef157df-49b4-4402-bc5a-e24d7b1fb51f"," f9224d93-95ac-4b87-946e-c41a526d5cfe"," 724ce197-f915-4028-9b92-8c0362c3853c"," fe7dc7d4-ec9c-45f9-8738-5b6d0521c623"," 219e7b1f-e333-4ef0-9cc2-e89d9d86f1b4"," ac3b3315-d53d-420b-9e96-c9f36eda8ea6"," 13df0a40-c56b-41b7-9481-02d3eb467148"," 44e15cdf-08e4-4735-95a2-c825baff129a"," 4cb975d5-12c5-45a0-9646-34043ae70e5d"," bf49e857-0b34-4fdd-bc57-6ff8c62c87c5"," f4773113-8874-4257-bca4-30176898f0da"," ff5aff2f-1542-4016-b272-90e3fd2b6a72"]

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/workflows' \
--header 'Authorization: {{auth}}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2025-05-07 18:30:55
Previous
Get All
Next
Update
Built with