API documentation

GET /sip_header_parsers

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers

List SIP Key records.

List the SIP Key records in your account, which define how a SIP header on an inbound call is mapped into a contact field.

Params

Param name	Description
ids Optional	Return records matching these ids. Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Must be a number.
per_page Optional	How many results to return per page. The default is 25. Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Must be a String
fulltext Optional	Search for any record that matches this text Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id name context_menu_name company_id sip_header_parser_group_id sip_header_key contact_field_key description Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Must be a boolean value: 1, true, yes, on, 0, false, no, off

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "sip_header_parsers": [
    {
      "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "type": "SipHeaderParser",
      "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "routes_edit_path": "/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
      "external_record_id": null,
      "name": "x_ph_campaign_id -> campaign_id",
      "context_menu_name": "x_ph_campaign_id -> campaign_id",
      "company_id": 10001,
      "sip_header_parser_group_id": "a09e6bca-255b-4217-af73-cb9601c80217",
      "sip_header_key": "x_ph_campaign_id",
      "contact_field_key": "campaign_id",
      "description": null
    },
    {
      "id": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
      "type": "SipHeaderParser",
      "uuid": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": "2026-01-15T15:30:00.000Z",
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/sip_header_parsers/49cca320-d2dd-4768-a730-8fc3e0a664e7",
      "routes_edit_path": "/sip_header_parsers/49cca320-d2dd-4768-a730-8fc3e0a664e7/edit",
      "external_record_id": null,
      "name": "x_ph_source_uuid -> source_uuid",
      "context_menu_name": "x_ph_source_uuid -> source_uuid",
      "company_id": 10001,
      "sip_header_parser_group_id": "a09e6bca-255b-4217-af73-cb9601c80217",
      "sip_header_key": "x_ph_source_uuid",
      "contact_field_key": "source_uuid",
      "description": null
    }
  ],
  "metadata": {
    "root": "sip_header_parsers",
    "page": 1,
    "total_pages": 4,
    "per_page": 2,
    "total_count": 8,
    "next_cursor": 10002
  }
}

GET /sip_header_parsers/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers/new

Build SIP Key with defaults.

Return a blank SIP Key record populated with default attribute values, useful for building a create form.

Params

Param name	Description
sip_header_parser_group_id Optional Blank value allowed	Sip Header Parser Group Must be a String
sip_header_key Optional Blank value allowed	Sip Header Key Must be a String
contact_field_key Optional Blank value allowed	Contact Field Key Must be a String
description Optional Blank value allowed	Description Must be a String

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sip_header_parser": {
    "id": null,
    "type": "SipHeaderParser",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sip_header_parsers/new",
    "routes_edit_path": "/sip_header_parsers/new",
    "external_record_id": null,
    "name": " -> ",
    "context_menu_name": " -> ",
    "company_id": 10001,
    "sip_header_parser_group_id": null,
    "sip_header_key": null,
    "contact_field_key": null,
    "description": null
  },
  "metadata": {
    "root": "sip_header_parser"
  }
}

POST /sip_header_parsers

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers

Create SIP Key.

Create a SIP Key that maps a SIP header (identified by its key) to a contact field key within a SIP Header Parser Group, so values from SIP trunk headers can be captured on calls.

Params

Param name	Description
sip_header_parser_group_id Optional Blank value allowed	Sip Header Parser Group Must be a String
sip_header_key Optional Blank value allowed	Sip Header Key Must be a String
contact_field_key Optional Blank value allowed	Contact Field Key Must be a String
description Optional Blank value allowed	Description Must be a String

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "sip_header_parser_group_id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
  "sip_header_key": "x_ph_example_key",
  "contact_field_key": "example_field"
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "sip_header_parser": {
    "id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "type": "SipHeaderParser",
    "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sip_header_parsers/a09e6bca-255b-4217-af73-cb9601c80217",
    "routes_edit_path": "/sip_header_parsers/a09e6bca-255b-4217-af73-cb9601c80217/edit",
    "external_record_id": null,
    "name": "x_ph_example_key -> example_field",
    "context_menu_name": "x_ph_example_key -> example_field",
    "company_id": 10001,
    "sip_header_parser_group_id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "sip_header_key": "x_ph_example_key",
    "contact_field_key": "example_field",
    "description": null
  },
  "metadata": {
    "root": "sip_header_parser"
  }
}

GET /sip_header_parsers/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers/:id

Get SIP Key by id.

Get the details of a single SIP Key record by id.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sip_header_parser": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "SipHeaderParser",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "name": "x_ph_campaign_id -> campaign_id",
    "context_menu_name": "x_ph_campaign_id -> campaign_id",
    "company_id": 10001,
    "sip_header_parser_group_id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "sip_header_key": "x_ph_campaign_id",
    "contact_field_key": "campaign_id",
    "description": null
  },
  "metadata": {
    "root": "sip_header_parser"
  }
}

PUT /sip_header_parsers/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers/:id

Update SIP Key by id.

Update the SIP header key, target contact field key, group, or description of an existing SIP Key.

Params

Param name	Description
sip_header_parser_group_id Optional Blank value allowed	Sip Header Parser Group Must be a String
sip_header_key Optional Blank value allowed	Sip Header Key Must be a String
contact_field_key Optional Blank value allowed	Contact Field Key Must be a String
description Optional Blank value allowed	Description Must be a String

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "contact_field_key": "example_field_renamed"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sip_header_parser": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "SipHeaderParser",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "name": "x_ph_example_key -> example_field_renamed",
    "context_menu_name": "x_ph_example_key -> example_field_renamed",
    "company_id": 10001,
    "sip_header_parser_group_id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "sip_header_key": "x_ph_example_key",
    "contact_field_key": "example_field_renamed",
    "description": null
  },
  "metadata": {
    "root": "sip_header_parser"
  }
}

DELETE /sip_header_parsers/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers/:id

Destroy SIP Key by id.

Permanently remove a SIP Key mapping so that header will no longer be parsed into a contact field.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sip_header_parser": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "SipHeaderParser",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": "/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/sip_header_parsers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "name": "x_ph_example_key -> example_field",
    "context_menu_name": "x_ph_example_key -> example_field",
    "company_id": 10001,
    "sip_header_parser_group_id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "sip_header_key": "x_ph_example_key",
    "contact_field_key": "example_field",
    "description": null
  },
  "metadata": {
    "root": "sip_header_parser"
  }
}

Params

Must be any combination of:

Params

Params

Params