Campaign Registry: Phone Number Assignments
List phone number assignments
Returns a list of phone numbers assigned to a campaign.
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
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"
}
}
]
}