API documentation

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"
  }
}