API documentation

GET /call_router_answer_groups

Authorization Required

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

List Answer Group records.

Lists Call Flow Answer Groups, the sets of key-press or digit-collection options used in a call router's IVR menus.

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 context_menu_name company_id sortable_order name description call_router_answers_count request_answer_with_pound request_answer_without_pound answer_length_min answer_length_max answer_length_timeout answer_assign_to_token_key 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/call_router_answer_groups/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "call_router_answer_groups": [
    {
      "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "type": "CallRouterAnswerGroup",
      "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": "/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "routes_edit_path": "/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
      "external_record_id": null,
      "context_menu_name": "Existing Customer? - 2 Answers",
      "company_id": 10001,
      "sortable_order": null,
      "name": "Existing Customer?",
      "description": "Ask whether the caller already has an account with us.",
      "call_router_answers_count": 2,
      "request_answer_with_pound": null,
      "request_answer_without_pound": false,
      "answer_length_min": null,
      "answer_length_max": null,
      "answer_length_timeout": 30,
      "answer_assign_to_token_key": null
    },
    {
      "id": "a09e6bca-255b-4217-af73-cb9601c80217",
      "type": "CallRouterAnswerGroup",
      "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": "/call_router_answer_groups/a09e6bca-255b-4217-af73-cb9601c80217",
      "routes_edit_path": "/call_router_answer_groups/a09e6bca-255b-4217-af73-cb9601c80217/edit",
      "external_record_id": null,
      "context_menu_name": "Interested In Refinancing? - 2 Answers",
      "company_id": 10001,
      "sortable_order": null,
      "name": "Interested In Refinancing?",
      "description": "Ask the caller whether they want to refinance before routing.",
      "call_router_answers_count": 2,
      "request_answer_with_pound": null,
      "request_answer_without_pound": false,
      "answer_length_min": null,
      "answer_length_max": null,
      "answer_length_timeout": 30,
      "answer_assign_to_token_key": null
    }
  ],
  "metadata": {
    "root": "call_router_answer_groups",
    "page": 1,
    "total_pages": 1,
    "per_page": 2,
    "total_count": 2,
    "next_cursor": 10002
  }
}

GET /call_router_answer_groups/new

Authorization Required

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

Build Answer Group with defaults.

Returns a blank Answer Group populated with default attribute values, without saving it.

Params

Param name	Description
name Optional Blank value allowed	Name of the Answer Group. Must be a String
description Optional Blank value allowed	Optional description for the Answer Group. Must be a String
call_router_answers_count Optional Blank value allowed	Number of single-key answers configured in this group. Must be a decimal number.
request_answer_with_pound Optional Blank value allowed	Collect a multi-digit response and require callers to press Must be a boolean value: 1, true, yes, on, 0, false, no, off
answer_length_min Optional Blank value allowed	Minimum number of digits expected when collecting a numeric response. Must be a decimal number.
answer_length_max Optional Blank value allowed	Maximum number of digits allowed when collecting a numeric response. Must be a decimal number.
answer_length_timeout Optional Blank value allowed	Seconds to wait for input before timing out when collecting a numeric response. Must be a decimal number.
answer_assign_to_token_key Optional Blank value allowed	The token key the caller’s entered digits are saved to when collecting a multi-digit response. Must be a String

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call_router_answer_group": {
    "id": null,
    "type": "CallRouterAnswerGroup",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/call_router_answer_groups/new",
    "routes_edit_path": "/call_router_answer_groups/new",
    "external_record_id": null,
    "context_menu_name": "0 Answers",
    "company_id": 10001,
    "sortable_order": null,
    "name": null,
    "description": null,
    "call_router_answers_count": null,
    "request_answer_with_pound": false,
    "request_answer_without_pound": true,
    "answer_length_min": 1,
    "answer_length_max": 12,
    "answer_length_timeout": 30,
    "answer_assign_to_token_key": null
  },
  "metadata": {
    "root": "call_router_answer_group"
  }
}

POST /call_router_answer_groups

Authorization Required

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

Create Answer Group.

Creates an Answer Group for collecting caller input in a call flow, either single-key answers or, with request_answer_with_pound enabled, a multi-digit response of between answer_length_min and answer_length_max digits terminated by #.

Params

Param name	Description
name Optional Blank value allowed	Name of the Answer Group. Must be a String
description Optional Blank value allowed	Optional description for the Answer Group. Must be a String
call_router_answers_count Optional Blank value allowed	Number of single-key answers configured in this group. Must be a decimal number.
request_answer_with_pound Optional Blank value allowed	Collect a multi-digit response and require callers to press Must be a boolean value: 1, true, yes, on, 0, false, no, off
answer_length_min Optional Blank value allowed	Minimum number of digits expected when collecting a numeric response. Must be a decimal number.
answer_length_max Optional Blank value allowed	Maximum number of digits allowed when collecting a numeric response. Must be a decimal number.
answer_length_timeout Optional Blank value allowed	Seconds to wait for input before timing out when collecting a numeric response. Must be a decimal number.
answer_assign_to_token_key Optional Blank value allowed	The token key the caller’s entered digits are saved to when collecting a multi-digit response. Must be a String

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/call_router_answer_groups/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Example Answer Group",
  "description": "Ask whether the caller wants a callback."
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "call_router_answer_group": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "CallRouterAnswerGroup",
    "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": "/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "context_menu_name": "Example Answer Group - 0 Answers",
    "company_id": 10001,
    "sortable_order": null,
    "name": "Example Answer Group",
    "description": "Ask whether the caller wants a callback.",
    "call_router_answers_count": null,
    "request_answer_with_pound": null,
    "request_answer_without_pound": false,
    "answer_length_min": null,
    "answer_length_max": null,
    "answer_length_timeout": 30,
    "answer_assign_to_token_key": null
  },
  "metadata": {
    "root": "call_router_answer_group"
  }
}

GET /call_router_answer_groups/:id

Authorization Required

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

Get Answer Group by id.

Fetches a single Answer Group by id.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call_router_answer_group": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "CallRouterAnswerGroup",
    "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": "/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "context_menu_name": "Existing Customer? - 2 Answers",
    "company_id": 10001,
    "sortable_order": null,
    "name": "Existing Customer?",
    "description": "Ask whether the caller already has an account with us.",
    "call_router_answers_count": 2,
    "request_answer_with_pound": null,
    "request_answer_without_pound": false,
    "answer_length_min": null,
    "answer_length_max": null,
    "answer_length_timeout": 30,
    "answer_assign_to_token_key": null
  },
  "metadata": {
    "root": "call_router_answer_group"
  }
}

PUT /call_router_answer_groups/:id

Authorization Required

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

Update Answer Group by id.

Updates an Answer Group's name, description, or digit-collection settings (minimum/maximum length, timeout, pound-terminated collection).

Params

Param name	Description
name Optional Blank value allowed	Name of the Answer Group. Must be a String
description Optional Blank value allowed	Optional description for the Answer Group. Must be a String
call_router_answers_count Optional Blank value allowed	Number of single-key answers configured in this group. Must be a decimal number.
request_answer_with_pound Optional Blank value allowed	Collect a multi-digit response and require callers to press Must be a boolean value: 1, true, yes, on, 0, false, no, off
answer_length_min Optional Blank value allowed	Minimum number of digits expected when collecting a numeric response. Must be a decimal number.
answer_length_max Optional Blank value allowed	Maximum number of digits allowed when collecting a numeric response. Must be a decimal number.
answer_length_timeout Optional Blank value allowed	Seconds to wait for input before timing out when collecting a numeric response. Must be a decimal number.
answer_assign_to_token_key Optional Blank value allowed	The token key the caller’s entered digits are saved to when collecting a multi-digit response. Must be a String

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Ask whether the caller wants a callback (updated)."
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call_router_answer_group": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "CallRouterAnswerGroup",
    "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": "/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "context_menu_name": "Example Answer Group - 0 Answers",
    "company_id": 10001,
    "sortable_order": null,
    "name": "Example Answer Group",
    "description": "Ask whether the caller wants a callback (updated).",
    "call_router_answers_count": null,
    "request_answer_with_pound": null,
    "request_answer_without_pound": false,
    "answer_length_min": null,
    "answer_length_max": null,
    "answer_length_timeout": 30,
    "answer_assign_to_token_key": null
  },
  "metadata": {
    "root": "call_router_answer_group"
  }
}

DELETE /call_router_answer_groups/:id

Authorization Required

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

Destroy Answer Group by id.

Deletes an Answer Group by id. Call routers that referenced it will need a replacement group.

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call_router_answer_group": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "CallRouterAnswerGroup",
    "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": "/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/call_router_answer_groups/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "context_menu_name": "Example Answer Group - 0 Answers",
    "company_id": 10001,
    "sortable_order": null,
    "name": "Example Answer Group",
    "description": "Ask whether the caller wants a callback.",
    "call_router_answers_count": null,
    "request_answer_with_pound": null,
    "request_answer_without_pound": false,
    "answer_length_min": null,
    "answer_length_max": null,
    "answer_length_timeout": 30,
    "answer_assign_to_token_key": null
  },
  "metadata": {
    "root": "call_router_answer_group"
  }
}

Params

Must be any combination of:

Params

Params

Params