{"swagger":"2.0","info":{"version":"v1","title":"_3NGNetworks_TC_WebAPI"},"host":"localhost:44397","basePath":"/api","tags":[{"name":"AccessToken","description":"Access Token related operations"},{"name":"Customer","description":"Customer related operations","externalDocs":{"description":"Find out more","url":"https://login.ringlogix.com/"}},{"name":"NetSapiens/PBXSetting","description":"NetSapiens/PBXSettings related operations","externalDocs":{"description":"Find out more about NetSapiens/PBXSettings","url":"http://api.netsapiens.com/ns-api/apidoc"}},{"name":"NetSapiens/DefaultPBXSetting","description":"NetSapiens/DefaultSetting related operations","externalDocs":{"description":"Find out more about NetSapiens/DefaultSetting","url":"http://api.netsapiens.com/ns-api/apidoc"}},{"name":"NetSapiens/User","description":"Manage PBX accounts"},{"name":"GetPlan","description":"Plan Details"},{"name":"SubscriptionDetails","description":"Subscription Details"}],"schemes":["http","https"],"paths":{"/AccessToken":{"get":{"tags":["AccessToken"],"summary":"Get AccessToken","operationId":"Customer_AccessToken","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"accesstoken","in":"body","required":true,"schema":{"$ref":"#/definitions/AccessTokenRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AccessToeknesponseModel"}}}}},"/Customer":{"get":{"tags":["Customer"],"summary":"Get Customer Details","operationId":"Customer_CustomerBillingDetail","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"iCustomer","in":"query","required":false,"type":"string"},{"name":"AccessToken","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/CustomerDeatilsResponseModel"}}}},"put":{"tags":["Customer"],"summary":"Update Customer info","operationId":"updateCustomer_CustomerDetail","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"customerinforeq","in":"body","required":true,"schema":{"$ref":"#/definitions/UpdateBillingInfoRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpdateResponseModel"}}}},"post":{"tags":["Customer"],"summary":"Create a New Customer","operationId":"createCustomer_CustomerDetail","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"customerreq","in":"body","required":true,"schema":{"$ref":"#/definitions/NewCustomerModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddCustomerResponseModel"}}}}},"/NetSapiensPBXSetting":{"post":{"tags":["NetSapiens/PBXSetting"],"summary":"Create a New NS PBX","operationId":"createNSPBX_User","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"NSPBXReq","in":"body","required":true,"schema":{"$ref":"#/definitions/NewNSPBXUserModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddNSPBXResponseModel"}}}},"get":{"tags":["NetSapiens/PBXSetting"],"summary":"Get NS PBX Settings Details","operationId":"User_NsPBXSettingDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"resellerId","in":"query","required":true,"type":"string"},{"name":"i_customer","in":"query","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSPBXSettingResponseModel"}}}},"put":{"tags":["NetSapiens/PBXSetting"],"summary":"Update NS PBX setting","operationId":"UpdateNSPBX_User","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"NSPBXReq","in":"body","required":true,"schema":{"$ref":"#/definitions/UpdateNSPBXUserModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpdateNSPBXResponseModel"}}}}},"/NetSapiensDefaulPBXtSetting":{"get":{"tags":["NetSapiens/DefaultPBXSetting"],"summary":"Get NS Default Settings Details","operationId":"Ns_DefaultSettingDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"resellerId","in":"query","required":false,"type":"string"},{"name":"i_customer","in":"query","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSDefaultSettingResponseModel"}}}},"put":{"tags":["NetSapiens/DefaultPBXSetting"],"summary":"Update NS Default setting","operationId":"Ns_UpdateDefaultSetting","consumes":["application/json","text/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"NSPBXReq","in":"body","required":true,"schema":{"$ref":"#/definitions/UpdateNSPBXDefaultSettingModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpdateNSPBXResponseModel"}}}}},"/NetSapiensUser":{"post":{"tags":["NetSapiens/User"],"summary":"Add NetSapiens User","operationId":"User_AddNetSapiensUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"NSPBXReq","in":"body","required":true,"schema":{"$ref":"#/definitions/NewNSUserModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/AddNSUseresponseModel"}}}},"get":{"tags":["NetSapiens/User"],"summary":"Get NetSapiens User Details","operationId":"User_NsUserDetails","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"i_customer","in":"query","required":true,"type":"string"},{"name":"sort","in":"query","required":false,"type":"string"},{"name":"page","in":"query","required":false,"type":"string","format":"int32"},{"name":"PageSize","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/NSPUserResponseModel"}}}},"put":{"tags":["NetSapiens/User"],"summary":"Update NetSapiens User","operationId":"User_UpdateNetSapiensUser","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"NSPBXReq","in":"body","required":true,"schema":{"$ref":"#/definitions/UpdateNSUserModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UpdateNSUserResponseModel"}}}}},"/GetPlan":{"get":{"tags":["GetPlan"],"summary":"Get Plan Details","operationId":"Customer_GetPlan","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"LoginUserType","in":"query","required":true,"type":"string"},{"name":"ResellerId","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/PlanResponseModel"}}}}},"/SubscriptionDetails":{"get":{"tags":["GetSubscription"],"summary":"Get Subscription Details","operationId":"Customer_Subscription","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"AccessToken","in":"query","required":true,"type":"string"},{"name":"LoginUserType","in":"query","required":true,"type":"string"},{"name":"ResellerId","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SubsceiptionResponseModel"}}}}}},"definitions":{"PlanResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"},"Data":{"type":"object"}},"example":{"Status":true,"Message":"Record Found Successfully","Data":[{"PlanId":"25818","PlanName":" 10K US Shared Bundle"},{"PlanId":"23222","PlanName":" PBX Unlimited Calling US & Canada"}]}},"SubsceiptionResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"},"Data":{"type":"object"}},"example":{"Status":true,"Message":"Record Found Successfully","Data":[{"Id":"16786,50.00","Name":" 007 Voip Call Recording 100 Hrs & 45 Days"},{"Id":"16787,100.00","Name":" 007 VoIP Call Recording 500 Hrs & 90 Days"},{"Id":"16763,30.00","Name":" 100 Call Recording"},{"Id":"16788,200.00","Name":" 10K US Shared Bundle"},{"Id":"16740,10.00","Name":" VoIP Reseller Call Recording"}]}},"AccessToeknesponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"},"Token":{"type":"string"}},"example":{"Status":true,"Message":"Access Toekn","Token":"baeae25168a5066c158f4a53205f87be"}},"UpdateResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"}},"example":{"Status":true,"Message":"Customer Info Updated Successfully"}},"AddCustomerResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"},"Data":{"type":"object"}},"example":{"Status":true,"Message":"Customer Added Successfully","Data":{"i_customer":121245}}},"CustomerDeatilsResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"},"Data":{"type":"object"}},"example":{"Status":true,"Message":"Record Found","Data":[{"firstname":"Maru","baddr2":"1907","iso_4217":"USD","i_parent":"160928","i_customer_class":"6072","state":"FL","out_date_format":"MM-DD-YYYY","email":"maru.arochi@icloud.com","opening_balance":"0.00000","password":"Aap6dfbd","blocked":"N","baddr4":"","out_date_time_format":"MM-DD-YYYY HH24:MI:SS","i_moh":"1","bill_status":"O","name":" Maru  Arochi ","baddr3":"","login":"NHzop1sB","bp_charge_cc":"N","zip":"33160","baddr5":"","balance":"0.00000","creation_date":"2019-04-02 11:56:32","in_date_format":"MM-DD-YYYY","phone1":"555-555-5555","i_time_zone":"331","i_balance_control_type":"1","phone2":"","cont1":"Maru Arochi","midinit":"","salutation":"","lastname":"Arochi","perm_credit_limit":"90.00000","i_customer_type":"1","city":"North Miami Beach","i_ui_time_zone":"331","callshop_enabled":"N","cont2":"","out_time_format":"HH24:MI:SS","country":"US","override_tariffs_enabled":"N","in_time_format":"HH24:MI:SS","service_flags":"     Y Y Y Y     YC","note":"","i_office_type":"1","i_billing_period":"4","faxnum":"","i_acl":"136","i_customer":"272365","baddr1":"16385 Biscayne Blvd","companyname":" Maru  Arochi ","credit_limit":"90.00000","i_do_batch":null,"i_lang":null,"credit_limit_warning":null,"i_template":null,"i_vd_plan":null,"max_abbreviated_length":null,"i_tariff":null,"i_routing_plan":null,"bcc":null,"scheduled_billing_change":null,"new_i_time_zone":null,"i_rep":null,"sale_commission_rate":null,"payment_commission_rate":null,"send_invoices":null,"send_statistics":null,"tax_id":null,"discount_rate":null},{"firstname":"Emilio","baddr2":"","iso_4217":"USD","i_parent":"53870","i_customer_class":"3405","state":"FL","out_date_format":"MM-DD-YYYY","email":"taylor@ringlogix.com","opening_balance":"0.00000","password":"2i1cEYJi","blocked":"N","baddr4":"","out_date_time_format":"MM-DD-YYYY HH24:MI:SS","i_moh":"1","bill_status":"O","name":"**Abo's House**","baddr3":"","login":"cs2jGbCV","bp_charge_cc":"N","zip":"33010","baddr5":"","balance":"0.00000","creation_date":"2019-03-19 18:27:07","in_date_format":"MM-DD-YYYY","phone1":"305-888-9548","i_time_zone":"331","i_balance_control_type":"1","phone2":"","cont1":"Emilio Fernandez","midinit":"","salutation":"","lastname":"Fernandez","perm_credit_limit":"250.00000","i_customer_type":"1","city":"Hialeah","i_ui_time_zone":"331","callshop_enabled":"N","cont2":"","out_time_format":"HH24:MI:SS","country":"US","override_tariffs_enabled":"N","in_time_format":"HH24:MI:SS","service_flags":"     Y Y Y Y     YC","note":"","i_office_type":"1","i_billing_period":"4","faxnum":"","i_acl":"136","i_customer":"272331","baddr1":"420 SE 8 Ave","companyname":"**Abo's House**","credit_limit":"250.00000","i_do_batch":"2111","i_lang":null,"credit_limit_warning":null,"i_template":null,"i_vd_plan":null,"max_abbreviated_length":null,"i_tariff":null,"i_routing_plan":null,"bcc":null,"scheduled_billing_change":null,"new_i_time_zone":null,"i_rep":null,"sale_commission_rate":null,"payment_commission_rate":null,"send_invoices":null,"send_statistics":null,"tax_id":null,"discount_rate":null}]}},"NewCustomerModel":{"required":["ResellerName","Company","ContactNo1","Phone","Email","BillingAddressLine1","City","State","Country","Zip","TimeZone"],"type":"object","properties":{"ResellerID":{"type":"string"},"Company":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Phone":{"type":"string"},"Email":{"type":"string"},"BillingAddressLine1":{"type":"string"},"BillingAddressLine2":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"Country":{"type":"string"},"Zip":{"type":"string"},"BillingProfile":{"type":"string"},"PaymentMethod":{"type":"string"},"PermanentCreditLimit":{"maximum":10000,"minimum":0,"type":"string"},"TimeZone":{"type":"string"}}},"UpdateBillingInfoRequest":{"type":"object","properties":{"i_customer":{"type":"string"},"Company":{"type":"string"},"ContactNo1":{"type":"string"},"ContactNo2":{"type":"string"},"CustomerClass":{"type":"string"},"Email":{"type":"string"},"AddressLine1":{"type":"string"},"AddressLine2":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"Zip":{"type":"string"},"Phone":{"type":"string"},"Country":{"type":"string"},"Representative":{"type":"string"},"PermanentCreditLimit":{"type":"string"},"Status":{"type":"string"},"TimeZone":{"type":"string"}}},"CustomerDetails":{"type":"object","properties":{"firstname":{"type":"string"},"baddr2":{"type":"string"},"iso_4217":{"type":"string"},"i_parent":{"type":"string"},"i_customer_class":{"type":"string"},"state":{"type":"string"},"out_date_format":{"type":"string"},"email":{"type":"string"},"opening_balance":{"type":"string"},"password":{"type":"string"},"blocked":{"type":"string"},"baddr4":{"type":"string"},"out_date_time_format":{"type":"string"},"i_moh":{"type":"string"},"bill_status":{"type":"string"},"name":{"format":"int32","type":"integer"},"baddr3":{"type":"string"},"zip":{"type":"string"},"baddr5":{"type":"string"},"balance":{"type":"string"},"creation_date":{"type":"string"},"in_date_format":{"type":"string"},"phone1":{"type":"string"},"i_time_zone":{"type":"string"},"i_balance_control_type":{"type":"string"},"phone2":{"type":"string"},"cont1":{"type":"string"},"midinit":{"type":"string"},"salutation":{"type":"string"},"lastname":{"type":"string"},"perm_credit_limit":{"type":"string"},"i_customer_type":{"type":"string"},"city":{"type":"string"},"i_ui_time_zone":{"type":"string"},"callshop_enabled":{"type":"string"},"cont2":{"type":"string"},"out_time_format":{"type":"string"},"country":{"type":"string"},"override_tariffs_enabled":{"type":"string"},"in_time_format":{"type":"string"},"service_flags":{"type":"string"},"note":{"type":"string"},"i_office_type":{"type":"string"},"i_billing_period":{"type":"string"},"faxnum":{"type":"string"},"i_acl":{"type":"string"},"i_customer":{"type":"string"},"baddr1":{"type":"string"},"companyname":{"type":"string"},"credit_limit":{"type":"string"},"i_do_batch":{"type":"string"},"i_lang":{"type":"string"},"credit_limit_warning":{"type":"string"},"i_template":{"type":"string"},"i_vd_plan":{"type":"string"},"max_abbreviated_length":{"type":"string"},"i_tariff":{"type":"string"},"i_routing_plan":{"type":"string"},"bcc":{"type":"string"},"scheduled_billing_change":{"type":"string"},"new_i_time_zone":{"type":"string"},"i_rep":{"type":"string"},"sale_commission_rate":{"type":"string"},"payment_commission_rate":{"type":"string"},"send_invoices":{"type":"string"},"send_statistics":{"type":"string"},"tax_id":{"type":"string"},"discount_rate":{"type":"string"}}},"NewNSPBXUserModel":{"required":["Domain","Territory","Type","NickName","MaxExternalCalls","CallerIDName","CallerID","CallerID911","LocalAreaCode","QuotaType"],"type":"object","properties":{"i_customer":{"type":"string"},"i_parent":{"type":"string"},"Plan":{"type":"string"},"NickName":{"type":"string"},"MaxExternalCalls":{"type":"string"},"CallerIDName":{"type":"string"},"CallerID":{"type":"string"},"CallerID911":{"type":"string"},"LocalAreaCode":{"type":"string"},"RecordingStorage":{"type":"string"},"TimeZone":{"type":"string"},"lstSubscription":{"$ref":"#/definitions/ServiceExtension"}}},"AddNSPBXResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"}},"example":{"Status":true,"Message":"New NS PBX Added Successfully"}},"AddNSUseresponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"}},"example":{"Status":true,"Message":"Netsapiens User Added Successfully"}},"UpdateNSPBXResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"}},"example":{"Status":true,"Message":"NS PBX Setting Updated Successfully"}},"UpdateNSUserResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"}},"example":{"Status":true,"Message":"Netsapiens User Updated Successfully"}},"NSPBXSettingResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"},"Data":{"type":"object"}},"example":{"Status":true,"Message":"Record Found","Data":[{"i_customer":274873,"i_parent":249475,"PlanId":"25818","NickName":"testsampl","MaxExternalCalls":"1","i_account":20654205,"activeUsers":0,"PlanName":"7: 10K US Shared Bundle","RecordingStorage":"500 Hours / 90 Days"}]}},"NSDefaultSettingResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"},"Data":{"type":"object"}},"example":{"Status":true,"Message":"Record Found","Data":[{"i_customer":274873,"i_parent":249475,"ExternalCIDName":"1544564","ExternalCID Number":"15446546545","911CIDNumber":"15645645645","LocalAreaCode":"121","TimeZone":"US/Eastern","i_account":20654205}]}},"UpdateNSPBXUserModel":{"required":["Domain","i_parent","Type","NickName","MaxExternalCalls","CallerIDName","CallerID","CallerID911","LocalAreaCode","isTrunkAccountCreated","QuotaType","MainUser"],"type":"object","properties":{"i_customer":{"type":"string"},"i_parent":{"type":"string"},"NickName":{"type":"string"},"MaxExternalCalls":{"type":"string"},"RecordingStorage":{"type":"string"}}},"UpdateNSPBXDefaultSettingModel":{"required":["i_customer","ExternalCIDName","ExternalCallerID","911CallerId","LocalAreaCode","TimeZone"],"type":"object","properties":{"i_customer":{"type":"string"},"ExternalCIDName":{"type":"string"},"ExternalCallerID":{"type":"string"},"911CallerId":{"type":"string"},"LocalAreaCode":{"type":"string"},"TimeZone":{"type":"string"}}},"ServiceExtension":{"type":"object","properties":{"Name":{"type":"string"},"Discount":{"type":"string"},"StartDate":{"type":"string"},"Quantity":{"type":"string"}}},"UserDetail":{"type":"object","properties":{"ExtensionNo":{"type":"string"},"FirstName":{"type":"string"},"LastName":{"type":"string"},"Email":{"type":"string"}}},"NewNSUserModel":{"type":"object","properties":{"i_customer":{"type":"string"},"NoOfExtension":{"type":"string"},"DefaultScope":{"type":"string"},"Defaultprice":{"$ref":"#/definitions/ServiceExtension"},"User Details":{"$ref":"#/definitions/UserDetail"}}},"NSPUserResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"},"Data":{"type":"object"}},"example":{"Status":true,"Message":"Record Found","Data":[{"name":"vcv bnbnb","Extension":"121","scope":"Basic User","monthly_service":null,"id":121,"i_account":20654231}]}},"UpdateNSUserModel":{"type":"object","properties":{"i_account":{"type":"string"},"ExtensionNumber":{"type":"string"},"i_customer":{"type":"string"},"ExtensionName":{"type":"string"},"Scope":{"type":"string"},"Price":{"$ref":"#/definitions/ServiceExtension"}}},"AccessTokenRequest":{"type":"object","properties":{"UserId":{"type":"string"},"Password":{"type":"string"}}},"DeleteCustomerResponseModel":{"type":"object","properties":{"Status":{"type":"boolean"},"Message":{"type":"string"}},"example":{"Status":true,"Message":"Customer Terminated Successfully"}}}}