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

Get Calls By Search Params

Developing
GET
/api/calls
Supported Fields to Search tag_uuid,uuid,callee_number,caller_number,ivr_uuid,route_uuid,cause,disposition,direction,environment_uuid,user_uuid,queue_uuid,duration,billing_duration,campaign_uuid

Request

Query Params
search[call.created_at]
string 
optional
Call Date in unixtime range
Example:
1736892000-1736978399
search[call.direction][IS][]
array[string]
optional
Call Direction, can be either incoming or outgoing
Example:
["incoming","outgoing"]
search[call.callee][IS]
string 
optional
Callee (Destination)
Example:
03900000
search[call.uuid][IS][]
string 
optional
Caller (Source Caller ID)
Example:
11e63594-b9f3-4591-ab7a-7a7304871503
search[text]
string 
optional
Wildcard search param
Example:
22222
page
string 
optional
Pagination page #
Example:
1
per_page
string 
optional
Pagination per page
Example:
50
Header Params
Authorization
string 
optional
Example:
{{auth}}
Body Params application/x-www-form-urlencoded
object {0}

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 -g --request GET '/api/calls?search[call.uuid][IS][]=11e63594-b9f3-4591-ab7a-7a7304871503&page= 1&per_page= 50' \
--header 'Authorization: {{auth}}'

Responses

🟢200Success
application/json
Body
object {0}
Example
{}
Modified at 2025-02-10 14:36:15
Previous
Get Calls - Free Text
Next
Make a call and play file
Built with