List short codes

GET

https://{your_space_name}.signalwire.com/api/relay/rest/short_codes

GET

/api/relay/rest/short_codes

curl https://{your_space_name}.signalwire.com/api/relay/rest/short_codes \
     -u "<project_id>:<api_token>"

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "My Short Code",
      "number": "12345",
      "capabilities": [
        "sms"
      ],
      "number_type": "shortcode",
      "code_type": "vanity",
      "country_code": "US",
      "created_at": "2023-01-15T10:30:00Z",
      "updated_at": "2023-01-15T10:30:00Z",
      "next_billed_at": "2024-01-15T10:30:00Z",
      "lease_duration": "12 months",
      "message_handler": "relay_context",
      "message_request_url": "https://example.com/message",
      "message_request_method": "GET",
      "message_fallback_url": "https://example.com/fallback",
      "message_fallback_method": "GET",
      "message_laml_application_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "message_relay_context": "my-context"
    }
  ]
}

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.

Lists the messaging Short Codes connected to your SignalWire project. These leased codes can send and receive high-volume messages through their configured handlers. Standard long-code phone numbers are available through [List phone numbers](/docs/apis/rest/phone-numbers/list-phone-numbers). Results are sorted by creation date, most recent first. #### 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](/docs/platform/your-signalwire-api-space).

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)

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) ```

Query parameters

filter_namestringOptional

Filter by name. Returns all short codes containing this value as a substring.

filter_numberstringOptional

Filter by number. Returns all short codes containing this value as a substring.

page_numberintegerOptionalDefaults to 0

The page number to retrieve.

page_sizeintegerOptional1-1000Defaults to 50

The number of results per page.

page_tokenstringOptional

Token for cursor-based pagination.

Response

The request has succeeded.

linksobject

Pagination links.

datalist of objects

List of short codes.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error