About
Configure a Number Block using the following request.
At least one of the parameters AccountSid or PropertySid must be provided.
The NumberBlockSid must always be provided in the URL.
Resource URI
POST
/v2/numberblocks/{numberBlockSid}
Request
URI Parameters
| Parameter |
Type |
Description |
| numberBlockSid |
string |
The secure identifier of the Number Block to configure. Required. |
Required Parameters (always)
| Parameter |
Type |
Description |
| AccountSid |
string |
The secure identifier of the Account. At least one of AccountSid or PropertySid must be provided. System validates that this account exists and that the caller has sufficient permissions. |
| PropertySid |
string |
The secure identifier of the Property. At least one of PropertySid or AccountSid must be provided. System validates that this property exists and the caller has sufficient permissions. |
Conditionally Required Parameters
These parameters become required depending on the chosen RoutingMethod.
| RoutingMethod value |
Required Parameter(s) |
Notes |
endpoint |
EndpointNumber |
Must be a valid Australian answering point. Additionally checked against allowed account prefixes. |
flow |
Flow, EndpointNumber (for prefix validation) |
The supplied flow identifier is used for routing. EndpointNumber must pass format & prefix checks. |
application |
Application |
Application identifier is required when routing to an application. |
Optional Parameters
| Parameter |
Type |
Description |
| RoutingMethod |
string |
Routing method for this Number Block. Valid values: endpoint, flow, application. Invalid values will cause validation errors. |
| Recording |
string |
Indicates whether recording is enabled. Accepts only predefined valid values (e.g. enabled, disabled), validated by the system. Invalid values will cause validation errors. |
| Source |
string |
Source identifier for tracking and analytics. |
| Medium |
string |
Medium identifier for tracking and analytics. |
| Campaign |
string |
Campaign identifier for tracking and analytics. |
| Content |
string |
Content identifier for tracking and analytics. |
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.