About
Purchase a Number Block using the following request.
At least one of the parameters AccountSid or PropertySid must be provided.
Resource URI
POST
/v2/Properties/{PropertySid}/NumberBlocks
Request
URI Parameters
| Parameter |
Type |
Description |
| numberBlockSid |
string |
The secure identifier of the Number Block to purchase. Required. |
Required Parameters
| Parameter |
Type |
Description |
| AccountSid |
string |
The secure identifier of the Account. At least one of AccountSid or PropertySid is required. |
| PropertySid |
string |
The secure identifier of the Property. At least one of AccountSid or PropertySid is required. |
| AnswerPoint |
string |
The answer point for the Number Block. Required. |
Optional Parameters
| Parameter |
Type |
Description |
| CallRecordingEnabled |
boolean |
Enable call recording for this Number Block. |
| CallWhisperEnabled |
boolean |
Enable call whisper functionality. |
| CallWhisperPath |
string |
Path for call whisper audio file. |
| Campaign |
string |
Campaign identifier for tracking purposes. |
| Content |
string |
Content identifier for tracking purposes. |
| Medium |
string |
Medium identifier for tracking purposes. |
| Source |
string |
Source identifier for tracking purposes. |
| Description |
string |
Description of the Number Block purchase. |
| GroupName |
string |
Name of the group for this Number Block. |
| GroupType |
short |
Type of group. Valid values: 0, 1. |
| Preamble |
short |
Preamble setting. Valid values: 0, 1, 2. |
| RoutingAction |
short |
Routing action setting. Valid values: 0, 1, 2, 3. |
| ProgrammableVoiceUrl |
string |
URL for programmable voice application. |
| MasterMode |
short |
Master mode setting. |
| Diaplan |
string |
Dial plan configuration. |
| CallWrapUpEnabled |
boolean |
Enable call wrap-up functionality. |
| Active |
boolean |
Set the Number Block as active after purchase. |
| EnableRules |
boolean |
Enable routing rules for this Number Block. |
| PortInProgress |
boolean |
Indicates if porting is in progress. |
| Ported |
boolean |
Indicates if the number has been ported. |
Response
200 – OK
A successful request returns a confirmation response.
Response Parameters
| Parameter |
Type |
Description |
| ResponseStatus |
object |
Response status information. |
| ResponseStatus.Message |
string |
Response message. Returns "OK" on success. |
Example Response
{
"ResponseStatus": {
"Message": "OK"
}
}
400 – Error
For error codes and messages, please refer to the
REST API Error Codes page.