Enable E911 on a number
PUT/origination/numbers/:id/e911_settings
Enables E911 on a number. The ID supplied can be the telephone number (e.g. +12124567890) or object ID.
Request
Path Parameters
Telephone number (ex: +12124567890) or object ID of number to update
- application/json
Body
required
Number E911 object
Default value: true
Responses
200: Number E911 enable
- application/json
- Schema
- Example (from schema)
Schema
Default value: true
DEPRECATED - Use enable_tech_prefix on API requests
the number that this number should be forwarded to; when this is set, forwarding_type must also be set
sets when this number should have its calls forwarded; valid values are 'always' and 'on-failure'
Default value: 1
Purchase Pending = 1, Purchase Failed = 2, Port Pending = 3, Active = 4, Deleted = 5, Port Failed = 6, Emergency Only = 7, Ported Out = 8, Port Out Pending = 9
reason(s) why the last attempt to purchase this number failed
Possible values: [disabled
, active
, provisioning
, deprovisioning
]
Default value: disabled
use this property to reference an Address record if required for a number record
Possible values: [pay-per-minute
, channel
]
Default value: pay-per-minute
setting for whether a number is billed per minute or uses your concurrent channels
Default value: true
When RTP Auto-Adjust is enabled, the destination RTP address port will be automatically changed to match the source of the incoming RTP packets.
Enable CNAM listings for this number. Requires cnam_listing_details to also be filled in.
The CNAM listing details for this number. Must be alphanumeric characters or spaces with a maximum length of 15. Requires cnam_listing_enabled to also be set.
External PINs are used to ensure that phone numbers on your account cannot be ported to another carrier without your consent. This has an account level default but may also be specified per phone number. External PINs must be 4 numeric digits ('3456').
DEPRECATION WARNING! Please use number_val_e164 or contact [email protected] if you depend on this key.
When enabled, any inbound call to this number will be recorded.
Possible values: [wav
, mp3
]
Default value: wav
The audio file format for calls being recorded.
Possible values: [single
, dual
]
Default value: single
When using 'dual' channels, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B.
The ID of the Billing Group to which the number is assigned. Defaults to null (for no group assigned).
{
"id": "string",
"connection_id": "string",
"number_val_e164": "string",
"ignore_tech_prefix": true,
"enable_tech_prefix": false,
"translated_number": "string",
"forwards_to": "string",
"forwarding_type": "string",
"tag_list": [
"string"
],
"status": 1,
"purchase_failure_reason": "string",
"e911_enabled": false,
"e911_address_id": "string",
"emergency_status": "disabled",
"address_id": "string",
"usage_payment_method": "pay-per-minute",
"enable_rtp_auto_adjust": true,
"cnam_listing_enabled": false,
"cnam_listing_details": "string",
"external_pin": "string",
"t38_fax_gateway_enabled": false,
"accept_any_rtp_packets_enabled": false,
"number_val": "string",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": "wav",
"inbound_call_recording_channels": "single",
"billing_group_id": "string"
}
202: Number Emergency Requested
- application/json
- Schema
- Example (from schema)
Schema
Default value: true
DEPRECATED - Use enable_tech_prefix on API requests
the number that this number should be forwarded to; when this is set, forwarding_type must also be set
sets when this number should have its calls forwarded; valid values are 'always' and 'on-failure'
Default value: 1
Purchase Pending = 1, Purchase Failed = 2, Port Pending = 3, Active = 4, Deleted = 5, Port Failed = 6, Emergency Only = 7, Ported Out = 8, Port Out Pending = 9
reason(s) why the last attempt to purchase this number failed
Possible values: [disabled
, active
, provisioning
, deprovisioning
]
Default value: disabled
use this property to reference an Address record if required for a number record
Possible values: [pay-per-minute
, channel
]
Default value: pay-per-minute
setting for whether a number is billed per minute or uses your concurrent channels
Default value: true
When RTP Auto-Adjust is enabled, the destination RTP address port will be automatically changed to match the source of the incoming RTP packets.
Enable CNAM listings for this number. Requires cnam_listing_details to also be filled in.
The CNAM listing details for this number. Must be alphanumeric characters or spaces with a maximum length of 15. Requires cnam_listing_enabled to also be set.
External PINs are used to ensure that phone numbers on your account cannot be ported to another carrier without your consent. This has an account level default but may also be specified per phone number. External PINs must be 4 numeric digits ('3456').
DEPRECATION WARNING! Please use number_val_e164 or contact [email protected] if you depend on this key.
When enabled, any inbound call to this number will be recorded.
Possible values: [wav
, mp3
]
Default value: wav
The audio file format for calls being recorded.
Possible values: [single
, dual
]
Default value: single
When using 'dual' channels, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B.
The ID of the Billing Group to which the number is assigned. Defaults to null (for no group assigned).
{
"id": "string",
"connection_id": "string",
"number_val_e164": "string",
"ignore_tech_prefix": true,
"enable_tech_prefix": false,
"translated_number": "string",
"forwards_to": "string",
"forwarding_type": "string",
"tag_list": [
"string"
],
"status": 1,
"purchase_failure_reason": "string",
"e911_enabled": false,
"e911_address_id": "string",
"emergency_status": "disabled",
"address_id": "string",
"usage_payment_method": "pay-per-minute",
"enable_rtp_auto_adjust": true,
"cnam_listing_enabled": false,
"cnam_listing_details": "string",
"external_pin": "string",
"t38_fax_gateway_enabled": false,
"accept_any_rtp_packets_enabled": false,
"number_val": "string",
"inbound_call_recording_enabled": false,
"inbound_call_recording_format": "wav",
"inbound_call_recording_channels": "single",
"billing_group_id": "string"
}
400: Bad request
401: Unauthorized