POST /api/v2/numbers/assign
Assigns a number to a target. The number will automatically be taken from the company's reserved pool if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Target includes user, department, office, room, callcenter, callrouter, staffgroup, channel and coachinggroup.
Added on November 18, 2020 for API v2.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
number |
String | No |
A phone number to assign. (e164-formatted) |
primary |
Boolean | No |
A boolean indicating whether this should become the target's primary phone number. Default value: true |
area_code |
String | No |
An area code in which to find an available phone number for assignment. |
target_id |
Integer | Yes |
The ID of the target to reassign this number to. |
target_type |
String | Yes |
The type of the target. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.