home
/
u941026986
/
domains
/
paratune.com
/
public_html
➕ New
📤 Upload
✎ Editing:
PBX_System_Admin_API.postman_collection.json
← Back
{ "info": { "name": "PBX System - Admin API", "description": "Postman collection for PBX System Admin APIs", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "Tenant APIs", "item": [ { "name": "Create Tenant - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/createTenant", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "createTenant" ] }, "description": "API endpoint: Create Tenant - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_name (required): Name of the tenant\n- tenant_username (required): Web Username for the tenant\n- tenant_password (required): Web Password for the tenant\n- tenant_feature_password (optional): Feature Code PIN for the tenant\n- tenant_email (required): Email for the tenant\n- tenant_language (optional): Languages for the tenant\n- tenant_default_language (optional): Default Langauge\n- default_date_format (required): Default Date Format\n- invoice_date_format (required): Invoice Date Format\n- tenant_moh_file (optional): MOH file for the tenant\n- moh_customization (optional): MOH Cutomization Feature for the tenant\n- tenant_currency (required): Currency of the tenant\n- tenant_country (required): Country of the tenant\n- tenant_ext_callerid_customization (optional): External Caller ID Customization value for the tenant\n- tenant_codec_pref (optional): Codec Preference for the tenant\n- tenant_bill_type (optional): Bill Type of the Tenant\n- tenant_tax (required): Tax for the tenant\n- tenant_customization (optional): Customization feature for tenant\n- tenant_payment (optional): Payment feature for tenant\n- tenant_reg_auth (optional): Tenant Access Restriction Feature\n- auto_call_record (optional): Extension auto Recording Feature for the tenant\n- tenant_audio_codec (optional): Audio Codecs for the tenant\n- tenant_video_codec (optional): Video Codecs for the tenant\n- tenant_outbound (optional): Outbound feature for the tenant\n- tenant_disable_ext_call (optional): \n- tenant_email_invoice (optional): Invoice Email Feature for the tenant\n- tenant_due_alert (optional): \n- tenant_due_notification (optional): \n- tenant_low_balance_alert (optional): Low Balance Alert Email Feature for the tenant\n- api_access (optional): API Access Feature for the tenant\n- api_callback (optional): API Callback URL for the tenant\n- tenant_concurrent_calls (optional): Concurrent Calls for the tenant\n- user_role_access (optional): User Role Access Feature for the tenant\n- tenant_auto_assign_service (optional): Auto Assign Service Feature For Tenant\n- timezone_id (required): Timezone For Tenant\n- external_call_ring_type (optional): External Call Ring Type for Tenant\n- first_name (required): First Name For Tenant\n- last_name (required): Last Name For Tenant\n- business_name (required): Business Name For Tenant\n- phone_number (optional): Phone Number for the tenant\n- address1 (required): Address Line 1 For Tenant\n- address2 (optional): Address Line 2 For Tenant\n- city (required): City Name For Tenant\n- state (required): State Name For Tenant\n- country (optional): Country For the Tenant Address\n- zip (required): ZIP Code For Tenant\n- tenant_billplan_id (required): Billplan ID for the tenant\n- tenant_charge (optional): One Time Charge for the tenant\n- bill_period (optional): Due Period for the billplan\n- notification_before_due_period (optional): Valid Notification Before Due Period for the billplan\n- alert_before_notification_before_due_period (optional): Valid Alert Before Notification Before Due Period\n- notification_after_due_period (optional): Valid Notification After Due Period for the billplan\n- alert_before_notification_after_due_period (optional): Valid Alert Before Notification After Due Period\n- outgoing_suspension_period (optional): Valid Outgoing Suspension Period for the billplan\n- alert_before_outgoing_suspension_period (optional): Valid Alert Before Outgoing Suspension Period\n- service_suspension_period (optional): Valid Service Suspension Period for the billplan\n- alert_before_service_suspension_period (optional): Valid Alert Before Service Suspension Period\n- service_inactivation_period (optional): Valid Service Inactivation Period for the billplan\n- alert_before_service_inactivation_period (optional): Valid Alert Before Service Inactivation Period\n- service_termination_period (optional): Valid Service Termination Period for the billplan\n- alert_before_service_termination_period (optional): Valid Alert Before Service Termination Period\n- min_inv_amount_paid_before_due_period (optional): Valid Maximum Invoice Amount Paid Before Due Period (%) for the billplan\n- min_inv_amount_paid_after_due_period (optional): Valid Maximum Invoice Amount Paid After Due Period (%) for the billplan\n- min_credit_balance (optional): Valid Minimum Credit Balance(%) for the billplan\n- late_payment_fee (optional): Valid Late Payment Fee for the billplan\n- cancellation_charge (optional): Valid Cancellation Charge for the billplan\n- cancellation_charge_period (optional): Valid Cancellation Charge Period for the billplan\n- bill_day (optional): Valid Bill Day For Billplan\n- security_deposit (optional): Valid Security Deposit for the billplan\n- tenant_serv_id_ext (required): Extension Service ID\n- tenant_serv_id_ext_count (required): Extension Service Count\n- tenant_serv_id_ext_rate (required): Extension Service Rate\n- tenant_serv_id_ext_rate_type (optional): Service Rate Type\n- tenant_serv_id_video (optional): Video Service ID\n- tenant_serv_id_video_count (optional): Video Service Count\n- tenant_serv_id_video_rate (optional): Video Service Rate\n- tenant_serv_id_video_rate_type (optional): Service Rate Type\n- tenant_serv_id_did (optional): DID Service ID\n- tenant_serv_id_did_count (optional): DID Service Count\n- tenant_serv_id_did_rate (optional): DID Service Rate\n- tenant_serv_id_did_rate_type (optional): Service Rate Type\n- tenant_serv_id_playback (optional): Playback Service ID\n- tenant_serv_id_playback_count (optional): Playback Service Count\n- tenant_serv_id_playback_rate (optional): Playback Service Rate\n- tenant_serv_id_playback_rate_type (optional): Service Rate Type\n- tenant_serv_id_queue (optional): Queue Service ID\n- tenant_serv_id_queue_count (optional): Queue Service Count\n- tenant_serv_id_queue_rate (optional): Queue Service Rate\n- tenant_serv_id_queue_rate_type (optional): Service Rate Type\n- tenant_serv_id_ivr (optional): IVR Service ID\n- tenant_serv_id_ivr_count (optional): IVR Service Count\n- tenant_serv_id_ivr_rate (optional): IVR Service Rate\n- tenant_serv_id_ivr_rate_type (optional): Service Rate Type\n- tenant_serv_id_conference (optional): Conference Service ID\n- tenant_serv_id_conference_count (optional): Conference Service Count\n- tenant_serv_id_conference_rate (optional): Conference Service Rate\n- tenant_serv_id_conference_rate_type (optional): Service Rate Type\n- tenant_serv_id_ringgroup (optional): Ringgroup Service ID\n- tenant_serv_id_ringgroup_count (optional): Ringgroup Service Count\n- tenant_serv_id_ringgroup_rate (optional): Ringgroup Service Rate\n- tenant_serv_id_ringgroup_rate_type (optional): Service Rate Type\n- tenant_serv_id_voicemail (optional): Voicemail Service ID\n- tenant_serv_id_voicemail_count (optional): Voicemail Service Count\n- tenant_serv_id_voicemail_rate (optional): Voicemail Service Rate\n- tenant_serv_id_voicemail_rate_type (optional): Service Rate Type\n- tenant_serv_id_fax (optional): Fax Service ID\n- tenant_serv_id_fax_count (optional): Fax Service Count\n- tenant_serv_id_fax_rate (optional): Fax Service Rate\n- tenant_serv_id_fax_rate_type (optional): Service Rate Type\n- tenant_serv_id_paging (optional): Paging Service ID\n- tenant_serv_id_paging_count (optional): Paging Service Count\n- tenant_serv_id_paging_rate (optional): Paging Service Rate\n- tenant_serv_id_paging_rate_type (optional): Service Rate Type\n- tenant_serv_id_disa (optional): Disa Service ID\n- tenant_serv_id_disa_count (optional): Disa Service Count\n- tenant_serv_id_disa_rate (optional): Disa Service Rate\n- tenant_serv_id_disa_rate_type (optional): Service Rate Type\n- tenant_serv_id_no_line_forward (optional): No Line Forward Service ID\n- tenant_serv_id_no_line_forward_count (optional): No Line Forward Service Count\n- tenant_serv_id_no_line_forward_rate (optional): No Line Forward Service Rate\n- tenant_serv_id_no_line_forward_rate_type (optional): Service Rate Type\n- tenant_serv_id_queue_pro (optional): QueuePro Service ID\n- tenant_serv_id_queue_pro_count (optional): QueuePro Service Count\n- tenant_serv_id_queue_pro_rate (optional): QueuePro Service Rate\n- tenant_serv_id_queue_pro_rate_type (optional): Service Rate Type\n- tenant_serv_id_call_feedback (optional): Call Feedback Service ID\n- tenant_serv_id_call_feedback_count (optional): Call Feedback Service Count\n- tenant_serv_id_call_feedback_rate (optional): Call Feedback Service Rate\n- tenant_serv_id_call_feedback_rate_type (optional): Service Rate Type\n- tenant_serv_id_voicemail_box (optional): Voicemail Box Service ID\n- tenant_serv_id_voicemail_box_count (optional): Voicemail Box Service Count\n- tenant_serv_id_voicemail_box_rate (optional): Voicemail Box Service Rate\n- tenant_serv_id_voicemail_box_rate_type (optional): Service Rate Type\n- tenant_serv_id_pin_based_dialing (optional): PIN Based Dialing Service ID\n- tenant_serv_id_pin_based_dialing_count (optional): PIN Based Dialing Service Count\n- tenant_serv_id_pin_based_dialing_rate_type (optional): Service Rate Type\n- tenant_serv_id_qr_code (optional): QR Code Service ID\n- tenant_serv_id_qr_code_count (optional): QR Code Service Count\n- tenant_serv_id_qr_code_rate (optional): QR Code Service Rate\n- tenant_serv_id_qr_code_rate_type (optional): Service Rate Type\n- tenant_serv_id_webphone (optional): Webphone Service ID\n- tenant_serv_id_webphone_count (optional): Webphone Service Count\n- tenant_serv_id_webphone_rate (optional): Webphone Service Rate\n- tenant_serv_id_webphone_rate_type (optional): Service Rate Type\n- tenant_serv_id_spam_call (optional): Spam Call Service ID\n- tenant_serv_id_spam_call_count (optional): Voicemail Service Count\n- tenant_serv_id_spam_call_rate (optional): Voicemail Service Rate\n- tenant_serv_id_simultaneous_calls (required): Simultaneous Calls Service ID\n- tenant_serv_id_simultaneous_calls_count (required): Simultaneous Calls Service Count\n- tenant_serv_id_simultaneous_calls_rate (required): Simultaneous Calls Service Rate\n- tenant_serv_id_simultaneous_calls_rate_type (optional): Simultaneous Calls Service Rate Type\n- tenant_serv_id_transcript (optional): Transcript Service ID\n- tenant_serv_id_transcript_count (optional): Transcript Service Count\n- tenant_serv_id_transcript_rate (optional): Transcript Service Rate\n- tenant_serv_id_transcript_rate_type (optional): Transcript Service Rate Type\n- tenant_serv_id_wakeupcall (optional): tenant_serv_id_wakeupcall\n- tenant_serv_id_wakeupcall_count (optional): Wakeup Call count\n- tenant_serv_id_wakeupcall_rate (optional): tenant_serv_id_wakeupcall_rate\n- tenant_serv_id_wakeupcall_rate_type (optional): tenant_serv_id_wakeupcall_rate_type\n- tenant_serv_id_callflow (optional): tenant_serv_id_callflow\n- tenant_serv_id_callflow_count (optional): tenant_serv_id_callflow_count\n- tenant_serv_id_callflow_rate (optional): tenant_serv_id_callflow_rate\n- tenant_serv_id_callflow_rate_type (optional): tenant_serv_id_callflow_rate_type\n- custom_service_id (optional): custom service ID\n- custom_service_count (optional): custom service Service Count\n- custom_service_rate (optional): custom service Service Rate\n- custom_service_rate_type (optional): Service Rate Type\n- rule_group_id (optional): Dialout Rule for the tenant\n- allow_default_rule_group (optional): \n- rp_id (optional): Rateplan ID for the tenant\n- call_balance (optional): Call Balance for the tenant\n- alert_balance (optional): Alert Balance for the tenant\n- call_alert (optional): Call Alert Type for the Tenant\n- prepand_digit (optional): Prepand Digit For Tenant\n- advance_payment_adjust (optional): Advance payment adjust\n- universal_forward (optional): Universal Forward Feature\n- busy_forward (optional): Busy Forward Feature\n- no_answer_forward (optional): No Answer Forward Feature\n- unavailable_forward (optional): Unavailable Forward Feature\n- time_based_forward (optional): Time Based Forward Feature\n- selective_forward (optional): Selective Forward Feature\n- shift_forward (optional): Shift Forward Feature\n- whitelist (optional): Whitelist Feature\n- blacklist (optional): Blacklist Feature\n- follow_me (optional): Follow Me Feature\n- caller_id_block (optional): Caller ID Block Feature\n- accept_blocked_caller_id (optional): Accept Blocked Caller ID Feature\n- do_not_disturb (optional): Do Not Disturb Feature\n- redial (optional): Redial Feature\n- call_return (optional): Call Return Feature\n- call_recording (optional): Call Recording Feature\n- holiday (optional): Holiday Feature\n- weekoff (optional): Weekoff Feature\n- bargein (optional): Bargein Feature\n- transfer (optional): Transfer Feature\n- park (optional): Park Feature\n- webphone (optional): Webphone Feature\n- call_screening (optional): Call Screening Feature\n- call_based_callid_restriction (optional): Call Based CallerID Restriction\n- first_time_charge (optional): First Time Charge\n- charge_status (optional): Charge Status\n- invoice_template (required): Invoice Template\n- busy_callback (optional): Busy Callback\n- service_fwd (optional): Service Forward\n- call_threshold_plan (optional): Threshold Plan ID for the tenant\n- ignore_numbers (optional): Ignore Numbers for the tenant\n- custom_fields (optional): Custom Field Array\n- tenant_device_ringtone_customization (optional): Ringtone Customization feature for tenant\n- tenant_device_wallpaper_customization (optional): Wallpaper Customization feature for tenant\n- allow_request_bill_plan (optional): Request Bill Plan for tenant\n- allow_c2c_plugin (optional): Click To Call Plugin Feature for Tenant\n- sms_customization (optional): \n- max_rec_storage_days (required): Maximum Recording Storage Days\n- rec_storage (optional): Recording Storage\n- rec_storage_days (optional): Recording Transfer After Days\n- rec_remove (optional): Remove Recording After Transfer\n- rec_transfer_type (optional): Recording Transfer Type\n- rec_storage_preference (optional): Recording Storage Preference\n- rec_storage_ip (optional): Storage IP/Domain for Recording\n- rec_storage_path (optional): Storage Path for Recording\n- rec_storage_username (optional): Storage Username for Recording\n- rec_storage_password (optional): Storage Password for Recording\n- allow_bundle_in_did_calls (optional): Use Bundle in DID calls\n- allow_custom_prompt (optional): Allow Custom Prompt\n- prompt_list (optional): Custom Promot List\n- allow_bundle_in_trunk_calls (optional): Use Bundle in Trunk calls\n- allow_internal_calling (optional): Allow Internal Calling\n- tenant_multiple_register (optional): Multiple Registration\n- tenant_transport_layer (optional): Transport Layer\n- dashboard_detail (optional): Dashboard Detail\n- show_services (optional): Show Services Listing in Invoice\n- show_calls (optional): Show Calls\n- send_paid_invoice (optional): Send PAID Invoice Receipt Feature for the tenant\n- allow_did_purchase (optional): DID Purchase Feature for the tenant\n- did_account_list (optional): DID Account List\n- allow_voicemail_transcript (optional): Allow Voicemail Transcript\n- allow_tax_exemption (optional): Enable Tax Exemption\n- taxExemptionCodeList (optional): Tax Exemption Code List for Tenant\n- tax_config_type (required): Tax Config Type for Tenant\n- tax_config (required): Tax Config for Tenant\n- service_plan_id (optional): Service Plan ID for Tenant\n- allow_recording_transcript (optional): Allow Recording Transcript\n- tenant_ext_callerid_required (optional): Is External Caller ID Required for Tenant\n- device_list (optional): Calling Device List For Tenant\n- tm_id (optional): Transacript Provider ID\n- call_recording_type (optional): Recording Type\n- retention_day (optional): Retention Day\n- allow_recording_compress (optional): Allow Recording Compress\n" }, "response": [] }, { "name": "Update Tenant - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/update/updateTenant", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "update", "updateTenant" ] }, "description": "API endpoint: Update Tenant - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): ID of the tenant\n- tenant_name (optional): Name of the tenant\n- tenant_feature_password (optional): Feature Code PIN for the tenant\n- tenant_web_password (optional): Web Password for the tenant\n- first_name (optional): First Name For Tenant\n- last_name (optional): Last Name For Tenant\n- business_name (optional): Business Name For Tenant\n- phone_number (optional): Phone Number for the tenant\n- address1 (optional): Address Line 1 For Tenant\n- address2 (optional): Address Line 2 For Tenant\n- city (optional): City Name For Tenant\n- state (optional): State Name For Tenant\n- country (required): Country For the Tenant Address\n- zip (optional): ZIP Code For Tenant\n- tenant_outbound (optional): Outbound feature for the tenant\n- rp_id (optional): ID of rate plan\n- rule_group_id (optional): Dialout Rule for the tenant\n- fax_rp_id (optional): ID of Fax rate plan\n- allow_internal_calling (optional): Allow Internal Calling\n- call_recording_type (optional): Recording Type\n- retention_day (optional): Retention Day\n- allow_recording_compress (optional): Allow Recording Compress\n" }, "response": [] }, { "name": "Update Tenant External Caller ID Number - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/update/updateTenantCallerIDNumber", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "update", "updateTenantCallerIDNumber" ] }, "description": "API endpoint: Update Tenant External Caller ID Number - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): ID of the tenant\n- tenant_external_calleridnumber (required): External Caller ID Number\n" }, "response": [] }, { "name": "Change Tenant Status - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/update/changeTenantStatus", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "update", "changeTenantStatus" ] }, "description": "API endpoint: Change Tenant Status - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): ID of the tenant\n- tenant_status (required): Status for tenant\n" }, "response": [] }, { "name": "Tenant Invoice Config - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/tenantInvoiceConfig", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "tenantInvoiceConfig" ] }, "description": "API endpoint: Tenant Invoice Config - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): ID of the tenant\n- extra_charge (optional): Extra charge for Invoice\n- refund_amount (optional): Refund Amount for Invoice\n- discount (optional): Discount for Invoice\n- extra_charge_description (optional): Description for extra charge\n- refund_description (optional): Description for refund\n- discount_description (optional): Description for discount\n" }, "response": [] }, { "name": "Request Tenant Service - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/requestService", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "requestService" ] }, "description": "API endpoint: Request Tenant Service - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): Valid Tenant ID.\n- serv_id (required): valid Service ID\n- serv_count (required): Valid Service Count\n- serv_start_date (required): Service Start Date\n" }, "response": [] }, { "name": "Get Tenant Service Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getTenantService", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getTenantService" ] }, "description": "API endpoint: Get Tenant Service Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (optional): Valid Tenant ID.\n" }, "response": [] }, { "name": "Get Tenant Info - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getTenantInfo", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getTenantInfo" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Tenant Info - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the Tenant details required. Allowed Type is: 'ADMIN'.\n- tenant_id (optional): Valid Tenant ID.\n" }, "response": [] }, { "name": "Get Tenant Custom fields - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getTenantCustomfield", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getTenantCustomfield" ] }, "description": "API endpoint: Get Tenant Custom fields - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Tenant Bundle Plan Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getTenantBundlePlan", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getTenantBundlePlan" ] }, "description": "API endpoint: Get Tenant Bundle Plan Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): Valid Tenant ID.\n" }, "response": [] }, { "name": "Get Tenant Rate Plan Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getTenantRatePlan", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getTenantRatePlan" ] }, "description": "API endpoint: Get Tenant Rate Plan Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): Valid Tenant ID.\n" }, "response": [] }, { "name": "Get Tenant Service Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getTenantServiceDetail", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getTenantServiceDetail" ] }, "description": "API endpoint: Get Tenant Service Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): Valid Tenant ID.\n" }, "response": [] }, { "name": "Get Tenant Status Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getTenantStatus", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getTenantStatus" ] }, "description": "API endpoint: Get Tenant Status Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): Valid Tenant ID\n" }, "response": [] }, { "name": "Get Tenant Status Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/billPlanRequestDetail", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "billPlanRequestDetail" ] }, "description": "API endpoint: Get Tenant Status Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- billplan_status (optional): Valid Bill Plan Status\n" }, "response": [] }, { "name": "Get Tenant Service Request Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/serviceRequestDetail", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "serviceRequestDetail" ] }, "description": "API endpoint: Get Tenant Service Request Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- service_status (optional): Valid Service Status\n" }, "response": [] }, { "name": "Get Tenant Call Charges - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getTenantCallCharges", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getTenantCallCharges" ] }, "description": "API endpoint: Get Tenant Call Charges - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- start_date (required): Start Date for get Tenant Call Charge\n- end_date (required): End Date for get Tenant Call Charge\n- tenant_id (optional): Valid Tenant ID passed.\n- data (optional): Data Type for Tenant Call Charge.\n" }, "response": [] }, { "name": "Get Tenant Device List - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getTenantDeviceList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getTenantDeviceList" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Tenant Device List - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (optional): Valid Tenant ID\n- userType (required): userType of the user of which the blacklist number required.i.e. userType='ADMIN', then it will give blacklist number whose tenant_id is passed.\n" }, "response": [] }, { "name": "Request Roaming Plan - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\",\n \"roaming_plan_id\": \"{{roaming_plan_id}}\",\n \"start_date\": \"{{start_date}}\",\n \"end_date\": \"{{end_date}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/requestRoamingPlan", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "requestRoamingPlan" ] }, "description": "API endpoint: Request Roaming Plan - POST Method\n\nParameters:\n- token_id (mandatory): Token ID for the authentication\n- tenant_id (mandatory): Valid Tenant ID\n- roaming_plan_id (mandatory): Valid Roaming Plan ID\n- start_date (mandatory): Start Date\n- end_date (mandatory): End Date" }, "response": [] } ] }, { "name": "User APIs", "item": [ { "name": "Create User - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/{{userType}}/createUser", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "{{userType}}", "createUser" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Create User - POST Method" }, "response": [] }, { "name": "Update User - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/update/{{userType}}/updateUser", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "update", "{{userType}}", "updateUser" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Update User - POST Method" }, "response": [] }, { "name": "Delete User - POST Method", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/delete/{{userType}}/deleteUser", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "delete", "{{userType}}", "deleteUser" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Delete User - POST Method" }, "response": [] }, { "name": "Get User Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getUser", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getUser" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get User Details - POST Method" }, "response": [] }, { "name": "Create Extension - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/{{userType}}/createExtension", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "{{userType}}", "createExtension" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Create Extension - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): User Type for Extension Create\n- tenant_id (required): Tenant ID For Extension Create\n- plan_id (required): Plan ID for Extension\n- ext_status (optional): Extension Status for Extension\n- ext_number (required): Extension Number for Extension\n- shift_id (required): Shift ID for Extension\n- ext_name (optional): Extension Name for Extension\n- ext_callgroup (required): Group IDs for Extension\n- ext_sip_password (required): SIP Password for Extension\n- language (required): Langauge for Extension\n- ext_web_password (required): Web Password for Extension\n- ext_calleridname (optional): Caller ID Name for Extension\n- ext_vm_password (optional): VM Password for Extension\n- ext_vm_password (optional): VM Password for Extension\n- ext_email_id (required): Email ID for Extension\n- ext_max_ext_call (required): Maximum External Call for Extension\n- ext_ring_timeout (required): Ring Timeout for Extension\n- ext_dial_timeout (required): Dial Timeout for Extension\n- ext_external_calleridnumber (optional): External Caller ID Number for Extension\n- allow_update_calleridnumber (optional): Allow to Update User Caller ID\n- ext_auto_call_rec (optional): Extension Auto Recording for Extension\n- ext_feature_code_pin (required): Feature Code PIN for Extension\n- ext_video_calling (optional): Video Calling Feature for Extension\n- ext_codec (required): Audio Codecs for Extension\n- ext_codec_video (optional): Video Codecs for Extension\n- ext_multiple_register (optional): Multiple Registration for Extension\n- ext_voicemail (optional): Voicemail Feature for Extension\n- ext_fax (optional): Fax Feature for Extension\n- outbound (optional): Dial-out Feature for Extension\n- rule_group_id (optional): Rule Group For Extension\n- phonebook_entry (optional): Phonebook Entry for Extension\n- ext_recv_fax_on_mail (optional): Fax On Mail Feature for Extension\n- ext_fax_header (optional): Fax Header Feature for Extension\n- ext_fax_cover_sheet (optional): Fax Cover Page Feature for Extension\n- ext_fax_name (optional): Fax Header Name for Extension\n- ext_fax_from_cmp (optional): Fax From Company for Extension\n- ext_balance_restriction (optional): Balance Restriction Feature for Extension\n- extension_balance_plan (optional): Balance Plan For Extension\n- ext_allowed_all_prefix (optional): Allow All Prefix Feature for Extension\n- ext_allowed_prefix (optional): Allow Prefix for Extension\n- timezone_id (required): Timezone For Extension\n- missed_call_notification (optional): Missed Call Notification for Extension\n- dtmf_type (optional): DTMF Type for Extension\n- ext_allow_alias (optional): Enable Alias for Extension\n- bypass_media (optional): Bypass Media For Extension\n- ext_qr_login (optional): QR Login for Extension\n- external_call_ring_type (optional): External Call Ring Type for Extension\n- caller_id_type (optional): Caller ID Type for Extension\n- caller_id_header_value (optional): Caller ID Header Value for Extension\n- ext_show_recording (optional): Extension Show Recording for Extension\n- ext_outbound_restriction (optional): Outbound Restriction\n- ext_recording_point (optional): Recording Point\n- default_date_format (required): Default Date Format\n- allow_welcome_mail (optional): Allow Welcome Mail\n- allow_external_c2c (optional): Allow External Click To Call For Extension\n- external_number (optional): External Number For Extension\n- ext_transport_layer (optional): Transport Layer\n- allow_did_routing (optional): If Caller ID Customization For Tenant Is DID , Pass Valid Value For Allow DID Routing.\n- allow_update_device_setting (optional): Allow Update Device Setting\n- holiday_group (optional): Holiday Group For Extension\n- weekoff_group (optional): Weekoff Group For Extension\n- ext_enable_webphone (optional): Webphone for Extension\n- ext_allow_feature_pin (optional): Use Feature PIN For Forwarding for Extension\n- emergency_callerid (optional): Emergency Caller ID Number for Extension\n- dynamic_emergency_callerid (optional): Dynamic Emergency CallID\n- ext_allow_feedback (optional): Call Feedback for Extension\n- allow_queue_pro (optional): Allow QueuePro for Extension\n- ext_user_as_fax_device (optional): Use As Fax Device For Extension If Extension Is Unregistered.\n- ext_allow_show_sip_password (optional): Allow To Show SIP Password For Extension\n- ext_allow_show_sip_password (optional): Allow To Show SIP Password For Extension\n- allow_queue_login_logout (optional): Allow Queue Login/Logout for Extension\n- allow_group_chat (optional): Allow Chat Group\n- allow_recording_pause_resume (optional): Allow Recording Pause/Resume\n" }, "response": [] }, { "name": "Update Extension - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/update/{{userType}}/updateExtension", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "update", "{{userType}}", "updateExtension" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Update Extension - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): User Type for Extension Update\n- tenant_id (required): Tenant ID For Extension Update\n- ext_id (required): Extension ID of Extension\n- plan_id (required): Plan ID for Extension\n- ext_status (optional): Extension Status for Extension\n- shift_id (required): Shift ID for Extension\n- ext_name (optional): Extension Name for Extension\n- ext_callgroup (required): Group IDs for Extension\n- ext_sip_password (required): SIP Password for Extension\n- language (required): Langauge for Extension\n- ext_web_password (required): Web Password for Extension\n- ext_calleridname (optional): Caller ID Name for Extension\n- ext_vm_password (optional): VM Password for Extension\n- ext_vm_password (optional): VM Password for Extension\n- ext_email_id (required): Email ID for Extension\n- ext_max_ext_call (required): Maximum External Call for Extension\n- ext_ring_timeout (required): Ring Timeout for Extension\n- ext_dial_timeout (required): Dial Timeout for Extension\n- ext_external_calleridnumber (optional): External Caller ID Number for Extension\n- allow_update_calleridnumber (optional): Allow to Update User Caller ID\n- ext_auto_call_rec (optional): Extension Auto Recording for Extension\n- ext_feature_code_pin (required): Feature Code PIN for Extension\n- ext_video_calling (optional): Video Calling Feature for Extension\n- ext_codec (required): Audio Codecs for Extension\n- ext_codec_video (optional): Video Codecs for Extension\n- ext_multiple_register (optional): Multiple Registration for Extension\n- ext_voicemail (optional): Voicemail Feature for Extension\n- ext_fax (optional): Fax Feature for Extension\n- outbound (optional): Dial-out Feature for Extension\n- rule_group_id (optional): Rule Group For Extension\n- phonebook_entry (optional): Phonebook Entry for Extension\n- ext_recv_fax_on_mail (optional): Fax On Mail Feature for Extension\n- ext_fax_header (optional): Fax Header Feature for Extension\n- ext_fax_cover_sheet (optional): Fax Cover Page Feature for Extension\n- ext_fax_name (optional): Fax Header Name for Extension\n- ext_fax_from_cmp (optional): Fax From Company for Extension\n- ext_balance_restriction (optional): Balance Restriction Feature for Extension\n- extension_balance_plan (optional): Balance Plan For Extension\n- ext_allowed_all_prefix (optional): Allow All Prefix Feature for Extension\n- ext_allowed_prefix (optional): Allow Prefix for Extension\n- timezone_id (required): Timezone For Extension\n- missed_call_notification (optional): Missed Call Notification for Extension\n- dtmf_type (optional): DTMF Type for Extension\n- ext_allow_alias (optional): Enable Alias for Extension\n- bypass_media (optional): Bypass Media For Extension\n- ext_qr_login (optional): QR Login for Extension\n- external_call_ring_type (optional): External Call Ring Type for Extension\n- caller_id_type (optional): Caller ID Type for Extension\n- caller_id_header_value (optional): Caller ID Header Value for Extension\n- ext_show_recording (optional): Extension Show Recording for Extension\n- ext_outbound_restriction (optional): Outbound Restriction\n- ext_recording_point (optional): Recording Point\n- default_date_format (required): Default Date Format\n- allow_external_c2c (optional): Allow External Click To Call For Extension\n- external_number (optional): External Number For Extension\n- ext_transport_layer (optional): Transport Layer\n- allow_did_routing (optional): If Caller ID Customization For Tenant Is DID , Pass Valid Value For Allow DID Routing.\n- allow_update_device_setting (optional): Allow Update Device Setting\n- holiday_group (optional): Holiday Group For Extension\n- weekoff_group (optional): Weekoff Group For Extension\n- ext_enable_webphone (optional): Webphone for Extension\n- ext_allow_feature_pin (optional): Use Feature PIN For Forwarding for Extension\n- emergency_callerid (optional): Emergency Caller ID Number for Extension\n- dynamic_emergency_callerid (optional): Dynamic Emergency CallID\n- ext_allow_feedback (optional): Call Feedback for Extension\n- allow_queue_pro (optional): Allow QueuePro for Extension\n- ext_user_as_fax_device (optional): Use As Fax Device For Extension If Extension Is Unregistered.\n- ext_allow_show_sip_password (optional): Allow To Show SIP Password For Extension\n- allow_group_chat (optional): Allow Chat Group\n" }, "response": [] }, { "name": "Get Extension - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getExtension", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getExtension" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Extension - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the Extension details required. Allowed Type is: 'ADMIN'.\n- tenant_id (optional): Valid Tenant ID.\n" }, "response": [] }, { "name": "Get Extension Live Status - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getExtensionWithLiveStatus", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getExtensionWithLiveStatus" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Extension Live Status - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the Extension details required. Allowed Type is: 'ADMIN'.\n- tenant_id (optional): Valid Tenant ID.\n" }, "response": [] } ] }, { "name": "Get Detail APIs", "item": [ { "name": "Call Hangup - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/hangup", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "hangup" ] }, "description": "API endpoint: Call Hangup - POST Method\n\nParameters:\n- uuid (required): Call UUID for hangup call.\n- tenant_id (optional): Valid Tenant ID.\n" }, "response": [] }, { "name": "Get SMS Record - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getSmsRecord", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getSmsRecord" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get SMS Record - POST Method" }, "response": [] }, { "name": "Get DID Provider Account - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getDIDAccount", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getDIDAccount" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get DID Provider Account - POST Method" }, "response": [] }, { "name": "Get Search DID From Provider - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getProviderDID", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getProviderDID" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Search DID From Provider - POST Method" }, "response": [] }, { "name": "Get Role Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getUserRole", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getUserRole" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Role Details - POST Method" }, "response": [] }, { "name": "Get Role Pages - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getRolePages", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getRolePages" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Role Pages - POST Method" }, "response": [] }, { "name": "Call Log - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{startDate}}/{{endDate}}/{{userType}}/callLog", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{startDate}}", "{{endDate}}", "{{userType}}", "callLog" ], "variable": [ { "key": "startDate", "value": "startDate", "description": "startDate parameter" }, { "key": "endDate", "value": "endDate", "description": "endDate parameter" }, { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Call Log - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- startDate (required): startDate for the required call log data in YYYY-MM-DD OR YYYY-MM-DD-HH:MM format.\n- endDate (required): endDate for the required call log data in YYYY-MM-DD OR YYYY-MM-DD-HH:MM format.\n- userType (required): userType of the user of which the call log details required.i.e. If userType='ADMIN', then it will give call details of all tenant.\n- tenant_id (optional): If userType is ADMIN and they want their tenant's details then, this parameter needs to be passed.\n- number (optional): number can be extension number or external number of which the call log details required.\n- unique_token (optional): Pass valid Unique Token.\n- required_media_state (optional): From “YES” or “NO”, one value can be set. Default is “NO”.\n- data_type (optional): From “CURRENT” or “ARCHIVE”, one value can be set. Default is “CURRENT”.\n" }, "response": [] }, { "name": "Active Calls - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/activeCalls", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "activeCalls" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Active Calls - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the active calls details required.i.e. If userType='ADMIN', then it will give active call details of all tenant.\n" }, "response": [] }, { "name": "Get BalancePOST Request URL :", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/balance", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "balance" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get BalancePOST Request URL :\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the active calls details required.i.e. If userType='ADMIN', then it will give balance details of all tenant.\n- tenant_id (optional): If userType is ADMIN and they want their tenant's details then, this parameter needs to be passed.\n" }, "response": [] }, { "name": "Get Recording Path - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/recordingPath", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "recordingPath" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Recording Path - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the recording details required. i.e. If userType='ADMIN', then it will give recording path of call detail of all record.\n- callid (required): Call ID of which the recording download path is required.\n" }, "response": [] }, { "name": "Get Country Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getCountry", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getCountry" ] }, "description": "API endpoint: Get Country Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Currency Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getCurrency", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getCurrency" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Currency Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which tax detail required.i.e. If userType='ADMIN' OR 'RESELLER' , then it will give Tax Detalis.\n" }, "response": [] }, { "name": "Get Device Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getDeviceList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getDeviceList" ] }, "description": "API endpoint: Get Device Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Codecs Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getCodecs", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getCodecs" ] }, "description": "API endpoint: Get Codecs Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Language Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getLanguage", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getLanguage" ] }, "description": "API endpoint: Get Language Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Billplan Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getBillplan", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getBillplan" ] }, "description": "API endpoint: Get Billplan Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Rateplan Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getRateplan", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getRateplan" ] }, "description": "API endpoint: Get Rateplan Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Outgoing Rule Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getOGRule", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getOGRule" ] }, "description": "API endpoint: Get Outgoing Rule Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Outgoing Rule Group - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getOGRuleGroup", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getOGRuleGroup" ] }, "description": "API endpoint: Get Outgoing Rule Group - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get DID Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getDID", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getDID" ] }, "description": "API endpoint: Get DID Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Plan - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getPlan", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getPlan" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Plan - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the plan details required.i.e. userType='ADMIN', then it will give plan details whose tenant_id is passed.\n- tenant_id (required): tenant_id of the user of which the plan details required.\n" }, "response": [] }, { "name": "Get Group - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getGroup", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getGroup" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Group - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the group details required.i.e. userType='ADMIN', then it will give group details whose tenant_id is passed.\n- tenant_id (required): tenant_id of the user of which the group details required.\n" }, "response": [] }, { "name": "Get Shift - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getShift", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getShift" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Shift - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the shift details required.i.e. userType='ADMIN', then it will give shift details whose tenant_id is passed.\n- tenant_id (required): tenant_id of the user of which the shift details required.\n" }, "response": [] }, { "name": "Get DID Type Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getDIDType", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getDIDType" ] }, "description": "API endpoint: Get DID Type Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Timezone - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getTimezone", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getTimezone" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Timezone - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user in which the timezone details required.i.e. userType='ADMIN'.\n" }, "response": [] }, { "name": "Get Balance Plan - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getBalancePlan", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getBalancePlan" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Balance Plan - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the balance plan details required.i.e. userType='ADMIN', then it will give balance plan details whose tenant_id is passed.\n- tenant_id (required): tenant_id of the user of which the balance plan details required.\n" }, "response": [] }, { "name": "Get Rule Group - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getRuleGroup", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getRuleGroup" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Rule Group - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the rule group details required.i.e. userType='ADMIN', then it will give rule group details whose tenant_id is passed.\n- tenant_id (required): tenant_id of the user of which the rule group details required.\n" }, "response": [] }, { "name": "Get Vendor Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getVendorList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getVendorList" ] }, "description": "API endpoint: Get Vendor Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Payment Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{startDate}}/{{endDate}}/{{userType}}/getPayment", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{startDate}}", "{{endDate}}", "{{userType}}", "getPayment" ], "variable": [ { "key": "startDate", "value": "startDate", "description": "startDate parameter" }, { "key": "endDate", "value": "endDate", "description": "endDate parameter" }, { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Payment Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- startDate (required): startDate for the required Payment data in YYYY-MM-DD format.\n- endDate (required): endDate for the required Payment data in YYYY-MM-DD format.\n- userType (required): userType of the user of which the Payment details required.i.e. If userType='ADMIN', then it will give Payment details of all tenant.\n- tenant_id (optional): Valid Tenant ID.\n- payment_type (required): Type of Payment. From “FAILED” or “SUCCESS”, one value can be selected.\n" }, "response": [] }, { "name": "Get Invoice Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getInvoice", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getInvoice" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Invoice Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the Invoice details required.i.e. If userType='ADMIN', then it will give Invoice details of all tenant.\n- tenant_id (optional): Valid Tenant ID.\n- invoice_status (optional): Invoice Payment Status. Allowed value is 'UNPAID','PAID' OR 'PARTIAL'.\n- invoice_duedate (optional): DueDate for the Invoice Detail in YYYY-MM-DD format.\n" }, "response": [] }, { "name": "Get Tax Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getTaxList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getTaxList" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Tax Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which tax detail required.i.e. If userType='ADMIN' OR 'RESELLER' , then it will give Tax Detalis.\n" }, "response": [] }, { "name": "Get Threshold Plan - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getThresholdPlanList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getThresholdPlanList" ] }, "description": "API endpoint: Get Threshold Plan - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Invoice Template - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getInvoiceTemplate", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getInvoiceTemplate" ] }, "description": "API endpoint: Get Invoice Template - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Service Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getService", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getService" ] }, "description": "API endpoint: Get Service Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Cluster Nodes - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getCluster", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getCluster" ] }, "description": "API endpoint: Get Cluster Nodes - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Billplan Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getBillplan", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getBillplan" ] }, "description": "API endpoint: Get Billplan Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Bundle Plan Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getBundlePlanList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getBundlePlanList" ] }, "description": "API endpoint: Get Bundle Plan Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get SMS Bundle Plan Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getSmsBundlePlanList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getSmsBundlePlanList" ] }, "description": "API endpoint: Get SMS Bundle Plan Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Rate Card Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getRateCardList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getRateCardList" ] }, "description": "API endpoint: Get Rate Card Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Currency wise Service Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getServiceList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getServiceList" ] }, "description": "API endpoint: Get Currency wise Service Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- currency_id (required): Valid Currency ID.\n" }, "response": [] }, { "name": "Get Payment History - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getPaymentHistory", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getPaymentHistory" ] }, "description": "API endpoint: Get Payment History - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): Valid Tenant ID\n" }, "response": [] }, { "name": "Get Reseller Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getResellerDetail", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getResellerDetail" ] }, "description": "API endpoint: Get Reseller Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Custom Prompt Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getCustomPromptDetail", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getCustomPromptDetail" ] }, "description": "API endpoint: Get Custom Prompt Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Date Format Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getDateFormat", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getDateFormat" ] }, "description": "API endpoint: Get Date Format Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Gateway Details - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getGatewayList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getGatewayList" ] }, "description": "API endpoint: Get Gateway Details - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Gateway Calling Profile - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getCallingProfile", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getCallingProfile" ] }, "description": "API endpoint: Get Gateway Calling Profile - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Circle List - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getCircleList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getCircleList" ] }, "description": "API endpoint: Get Circle List - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Blacklist Number - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getBlacklistNumber", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getBlacklistNumber" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Blacklist Number - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- userType (required): userType of the user of which the blacklist number required.i.e. userType='ADMIN', then it will give blacklist number whose tenant_id is passed.\n" }, "response": [] }, { "name": "Get Transcript Provider - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getTranscriptProviders", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getTranscriptProviders" ] }, "description": "API endpoint: Get Transcript Provider - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n" }, "response": [] }, { "name": "Get Phone Number - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/getPhoneNumber", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "getPhoneNumber" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Get Phone Number - POST Method" }, "response": [] } ] }, { "name": "Other APIs", "item": [ { "name": "Add DID - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/createDid", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "createDid" ] }, "description": "API endpoint: Add DID - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- number (required): DIDs for adding and assigning to the tenant.\n- ven_id (required): Vendor ID for DID\n- buy_rate_plan_id (required): Buy Rateplan ID for DID\n- tenant_id (optional): Tenant ID for DID\n- sell_rate_plan_id (required): Sell Rateplan ID for DID\n- did_type (required): DID Type for DID\n- max_call (optional): Max Simultaneous Call for DID\n- did_name (optional): Name for DID\n- did_name (optional): Name for DID\n- enable_stir_shaken_verification (optional): Enable STIR/SHAKEN Verification for DID.\n- stir_no_identity (optional): Action to Take For No Identity\n- stir_no_identity_message (optional): Message For No Identity\n- stir_invalid_identity (optional): Action to Take For Invalid Identity\n- stir_invalid_identity_message (optional): Message For Invalid Identity\n- stir_valid_attest_a (optional): Action to Take For Valid Attest A\n- stir_valid_attest_a_message (optional): Message For Valid Attest A\n- stir_valid_attest_b (optional): Action to Take For Valid Attest B\n- stir_valid_attest_b_message (optional): Message For Valid Attest B\n- stir_valid_attest_c (optional): Action to Take For Valid Attest C\n- stir_valid_attest_c_message (optional): Message For Valid Attest C\n" }, "response": [] }, { "name": "Create Role - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/{{userType}}/createUserRole", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "{{userType}}", "createUserRole" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Create Role - POST Method" }, "response": [] }, { "name": "Update Role - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/update/{{userType}}/updateUserRole", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "update", "{{userType}}", "updateUserRole" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Update Role - POST Method" }, "response": [] }, { "name": "Detele Role - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/delete/{{userType}}/deleteUserRole", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "delete", "{{userType}}", "deleteUserRole" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Detele Role - POST Method" }, "response": [] }, { "name": "Create Vendor - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/createVendor", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "createVendor" ] }, "description": "API endpoint: Create Vendor - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- vendor_name (required): Name of the Vendor\n- vendor_email_id (required): Email for the Vendor\n- vendor_country (required): Country of the vendor\n- vendor_currency (required): Currency of the vendor\n- vendor_status (optional): Status of the Vendor\n" }, "response": [] }, { "name": "Update Vendor - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/update/updateVendor", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "update", "updateVendor" ] }, "description": "API endpoint: Update Vendor - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- vendor_id (required): Vendor ID for Update Vendor\n- vendor_name (optional): Name of the Vendor\n- vendor_email_id (optional): Email for the Vendor\n- vendor_status (optional): Status of the Vendor\n" }, "response": [] }, { "name": "Delete Vendor - POST Method", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/delete/deleteVendor", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "delete", "deleteVendor" ] }, "description": "API endpoint: Delete Vendor - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- vendor_id (required): Vendor ID for Delete Vendor\n" }, "response": [] }, { "name": "Create Gateway - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/createGateway", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "createGateway" ] }, "description": "API endpoint: Create Gateway - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- gateway_name (required): Name of the Gateway\n- register (optional): Register\n- ven_id (required): Vendor ID\n- rp_id (required): Buy Rate Plan ID\n- proxy (required): IP/Domain\n- port (required): Port\n- expiry_sec (required): Expiry (Sec)\n- retry_sec (required): Retry (Sec)\n- ping (required): Ping (Sec)\n- caller_id (optional): Caller ID\n- prepand_digit (optional): Prepend Digit In Dial Number\n- prepand_digit_in_callerid (optional): Prepend Digit In Caller ID\n- caller_id_in_from (optional): CallerID in From Header\n- caller_id_type (optional): Caller ID Type for Gateway\n- caller_id_header_value (optional): Caller ID Header Value for Gateway\n- codec (required): Codec for Gateway\n- transport_type (required): Transport Type for Gateway\n- dtmf_type (optional): DTMF Type for Gateway\n- max_call (optional): Max Simultaneous Call for Gateway\n- auth_username (optional): Auth Username for Gateway\n- username (required): Username for Gateway\n- password (optional): Password for Gateway\n- sofia_id (required): sofiaID passed\n- strip_digit_in_callerid (optional): Strip Digit In Caller ID\n- video_codec (optional): Video Codec\n- enable_stir_shaken_authentication (optional): Enable STIR/SHAKEN Authentication for Gateway.\n- attestation_level (optional): Attestation Level For Gateway\n- contact_username (optional): Enable / Disable Username in Contact.\n" }, "response": [] }, { "name": "Create Outgoing Rule - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/createOGRule", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "createOGRule" ] }, "description": "API endpoint: Create Outgoing Rule - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- rule_name (required): Name of the Outgoing Rule\n- rule_pattern (required): Rule Pattern\n- rule_gateway (required): Rule Gateway\n- strip_digit (optional): Strip Digit\n- prepand_digit (optional): Prepend Digit\n- callerid (optional): Caller ID\n- rule_desc (required): Rule Description\n- rule_blacklist_manipulation (optional): Blacklist Number Manipulation\n- rule_billing_number (optional): Billing Number Manipulation\n- lcr (optional): LCR\n- rule_type (optional): Rule Type\n- rule_pattern_exceptional (optional): Exceptional Rule Pattern\n" }, "response": [] }, { "name": "Create Outgoing Rule Group - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/{{userType}}/createOGRulesGroup", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "{{userType}}", "createOGRulesGroup" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Create Outgoing Rule Group - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- or_grp_name (required): Name of the Outgoing Rule Group\n- or_grp_status (optional): Status\n- or_grp_member (required): Rule for Outgoing Rule Group\n" }, "response": [] }, { "name": "Add Balance - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/addBalance", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "addBalance" ] }, "description": "API endpoint: Add Balance - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): ID of the tenant\n- amount (required): Amount for balance\n- remark (required): Remark for balance\n- payment_method (optional): Payment Method For Add Balance\n" }, "response": [] }, { "name": "Add Advance Payment - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/addAdvancePayment", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "addAdvancePayment" ] }, "description": "API endpoint: Add Advance Payment - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): ID of the tenant\n- amount (required): Amount for payment\n- remark (required): Remark for payment\n" }, "response": [] }, { "name": "Make Invoice Payment - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/invoicePayment", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "invoicePayment" ] }, "description": "API endpoint: Make Invoice Payment - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): ID of the tenant\n- amount (required): Amount for Invoice Payment\n" }, "response": [] }, { "name": "Request Bill Plan - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/requestBillPlan", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "requestBillPlan" ] }, "description": "API endpoint: Request Bill Plan - POST Method\n\nParameters:\n- token_id (required): Token ID for the authentication\n- tenant_id (required): Valid Tenant ID.\n- billplan_id (required): valid Bill Plan ID\n" }, "response": [] }, { "name": "Create Blacklist Number - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/{{userType}}/createBlacklistNumber", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "{{userType}}", "createBlacklistNumber" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Create Blacklist Number - POST Method" }, "response": [] }, { "name": "Delete Blacklist Number - POST Method", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/delete/{{userType}}/deleteBlacklistNumber", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "delete", "{{userType}}", "deleteBlacklistNumber" ], "variable": [ { "key": "userType", "value": "{{userType}}", "description": "userType parameter" } ] }, "description": "API endpoint: Delete Blacklist Number - POST Method" }, "response": [] } ] }, { "name": "General APIs", "item": [ { "name": "Click To Call - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"extension_number\": \"{{extension_number}}\",\n \"extension_password\": \"{{extension_password}}\",\n \"phone_number\": \"{{phone_number}}\",\n \"call_type\": \"{{call_type}}\",\n \"mask_cli\": \"{{mask_cli}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/click2call", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "click2call" ] }, "description": "API endpoint: Click To Call - POST Method\n\nParameters:\n- token_id (mandatory): Token ID for the authentication\n- extension_number (mandatory): Extension Number on which Call will first come\n- extension_password (mandatory): MD5 of Web Password of extNumber for authentication\n- phone_number (mandatory): Phone Number on which Call will be made once extension answers the call\n- call_type (optional): From \"extension\" or \"external_caller_id\", one value can be selected. Default is \"extension\".\n- mask_cli (optional): From \"OFF\" or \"ON\", one value can be selected. Default is \"OFF\"." }, "response": [] } ] }, { "name": "DID APIs", "item": [ { "name": "Purchase DID - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"did_number\": \"{{did_number}}\",\n \"did_type\": \"{{did_type}}\",\n \"did_account_id\": \"{{did_account_id}}\",\n \"tenant_id\": \"{{tenant_id}}\",\n \"sell_rate_plan_id\": \"{{sell_rate_plan_id}}\",\n \"allow_sms\": \"{{allow_sms}}\",\n \"max_call\": \"{{max_call}}\",\n \"did_name\": \"{{did_name}}\",\n \"allow_mms\": \"{{allow_mms}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/add/{{userType}}/purchaseDID", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "add", "{{userType}}", "purchaseDID" ] }, "description": "API endpoint: Purchase DID - POST Method\n\nParameters:\n- token_id (mandatory): Token ID for the authentication\n- did_number (mandatory): DID number\n- did_type (optional): DID Type for DID\n- did_account_id (mandatory): DID Account ID\n- tenant_id (optional): Tenant ID for DID\n- sell_rate_plan_id (mandatory if tenant_id is given): Sell Rateplan ID for DID\n- allow_sms (optional): Enable SMS (OFF or ON, default OFF)\n- max_call (optional): Max Simultaneous Call for DID\n- did_name (optional): Name for DID\n- allow_mms (optional): Enable MMS (OFF or ON, default OFF)" }, "response": [] }, { "name": "Assign DID - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\",\n \"did_id\": \"{{did_id}}\",\n \"sell_rate_plan_id\": \"{{sell_rate_plan_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/assign/assignDid", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "assign", "assignDid" ] }, "description": "API endpoint: Assign DID - POST Method\n\nParameters:\n- token_id (mandatory): Token ID for the authentication\n- tenant_id (mandatory): ID of the tenant\n- did_id (mandatory): DID Ids for the assignment (JSON array format for multiple)\n- sell_rate_plan_id (mandatory): Sell Rate Plan for the Tenant" }, "response": [] } ] }, { "name": "Information APIs", "item": [ { "name": "Get Reseller - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getReseller", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getReseller" ] }, "description": "API endpoint: Get Reseller - POST Method\n\nParameters:\n- token_id (mandatory): Token ID for the authentication" }, "response": [] }, { "name": "Get Roaming Plan List - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/getRoamingPlanList", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "getRoamingPlanList" ] }, "description": "API endpoint: Get Roaming Plan List - POST Method\n\nParameters:\n- token_id (mandatory): Token ID for the authentication" }, "response": [] }, { "name": "Get Roaming Plan Request Detail - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/roamingPlanRequestDetail", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "roamingPlanRequestDetail" ] }, "description": "API endpoint: Get Roaming Plan Request Detail - POST Method\n\nParameters:\n- token_id (mandatory): Token ID for the authentication\n- tenant_id (optional): Tenant ID" }, "response": [] }, { "name": "Get SMS Notification Account - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/smsNotificationAccount", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "smsNotificationAccount" ] }, "description": "API endpoint: Get SMS Notification Account - POST Method\n\nParameters:\n- token_id (mandatory): Token ID for the authentication\n- tenant_id (optional): Tenant ID" }, "response": [] }, { "name": "Get SMS Notification Number - POST Method", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"token_id\": \"{{token_id}}\",\n \"tenant_id\": \"{{tenant_id}}\"\n}" }, "url": { "raw": "https://pbx.s1soft.com/hodupbx_api/v1.4/api/info/{{userType}}/smsNotificationNumber", "protocol": "https", "host": "pbx.s1soft.com", "path": [ "hodupbx_api", "v1.4", "api", "info", "{{userType}}", "smsNotificationNumber" ] }, "description": "API endpoint: Get SMS Notification Number - POST Method\n\nParameters:\n- token_id (mandatory): Token ID for the authentication\n- tenant_id (optional): Tenant ID" }, "response": [] } ] } ], "variable": [ { "key": "base_url", "value": "https://pbx.s1soft.com/hodupbx_api/v1.4", "type": "string" }, { "key": "token_id", "value": "", "type": "string", "description": "Token ID for authentication" }, { "key": "userType", "value": "ADMIN", "type": "string", "description": "User type (ADMIN, TENANT, etc.)" } ] }
💾 Save Changes
Cancel
📤 Upload File
×
Select File
Upload
Cancel
➕ Create New
×
Type
📄 File
📁 Folder
Name
Create
Cancel
✎ Rename Item
×
Current Name
New Name
Rename
Cancel
🔐 Change Permissions
×
Target File
Permission (e.g., 0755, 0644)
0755
0644
0777
Apply
Cancel