Short Code Object

The Short Code Object represents a short numerical code used for messaging or voice routing within the CarrierX platform. It contains identifying details about the short code itself, such as its value, assigned partner, and associated region or country.

In addition to core identifiers like short_code_sid and partner_sid, the object includes configuration fields such as callback URLs, string keys, and attribute data that can be updated as needed. Each short code may also be linked to a specific DID group or Location Routing Number (LRN), depending on its setup and routing behavior.

tip

Contact technical support at support@carrierx.com to create a short code.

Short Code 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 update	object	The attributes of the short code.
callback_url update	string	The callback URL.
country_code read only	string	The country of the short code.
did_group_sid update	string	The DID group secure ID.
locality read only	string	The region of the short code.
lrn_sid read only	string	The secure ID of the Location Routing Number assigned to this short code.
name update	string	The short code name.
partner_sid read only	string	The secure ID of the partner associated with the short code.
short_code read only	string	The short code value.
short_code_sid read only	string	The short code secure ID.
state read only	string	The state of the short code.
string_key_1 update	string	A user-defined string key.
string_key_2 update	string	A user-defined string key.

Sample Short Code Object

{
    "attributes": {},
    "callback_url": null,
    "country_code": "USA",
    "did_group_sid": "9cf3c0aa-3f80-43f7-b8c2-8f88251ff562",
    "locality": null,
    "lrn_sid": null,
    "name": "test",
    "partner_sid": "b9ba2c8b-2368-4a0b-9ba0-866ff2618417",
    "short_code": "26399",
    "short_code_sid": "531f65b7-dff7-42b4-b638-597f91da9ccc",
    "state": "IL",
    "string_key_1": null,
    "string_key_2": null
}