API Documentation

Account Username

Account Plain Password

Account Username

Account Plain Password

• npa: 706 (string)

• nxx: 995 (string)

• xxxx: 6092 (string)

• state: GA (string)

• ratecenter: ATHENS (string)

• loc: 1fccd99f2f65707c290bbe4fa2ad4ecbe31fd4f69ca5ce6160bc4534c4cb292dca08c093c3ca8b (string) (required)

• locData: 2d80c0952d7869653547f0 (string) - only required if returned in search result

• fwd_trunk_grpid: 55555 (number, optional) - OD Trunk group number

• fwd_preconfigured: true(boolean, optional) - Use forwarding data of account preconfigured settings

• npa: 706 (string)

• nxx: 995 (string)

• xxxx: 6092 (string)

• loc: 1fccd99f2f65707c290bbe4fa2ad4ecbe31fd4f69ca5ce6160bc4534c4cb292dca08c093c3ca8b (string) (required)

• locData: 2d80c0952d7869653547f0 (string) - only required if returned in search result

• fwd_trunk_grpid: 55555 (number, optional) - OD Trunk group number

• fwd_preconfigured: true(boolean, optional) - Use forwarding data of account preconfigured settings

• id: “fc70c45e-5d6c-4ff6-a744-881ed2fc8095” (string)

• name: “Aracaju” (string, required)

• prefix: “8182” (string, required)

• loc: “1fccda912c743a2a724be804e6f95ed7f14191b9d2e2cf262efa0122cbc53b719f4c9581c9cabe4dc5872028f508” (string)

• locData: “2d80c0952d7869653547f0” (string) - only required if returned in search result

• country: “BR” (string, required) - Country code

• quantity: 1 (number)

• fwd_trunk_grpid: 55555 (number, optional) - OD Trunk group number

• fwd_preconfigured: true(boolean, optional) - Use forwarding data of account preconfigured settings

Possible types are state, lata, npa & rate_center

Only applicable to OD Numbers, Look for ext_tgid parameter found in List trunk group API

this csv file will hold multiple search criteria as per the order type to fullfil this order.

0 - false(default), 1 - true

0 - false(default), 1 - true - Please be advised that depending on your contract offnet numbers may have different charges then onnet. Please confirm that you want to proceed with searching both onnet and offnet for your request.

All applicable DIDs will have this Tag attached against them

In case of US Numbers, don’t include the Country Code “1”

0 - disable, 1 - Inbound Only, 2 - In and Outbound, 3 - Fax ATA

Required If service is 3 - Fax ATA

Number to be updated

Order, Simultaneous, Random

i_product value, auto selection of product enabled in case of wholesale customer.

0 - Reject, 1 - Ring Only, 2 - Forward Only, 3 - Ring Then Forward, 4 - Voicemail Only, 5 - Ring Then Voicemail, 6 - Forward, Voicemail, 7 - Ring, Forward, Voicemail

“” - None, “preconfigured” - Preconfigured Setting, “simple” - Forward to Local Number, “ip” - Forward to IP address/PBX, “trunk” - Register Device/Trunk

if method1 is simple

if method1 is not preconfigured, value in seconds

11, 10

if method1 is trunk

if method1 is ip, forward to IP address

if method2 is simple

if method2 is not preconfigured, value in seconds

if method2 is ip, forward to IP address

if method3 is simple

if method3 is not preconfigured, value in seconds

if method3 is ip, forward to IP address

Only applicable to OD Numbers, Look for ext_tgid parameter found in List trunk group API

RR - RoundRobin(default), TD - TopDown

e164(default), 11, 10

paid(default), rpid

• ip_address: “10.50.250.10” (string, required) - valid ip address, with or without port number.

Account Id of the customer.

Default - N, Direct - 0, Optimal - 1, On Nat - 2, Always - 3

Account Id of the customer.

No, Yes

for assigning port to internal customer

• cust_acc_name: “test 1232” (string, required)

• cust_authorized_name: “test” (string, required)

• cust_acc_type: “RES”, (string, required) - Value : ‘RES’, ‘BIZ’

• cust_acc_number: 1234566 (string, required)

• cust_acc_pin: 123 (string, optional)

• activation_type: “Auto” (string, required), Default : ‘Auto’, Other: ‘Manual’, ‘Scheduled’

• address_direction_prefix: “test” (string, optional)

• address_direction_suffix: “test” (string, optional)

• address_street_name_suffix: “test” (string, optional)

• address_street_name: “test” (string, required)

• address_number: “test” (string, required)

• address_loc_value: “test” (string, optional)

• address_loc_designator: “test” (string, required)

• city: “test” (string, required)

• postal_code: “1234e” (string, required)

• desired_foc_date: “2022-05-02T00:00:00Z” (date, required) - UTC date format

• btn: 64221 (string, required)

• state: “MI”, (string, required)

• activation_date: “2022-05-02T12:00:00-04:00” (date, required) - EST date format

• email_updates: "test.user@example.com" (string, optional)

• fwd_preconfigured: false (boolean, optional)

• fwd_trunk_grpid: 123 (number, optional)

• fwd_sip_type: ‘NA’ (string, required)- DEFAULT - NA, Other - ‘11’, ‘10’, ‘E164’, ‘INTL’, ‘OPEN’

• fwd_order: ‘NA’ (string, required)- Default - NA , Other - ‘ALS’, ‘SIML’, ‘RND’

• fwd_answering_mode: ‘NA’ (string, required) - Default - NA , Other - ‘REJ’, ‘RO’, ‘FO’, ‘RTF’, ‘VO’, ‘RTV’, ‘FV’, ‘RFV’

• fwd_device_password: ‘23211’ (string, optional)

• notes: ‘testing’ (string, optional)

• tags: “t1 , t2” (string, optional)

value : “In_Progress”, “Completed”, “Cancelled”, “Queue”, “Validation_Pending”, “Processing”, “Error”

value : ‘LCL’, ‘TF’, ‘INTL’

required only when update sub order details

• cust_acc_name: “test 1232” (string, required)

• cust_authorized_name: “test” (string, required)

• cust_acc_type: “RES”, (string, required) - Value : ‘RES’, ‘BIZ’

• cust_acc_number: 1234566 (string, required)

• cust_acc_pin: 123 (string, optional)

• activation_type: “Auto” (string, optional) - Default : ‘Auto’, Other: ‘Manual’, ‘Scheduled’

• address_direction_prefix: “test” (string, optional)

• address_direction_suffix: “test” (string, optional)

• address_street_name_suffix: “test” (string, optional)

• address_street_name: “test” (string, required)

• address_number: “test” (string, required)

• address_loc_value: “test” (string, optional)

• address_loc_designator: “test” (string, required)

• postal_code: “1234e” (string, required)

• city: “test” (string, required)

• desired_foc_date: “2022-05-02T00:00:00Z” (date, required) - UTC date format

• btn: 64221 (string, required)

• state: “MI”, (string, required)

• activation_date: “2022-05-02T12:00:00-04:00” (date, required) - EST date format

• email_updates : "test.user@example.com" (string, optional)

• notes: ‘testing’ (string, optional)

• tags: “t1, t2” (string, optional)

required only when cancel port

required only when cancel sub order

• forwarding_type_id: 2 (number)

• timeout: 30 (number)

• value: “12356789133” (string)

• method: “NUM” (string)

• sequence: 1 (number)

Required only when delete master port request

Required only when delete sub order or DID number

Required only when delete DID number

Required only when need to activate master port

Required only when activate sub order

Required only when need to upload docs at master level

Required only when need to upload docs at suborder level

Value : ‘loa’, ‘bill’ or ‘csr’

Required only when need to upload docs at master level

Required only when need to upload docs at suborder level

Value : ‘loa’, ‘bill’ or ‘csr’

Required only when need export sub order list

Required only when need to export DID number list

value : “In_Progress”, “Completed”, “Cancelled”, “Queue”, “Validation_Pending”, “Processing”, “Error”

value : ‘LCL’, ‘TF’, ‘INTL’

Value : ‘Auto’, ‘Manual’, ‘Scheduled’

01-21T12:00:00-05:00’ - EST Date format

value : “In_Progress”, “Completed”, “Cancelled”, “Queue”, “Validation_Pending”, “Processing”, “Error”

value : ‘LCL’, ‘TF’, ‘INTL’