Campaign Registry: Phone Number Assignments

List phone number assignments

Lists the project phone numbers bound to one US 10-digit long code (10DLC) campaign. These assignments determine which numbers may send traffic for the registered use case. Use List phone number assignment orders to monitor batch requests that create the bindings.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Messaging and Numbers.

Learn more about API scopes.

get/api/relay/rest/registry/beta/campaigns/{id}/numbers

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/relay/rest/registry/beta/campaigns/{id}/numbers
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the campaign.

Query parameters

filter_statestring

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.

Example response

{
  "data": [
    {
      "state": "pending",
      "phone_number": {
        "name": "Jenny",
        "number": "+15558675309",
        "status_callback_url": "https://example.com/handle_callback"
      }
    }
  ]
}

Changes

No operation changes found yet. Some revisions have not been checked.