Retrieve a Number Group

View as Markdown

Retrieves the details of a number group.

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 number group.

Response

The request has succeeded.
idstringformat: "uuid"
The unique identifier of the Number Group on SignalWire. This can be used to update or delete the group programmatically.
namestring
The name given to the number group. Helps to distinguish different groups within your project.
sticky_senderboolean
Whether the number group uses the same 'From' number for outbound requests to a number, or chooses a random one.
phone_number_countinteger
The number of phone numbers within the group.

Errors