Skip to main content

Retrieve a bulk number update request

GET 
/origination/bulk_number_update_requests/:id

Update multiple numbers at once with POST/origination/bulk_number_update_requests/.

Each number's status must be Active (4) or Port Pending (3).

Check the status of your bulk request and the error_messages property with GET/origination/bulk_number_update_requests/{id}. Note that only the properties you specified are returned in the GET.

New bulk requests are created in Pending status (1). They move to Complete status (2) after a period of time that varies with the size of the request. If for some reason they can't be processed within 15 minutes then they are moved to Expired status (3).

PLEASE NOTE: Any changes made to a number while a bulk request is pending can and will be overwritten when the bulk request is processed.

Additional note: All parameters are optional except for: ids_or_number_values. If you want to nullify a property then you should send an empty value for it. If you want to leave a property unmodified then you should leave its key out of the request.

Request ​

Path Parameters

    id stringrequired

    ID of the bulk update request

Responses ​

200: Bulk Number Update Request

Schema

    ids_or_number_vals string[]required

    Array of number ids and/or number values to update

    connection_id string
    forwards_to string
    forwarding_type string

    sets when this number should have its calls forwarded; valid values are 'always' and 'on-failure'

    e911_enabled boolean
    e911_address_id string
    address_id string

    references an Address record

    enable_tech_prefix boolean
    translated_number string
    usage_payment_method string

    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

    enable_rtp_auto_adjust boolean

    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.

    tag_list string[]
    t38_fax_gateway_enabled boolean
    cnam_listing_enabled boolean

    Enable CNAM listings for this number. Requires cnam_listing_details to also be filled in.

    cnam_listing_details string

    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.

    accept_any_rtp_packets_enabled boolean
    inbound_call_recording_enabled boolean

    When enabled, any inbound call to this number will be recorded.

    inbound_call_recording_format string

    Possible values: [wav, mp3]

    Default value: wav

    The audio file format for calls being recorded.

    inbound_call_recording_channels string

    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.

401: Unauthorized

404: Resource not found

422: Unprocessable entity. Can be caused by invalid values. Check message field in response for details.

Request samples

curl -L 'https://api.telnyx.com/origination/bulk_number_update_requests/:id' \
-H 'Accept: application/json'

Response samples

{
  "ids_or_number_vals": [
    "string"
  ],
  "connection_id": "string",
  "forwards_to": "string",
  "forwarding_type": "string",
  "e911_enabled": true,
  "e911_address_id": "string",
  "address_id": "string",
  "enable_tech_prefix": true,
  "translated_number": "string",
  "usage_payment_method": "pay-per-minute",
  "enable_rtp_auto_adjust": true,
  "tag_list": [
    "string"
  ],
  "t38_fax_gateway_enabled": false,
  "cnam_listing_enabled": false,
  "cnam_listing_details": "string",
  "accept_any_rtp_packets_enabled": false,
  "inbound_call_recording_enabled": false,
  "inbound_call_recording_format": "wav",
  "inbound_call_recording_channels": "single"
}