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

Create phone number assignment order

|View as Markdown|Open in Claude|
POST
https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/campaigns/:id/orders
POST
/api/relay/rest/registry/beta/campaigns/:id/orders
$curl -X POST https://{your_space_name}.signalwire.com/api/relay/rest/registry/beta/campaigns/id/orders \
>     -H "Content-Type: application/json" \
>     -u "<project_id>:<api_token>" \
>     -d '{}'
1{
2  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3  "state": "pending",
4  "processed_at": "2024-01-15T09:30:00Z",
5  "created_at": "2024-01-15T09:30:00Z",
6  "updated_at": "2024-01-15T09:30:00Z",
7  "status_callback_url": "https://example.com/handle_callback"
8}

Creates a new order for 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

Delete phone number assignment

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.

Request

This endpoint expects an object.
phone_numberslist of stringsOptional
A list of phone numbers in E164 format.
status_callback_urlstringOptional

Optional: Specify a URL to receive webhook notifications when your number assignment order and the number assignments that belong to it change state. See the 10DLC status callback docs for the webhook payload.

Response

The request has succeeded.
idstringformat: "uuid"
The unique identifier of the order.
statestring
The current state of the order.
processed_atdatetime
Timestamp when the order was processed.
created_atdatetime
Timestamp when the order was created.
updated_atdatetime
Timestamp when the order was last updated.
status_callback_urlstring

Optional: Specify a URL to receive webhook notifications when your number assignment order and the number assignments that belong to it change state. See the 10DLC status callback docs for the webhook payload.

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)