API documentation

PUT /secure/:secure_token/calls/:uuid

Secure token and call UUID required

https://[your-subdomain].trackdrive.com/api/v1/secure/:secure_token/calls/:uuid

Update a call by SIP tokens

Update a call with td_secure_token and td_uuid passed in a call’s SIP headers.

Params

Param name	Description
secure_token Required	The secure token used to authorize access to an individual object. Must be 40 characters. Must match regular expression `/.{40}/`.
uuid Required	A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1 Must be a String
revenue Optional	The revenue paid out for the call. Must be a decimal number.
buyer_converted Optional	Did the buyer convert? Must be a boolean value: 1, true, yes, on, 0, false, no, off
digits Optional Blank value allowed	DTMF digit Must be a String
data Optional Blank value allowed	Update the call with this data. `{interest: 'kittens', source: 'google', first_name: 'John', last_name: 'Smith'}` Must be a Hash

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/secure/11111111035c9a8287c2e413a03fb32051f620e0/calls/b1e5ad59-2c2f-4871-bd1e-eb882bb6a0ac' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "revenue": "10",
  "buyer_converted": true
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call": {
    "uuid": "b1e5ad59-2c2f-4871-bd1e-eb882bb6a0ac",
    "revenue": "10.0",
    "buyer_converted": true
  },
  "metadata": {
    "root": "call"
  }
}

DELETE /secure/:secure_token/calls/:uuid

Secure token and call UUID required

https://[your-subdomain].trackdrive.com/api/v1/secure/:secure_token/calls/:uuid

Hang up a call by SIP tokens

Hang up an ongoing call using a td_secure_token and td_uuid passed in a call’s SIP headers.

Params

Param name Description

secure_token
Required

The secure token used to authorize access to an individual object. Must be 40 characters.

Must match regular expression /.{40}/.

uuid
Required

A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1

Must be a String

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/secure/11111111035c9a8287c2e413a03fb32051f620e0/calls/b1e5ad59-2c2f-4871-bd1e-eb882bb6a0ac' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call": {
    "uuid": "b1e5ad59-2c2f-4871-bd1e-eb882bb6a0ac",
    "revenue": null,
    "buyer_converted": null
  },
  "metadata": {
    "root": "call"
  }
}

GET /secure/:secure_token/calls/:uuid/data

Secure token and call UUID required

https://[your-subdomain].trackdrive.com/api/v1/secure/:secure_token/calls/:uuid/data

Returns UUID and data for the call.

Returns the call's uuid and its stored custom field data for a downstream carrier or SIP trunk, authenticated by the call's own secure_token and uuid rather than an auth_token. Used by systems that echo Trackdrive's custom SIP headers or X-PH- webhook parameters back to look up the associated call's data mid-call.

Params

Param name Description

secure_token
Required

The secure token used to authorize access to an individual object. Must be 40 characters.

Must match regular expression /.{40}/.

uuid
Required

A unique identifier eg: 5cc8897c-ad0f-44cb-8ea7-8f7736ae76f1

Must be a String

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/secure/11111111035c9a8287c2e413a03fb32051f620e0/calls/b1e5ad59-2c2f-4871-bd1e-eb882bb6a0ac/data' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "uuid": "b1e5ad59-2c2f-4871-bd1e-eb882bb6a0ac",
  "data": {
    "first_name": "John",
    "last_name": "Doe",
    "custom_field": "example"
  }
}