Retrieve a Phone Number Assignment Order

View as Markdown

Retrieves the details of an order.

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.

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

Response

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

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