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
  • 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. Call

Call Broadcast - Make a Call and Play it an audio file

Developing
POST
/api/calls
With Call Broadcast api we can trigger calls to external numbers and play audio files.
This module can be used with IOT Automation , Notification Services etc

Request

Body Params multipart/form-data
leg_a[type]
string 
required
Example:
number
leg_a[number]
string 
optional
Leg A Number
Example:
888888888888
leg_b[type]
string 
optional
Example:
announcement
leg_b[uuid]
string 
optional
Uuid if Annuncement
Example:
c9a51d20-c64d-42d5-bd4f-9d334442faee
profile[gateway_uuid]
string 
optional
Optional: we can set the SIP Gateway of the Call
Example:
208496cf-b572-4794-a9ab-c7ca3647f673
profile[caller_id_number]
string 
optional
OPtional: we can set the Caller ID of the Call
Example:
999999999999

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/calls' \
--form 'leg_a[type]="number"' \
--form 'leg_a[number]="888888888888"' \
--form 'leg_b[type]="announcement"' \
--form 'leg_b[uuid]="c9a51d20-c64d-42d5-bd4f-9d334442faee"' \
--form 'profile[gateway_uuid]="208496cf-b572-4794-a9ab-c7ca3647f673"' \
--form 'profile[caller_id_number]="999999999999"'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2024-11-29 08:55:08
Previous
3 way call (Conf) - add a number to exsiting Call
Next
3 way call (Conf) - add an extension to exsiting Call
Built with