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
        • POSTCreate phone number assignment order
        • DELDelete phone number assignment
        • GETGet phone number assignment order
        • GETList phone number assignment orders
        • GETList phone number assignments
  • Phone Number Management
  • Platform
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
MessagingCampaign RegistryPhone Number Assignments

List phone number assignments

|View as Markdown|Open in Claude|
GET
https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/campaigns/:id/numbers
GET
/api/relay/rest/registry/beta/campaigns/:id/numbers
$curl https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/campaigns/id/numbers \
>     -u "<project_id>:<api_token>"
1{
2  "links": {
3    "self": "string",
4    "first": "string",
5    "next": "string",
6    "prev": "string"
7  },
8  "data": [
9    {
10      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
11      "state": "pending",
12      "campaign_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
13      "phone_number": {
14        "id": "string",
15        "name": "Jenny",
16        "number": "+15558675309",
17        "status_callback_url": "https://example.com/handle_callback"
18      },
19      "created_at": "2024-01-15T09:30:00Z",
20      "updated_at": "2024-01-15T09:30:00Z"
21    }
22  ]
23}

Returns a list of phone numbers assigned to a campaign.

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

10DLC status callback

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 campaign.

Query parameters

filter_statestringOptional
The state of the assignments in the registration process, such as pending or complete. Will return all assignments with this value.

Response

The request has succeeded.
linksobject
Pagination links.
datalist of objects
List of assigned numbers.

Errors

401
Unauthorized Error
404
Not Found 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)