Create phone number assignment order

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.

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

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)