List all Phone Number Assignments

GET 
/registry/beta/campaigns/:id/numbers

Returns a list of the phone number assignments for a campaign. The numbers are returned sorted by creation date, with the most recent appearing first. The list is filterable by sending in any of the following parameters.

Permissions

The API token must include the following scopes: Messaging.

Request

Path Parameters

id uuidrequired

Unique ID of the campaign

Query Parameters

filter_state string

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

Responses

200

OK

application/json

Schema

Schema

links

object

self string

first string

next string

prev string
data object[]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "state": "pending",
      "campaign_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "phone_number": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "Jenny",
        "number": "+15558675309",
        "status_callback_url": "https//example.com/handle_callback"
      },
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z"
    }
  ]
}

Loading...