voipappz
  1. Call
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
    • Create
    • Update
    • Get By ID
    • Get All
  • Groups
    • Types
    • Create
    • Update
    • Get By ID
    • Get All
  • Segments
    • Create
    • Update
    • Get By ID
    • Get All
  • Workflows
    • Create
    • Update
    • Get By ID
    • Get All
  • Call
    • Make a Call
      POST
    • Click2Dial
      GET
    • Call Control
      PATCH
    • 3 way call (Conf) - add a number to exsiting Call
      POST
    • Call Broadcast - Make a Call and Play it an audio file
      POST
    • 3 way call (Conf) - add an extension to exsiting Call
      POST
    • Hold A Call
      PATCH
    • Spy call - Create A new Call That will preform spy
      POST
    • Whisper To Customer (Leg A)
      PATCH
    • Whisper to an Agent (Leg A)
      PATCH
    • Hangup Call
      DELETE
    • Get Call Data
      GET
    • Send DTMF keys - Leg A
      PATCH
    • Update Call Meta
      PATCH
    • Get Calls - Free Text
      GET
    • Get Calls By Search Params
      GET
    • Make a call and play file
      POST
  • 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
  • Groups
    • Create (Group of Numbers)
    • 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
    • Import
    • CallCenterOutgoing
  • Login Token
    POST
  • Forgot Password
    POST
  1. Call

Hold A Call

Developing
PATCH
/api/calls/{id}
With Call Hold you can place a call on "hold" , this feature usualy used when we need to consult with 3rd party
please note that in order to know the call id we should subscribe to webhook service
Please note that {id} can be one of the following:
GUUID Of The Call - Will be received via webhooks

Request

Path Params

Body Params multipart/form-data

Request Code 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 PATCH '/api/calls/' \
--form 'action="hold"' \
--form 'username="9000"'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2024-11-29 08:55:20
Previous
3 way call (Conf) - add an extension to exsiting Call
Next
Spy call - Create A new Call That will preform spy
Built with