Prefix Object

The Prefix Object defines routing prefixes that determine how inbound or outbound calls are directed within the network. Each prefix specifies routing logic through its associated trunk groups, transformations, and optional attributes, allowing precise control over how call traffic is processed.

This object also includes partner associations, callback settings, and user-defined keys for advanced routing use cases. Together, these properties form the foundation for prefix-based routing configuration, enabling flexible call handling and optimized network management.

tip

Refer to How It Works: Prefix Routing to learn more about what prefixes are, what they are used for, and how you can work with them.

Prefix Object Attributes

The fields listed in the table below will be returned in a JSON object when a successful request has been made.

Attribute	Data Type	Description
attributes createupdate	object	The prefix attributes.
callback_url createupdate	string	The callback URL.
lrn_sid read only	string	The secure ID of the Location Routing Number assigned to this prefix.
name createupdate	string	The prefix name. The default value is N/A.
partner_sid createupdate	string	The secure ID of the partner associated with the prefix.
prefix createupdate	string	The prefix that will enable the routing logic.
prefix_sid read only	string	The prefix secure ID.
source_trunk_group_sid createupdate	string	The prefix source trunk group secure ID.
string_key_1 createupdate	string	A user-defined string key.
string_key_2 createupdate	string	A user-defined string key.
transformations createupdate	array	The prefix transformations.
trunk_group_sid createupdate	string	The trunk group secure ID.

Sample Prefix Object

{
    "attributes": {},
    "callback_url": null,
    "lrn_sid": null,
    "name": "N/A",
    "partner_sid": "e00430c3-a7d0-4666-ab5c-f7202448382f",
    "prefix": "51625",
    "prefix_sid": "cc367acb-94c8-418f-b247-85dce5806ef4",
    "source_trunk_group_sid": null,
    "string_key_1": null,
    "string_key_2": null,
    "transformations": [],
    "trunk_group_sid": null
}