SIP Header Parsing

A named set of rules that pull data out of SIP call headers and save it to a lead.

GET /sip_header_parser_groups

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/sip_header_parser_groups

List SIP Header Parsing records.

Lists the SIP Header Parsing groups configured on the account. Each group bundles individual header parsers that extract values from a call's inbound SIP headers and is attached to one or more offers.

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.
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
  • company_id
  • name
  • description
  • sip_header_parser_ids
  • sip_header_parsers_count

  • 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

GET /sip_header_parser_groups/new

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/sip_header_parser_groups/new

Build SIP Header Parsing with defaults.

Returns a blank SIP Header Parsing group populated with default attribute values, without saving it.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String

POST /sip_header_parser_groups

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/sip_header_parser_groups

Create SIP Header Parsing.

Creates a SIP Header Parsing group. Attach it to offers and add individual header parsers to it afterward to start extracting values from inbound SIP headers on calls.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String

GET /sip_header_parser_groups/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/sip_header_parser_groups/:id

Get SIP Header Parsing by id.

Fetches a single SIP Header Parsing group by id.

PUT /sip_header_parser_groups/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/sip_header_parser_groups/:id

Update SIP Header Parsing by id.

Updates a SIP Header Parsing group's name or description.

Params

Param name Description
name
Optional Blank value allowed

Name

  • Must be a String
description
Optional Blank value allowed

Description

  • Must be a String

DELETE /sip_header_parser_groups/:id

Authorization Required
https://[your-subdomain].trackdrive.com/api/v1/sip_header_parser_groups/:id

Destroy SIP Header Parsing by id.

Soft deletes a SIP Header Parsing group by id, excluding it from future lookups without permanently removing the record. Offers that referenced it stop applying that header parsing, and the individual header parsers that belonged to the group are not deleted along with it.