For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
      • GETGet short code
      • GETList short codes
      • PUTUpdate short code
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
MessagingShort Codes

Get short code

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/short_codes/:id
GET
/api/relay/rest/short_codes/:id
$curl https://{your_space_name}.signalwire.com/api/relay/rest/short_codes/id \
>     -u "<project_id>:<api_token>"
1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "name": "My Short Code",
4  "number": "12345",
5  "capabilities": [
6    "sms"
7  ],
8  "number_type": "shortcode",
9  "code_type": "vanity",
10  "country_code": "US",
11  "created_at": "2023-01-15T10:30:00Z",
12  "updated_at": "2023-01-15T10:30:00Z",
13  "next_billed_at": "2024-01-15T10:30:00Z",
14  "lease_duration": "12 months",
15  "message_handler": "relay_context",
16  "message_request_url": "https://example.com/message",
17  "message_request_method": "GET",
18  "message_fallback_url": "https://example.com/fallback",
19  "message_fallback_method": "GET",
20  "message_laml_application_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
21  "message_relay_context": "my-context"
22}

Retrieves the details of a short code.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

Was this page helpful?
Previous

List short codes

Next
Built with

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the short code.

Response

The request has succeeded.
idstringformat: "uuid"
The unique identifier of the short code.
namestring or null
The name given to the short code.
numberstring
The short code number.
capabilitieslist of enums
The messaging capabilities of the short code.
Allowed values:
number_typeenum

The type of number (always ‘shortcode’).

Allowed values:
code_typeenum
The type of short code.
Allowed values:
country_codestring

The ISO 3166-1 alpha-2 country code.

created_atstring
The date and time when the short code was created.
updated_atstring
The date and time when the short code was last updated.
next_billed_atstring or null
The date and time when the short code will next be billed.
lease_durationstring or null

The lease duration of the short code (e.g., ‘12 months’).

message_handlerenum or null
The message handler type for incoming messages.
Allowed values:
message_request_urlstring or null

The URL to send message requests to when using laml_webhooks handler.

message_request_methodenum or null
The HTTP method to use for message requests.
Allowed values:
message_fallback_urlstring or null
The fallback URL for message requests.
message_fallback_methodenum or null
The HTTP method to use for fallback requests.
Allowed values:
message_laml_application_idstring or nullformat: "uuid"

The ID of the LāML application to handle messages when using laml_application handler.

message_relay_contextstring or null

The Relay context to use when using relay_context handler.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)