Create Call Recording Subscription

Create a subscription to receive events for any of a user's call recordings. You define a URL that will receive a callback any time a call recording event on the PBX matches the parameters of the subscription.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Event Callbacks

Call recordings that match the subscription parameters will result in a HTTP(S) post from the PBX to the post_url defined in the subscription. This post will contain a payload that looks like the example below. Because of the nature of how events are processed, multiple call_recording events can be contained in a single callback. The structure of the post is an array of call recordings.

[
  {
    "accElm": "sip:[email protected]",
    "aor0": "sip:[email protected]",
    "aor1": "sip:[email protected]",
    "callId": "99999aaa-5555-5555-5555-0022482b9ee7",
    "caseId":["[email protected]", "sip:[email protected]"],
    "cccId": "1104",
    "count0": "11801",
    "count1": "11747",
    "domain0": "domain.123456.service",
    "domain1": "domain.123456.service",
    "duration": "276",
    "event": "convertDone",
    "file0": "2025/01/24/aaa-99999aaa-5555-5555-5555-0022482b9ee7-1104-0.rtp",
    "file1": "2025/01/24/aaa-99999aaa-5555-5555-5555-0022482b9ee7-1104-1.rtp",
    "file2": "2025/01/24/aaa-99999aaa-5555-5555-5555-0022482b9ee7-1104.wav",
    "hostname": "licf1-dal.dialtoen.com",
    "size2": "3775",
    "status": "converted",
    "territory0": "123456",
    "territory1": "123456",
    "time": "2025-01-24 15:24:33",
    "timeClose": "2025-01-24 15:23:09",
    "timeOpen": "2025-01-24 15:18:33",
    "uid0": "[email protected]",
    "uid1": "[email protected]",
    "object": "call_recording",
    "action": "update",
    "download_url": "https://licf1-dal.dialtoen.com/licf-storage-v2/api/recording?object=recording&action=play&accel=sip%3Asystem%40g1-sw01-hpbx.dialtoen.com&casid=111%40domain.123456.service%3Bsip%3A111t%40domain.123456&cccid=1104&calid=99999aaa-5555-5555-5555-0022482b9ee7&uid=licf1-dal.dialtoen.com&time=20250124152433&auth=123456",
    "node_ts_tx": "2025-01-24 15:24:35"
  }
]
📘

Download Expiration

Please note that the download_url is only valid for 24 hours.

Form Data
string
required

Specify which domain you would like to receive events for. Use * to receive for all domains

string
required

Specify which user to receive events for. Use * to receive for all users

string
required

HTTP or HTTPS endpoint. This is where Netsapiens will POST the events

date

Specifies when the subscription will expire. (Set date a couple days in the future as server time calculates the expiration incorrectly)

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/xml
application/json