{
"info" : {
"version" : "1.0.0",
"title" : "PortaBilling JSON API Reference Guide",
"description" : "This document provides information for developers who want to interface their applications with PortaBilling via JSON API"
},
"components" : {
"schemas" : {
"DeleteFollowMeNumberResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"DeleteScheduledCommitmentRecordReplacementRequest" : {
"required" : [
"i_account_commitment"
],
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
}
}
},
"ArrayOfVendorXDRInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VendorXDRInfo"
}
},
"ArrayOfServiceFeatureAttributes" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServiceFeatureAttributeDetails"
}
},
"ArrayOfCustomerClassInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerClassInfo"
}
},
"DestinationUpdateCSetGroupResponse" : {
"required" : [
"dest_group_info"
],
"type" : "object",
"properties" : {
"dest_group_info" : {
"$ref" : "#/components/schemas/CSetGroupInfo"
}
}
},
"ArrayOfAuthzRuleInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AuthzRuleInfo"
}
},
"ArrayOfLocaleLanguageInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/LocaleLanguageInfo"
}
},
"XDRCollectionDetailedInfo" : {
"type" : "object",
"properties" : {
"xdr_error_stats" : {
"$ref" : "#/components/schemas/XDRErrorStatsInfo"
},
"xdr_status_stats" : {
"$ref" : "#/components/schemas/XDRStatsInfo"
}
}
},
"GetTaxTransactionCodeInfoResponse" : {
"type" : "object",
"properties" : {
"tax_transaction_code_info" : {
"$ref" : "#/components/schemas/TaxTransactionCode"
}
}
},
"XDRStatsInfo" : {
"type" : "object",
"properties" : {
"rejected" : {
"type" : "integer",
"description" : "The number of rejected xDR records"
},
"total" : {
"type" : "integer",
"description" : "The total number of the xDR records in the collection"
},
"imported" : {
"type" : "integer",
"description" : "The number of succesful imported of xDR records"
},
"todo" : {
"type" : "integer",
"description" : "The number of xDR records to be processed"
},
"skipped" : {
"type" : "integer",
"description" : "The number of skipped xDR records"
}
}
},
"GetMetricsDataResponse" : {
"type" : "object",
"properties" : {
"metrics_data" : {
"$ref" : "#/components/schemas/ArrayOfMetricDataInfo"
}
}
},
"ArrayOfCustomerCustomFieldsInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerCustomFieldsInfo"
}
},
"UpdateTrafficProfileResponse" : {
"required" : [
"i_traffic_profile"
],
"type" : "object",
"properties" : {
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
}
}
},
"CustomerClassInfo" : {
"type" : "object",
"properties" : {
"closing_days" : {
"type" : "integer",
"description" : "In how many days after the due date the customer's account will be closed if the regular invoice is still unpaid"
},
"warning_days" : {
"type" : "integer",
"description" : "How many days before the suspension date a notification of possible suspension of services should be sent to the customer if the regular invoice is still unpaid"
},
"comm_term_periods" : {
"type" : "integer",
"description" : "How many periods (days or billing periods, depending on \"period_terms_in\" value) after the due date the customer's account commitments will be terminated if the regular invoice is still unpaid"
},
"inclusive_taxation" : {
"type" : "string",
"description" : "Identifies that taxes are included in rates for a Customer Class (Y, N)"
},
"collection_threshold" : {
"type" : "number",
"description" : "If no payment is made, the balance is applied to the next invoice(s) until the amount due on a new invoice crosses this threshold"
},
"ot_notific_days" : {
"type" : "string",
"description" : "Out-of-turn invoice notification intervals"
},
"i_template" : {
"type" : "integer",
"description" : "The unique ID for customer's regular invoice template; refers to the Templates table"
},
"send_invoices" : {
"type" : "string",
"description" : "Defines whether a regular invoice should be automatically sent to the customer as soon as it is created"
},
"ot_closing_warning_days" : {
"type" : "integer",
"description" : "How many days before the closing date a notification of possible closing should be sent to the customer if the out-of-turn invoice is still unpaid"
},
"i_business_model" : {
"type" : "integer",
"description" : "The unique identifier for a business model; refers to the Business_Models table"
},
"limit_warning_days" : {
"type" : "integer",
"description" : "How many days before the customer's services are limited a notification of the possible limitation of services should be sent to the customer if the regular invoice is still unpaid"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the customer class is in use"
},
"use_external_billing" : {
"type" : "integer",
"description" : "Shows whether an external billing is used by the customer class's postpaid customers"
},
"name" : {
"type" : "string",
"description" : "The name of the customer class on the PortaBilling interface, unique in the environment"
},
"description" : {
"type" : "string",
"description" : "The customer class description"
},
"ot_resend_days" : {
"type" : "string",
"description" : "Out-of-turn invoice re-sending intervals"
},
"pdf_generation_mode" : {
"type" : "string",
"description" : "Generate Invoice PDF: C - At the end of the billing period; R - Postponed, based on resource availability; D - On demand"
},
"period_terms_in" : {
"type" : "string",
"description" : "Defines the units in which the options grace_period, suspension_days, closing_days are specified"
},
"ot_send_invoices" : {
"type" : "string",
"description" : "Defines whether an out-of-turn invoice should be automatically sent to the customer as soon as it is created"
},
"send_statistics" : {
"type" : "string",
"description" : "Defines what kind of xDR statistics should be delivered to the customer by email"
},
"i_billing_processor" : {
"type" : "integer",
"description" : "Refers to Billing Processor record"
},
"suspension_days" : {
"type" : "integer",
"description" : "In how many days after the due date the customer's services will be suspended if the regular invoice is still unpaid"
},
"ot_grace_period" : {
"type" : "integer",
"description" : "Out-of-turn invoice grace period, i.e. for how many days after invoice generation the payment is expected"
},
"limit_after_periods" : {
"type" : "integer",
"description" : "How many periods (days or billing periods, depending on the \"period_terms_in\" value) after the due date the customer's services will be limited if regular invoice is still unpaid"
},
"closing_days_after_terminated" : {
"type" : "integer",
"description" : "In how many days after provisional termination the customer’s account will be permanently closed (if the administrator does not manually restore this customer within this period)"
},
"charge_cc_on_generation" : {
"type" : "string",
"description" : "The flag shows whether to start charging the customer's credit card starting from the regular invoice due date"
},
"tax_info" : {
"type" : "string",
"description" : "Taxation info"
},
"ot_closing_days" : {
"type" : "integer",
"description" : "In how many days after the due date the customer's account will be closed if the out-of-turn invoice is still unpaid"
},
"closing_warning_days" : {
"type" : "integer",
"description" : "How many days before the closing date a notification of possible closing should be sent to the customer if the regular invoice is still unpaid"
},
"i_notification_preset" : {
"type" : "integer",
"description" : "The notification preset assigned to the customer class"
},
"rounding_step" : {
"type" : "number",
"description" : "The amount to be used to round the expected payment"
},
"resend_days" : {
"type" : "string",
"description" : "Regular invoice re-sending intervals"
},
"iso_4217" : {
"type" : "string",
"description" : "Currency"
},
"comm_term_warning_days" : {
"type" : "integer",
"description" : "How many days before the commitment terminate date a notification of possible closing should be sent to the customer if the regular invoice is still unpaid"
},
"reactivation_fee" : {
"type" : "number",
"description" : "The service reactivation fee"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class record"
},
"shared" : {
"type" : "string",
"description" : "Shows whether the customer class managed by the administrator is available to resellers"
},
"ot_recollect_days" : {
"type" : "string",
"description" : "Out-of-turn invoice re-collection intervals"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique identifier for a tax transaction code; refers to the Tax_Transaction_Codes table"
},
"ot_suspension_days" : {
"type" : "integer",
"description" : "In how many days after the due date the customer's services will be suspended if the out-of-turn invoice is still unpaid"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
},
"recollect_days" : {
"type" : "string",
"description" : "Regular invoice re-collect intervals"
},
"bp_charge_cc" : {
"type" : "string",
"description" : "Automatically charge customer's credit card when a billing period is closed"
},
"bp_closure_delay_days" : {
"type" : "integer",
"description" : "Max days to delay billing period closure"
},
"notific_days" : {
"type" : "string",
"description" : "Regular invoice notification intervals"
},
"special_rounding" : {
"type" : "string",
"description" : "With this option you can use a special rounding up behaviour"
},
"estimate_taxes" : {
"type" : "string",
"description" : "Estimate taxes on receiving payments for the prepaid customers is enabled or disabled"
},
"review_term_days" : {
"type" : "integer",
"description" : "Days to hold invoice for review"
},
"ot_i_template" : {
"type" : "integer",
"description" : "ID for customer's out-of-turn invoice template; refers to the Templates table"
},
"balance_transfer_allowed" : {
"type" : "string",
"description" : "Defines if balance transfer is enabled for a Customer Class (Y, N)"
},
"block_debit_on_insuff_funds" : {
"type" : "string",
"description" : "Defines if a debit account should be blocked when its funds are not enough for subscription charges"
},
"statistics_disabled" : {
"type" : "string",
"description" : "Defines if the customers of this class will be processed by the statistics task. Be careful while disabling statistics: the system keeps xDRs only for a limited time, and you'll need statistics reports to access the records for earlier dates"
},
"reset_customer_balance" : {
"type" : "integer",
"description" : "Shows whether related customers' balances are reset to 0 at the end of the billing period. This option is related to the 'use_external_billing' option and can be enabled only together with it"
},
"grace_period" : {
"type" : "integer",
"description" : "Regular invoice grace period, i.e. for how many days after invoice generation the payment is expected"
},
"is_used_by_resellers" : {
"type" : "integer",
"description" : "Shows whether the shared customer class is used by resellers"
},
"hide_reset_balance_xdr" : {
"type" : "integer",
"description" : "Shows whether the reset balance XDR is hidden from end-user. This option is related to the 'reset_customer_balance' option and can be enabled only together with it"
},
"default_class" : {
"type" : "string",
"description" : "Flag that designates default customer class"
},
"ot_warning_days" : {
"type" : "integer",
"description" : "How many days before the suspension date a notification of possible suspension of services should be sent to the customer if the out-of-turn invoice is still unpaid"
},
"invoice_rounding_precision" : {
"type" : "integer",
"description" : "The number of digits after decimal point for rounding"
},
"late_payment_fee" : {
"type" : "number",
"description" : "The service late payment fee"
},
"ot_bp_charge_cc" : {
"type" : "string",
"description" : "Enables customer's credit card auto-charge for Out-of-Turn invoices"
},
"suspend_on_insuff_funds" : {
"type" : "string",
"description" : "Suspend customer on insufficient funds for subscriptions"
},
"managed_by" : {
"type" : "string",
"description" : "The name of the reseller who manages the customer class"
},
"active_custom_fields" : {
"$ref" : "#/components/schemas/ArrayOfInt"
},
"purge_after_months" : {
"type" : "integer",
"description" : "Shows when customer personal data will be deleted. NULL - functionality is disabled, 0 - immediately, N - delete in N months"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller who manages the customer class"
},
"ot_charge_cc_on_generation" : {
"type" : "string",
"description" : "The flag shows whether to start charging the customer's credit card starting from the Out-of-Turn invoice due date"
},
"review_invoices" : {
"type" : "string",
"description" : "Send invoices via email after review and approval by admin"
},
"extra_invoice" : {
"type" : "string",
"description" : "Separate Invoice for Recurring Fees"
}
}
},
"DownloadCollectionSkippedXDRsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 in case of success, 0 in case of failure"
}
}
},
"NotificationTemplateVariableFormat" : {
"required" : [
"i_format"
],
"type" : "object",
"properties" : {
"format" : {
"type" : "string",
"description" : "Format of the variable"
},
"i_format" : {
"type" : "integer",
"description" : "The unique ID of the format of the variable"
},
"i_format_type" : {
"type" : "integer",
"description" : "The unique ID of the format type of the variable"
}
}
},
"UpdateCustomerClassNotificationCategoryListRequest" : {
"required" : [
"notification_category_list",
"i_customer_class"
],
"type" : "object",
"properties" : {
"notification_category_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerClassNotificationCategoryInfo"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
}
}
},
"GetAutoPaymentInfoRequest" : {
"required" : [
"i_object"
],
"type" : "object",
"properties" : {
"i_object" : {
"type" : "integer",
"description" : "The unique ID of an account or a customer. Not mandatory when the method that requires this structure is executed from the retail customer realm or the account realms"
}
}
},
"AddUpdateRepresentativeResponse" : {
"type" : "object",
"properties" : {
"i_rep" : {
"type" : "integer",
"description" : "The unique ID of the created/modified representative record"
}
}
},
"GetDestinationPrefixInfoResponse" : {
"type" : "object",
"properties" : {
"destination_info" : {
"$ref" : "#/components/schemas/DestinationPrefixInfo"
}
}
},
"GetVendorBatchListRequest" : {
"type" : "object",
"properties" : {
"country" : {
"type" : "string",
"description" : "ISO 3166 two-letter country code"
},
"area_code" : {
"type" : "string",
"description" : "Search pattern for area code"
},
"reserve_term" : {
"type" : "integer",
"description" : "The period in seconds during which a DID number is considered 'reserved' and thus the vendor batch that contains it must not be included in the result list. For example, if you send now the request with reserve_term property set to 60, then all the DID numbers that were reserved less than 60 seconds ago will not be included in the result list"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"owner_batch" : {
"type" : "integer",
"description" : "The unique ID of the pricing batch record; the list will include only those vendor batches containing DID numbers included in this particular pricing batch"
},
"name" : {
"type" : "string",
"description" : "The name of the vendor batch"
},
"description" : {
"type" : "string",
"description" : "The description of the vendor batch"
},
"get_did_total_usage" : {
"type" : "integer",
"description" : "Get the usage of DID numbers for each DID vendor batch in the response"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the DID vendor batch is in use"
},
"area_code_description" : {
"type" : "string",
"description" : "Search pattern for area code description"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"get_used" : {
"type" : "integer",
"description" : "If set to '1', the method returns only vendor batches that contain at least one used DID number"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"ArrangeFollowMeNumbersRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"numbers" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
}
}
},
"MeasuredMetricDataInfo" : {
"required" : [
"object",
"value_list",
"i_measured_metric",
"i_object"
],
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The type of object to which the addition of measurement data is applied. Possible values: 'account', 'customer'"
},
"value_list" : {
"$ref" : "#/components/schemas/ArrayOfMetricDataInfo"
},
"i_measured_metric" : {
"type" : "integer",
"description" : "The unique identifier of the measured metric"
},
"i_object" : {
"type" : "integer",
"description" : "The unique identifier of the object"
}
}
},
"GetExtendedDataListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of found records"
},
"list" : {
"$ref" : "#/components/schemas/ArrayOfExtendedDataRecordInfo"
}
}
},
"RepresentativeInfo" : {
"type" : "object",
"properties" : {
"firstname" : {
"type" : "string",
"description" : "The representative's first name"
},
"resellers_total" : {
"type" : "integer",
"description" : "The total number of resellers related to the representative"
},
"commission_plan_effective_from" : {
"type" : "string",
"description" : "The date and time when the commission plan was assigned"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code of the currency"
},
"out_date_format" : {
"type" : "string",
"description" : "Output format for date indication on customer's self-care interface"
},
"state" : {
"type" : "string",
"description" : "Province or state of the representative's address"
},
"email" : {
"type" : "string",
"description" : "Email address"
},
"password" : {
"type" : "string",
"description" : "The representative's password for self-care web interface"
},
"i_commission_plan" : {
"type" : "integer",
"description" : "The ID of the commission plan for this representative"
},
"out_date_time_format" : {
"type" : "string",
"description" : "Output format for full date/time indication"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the representative is in use"
},
"name" : {
"type" : "string",
"description" : "Name of the representative on the PortaBilling interface, unique in the environment"
},
"i_lang" : {
"type" : "string",
"description" : "Code for the representative's web language; refers to Languages table"
},
"login" : {
"type" : "string",
"description" : "The representative's login for self-care web interface"
},
"address_line_2" : {
"type" : "string",
"description" : "The 2nd line of the representative's address"
},
"zip" : {
"type" : "string",
"description" : "Postal (zip) code of the representative's address"
},
"in_date_format" : {
"type" : "string",
"description" : "Input format for date indication"
},
"balance" : {
"type" : "number",
"description" : "The balance of the representative's outstanding payout"
},
"phone1" : {
"type" : "string",
"description" : "Main phone number"
},
"i_time_zone" : {
"type" : "integer",
"description" : "ID for the representative's time zone; refers to Time_Zones table"
},
"phone2" : {
"type" : "string",
"description" : "Alternative phone number"
},
"salutation" : {
"type" : "string",
"description" : "The representative's salutation"
},
"cont1" : {
"type" : "string",
"description" : "Main contact person"
},
"midinit" : {
"type" : "string",
"description" : "The representative's middle initial(s)"
},
"customers_total" : {
"type" : "integer",
"description" : "The total number of customers related to the representative"
},
"lastname" : {
"type" : "string",
"description" : "The representative's last name"
},
"refnum" : {
"type" : "string",
"description" : "Reference number (custom field)"
},
"city" : {
"type" : "string",
"description" : "City of the representative's address"
},
"distributors_total" : {
"type" : "integer",
"description" : "The total number of distributors related to the representative"
},
"cont2" : {
"type" : "string",
"description" : "Alternative contact person"
},
"out_time_format" : {
"type" : "string",
"description" : "Output format for time indication"
},
"initials" : {
"type" : "string",
"description" : "Initials of the representative"
},
"country" : {
"type" : "string",
"description" : "Country of the representative's address"
},
"in_time_format" : {
"type" : "string",
"description" : "Input format for time indication"
},
"i_rep" : {
"type" : "integer",
"description" : "The unique ID of the representative record"
},
"notepad" : {
"type" : "string",
"description" : "Comments regarding this representative"
},
"faxnum" : {
"type" : "string",
"description" : "Fax number"
},
"tax_id" : {
"type" : "string",
"description" : "Tax ID"
},
"hidden" : {
"type" : "string",
"description" : "Hidden"
},
"i_acl" : {
"type" : "integer",
"description" : "ID for the representative's access level; refers to Access_Levels table"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of the reseller who manage this representative"
},
"companyname" : {
"type" : "string",
"description" : "The representative's company name"
},
"baddr1" : {
"type" : "string",
"description" : "1st line of the representative's address"
}
}
},
"GetDiscountInfoRequest" : {
"required" : [
"i_vd_dg"
],
"type" : "object",
"properties" : {
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the discount for a specific destination group"
},
"with_thresholds" : {
"type" : "integer",
"description" : "Specifies whether to retrieve thresholds for the discount"
}
}
},
"ActivateCustomerSubscriptionsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"ExemptionCodeInfo" : {
"required" : [
"name",
"code"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the exemption code"
},
"code" : {
"type" : "string",
"description" : "The exemption code"
}
}
},
"GetDeleteBundlePromotionRequest" : {
"required" : [
"i_bd_plan"
],
"type" : "object",
"properties" : {
"i_bd_plan" : {
"type" : "integer",
"description" : "The unique ID of the bundle promotion plan"
}
}
},
"ArrayOfTrafficProfileInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TrafficProfileInfo"
}
},
"MakeVendorTransactionRequest" : {
"required" : [
"i_vendor",
"amount",
"action"
],
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"i_service" : {
"type" : "integer",
"description" : "The service for which the manual charge/credit is made"
},
"date_inside_billing_period" : {
"type" : "string",
"description" : "A date associated with the manual charge/credit. For example, you can specify a date for the manual credit action when an item is credited"
},
"datetime_inside_billing_period" : {
"type" : "string",
"description" : "A date and time associated with the manual charge/credit. For example, you can specify a date for manual credit action for when an item is credited."
},
"internal_comment" : {
"type" : "string",
"description" : "An internal comment on this transaction; not visible in the xDR browser, and accessible only directly from the database "
},
"visible_comment" : {
"type" : "string",
"description" : "A comment on this transaction, visible to the vendor in the xDR browser"
},
"amount" : {
"type" : "number",
"description" : "The amount the vendor's balance will be increased/decreased by"
},
"action" : {
"type" : "string",
"description" : "One of the following: Manual Charge, Manual Credit, Manual Payment, Refund"
}
}
},
"ArrayOfDIDOwnerBatchInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DIDOwnerBatchInfo"
}
},
"DeleteRoutingCriteriaDestGroupRequest" : {
"required" : [
"i_criteria_dest_group"
],
"type" : "object",
"properties" : {
"i_criteria_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria destination group DB record"
}
}
},
"GetAccountUsedVdDestGroupListResponse" : {
"required" : [
"vd_dest_group_list"
],
"type" : "object",
"properties" : {
"vd_dest_group_list" : {
"$ref" : "#/components/schemas/ArrayOfVdDestGroup"
}
}
},
"ArrayOfZendeskOrganizationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ZendeskOrganizationInfo"
}
},
"UpdateCommissionPlanResponse" : {
"required" : [
"i_commission_plan"
],
"type" : "object",
"properties" : {
"i_commission_plan" : {
"type" : "integer",
"description" : "The unique ID of the commission plan"
}
}
},
"GetRPCategoryListRequest" : {
"required" : [
"i_routing_plan"
],
"type" : "object",
"properties" : {
"i_routing_plan" : {
"type" : "integer",
"description" : "The unique ID of the routing plan record"
}
}
},
"DeleteDestGroupRequest" : {
"required" : [
"i_dest_group"
],
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
}
}
},
"AddMeasuredMetricDataResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 in case of failure"
}
}
},
"CustomerSubscriptionInfo" : {
"type" : "object",
"properties" : {
"activation_date" : {
"type" : "string",
"description" : "Date when the subscription was activated"
},
"int_status" : {
"type" : "integer",
"description" : "Status of the subscription: 0 - pending, 1 - active, 2 - closed"
},
"generate_daily_charge" : {
"type" : "string",
"description" : "Specifies whether to keep the total charge only or to generate daily charges. Possible values: Y – Generate daily charges; N – Keep the total charge only"
},
"effective_fee" : {
"type" : "number",
"description" : "The amount of the periodic fee for the current billing period"
},
"discount_list" : {
"$ref" : "#/components/schemas/SubscriptionDiscountList"
},
"next_effective_fee" : {
"type" : "number",
"description" : "The amount of the periodic fee for the next billing period"
},
"i_discount_current" : {
"type" : "integer",
"description" : "The unique ID of the current period multi-months discount"
},
"i_customer_subscription" : {
"type" : "integer",
"description" : "The unique ID of the customer subscription record"
},
"i_subscription" : {
"type" : "integer",
"description" : "ID for subscription plan; refers to Subscriptions table"
},
"billed_to" : {
"type" : "string",
"description" : "Date to which subscription charges have already been applied"
},
"start_date" : {
"type" : "string",
"description" : "The desired subscription activation date (defined in the customer's timezone), if missed or provided undefined when a subscription record is created, subscription will start immediately otherwise should be greater or equal to the customer's today date; can be updated for pending subscriptions only"
},
"has_discount" : {
"type" : "integer",
"description" : "The flag shows whether the subscription has a discount assigned."
},
"is_finished" : {
"type" : "string",
"description" : "Indicates whether the subscription has been already closed"
},
"i_discount_next" : {
"type" : "integer",
"description" : "The unique ID of the next period multi-months discount"
},
"invoice_description" : {
"type" : "string",
"description" : "The subscription plan name that is visible to the end user"
},
"name" : {
"type" : "string",
"description" : "Name of the subscription plan, referenced by the i_subscription attribute"
},
"finish_date" : {
"type" : "string",
"description" : "Date when the subscription should be automatically canceled; if defined must be greater or equal to the start_date"
},
"rounding" : {
"type" : "integer",
"description" : "A pattern that defines the rounding of the amount charged for a billing period"
},
"discount_rate" : {
"type" : "number",
"description" : "Discount rate for the subsciption in percents; if missed or provided undefined, it means that the discount rate defined in the customer information should be applied"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"GetDialingRulesListRequest" : {
"type" : "object",
"properties" : {
"name_pattern" : {
"type" : "string",
"description" : "A pattern for the dialing rule name to search by"
},
"description" : {
"type" : "string",
"description" : "A pattern for the dialing rule description to search by"
},
"rule_type" : {
"type" : "string",
"description" : "Dialing rule type"
},
"with_tech_prefix" : {
"type" : "integer",
"description" : "For administrators the response may contain a special \"Tech Prefix\" dialing rule"
},
"restricted" : {
"type" : "string",
"description" : "Specifies whether the response should include dialing rules with or without restriction"
},
"with_internal" : {
"type" : "integer",
"description" : "Specifies whether predefined dialing rules should be included in the response"
},
"usage_type" : {
"type" : "string",
"description" : "Where this rule applies: 'D'- dialing rules, 'O'- outgoing connections, 'I'- incoming connections, 'IO' - incoming and outgoing connections"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the dialing rule is in use"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved dialing rules"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"SendLogToRTResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 on success, exception on failure"
}
}
},
"GetAccountSubscriptionsResponse" : {
"type" : "object",
"properties" : {
"subscriptions" : {
"$ref" : "#/components/schemas/ArrayOfAccountSubscriptionInfo"
}
}
},
"ResaleMapRecordInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the related service type"
},
"i_resale_tariff_mapping" : {
"type" : "integer",
"description" : "The unique ID of the tariff mapping record"
},
"markup_percent" : {
"type" : "number",
"description" : "Specifies a percentage markup for the resale tariff as compared with the wholesale tariff rates. Only used if the i_tariff_sell property is not provided"
},
"i_tariff_sell" : {
"type" : "integer",
"description" : "The unique ID of the resale tariff record (the one that the reseller charges their subresellers). If this property is not defined, a new resale tariff will be created as a copy of the reseller's wholesale tariff with the markup"
},
"buying_tariff_name" : {
"type" : "string",
"description" : "The name of the wholesale tariff record (according to which the reseller is billed by a higher level reseller or service provider)"
},
"description" : {
"type" : "string",
"description" : "The resale tariff description. Only used if the i_tariff_sell property is not defined"
},
"markup_fixed_amount" : {
"type" : "number",
"description" : "Specifies the fixed amount to be added to the resale tariff if (only if) the calculated percentage markup is lower than this one. Only used if the i_tariff_sell property is not provided"
},
"i_tariff_buy" : {
"type" : "integer",
"description" : "The unique ID of the wholesale tariff record (according to which the reseller is billed by a higher level reseller or service provider)"
},
"ex_rate" : {
"type" : "number",
"description" : "A custom exchange rate. If empty or not defined, the current exchange rate will be used. Only used if the i_tariff_sell property is not defined"
},
"currency" : {
"type" : "string",
"description" : "Shows the resale tariff currency"
},
"selling_tariff_name" : {
"type" : "string",
"description" : "The name of the resale tariff record (the one that the reseller charges their subresellers). Only used if the i_tariff_sell property is not defined"
},
"service_name" : {
"type" : "string",
"description" : "The name of the service"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller record"
}
}
},
"GetDIDNumberListRequest" : {
"type" : "object",
"properties" : {
"estimate_cost" : {
"$ref" : "#/components/schemas/EstimateDIDNumberCostInfo"
},
"number" : {
"type" : "string",
"description" : "Number search pattern"
},
"owner_batch" : {
"type" : "integer",
"description" : "Owner Batch ID"
},
"i_group" : {
"type" : "integer",
"description" : "The unique ID of the DID group"
},
"owner_batch_individual" : {
"type" : "string",
"description" : "Shows DID numbers with a specific value of the 'owner_batch_individual' field"
},
"number_list" : {
"$ref" : "#/components/schemas/ArrayOfRequestDIDNumberInfo"
},
"min_periodic_fee" : {
"type" : "number",
"description" : "Return DID numbers with the 'periodic_fee' field value >= than the value in this field"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the DID number is in use"
},
"max_activation_fee" : {
"type" : "number",
"description" : "Return DID numbers with the 'activation_fee' field value <= than the value in this field"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved DID numbers"
},
"limit" : {
"type" : "integer",
"description" : "Number of rows to retrieve"
},
"min_activation_fee" : {
"type" : "number",
"description" : "Return DID numbers with the 'activation_fee' field value >= than the value in this field"
},
"city_name" : {
"type" : "string",
"description" : "The area that numbers belong to"
},
"offset" : {
"type" : "integer",
"description" : "Result offset"
},
"country" : {
"type" : "string",
"description" : "An ISO 3166 two-letter country code. Use it with the “use_did_location” attribute"
},
"usage" : {
"type" : "string",
"description" : "I - Idle (assigned to neither an account nor a customer); U - Used (assigned to an account); F - Not used (idle and / or assigned to a customer, but not to an account); A - All (the default value); Z - Frozen (displayed on the administrator's DID inventory page only)"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor who owns the DID number"
},
"reserve_term" : {
"type" : "integer",
"description" : "Number of seconds to check for reservation. If number has been reserved more than reserve_term seconds ago (or not reserved at all) it will be fetched"
},
"area_code" : {
"type" : "string",
"description" : "The area code search pattern. Can be used only if the 'use_did_location' field in the request is absent or false"
},
"with_extended_info" : {
"type" : "integer",
"description" : "If the field is equal to 1, the method returns the following fields: vendor_name, reseller_name, customer_name, country_name"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who owns the DID Number"
},
"start_number" : {
"type" : "string",
"description" : "Starting DID number. This field is used to get a list starting with a specific template or a specific DID number. For example: to get a list starting from number 123001 for list (..., 123000, 123001, 123002, ...), enter 123001 in this field."
},
"external" : {
"type" : "integer",
"description" : "Return DID numbers: 1 - received from an external DID provider, 0 - uploaded to the system manually"
},
"description" : {
"type" : "string",
"description" : "The description search pattern. Use it with the \"use_did_location\" attribute. To change the description, use the update_number or update_number_list API methods or provide the required description via the user interface"
},
"i_dv_batch" : {
"type" : "integer",
"description" : "The unique ID of the vendor batch this DID belongs to"
},
"format" : {
"type" : "string",
"description" : "This parameter enables the user to get DID numbers in other formats via an attachment. Possible values: 'csv', 'xls', 'xlsx'"
},
"area_code_description" : {
"type" : "string",
"description" : "The area code description search pattern. Can be used only if the 'use_did_location' field in the request is absent or false"
},
"available_to_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer to return available DID numbers for"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer who owns the DID number"
},
"max_periodic_fee" : {
"type" : "number",
"description" : "Return DID numbers with the 'periodic_fee' field value <= than the value in this field"
},
"use_did_location" : {
"type" : "integer",
"description" : "If set, use the DID Numbers country and description to search by"
}
}
},
"ProductRolesInfo" : {
"required" : [
"i_account_role",
"name"
],
"type" : "object",
"properties" : {
"i_account_role" : {
"type" : "integer",
"description" : "The role id"
},
"name" : {
"type" : "string",
"description" : "Role name"
},
"realm" : {
"type" : "string",
"description" : "The name of the realm"
}
}
},
"UpdateTemplateResponse" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
}
}
},
"GetNotificationListResponse" : {
"type" : "object",
"properties" : {
"notification_list" : {
"$ref" : "#/components/schemas/ArrayOfNotificationInfo"
}
}
},
"AddUpdateCallQueueResponse" : {
"required" : [
"i_c_queue"
],
"type" : "object",
"properties" : {
"i_c_queue" : {
"type" : "integer",
"description" : "The unique ID of the call queue record"
}
}
},
"ArrayOfDiscountInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DiscountInfo"
}
},
"ArrayOfTaxPluginInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TaxPluginInfo"
}
},
"DeleteConnectionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"DeleteCurrencyResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"GetRetailCustomerXDRQualityInfoRequest" : {
"required" : [
"id"
],
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "ID of the XDR record"
}
}
},
"AddUpdateCustomTaxOptionRequest" : {
"required" : [
"custom_tax_option"
],
"type" : "object",
"properties" : {
"custom_tax_option" : {
"$ref" : "#/components/schemas/CustomTaxOptionInfo"
}
}
},
"ArrayOfCCStaffInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CCStaffInfo"
}
},
"GetVendorXDRListRequest" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"cli" : {
"type" : "string",
"description" : "The calling line phone number"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of service, refers to the Services table"
},
"connect_time_before" : {
"type" : "string",
"description" : "Get xDRs with connect_time before this date"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved xDRs"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"connect_time_after" : {
"type" : "string",
"description" : "Get xDRs with connect_time after this date"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"to_date" : {
"type" : "string",
"description" : "Get xDRs with bill_time before this date"
},
"show_unsuccessful" : {
"type" : "integer",
"description" : "If set to 1, the list of unsuccessful attempt xDRs will be provided in the response"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"history" : {
"type" : "string",
"description" : "Specifies, whether to show xDRs with 'history' that matches the pattern"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"from_date" : {
"type" : "string",
"description" : "Get xDRs with bill_time starting from this date"
},
"call_id" : {
"type" : "string",
"description" : "The unique identifier of the call"
},
"show_hidden" : {
"type" : "integer",
"description" : "If set to 1, the list of hidden xDRs will be provided in the response"
},
"format" : {
"type" : "string",
"description" : "This parameter enables the user to get xDRs in other formats via a SOAP attachment. Currently only the \"csv\" format is supported"
},
"cld" : {
"type" : "string",
"description" : "The called line phone number"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The unique identifier of the session"
}
}
},
"GetMarketingGroupListRequest" : {
"type" : "object",
"properties" : {
"get_external_groups" : {
"type" : "integer",
"description" : "This flag indicates whether local groups or groups from the CoSS server should be returned"
},
"name" : {
"type" : "string",
"description" : "Marketing group name pattern"
},
"id" : {
"type" : "string",
"description" : "Marketing group code pattern"
}
}
},
"RegisterTransactionResponse" : {
"type" : "object",
"properties" : {
"transaction" : {
"$ref" : "#/components/schemas/TransactionInfo"
}
}
},
"DeleteCallQueueRequest" : {
"required" : [
"i_c_queue"
],
"type" : "object",
"properties" : {
"i_c_queue" : {
"type" : "integer",
"description" : "The unique ID of the call queue record to be deleted"
}
}
},
"GetChargeMethodsListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Enables retrieving the charge methods list by name"
}
}
},
"RouteCategoryInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Shows whether the route category is in use"
},
"i_route_category" : {
"type" : "integer",
"description" : "The unique ID of the route category DB record"
},
"name" : {
"type" : "string",
"description" : "The name of the route category"
},
"default" : {
"type" : "string",
"description" : "Shows whether the route category is default. Possible values: 'Y', 'N'"
},
"description" : {
"type" : "string",
"description" : "The route category record description"
}
}
},
"ListMerchantAccountsRequest" : {
"type" : "object",
"properties" : {
"remittance" : {
"type" : "integer",
"description" : "Specifies whether to show payment remittance systems"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique Customer ID to list payment systems for"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"CSetGroupInfo" : {
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"name" : {
"type" : "string",
"description" : "The destination group name"
},
"default" : {
"type" : "integer",
"description" : "Shows whether the destination group is the default one for the related set"
},
"description" : {
"type" : "string",
"description" : "The destination group description"
},
"group_level" : {
"type" : "integer",
"description" : "The depth of the destination group subtree"
},
"parent_i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the parent destination group"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set to which the current destination group belongs"
},
"used" : {
"type" : "integer",
"description" : "Shows whether the destination group set is in use"
},
"empty" : {
"type" : "integer",
"description" : "Shows whether the destination group set is empty"
}
}
},
"TemplateComponentInfo" : {
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"comp_name" : {
"type" : "string",
"description" : "The name of the component's type"
},
"editor_order" : {
"type" : "integer",
"description" : "Defines the position of the component in the editor"
},
"handler" : {
"type" : "string",
"description" : "The handler for the component"
},
"i_component_type" : {
"type" : "integer",
"description" : "The unique ID of the component's type"
},
"i_template_component" : {
"type" : "integer",
"description" : "The unique ID of the component"
}
}
},
"ProcessCollectionResponse" : {
"required" : [
"success",
"result_list"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 on success, exception on failure"
},
"result_list" : {
"$ref" : "#/components/schemas/ArrayOfXDRCollectionInfo"
}
}
},
"GetRetailCustomerSWXDRListRequest" : {
"required" : [
"from_date",
"i_customer",
"to_date"
],
"type" : "object",
"properties" : {
"with_aux_xdrs" : {
"type" : "integer",
"description" : "Includes the array of auxiliary xDRs to the retrieved XDRs list"
},
"history_pattern" : {
"type" : "string",
"description" : "Specifies whether to show xDRs with history that matches the pattern"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"with_usage" : {
"type" : "integer",
"description" : "Include usage records to the retrieved XDRs list"
},
"from_date" : {
"type" : "string",
"description" : "Get xDRs with bill_time starting from this date"
},
"connect_time_before" : {
"type" : "string",
"description" : "Get xDRs with connect_time before this date"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved xDRs"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"connect_time_after" : {
"type" : "string",
"description" : "Get xDRs with connect_time after this date"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"to_date" : {
"type" : "string",
"description" : "Get XDRs with bill_time before this date"
}
}
},
"GetCustomFieldsSchemaResponse" : {
"type" : "object",
"properties" : {
"custom_fields" : {
"$ref" : "#/components/schemas/ArrayOfCustomFieldsInfo"
}
}
},
"ChargeAccountSubscriptionFeesRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record to be charged"
},
"immediately_in_advance" : {
"type" : "integer",
"description" : "Amount of periods that should be charged in advance"
}
}
},
"AccountTraceXdrRequest" : {
"type" : "object",
"properties" : {
"trace" : {
"type" : "integer",
"description" : "The flag shows whether to add XDR to the list of tracing XDRs. Enabled by default"
},
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the XDR record"
},
"failed" : {
"type" : "integer",
"description" : "The flag shows whether to check failed XDRs"
}
}
},
"GetPromptFileRequest" : {
"required" : [
"codec",
"i_prompt"
],
"type" : "object",
"properties" : {
"codec" : {
"type" : "string",
"description" : "Name of codec, by which file in response was encoded"
},
"handler" : {
"type" : "string",
"description" : "Name of the handler to be used for fetching the prompt. Possible values: 'dial_by_name', 'audio_file'"
},
"i_prompt" : {
"type" : "integer",
"description" : "ID of requested Prompt"
},
"description_only" : {
"type" : "integer",
"description" : "Non-zero value means that the method should not attach a prompt file"
}
}
},
"GetAclListResponse" : {
"required" : [
"acl_list"
],
"type" : "object",
"properties" : {
"acl_list" : {
"$ref" : "#/components/schemas/ArrayOfAclInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of found ACLs"
}
}
},
"ExtensionsInfo" : {
"type" : "object",
"properties" : {
"cont1" : {
"type" : "string",
"description" : "Main contact person"
},
"firstname" : {
"type" : "string",
"description" : "Account's first name"
},
"midinit" : {
"type" : "string",
"description" : "Account's middle initial(s)"
},
"i_customer_of_account" : {
"type" : "integer",
"description" : "The unique ID of the customer – owner of these accounts"
},
"primary_i_c_group" : {
"type" : "integer",
"description" : "The unique ID of the huntgroup that is set for this extension as primary. Returns an empty string if this extension doesn't have a primary extension assigned"
},
"lastname" : {
"type" : "string",
"description" : "Account's last name"
},
"prompt_error" : {
"type" : "string",
"description" : "A description of the last processing error"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record (for type = Account). Can only be a regular account, not an alias. For linked customers the account can belong to both current Branch Office (site) customer or the Main Office (HQ) customer which is linked with it"
},
"primary_group_id" : {
"type" : "integer",
"description" : "The number of the huntgroup that is set for this extension as primary. Returns an empty string if this extension doesn't have a primary extension assigned"
},
"ip_phone_name" : {
"type" : "string",
"description" : "IP phone model"
},
"hunt_keep_original_cli" : {
"type" : "string",
"description" : "Specifies whether to keep the original CLI; one of the following: 'Y' – The call is redirected with the phone number and name of the original caller; 'N' – The call is redirected with the phone number and name of the huntgroup; 'I' – ID only, the call is redirected with the phone number of the original caller and name of the huntgroup"
},
"hunt_sequence" : {
"type" : "string",
"description" : "The ringing strategy; One of the following: Order, Random, Simultaneous, LeastUsed"
},
"primary_group_name" : {
"type" : "string",
"description" : "The name of the huntgroup that is set for this extension as primary. Returns an empty string if this extension doesn't have a primary extension assigned"
},
"id" : {
"type" : "string",
"description" : "The extension identifier used in dialing"
},
"group_name" : {
"type" : "string",
"description" : "Group name"
},
"i_prompt" : {
"type" : "integer",
"description" : "The unique ID of the assigned prompt file"
},
"i_c_ext" : {
"type" : "integer",
"description" : "Extension ID; Refers to the Centrex_Group_Extensions table"
},
"bill_status" : {
"type" : "string",
"description" : "Possible values: O – The account is open, I – The account is inactive, C – The account is terminated"
},
"name" : {
"type" : "string",
"description" : "The name of the extension / owner"
},
"prompt_name" : {
"type" : "string",
"description" : "The name of the prompt file"
},
"account_id" : {
"type" : "string",
"description" : "Account name"
},
"published" : {
"type" : "string",
"description" : "When creating an extension you can mark it as \"published\" so that it is included in the dial-by-name directory. One of the following: Y – Makes an extensions accessible via dial-by-name; N – Excludes a certain extension from being accessible via dial-by-name (e.g. you do not want telemarketers to directly reach your CEO or CFO because their names are publicly accessible)"
},
"i_c_group" : {
"type" : "integer",
"description" : "The unique ID of the group record (for type = Group)"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"type" : {
"type" : "string",
"description" : "One of the following: Account, Group, Unassigned"
},
"prompt_status" : {
"type" : "string",
"description" : "The prompt file processing status. Possible values: IN_PROGRESS, ERROR, FINISHED)"
}
}
},
"ObtainDIDNumberRequest" : {
"required" : [
"number"
],
"type" : "object",
"properties" : {
"number" : {
"type" : "string",
"description" : "DID Number"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"CleanUpInactiveRatesResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if the operation is successful, 0 if not"
}
}
},
"ArrayOfSpendingCounterInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SpendingCounterInfo"
}
},
"GetAccountVDCounterListRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"service_name" : {
"type" : "string",
"description" : "Service name pattern"
},
"peak_level" : {
"type" : "integer",
"description" : "ID of the Peak Level (0 - Peak Period, 1 - Off-Peak Period, 2 - 2nd Off-Peak Period)"
},
"detailed_info" : {
"type" : "integer",
"description" : "Detailed information"
},
"dg_name" : {
"type" : "string",
"description" : "Destination group name pattern"
}
}
},
"SessionLogInfo" : {
"type" : "object",
"properties" : {
"meta_info" : {
"$ref" : "#/components/schemas/SessionLogMetaInfo"
},
"log_message_list" : {
"$ref" : "#/components/schemas/ArrayOfSessionLogMessage"
}
}
},
"GetAccountCustomFieldsValuesRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
}
}
},
"ArrayOfInvoiceStatusInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/InvoiceStatusInfo"
}
},
"AddRoutingCriteriaDestGroupResponse" : {
"required" : [
"i_criteria_dest_group"
],
"type" : "object",
"properties" : {
"i_criteria_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria destination group DB record"
}
}
},
"ReportFileInfo" : {
"required" : [
"file_name"
],
"type" : "object",
"properties" : {
"file_name" : {
"type" : "string",
"description" : "The file name"
}
}
},
"ArrayOfConnectionTypeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ConnectionTypeInfo"
}
},
"GetLocaleLanguagesListRequest" : {
"type" : "object"
},
"GetNodeInfoRequest" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the node is in use"
},
"i_node" : {
"type" : "integer",
"description" : "The unique ID of the node"
}
}
},
"GetServiceAndRatingInfoResponse" : {
"type" : "object",
"properties" : {
"service_and_rating_info" : {
"$ref" : "#/components/schemas/ServiceAndRatingInfo"
}
}
},
"GetAccessRoleListResponse" : {
"required" : [
"access_roles"
],
"type" : "object",
"properties" : {
"access_roles" : {
"$ref" : "#/components/schemas/ArrayOfAccessRoleInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the access roles"
}
}
},
"EstimatedTax" : {
"required" : [
"amount",
"level_name",
"name",
"type"
],
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Estimated or calculated tax for provided xDRs"
},
"level_name" : {
"type" : "string",
"description" : "Tax name. Possible values for the EZtax (formerly known as BillSoft EZtax) plug-in: Federal; State; County; City; Un-incorporated. Possible values for Suretax: Federal; State; County; City; Local; Reporting Agency. Possible values for VAT: VAT. Possible values for GST: GST. Or specify a custom name of tax if you use a different one"
},
"name" : {
"type" : "string",
"description" : "N% for VAT or the name of tax for custom tax"
},
"type" : {
"type" : "string",
"description" : "The name of the plugin that was used for tax estimation"
}
}
},
"GetPreferableAccountListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The number of the retrieved frequently used accounts"
},
"preferable_account_list" : {
"$ref" : "#/components/schemas/ArrayOfPreferableAccountInfo"
}
}
},
"UpdateRoutingCriteriaDestGroupResponse" : {
"required" : [
"i_criteria_dest_group"
],
"type" : "object",
"properties" : {
"i_criteria_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria destination group DB record"
}
}
},
"GetWebLogListResponse" : {
"required" : [
"web_log_list"
],
"type" : "object",
"properties" : {
"web_log_list" : {
"$ref" : "#/components/schemas/ArrayOfWebLogInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of web log records"
}
}
},
"VoiceQualityMetricDataInfo" : {
"type" : "object",
"properties" : {
"sample_rate" : {
"type" : "number",
"description" : "The field provides the rate at which the voice was sampled, measured in Hertz (Hz)"
},
"payload_desc" : {
"type" : "string",
"description" : "A text description of the codec"
},
"silence_suppression_state" : {
"type" : "integer",
"description" : "The field indicates whether silence suppression, also known as Voice Activity Detection (VAD), is enabled for the identified session"
},
"inter_arrival_jitter" : {
"type" : "integer",
"description" : "The parameter is expressed in milliseconds; related to quality"
},
"direction" : {
"type" : "string",
"description" : "The direction of the call (incoming, outgoing)"
},
"remote_address" : {
"type" : "string",
"description" : "The field provides the IP address, port, and SSRC of the session peer from the perspective of the remote endpoint measuring performance"
},
"mos_cq" : {
"type" : "number",
"description" : "The parameter is the estimated mean opinion score for conversation voice quality on a scale from 1 to 5, in which 5 represents excellent and 1 represents unacceptable; related to quality"
},
"round_trip_delay" : {
"type" : "integer",
"description" : "The parameter is expressed in milliseconds; related to quality"
},
"local_address" : {
"type" : "string",
"description" : "The field provides the IP address, port, and synchronization source (SSRC) for the session from the perspective of the endpoint that is measuring performance. The IPAddress MAY be in IPv4 or IPv6 format"
},
"packet_loss" : {
"type" : "integer",
"description" : "The value corresponds to \"loss rate\" in RFC, related to quality"
},
"party_id" : {
"type" : "string",
"description" : "The party number (ANI or DNIS)"
},
"payload_type" : {
"type" : "integer",
"description" : "The payload type, codec. IANA-registered type"
},
"ptime" : {
"type" : "integer",
"description" : "The field reflects the amount of voice content in each frame within the RTP payload, measured in milliseconds"
},
"quality" : {
"type" : "string",
"description" : "The call quality. Possible values: good, fair, poor, unknown"
}
}
},
"RateGetRateMatchModeInfoRequest" : {
"required" : [
"i_rate_match_mode"
],
"type" : "object",
"properties" : {
"i_rate_match_mode" : {
"type" : "integer",
"description" : "The unique ID of the rate match mode record"
}
}
},
"GetAccountPaymentMethodInfoResponse" : {
"type" : "object",
"properties" : {
"payment_method_info" : {
"$ref" : "#/components/schemas/AccountPaymentMethodInfo"
}
}
},
"ConnectionTypeInfo" : {
"type" : "object",
"properties" : {
"i_connection_type" : {
"type" : "integer",
"description" : "The unique ID of the connection type"
},
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"name" : {
"type" : "string",
"description" : "The name of the connection type"
},
"leg_type" : {
"type" : "integer",
"description" : "The numeric identification of the leg type (the meaning depends on the service type: for VOICE CALLS, 0 - Telephony, 1 - VoIP; for messaging it's always 0)"
},
"transport_code" : {
"type" : "string",
"description" : "The internal unique identifier used for connection matching"
},
"technology" : {
"type" : "string",
"description" : "The technology used to perform the transport"
},
"transport_protocol" : {
"type" : "string",
"description" : "The protocol used to perform the transport"
},
"leg_origin" : {
"type" : "integer",
"description" : "The numeric identification of the origin (the meaning depends on the service type: for VOICE CALLS, 0 - originate, 1 - answer; for messaging, 0 - outgoing message, 1 - incoming message)"
}
}
},
"GetAccessNumberInfoResponse" : {
"required" : [
"access_number_info"
],
"type" : "object",
"properties" : {
"access_number_info" : {
"$ref" : "#/components/schemas/AccessNumberInfo"
}
}
},
"BatchAddRateRequest" : {
"required" : [
"rate_list"
],
"type" : "object",
"properties" : {
"rate_list" : {
"$ref" : "#/components/schemas/ArrayOfRateInfo"
}
}
},
"ArrayOfSIMCardInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SIMCardInfo"
}
},
"ArrayOfCSetGroupInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CSetGroupInfo"
}
},
"ArrayBillingPeriodInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BillingPeriodInfo"
}
},
"ArrayOfSubscriptionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SubscriptionInfo"
}
},
"DeleteCustomerSiteRequest" : {
"required" : [
"i_customer_site"
],
"type" : "object",
"properties" : {
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of a customer site"
}
}
},
"DeleteAccountPaymentMethodRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "ID of account record"
}
}
},
"GetPaymentProcessorRequest" : {
"required" : [
"i_online_payment_processor"
],
"type" : "object",
"properties" : {
"i_online_payment_processor" : {
"type" : "integer",
"description" : "The unique payment processor ID"
}
}
},
"ArrayOfBundlePromotionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BundlePromotionInfo"
}
},
"GetCustomFieldInfoResponse" : {
"type" : "object",
"properties" : {
"custom_field_info" : {
"$ref" : "#/components/schemas/CustomFieldsInfo"
}
}
},
"AccountGetRoutingOptionsRequest" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product"
}
}
},
"GetCallRecordingRequest" : {
"required" : [
"i_xdr"
],
"type" : "object",
"properties" : {
"call_recording_id" : {
"type" : "string",
"description" : "The ID of the call recording record"
},
"i_xdr" : {
"type" : "integer",
"description" : "ID of XDR record"
}
}
},
"UpdateAccountPaymentMethodResponse" : {
"required" : [
"i_credit_card"
],
"type" : "object",
"properties" : {
"i_credit_card" : {
"type" : "integer",
"description" : "ID of modified payment method record"
}
}
},
"ApplyInvoiceAdjustmentResponse" : {
"required" : [
"i_invoice"
],
"type" : "object",
"properties" : {
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"DeleteServicePolicyResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"GetRateInfoResponse" : {
"type" : "object",
"properties" : {
"rate_info" : {
"$ref" : "#/components/schemas/RateInfo"
}
}
},
"DestinationDeleteCSetGroupRequest" : {
"required" : [
"i_dest_group"
],
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
}
}
},
"UpdateFollowMeNumberListRequest" : {
"type" : "object",
"properties" : {
"followme_numbers" : {
"$ref" : "#/components/schemas/ArrayOfFollowMeNumberInfo"
}
}
},
"DeleteCCStaffResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"DeleteCPRuleResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "One of the following: 1 – success, 0 – failed"
}
}
},
"UpdateIvrApplicationRequest" : {
"required" : [
"ivr_application_info"
],
"type" : "object",
"properties" : {
"ivr_application_info" : {
"$ref" : "#/components/schemas/IvrApplicationInfo"
}
}
},
"DIDRequestParameters" : {
"type" : "object",
"properties" : {
"area_name" : {
"type" : "string",
"description" : "Area name"
},
"city_id" : {
"type" : "integer",
"description" : "Unique city ID number"
},
"country_name" : {
"type" : "string",
"description" : "Country name"
},
"number" : {
"type" : "string",
"description" : "DID number"
},
"area_prefix" : {
"type" : "string",
"description" : "Area prefix"
},
"country_id" : {
"type" : "integer",
"description" : "The unique ID of the country record"
},
"country_iso" : {
"type" : "string",
"description" : "Country ISO code"
},
"city_prefix" : {
"type" : "string",
"description" : "City prefix"
},
"i_did_provider" : {
"type" : "integer",
"description" : "The unique ID of the DID provider record"
},
"country_prefix" : {
"type" : "string",
"description" : "Country prefix"
}
}
},
"GetConnectionDestinationGroupListRequest" : {
"required" : [
"i_connection"
],
"type" : "object",
"properties" : {
"i_connection" : {
"type" : "integer",
"description" : "The unique identifier of the connection"
}
}
},
"DeleteDIDGroupResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception or 0 for failure"
}
}
},
"DeleteEmergencyUnitResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "The result of deleting an emergency routing unit. 1 for success"
}
}
},
"GetAccountCustomFieldsValuesResponse" : {
"type" : "object",
"properties" : {
"custom_fields_values" : {
"$ref" : "#/components/schemas/ArrayOfCustomFieldsValuesInfo"
}
}
},
"ArrayOfRoamingProfileInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RoamingProfileInfo"
}
},
"DeleteCriterionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 – The bundle promotion criteria are successfully deleted. 0 – The bundle promotion criteria have not been deleted."
}
}
},
"AddResaleTariffMappingsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"GenericGetNotificationTemplateVariableFormatListRequest" : {
"type" : "object",
"properties" : {
"i_format_type" : {
"type" : "integer",
"description" : "The unique ID of the format type of the variable"
}
}
},
"EnableApiNotificationsAccountResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation has been successfully completed"
}
}
},
"AddMarketingGroupResponse" : {
"type" : "object",
"properties" : {
"i_marketing_group" : {
"type" : "integer",
"description" : "The ID of the marketing group"
}
}
},
"GetAccountStateResponse" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "integer",
"description" : "The state of the account. Possible values: 0 – ACTIVE, 1 – SCREENED – Allow calls only via the Screening IVR, 2 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user once, 3 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user twice, 4 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user three times, 5 – QUARANTINED – Disallow all calls"
}
}
},
"ArrayOfVendorPerServiceInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VendorPerServiceInfo"
}
},
"ArrayOfMerchantAccounts" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MerchantAccount"
}
},
"ArrayOfTimePeriodDefinitionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ArrayOfSubPeriodInfo"
}
},
"DeleteRPCategoryResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"AddServicePolicyRequest" : {
"required" : [
"service_policy_info"
],
"type" : "object",
"properties" : {
"service_policy_info" : {
"$ref" : "#/components/schemas/ServicePolicyInfo"
}
}
},
"Discounts" : {
"type" : "object",
"properties" : {
"alter_service" : {
"type" : "string",
"description" : "This property is only available for services based on the Internet Access service type. In this case, when the discount period is active and the threshold has been crossed, the level of service provided can also be adjusted.The possible values are: l – limited, b – blocked, The nill flag sets to norestriction"
},
"notify_if_exceeded" : {
"type" : "string",
"description" : "Specifies whether to send an email notification to the customer when the threshold is crossed and the discount no longer applies"
},
"threshold" : {
"type" : "number",
"description" : "The threshold value is measured either in currency units or time units (minutes), according to the type of discount. Will show \"0\" for unlimited"
},
"xdr_split" : {
"type" : "string",
"description" : "When a session spans several rating periods (e.g. covers both peak and off-peak periods) it is divided into portions. This property specifies whether multiple xDR records will be produced for sessions like this one. Each xDR record will be linked to the applicable discount level / rate"
},
"discount" : {
"type" : "number",
"description" : "The percentage discount value must be numeric (with a period allowed) in the 0 – 100 range. A 0% discount means \"standard rate applied,\" while a 100% discount means \"free call\""
}
}
},
"GetPayRequiredInvoicesSummaryRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"with_last_payment_info" : {
"type" : "integer",
"description" : "Returns extra information about the last payment applied to an invoice"
},
"i_customer" : {
"type" : "integer",
"description" : "Refers to the record of a customer"
},
"with_last_invoice_info" : {
"type" : "integer",
"description" : "Returns extra information about the last issued invoice"
}
}
},
"GetIvrApplicationListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the IVR application"
},
"description" : {
"type" : "string",
"description" : "The description of the IVR application"
},
"with_callbacks" : {
"type" : "integer",
"description" : "Specifies whether the WEB, SMS, Email callbacks should be included in the response. If set to 1, External callbacks will be added to the response. The default value is 0, which means the response will not contain these records"
},
"i_voice_application" : {
"type" : "integer",
"description" : "The ID of the corresponding voice application"
},
"number_pattern" : {
"type" : "string",
"description" : "The pattern for matching the CLD of the assigned access numbers"
},
"get_total" : {
"type" : "integer",
"description" : "Include the total number of records"
},
"limit" : {
"type" : "integer",
"description" : "The number of records to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of records to skip at the beginning"
}
}
},
"GetVersionResponse" : {
"required" : [
"version"
],
"type" : "object",
"properties" : {
"version" : {
"type" : "string",
"description" : "PortaBilling version"
}
}
},
"DIDCountryInfo" : {
"required" : [
"name",
"id"
],
"type" : "object",
"properties" : {
"req_params" : {
"$ref" : "#/components/schemas/DIDRequestParameters"
},
"name" : {
"type" : "string",
"description" : "Country name"
},
"id" : {
"type" : "integer",
"description" : "The consecutive country number in the list"
},
"prefix" : {
"type" : "string",
"description" : "Country prefix"
}
}
},
"GetTaxPluginCodesListRequest" : {
"required" : [
"i_billing_processor"
],
"type" : "object",
"properties" : {
"i_billing_processor" : {
"type" : "integer",
"description" : "The ID of the billing processor"
},
"object" : {
"type" : "string",
"description" : "The name of the entity to return taxation plugin codes for. Possible values: \"customer\" and \"env\""
}
}
},
"DeleteVDThresholdRequest" : {
"required" : [
"i_vd_threshold"
],
"type" : "object",
"properties" : {
"i_vd_threshold" : {
"type" : "integer",
"description" : "The unique ID of a threshold to be deleted from a specific discount"
}
}
},
"AddAccessPolicyRequest" : {
"required" : [
"access_policy_info"
],
"type" : "object",
"properties" : {
"access_policy_info" : {
"$ref" : "#/components/schemas/AccessPolicyInfo"
}
}
},
"UploadEmergencyUnitsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"ArrayOfNodeTypeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NodeTypeInfo"
}
},
"GetBusinessModelsListResponse" : {
"type" : "object",
"properties" : {
"business_models" : {
"$ref" : "#/components/schemas/ArrayOfBusinessModelInfo"
}
}
},
"GetTimeZoneInfoRequest" : {
"required" : [
"i_time_zone"
],
"type" : "object",
"properties" : {
"i_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the time zone"
}
}
},
"GetDefaultCustomerClassResponse" : {
"type" : "object",
"properties" : {
"customer_class_info" : {
"$ref" : "#/components/schemas/CustomerClassInfo"
}
}
},
"GetSupportedLanguageResponse" : {
"required" : [
"supported_language_list"
],
"type" : "object",
"properties" : {
"supported_language_list" : {
"$ref" : "#/components/schemas/ArrayOfSupportedLanguageInfo"
}
}
},
"CSetGroupTreeNode" : {
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"name" : {
"type" : "string",
"description" : "The destination group name"
},
"default" : {
"type" : "integer",
"description" : "Shows whether the destination group is the default one for the related set"
},
"description" : {
"type" : "string",
"description" : "The destination group description"
},
"group_level" : {
"type" : "integer",
"description" : "The depth of the destination group subtree"
},
"parent_i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the parent destination group"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set to which the current destination group belongs"
},
"used" : {
"type" : "integer",
"description" : "Shows whether the destination group set is in use"
},
"empty" : {
"type" : "integer",
"description" : "Shows whether the destination group set is empty"
},
"destination_groups" : {
"$ref" : "#/components/schemas/ArrayOfCSetGroupTreeNode"
}
}
},
"TimeZoneInfo" : {
"type" : "object",
"properties" : {
"time_zone_name" : {
"type" : "string",
"description" : "A commonly used name of the time zone"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the time zone"
}
}
},
"UpdateNegotiatedFeatureListRequest" : {
"required" : [
"negotiated_feature_list",
"object"
],
"type" : "object",
"properties" : {
"negotiated_feature_list" : {
"$ref" : "#/components/schemas/ArrayOfNegotiatedFeatureInfo"
},
"object" : {
"type" : "string",
"description" : "The entity the negotiated features belong to. Possible values: connection, routing_plan"
},
"i_object" : {
"type" : "integer",
"description" : "The unique ID of a routing plan or connection"
}
}
},
"CreateOtpRequest" : {
"required" : [
"notification_type",
"send_to"
],
"type" : "object",
"properties" : {
"email" : {
"type" : "string",
"description" : "The e-mail for the fake type requestor entity"
},
"notification_type" : {
"type" : "string",
"description" : "The email/mobile notification type of the requestor. Possible values: mail, sms"
},
"send_to" : {
"type" : "string",
"description" : "The requestor entity. Possible values: account, customer, repr, user, vendor, reseller, fake"
},
"id" : {
"type" : "integer",
"description" : "The unique ID of the requestor entity"
},
"operation" : {
"type" : "string",
"description" : "A unique operation name that requires an additional ID for access"
},
"phone" : {
"type" : "string",
"description" : "The phone number for the fake type requestor entity"
}
}
},
"ArrayOfEstimatedDIDNumberPricingParameterInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EstimatedDIDNumberPricingParameterInfo"
}
},
"GetResaleMapRecordRequest" : {
"required" : [
"i_resale_tariff_mapping"
],
"type" : "object",
"properties" : {
"i_resale_tariff_mapping" : {
"type" : "integer",
"description" : "The unique ID of the tariff mapping record"
}
}
},
"UpdateCPConditionResponse" : {
"required" : [
"i_cp_condition"
],
"type" : "object",
"properties" : {
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the call screening condition rule"
}
}
},
"GetDIDCountriesListRequest" : {
"type" : "object",
"properties" : {
"did_provider_info" : {
"$ref" : "#/components/schemas/CustomerDIDProviderIdent"
},
"for_idle_numbers_only" : {
"type" : "string",
"description" : "Get the list of countries by numbers in the DID Pool, By default - N"
}
}
},
"GetCreditLimitHistoryRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"ProductGetServiceFeaturesMetaInfoRequest" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"addon_priority" : {
"type" : "integer",
"description" : "The addon priority"
},
"with_localization" : {
"type" : "integer",
"description" : "The flag shows whether to localize options using the language selected on the web interface"
},
"array_mode" : {
"type" : "integer",
"description" : "The flag shows whether to pack the response into service_features or return raw subtypes"
},
"full_list" : {
"type" : "integer",
"description" : "The flag shows whether to return all the available information"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"GetCustomerListRequest" : {
"required" : [
"limit",
"offset"
],
"type" : "object",
"properties" : {
"firstname" : {
"type" : "string",
"description" : "Customer's first name"
},
"skip_exported" : {
"type" : "integer",
"description" : "Specifies whether the customers with 'bill_status'='E' should be excluded from the response"
},
"invoicing_enabled" : {
"type" : "integer",
"description" : "Filters customer list by their invoicing status. Possible values: 1 - Invoicing enabled; 0 - Invoicing disabled"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for currency in which the customer is billed"
},
"i_parent" : {
"type" : "integer",
"description" : "The unique ID of the reseller who manages the customer"
},
"credit_limit_exceeded" : {
"type" : "integer",
"description" : "Include into the response only the customers who exceeded their credit limit. Possible values: 1 - Credit limit exceeded; 0 - Credit limit not exceeded"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class; refers to Customer_Classes table"
},
"state" : {
"type" : "string",
"description" : "Province or state"
},
"email" : {
"type" : "string",
"description" : "Email address"
},
"spending_limit_reached" : {
"type" : "integer",
"description" : "Include into the response only the customers who reached their spending limit. Possible values: 1 - Spending limit reached; 0 - Spending limit not reached"
},
"get_statuses" : {
"type" : "integer",
"description" : "Get the statuses of the customers"
},
"bill_status" : {
"type" : "string",
"description" : "The billing status of the customer to search by.\nPossible values: O, S, C, E, D.\n O – The customer is open.\n S – The customer is suspended due to an overdue invoice.\n C – The customer is closed due to an unpaid invoice.\n E – The customer is exported.\n D – The customer is deactivated due to provisional termination.\n"
},
"i_main_customer" : {
"type" : "integer",
"description" : "The unique ID of the \"main\" customer (Main Office (HQ) customer) record within one linked customers' group"
},
"name" : {
"type" : "string",
"description" : "The customer name pattern"
},
"login" : {
"type" : "string",
"description" : "Customer's login for self-care web interface"
},
"with_commission_plan" : {
"type" : "integer",
"description" : "Specifies whether to include customers' commission plan into the list. Possible values: 1 - Include customers' commission plan into the list; 0 - Do not include customers commission plan into the list. Default value: 1"
},
"get_auth_info" : {
"type" : "integer",
"description" : "If set to '1', the information about the customer's authorization parameters will be provided in the response"
},
"with_bp_charge_cc" : {
"type" : "integer",
"description" : "Specifies whether to include customers' bp_charge_cc into the list. Possible values: 1 - Include customers' bp_charge_cc into the list; 0 - Do not include customers' bp_charge_cc into the list. Default value: 1"
},
"zip" : {
"type" : "string",
"description" : "Postal (zip) code"
},
"phone1" : {
"type" : "string",
"description" : "Main phone number"
},
"phone2" : {
"type" : "string",
"description" : "Alternative phone number"
},
"midinit" : {
"type" : "string",
"description" : "Customer's middle initial(s)"
},
"cont1" : {
"type" : "string",
"description" : "Main contact person"
},
"salutation" : {
"type" : "string",
"description" : "Customer's salutation"
},
"detailed_info" : {
"type" : "integer",
"description" : "Specifies whether detailed information will be returned in the response"
},
"lastname" : {
"type" : "string",
"description" : "Customer's last name"
},
"with_terminated" : {
"type" : "integer",
"description" : "Specifies whether to include terminated customers into the list. Possible values: 1 - Include terminated customers into the list; 0 - Do not include terminated customers into the list"
},
"i_customer_type" : {
"type" : "integer",
"description" : "The type of the customer. Possible values: 1 - Retail customer or subcustomer, 2 - Reseller, 3 - Distributor"
},
"city" : {
"type" : "string",
"description" : "City of customer's address"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the customer has entities assigned"
},
"callshop_enabled" : {
"type" : "string",
"description" : "Filter the customer list by the 'callshop_enabled' field"
},
"with_subresellers" : {
"type" : "integer",
"description" : "Specifies whether to include subresellers into the list. Possible values: 1 - Include subresellers into the list; 0 - Do not include subresellers into the list"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved customers"
},
"cont2" : {
"type" : "string",
"description" : "Alternative contact person"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"country" : {
"type" : "string",
"description" : "The ISO 3166 two-letter country code. To change the country, use the update_customer API method or select the desired country on the UI. Note: after changing the country, the state may have a wrong value"
},
"i_distributor" : {
"type" : "integer",
"description" : "The unique ID of the distributor associated with the customer. The distributor indicates the percentage commission from payments of related customers. To change the distributor, use the update_customer API method or select the desired distributor on the UI. Note: after changing the distributor, the distributor commission payment may change"
},
"with_credit_limit_warnings" : {
"type" : "integer",
"description" : "Specifies whether to include customers' credit limit warnings into the list. Possible values: 1 - Include customers' credit limit warnings into the list; 0 - Do not include customers' credit limit warnings into the list. Default value: 1"
},
"i_rep" : {
"type" : "integer",
"description" : "The unique ID of the customer's representative; refers to Representatives table"
},
"custom_fields_values" : {
"$ref" : "#/components/schemas/ArrayOfCustomFieldsValuesInfo"
},
"get_notepad" : {
"type" : "integer",
"description" : "Specifies whether to include the notes into the info. Possible values: 1 - Include the notes into the info; 0 - Do not include the notes into the info"
},
"i_office_type" : {
"type" : "integer",
"description" : "The unique ID of the Office_Types record. Possible values: 1 – none; 2 – branch_office; 3 – main_office"
},
"note" : {
"type" : "string",
"description" : "Short note (description)"
},
"marked_for_porting" : {
"type" : "integer",
"description" : "Specifies whether to list customers that will be ported. Possible values: 1 - the result list contains only customers that are marked for porting, 0 - the result list contains only customers that aren't marked for porting."
},
"bcc" : {
"type" : "string",
"description" : "BCC email address"
},
"has_invoices" : {
"type" : "integer",
"description" : "Filters customer list by invoice presence. Possible values: 1 - Return customers with at least one invoice present; 0 - Return customers with no invoices"
},
"faxnum" : {
"type" : "string",
"description" : "Fax number"
},
"tax_id" : {
"type" : "string",
"description" : "Tax ID"
},
"companyname" : {
"type" : "string",
"description" : "Customer's company name"
}
}
},
"DeleteBundlePromotionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 – The bundle promotion is successfully deleted. 0 – The bundle promotion has not been deleted"
}
}
},
"DeleteAccessNumberRequest" : {
"required" : [
"i_ivr_an"
],
"type" : "object",
"properties" : {
"i_ivr_an" : {
"type" : "integer",
"description" : "The unique ID of the IVR access number"
}
}
},
"ActiveCallInfo" : {
"required" : [
"call_id",
"id"
],
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"session_id" : {
"type" : "string",
"description" : "ID of the session to work with"
},
"leg_type" : {
"type" : "string",
"description" : "Together with leg_origin determines leg for accounting record"
},
"i_node" : {
"type" : "integer",
"description" : "The unique ID of the node"
},
"CLD" : {
"type" : "string",
"description" : "Calling line destination"
},
"call_id" : {
"type" : "string",
"description" : "The unique ID of the call"
},
"CLI" : {
"type" : "string",
"description" : "Calling line identification"
},
"connect_time" : {
"type" : "string",
"description" : "Time when connection was initiated"
},
"subscriber_ip" : {
"type" : "string",
"description" : "Subscriber IP address"
},
"id" : {
"type" : "string",
"description" : "Call owner's account ID"
},
"leg_origin" : {
"type" : "string",
"description" : "Together with leg_type determines leg for accounting record"
}
}
},
"EstimateTaxesXDRInfo" : {
"required" : [
"charged_amount"
],
"type" : "object",
"properties" : {
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination record"
},
"CLD" : {
"type" : "string",
"description" : "Called Line Identification"
},
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the xDR record"
},
"iso_3166_1_a3" : {
"type" : "string",
"description" : "A three-letter country code defined in ISO 3166-1 alpha-3"
},
"account_id" : {
"type" : "string",
"description" : "The unique ID of the account record. Applicable only to accounts"
},
"taxation_code" : {
"type" : "string",
"description" : "The tax transaction code"
},
"CLI" : {
"type" : "string",
"description" : "Calling Line Identification"
},
"charged_amount" : {
"type" : "number",
"description" : "The amount charged"
},
"charged_quantity" : {
"type" : "integer",
"description" : "The units charged"
},
"bill_time" : {
"type" : "string",
"description" : "The call bill time"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the subscription plan record"
}
}
},
"GetCostRevenueFileListResponse" : {
"type" : "object",
"properties" : {
"file_list" : {
"$ref" : "#/components/schemas/ArrayOfReportFileInfo"
}
}
},
"DeleteServiceRequest" : {
"required" : [
"i_service"
],
"type" : "object",
"properties" : {
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
}
}
},
"GetSpendingConstraintInfoResponse" : {
"type" : "object",
"properties" : {
"spending_constraint_info" : {
"$ref" : "#/components/schemas/SpendingConstraintInfo"
}
}
},
"UploadSIMCardsRequest" : {
"type" : "object"
},
"UpdateUserNotificationListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation was completed"
}
}
},
"CodecConverterStorageInfo" : {
"type" : "object",
"properties" : {
"column_family" : {
"type" : "string",
"description" : "Storage column family. E.g. MusicOnHold, VoicePrompts or AudioFiles"
},
"key" : {
"$ref" : "#/components/schemas/CodecStorageKeysInfo"
},
"working_dir" : {
"type" : "string",
"description" : "Directory with audio files"
}
}
},
"AddUpdateCustomerBatchRequest" : {
"required" : [
"batch_info"
],
"type" : "object",
"properties" : {
"batch_info" : {
"$ref" : "#/components/schemas/CustomerBatchInfo"
}
}
},
"TaxationOptionsAvalara" : {
"type" : "object",
"properties" : {
"service_class" : {
"type" : "string",
"description" : "Defines the primary activity. Possible values: local - If more than 50% revenue is received from local calls; long_distance - If more than 50% revenue is received from long distance calls"
},
"customer_type" : {
"type" : "string",
"description" : "The type of customers who use the service. Possible values: industrial - These are manufacturing companies; business - These are business entities that use the services for business purposes; residential - These are customers that use the services for personal purposes"
},
"incorporated_area" : {
"type" : "string",
"description" : "The location of the customer. Possible values: inside - Located inside an incorporated city area; outside - Located outside an incorporated city area"
},
"transaction_codes" : {
"$ref" : "#/components/schemas/ArrayOfTransactionCodes"
},
"voipa" : {
"type" : "string",
"description" : "VoIP Taxation; Available options: normal, aggressive"
},
"county_exempt" : {
"type" : "string",
"description" : "Exempt from county taxes"
},
"business_class" : {
"type" : "string",
"description" : "Describes a company as a service provider. Possible values: ILEC - This is a telephone company that owns most of the local loops and facilities in a serving area; CLEC - This is a company that builds and operates communication networks within areas, providing its customers with an alternative to the local telephone company within the existing ILEC's territory"
},
"facilities_based" : {
"type" : "string",
"description" : "This defines if a company owns or controls facilities for providing telecommunication services"
},
"regulated" : {
"type" : "string",
"description" : "Defines whether a company is regulated by the regulatory commission in the state where the services are provided. Possible values: Y, N"
},
"state_exempt" : {
"type" : "string",
"description" : "Exempt from state taxes"
},
"lifeline_program" : {
"type" : "string",
"description" : "Defines a company as entitled to a Lifeline assistance program. Possible values: Y, N"
},
"franchise" : {
"type" : "string",
"description" : "This defines if a company provides services under a franchise agreement. Possible values: Y, N"
},
"federal_exempt" : {
"type" : "string",
"description" : "Exempt from federal taxes"
},
"taxation_mode" : {
"type" : "string",
"description" : "Defines which taxes will be calculated for a customer. Possible values: not_switched - Tax is calculated based on the number of DID numbers a customer uses; switched - Taxes are calculated for the number of customer sites and extensions and the number of an IP Centrex customer's simultaneous outgoing calls"
},
"local_exempt" : {
"type" : "string",
"description" : "Exempt from local taxes"
}
}
},
"GetAccessPolicyListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of retrieved records"
},
"access_policy_list" : {
"$ref" : "#/components/schemas/ArrayOfAccessPolicyInfo"
}
}
},
"GetVDTopupOptionInfoRequest" : {
"required" : [
"i_vd_topup"
],
"type" : "object",
"properties" : {
"i_vd_topup" : {
"type" : "integer",
"description" : "The unique ID of the volume discount topup record"
}
}
},
"APIMethodInfo" : {
"required" : [
"access_list",
"name"
],
"type" : "object",
"properties" : {
"input" : {
"$ref" : "#/components/schemas/ArrayOfAPIMethodFieldInfo"
},
"access_list" : {
"$ref" : "#/components/schemas/ArrayOfAPIMethodACLInfo"
},
"realm_list" : {
"$ref" : "#/components/schemas/ArrayOfAPIMethodRealmInfo"
},
"name" : {
"type" : "string",
"description" : "The name of the API method"
},
"output" : {
"$ref" : "#/components/schemas/APIMethodFieldInfo"
}
}
},
"GetVendorBatchInfoResponse" : {
"type" : "object",
"properties" : {
"vendor_batch_info" : {
"$ref" : "#/components/schemas/VendorBatchInfo"
}
}
},
"AddUpdatePhoneBookRecordRequest" : {
"type" : "object",
"properties" : {
"phonebook_rec_info" : {
"$ref" : "#/components/schemas/PhoneBookRecInfo"
}
}
},
"GetTariffInfoResponse" : {
"type" : "object",
"properties" : {
"tariff_info" : {
"$ref" : "#/components/schemas/TariffInfo"
}
}
},
"DeleteCustomerPaymentMethodRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer. Not mandatory when sent from the retail customer interface"
}
}
},
"GetZendeskOrganizationListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name pattern of a Zendesk organization"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved Zendesk organizations"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. The value must be a multiple of get_total, it will be recounted. For example, if get_total is equal 50 and: - the value is < 50, it will be canged to '0'; - the value is in the range of [50-99], it will be canged to '50' etc."
}
}
},
"GetAccountProvisioningStatusListRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"i_group" : {
"type" : "integer",
"description" : "The unique ID of the provisioning group"
}
}
},
"GetCustomerInvoicesRequest" : {
"type" : "object",
"properties" : {
"show_void" : {
"type" : "integer",
"description" : "Show void invoices"
},
"only_last_unpaid_invoice" : {
"type" : "integer",
"description" : "Show only last unpaid invoice"
},
"from_date" : {
"type" : "string",
"description" : "Get invoices dated starting from this date"
},
"invoice_number" : {
"type" : "string",
"description" : "Invoice Number – unique identifier of the invoice (a customer can see only his own invoices)"
},
"only_pay_required" : {
"type" : "integer",
"description" : "Show invoices that require payment"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"to_date" : {
"type" : "string",
"description" : "Get invoices dated before this date"
}
}
},
"GetRoamingProfileListRequest" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Checks whether the roaming profiles are in use"
},
"filter" : {
"type" : "string",
"description" : "Allows retrieving roaming profiles by the name or part of the name"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who manages the required roaming profiles"
},
"get_total" : {
"type" : "integer",
"description" : "Specifies whether to show the total number of roaming profiles found. Then, even if, e.g. the limit property is specified, the total number of roaming profiles that satisfy other conditions will be shown"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property specified in the API request"
},
"with_countries" : {
"type" : "integer",
"description" : "Specifies whether the lists of roaming countries for each restriction level will be returned for each item in the list of roaming profiles"
}
}
},
"CPConditionTimeWindowInfo" : {
"required" : [
"period"
],
"type" : "object",
"properties" : {
"period" : {
"type" : "string",
"description" : "Time::Period string"
},
"description" : {
"type" : "string",
"description" : "Description of period"
}
}
},
"CustomerClassNotificationInfo" : {
"type" : "object",
"properties" : {
"send_sms" : {
"type" : "integer",
"description" : "Specifies whether this notification will be sent by sms. Possible values: 1 – The notification will be sent by sms, 0 – The notification will not be sent by sms"
},
"send_mail" : {
"type" : "integer",
"description" : "Specifies whether this notification will be sent by email. Possible values: 1 – The notification will be sent by email, 0 – The notification will not be sent by email"
},
"i_notification" : {
"type" : "integer",
"description" : "The unique ID of the notification"
}
}
},
"ReleaseDIDFromResellerRequest" : {
"required" : [
"i_did_number"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique DID Number identifier"
}
}
},
"ArrayOfServiceFeatureDefinition" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServiceFeatureDetails"
}
},
"ProductGetProductDiscountPlanListResponse" : {
"type" : "object",
"properties" : {
"discount_plan_list" : {
"$ref" : "#/components/schemas/ArrayOfRawDiscountPlanInfo"
}
}
},
"GetAuthzMethodTypeListRequest" : {
"type" : "object"
},
"GetZendeskTicketListRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"priority" : {
"type" : "string",
"description" : "The priority of the Zendesk ticket. Possible values: 'urgent', 'high', 'normal', 'low'"
},
"subject" : {
"type" : "string",
"description" : "The subject of the Zendesk ticket"
},
"status" : {
"type" : "string",
"description" : "The status of the Zendesk ticket. Possible values: 'new', 'open', 'pending', 'hold', 'solved', 'closed'"
},
"created_at_start" : {
"type" : "string",
"description" : "The start date and time when the Zendesk ticket was created"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved Zendesk tickets"
},
"updated_at_end" : {
"type" : "string",
"description" : "The end date and time when the Zendesk ticket last got updated"
},
"type" : {
"type" : "string",
"description" : "The type of the Zendesk ticket. Possible values: 'problem', 'incident', 'question' or 'task'"
},
"created_at_end" : {
"type" : "string",
"description" : "The end date and time when the Zendesk ticket was created"
},
"zendesk_ticket_id" : {
"type" : "integer",
"description" : "The unique ID number of the Zendesk ticket"
},
"i_customer" : {
"type" : "integer",
"description" : "The Zendesk organization (already existing) for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side"
},
"updated_at_start" : {
"type" : "string",
"description" : "The start date and time when the Zendesk ticket last got updated"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The value must be a multiple of get_total, it will be recounted. For example, if get_total is equal 50 and: - the value is < 50, it will be canged to '0'; - the value is in the range of [50-99], it will be canged to '50' etc."
}
}
},
"ArrayOfCriterionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CriterionInfo"
}
},
"XrateInfo" : {
"type" : "object",
"properties" : {
"source" : {
"type" : "string",
"description" : "Shows the exchange rate source for the given currency as defined on the Currency page"
},
"base_units" : {
"type" : "number",
"description" : "Currency exchange rate. Defines the number of units of the base currency equal to one unit of the foreign currency. (For example, with British Pounds as the foreign currency and U.S. Dollars as the base currency , the base currency units would be \"1.5326\" and the value of this column would be \"1 GBP = 1.5326\")"
},
"is_active" : {
"type" : "integer",
"description" : "Specifies whether the exchange rate is usable now: 1 - the exchange rate is now usable, 0 - the exchange rate is not usable, e.g. outdated"
},
"timestamp" : {
"type" : "string",
"description" : "The effective date for the given exchange rate"
},
"iso_4217" : {
"type" : "string",
"description" : "Specifies a currency in ISO4217 code (the currency to convert to)"
},
"name" : {
"type" : "string",
"description" : "A currency name"
}
}
},
"VDTopupOptionInfo" : {
"type" : "object",
"properties" : {
"topup_expiry_time" : {
"type" : "integer",
"description" : "The lifetime of the top-up option, the number of days"
},
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the discount for a specific destination group"
},
"i_vd_topup" : {
"type" : "integer",
"description" : "The unique ID of the volume discount topup record"
},
"topup_amount" : {
"type" : "number",
"description" : "The amount of service units to topup"
},
"topup_fee" : {
"type" : "number",
"description" : "The amount of money an end user is charged for topup"
}
}
},
"UpdateCustomFieldResponse" : {
"required" : [
"i_custom_field"
],
"type" : "object",
"properties" : {
"i_custom_field" : {
"type" : "integer",
"description" : "The unique ID of the custom field record"
}
}
},
"DeleteCustomFieldRequest" : {
"required" : [
"i_custom_field"
],
"type" : "object",
"properties" : {
"i_custom_field" : {
"type" : "integer",
"description" : "The unique ID of the custom field record"
}
}
},
"ArrayOfInt" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"AddResaleTariffMappingsRequest" : {
"type" : "object",
"properties" : {
"resale_map_list" : {
"$ref" : "#/components/schemas/ArrayOfResaleMapInfo"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller record to apply the tariff mapping to"
}
}
},
"AddDefaultCallBarringOptionResponse" : {
"required" : [
"i_default_cb_option"
],
"type" : "object",
"properties" : {
"i_default_cb_option" : {
"type" : "integer",
"description" : "The unique ID of the default call barring option"
}
}
},
"AccountGetBoothsRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"include_non_paid_calls" : {
"type" : "integer",
"description" : "The flag shows whether to include booths with non-paid calls"
},
"hide_closed" : {
"type" : "integer",
"description" : "The flag shows whether to exclude closed booths"
},
"include_destinations" : {
"type" : "integer",
"description" : "The flag shows whether to include destination information"
},
"include_active_calls" : {
"type" : "integer",
"description" : "The flag shows whether to include booths with active calls"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"GetAccountMOHListInfoResponse" : {
"type" : "object",
"properties" : {
"moh_list_info" : {
"$ref" : "#/components/schemas/AccountMOHListInfo"
}
}
},
"DeleteQFRequest" : {
"required" : [
"i_quick_form"
],
"type" : "object",
"properties" : {
"i_quick_form" : {
"type" : "integer",
"description" : "The unique ID of the quick form"
}
}
},
"AddCPRuleResponse" : {
"required" : [
"i_cp_rule"
],
"type" : "object",
"properties" : {
"i_cp_rule" : {
"type" : "integer",
"description" : "The unique ID of the call screening rule record"
}
}
},
"TemplateGetTemplateScopedListRequest" : {
"type" : "object",
"properties" : {
"type_name" : {
"type" : "string",
"description" : "The name of the template type"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the template is in use"
},
"name" : {
"type" : "string",
"description" : "The name of the template"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetCQPromptFileRequest" : {
"required" : [
"i_c_queue"
],
"type" : "object",
"properties" : {
"i_c_queue" : {
"type" : "integer",
"description" : "The unique record of a call queue"
}
}
},
"GetServiceAndRatingListResponse" : {
"type" : "object",
"properties" : {
"service_and_rating_list" : {
"$ref" : "#/components/schemas/ServiceAndRatingInfoList"
}
}
},
"ObjectPermissions" : {
"required" : [
"object",
"attributes"
],
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The web interface object for which the ACL permissions were collected"
},
"attributes" : {
"$ref" : "#/components/schemas/ArrayOfAttributePermissions"
}
}
},
"RoutingCriteriaDestGroupInfo" : {
"type" : "object",
"properties" : {
"low_pdd_penalty_threshold" : {
"type" : "integer",
"description" : "The penalty threshold of the minimum acceptable PDD. The value of the field defines when the route should be penalized if the quality statistics are below the threshold value. Measured in percents"
},
"ppm_warning_threshold" : {
"type" : "number",
"description" : "The warning threshold of the profit per minute. The value of the field defines when an alert will be sent to the administrator if the quality statistics are outside of the threshold value. Measured in the monetary units of your base currency"
},
"disabled_flags" : {
"$ref" : "#/components/schemas/RoutingCriteriaDestGroupMetricFlags"
},
"i_criteria_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria destination group DB record"
},
"asr_penalty_threshold" : {
"type" : "integer",
"description" : "The penalty threshold of the average success rate (the number of successfully connected calls divided by the total number of call attempts). The value of the field defines when the route should be penalized if the quality statistics are outside of the threshold value. Measured in percents"
},
"asr_warning_threshold" : {
"type" : "integer",
"description" : "The warning threshold of the average success rate. The value of the field defines when an alert will be sent to the administrator if the quality statistics are under the threshold. Measured in percents"
},
"high_pdd_penalty_threshold" : {
"type" : "integer",
"description" : "The penalty threshold for the maximum acceptable PDD. The value of the field defines when the route should be penalized if the quality statistics are above the threshold value. Measured in percents"
},
"high_pdd_value" : {
"type" : "integer",
"description" : "Defines the maximum acceptable PDD (Post-Dial Delay). Measured in milliseconds"
},
"calls_threshold" : {
"type" : "integer",
"description" : "The minimum required amount of calls to enable routing adjustments"
},
"penalty_time" : {
"type" : "integer",
"description" : "The time interval for which the connection will be “penalized” (put at the very bottom of the routing list) if a given vendor does not meet the quality criteria. Measured in minutes"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group DB record"
},
"low_pdd_warning_threshold" : {
"type" : "integer",
"description" : "The warning threshold of the minimum acceptable PDD. The value of the field defines when an alert will be sent to the administrator if the quality statistics are below the threshold value. Measured in percents"
},
"low_pdd_value" : {
"type" : "integer",
"description" : "Defines the minimum acceptable PDD (Post-Dial Delay). Measured in milliseconds"
},
"high_pdd_warning_threshold" : {
"type" : "integer",
"description" : "The warning threshold of the maximum acceptable PDD. The value of the field defines when an alert will be sent to the administrator if the quality statistics are above the threshold value. Measured in percents"
},
"i_criteria" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria DB record"
},
"aloc_warning_threshold" : {
"type" : "integer",
"description" : "The warning threshold of the average length of call. The value of the field defines when an alert will be sent to the administrator if the quality statistics are below the threshold value. Measured in seconds"
},
"aloc_penalty_threshold" : {
"type" : "integer",
"description" : "The penalty threshold of the average length of call. The value of the field defines when the route should be penalized if the quality statistics are below the threshold value. Measured in seconds"
},
"ppm_penalty_threshold" : {
"type" : "number",
"description" : "The penalty threshold of the profit per minute. The value of the field defines when the route should be penalized if the quality statistics are outside of the threshold value. Measured in the monetary units of your base currency"
}
}
},
"DeleteCustomerClassResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"GetDestGroupSetListRequest" : {
"type" : "object",
"properties" : {
"complete_match" : {
"type" : "string",
"description" : "Y/N/ALL filter list by \"complete match\" property. Default: N"
},
"get_total" : {
"type" : "integer",
"description" : "Get total number of found destination group sets"
},
"name" : {
"type" : "string",
"description" : "Search pattern in the names of destination group sets"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"check_set_emptiness" : {
"type" : "integer",
"description" : "If set to '1', the 'is_set_empty' field will be present in the method response"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"RerateXDRsRequest" : {
"required" : [
"owner",
"date_from"
],
"type" : "object",
"properties" : {
"date_to" : {
"type" : "string",
"description" : "The end of the date-time interval for xDRs to be re-rated (current date-time is picked if the field is left empty)"
},
"effective_time" : {
"type" : "string",
"description" : "The date and the time when the rates associated with the correct tariff become effective"
},
"owner" : {
"type" : "string",
"description" : "The xDR owner type. Possible values: 'customer', 'vendor' and 'reseller'"
},
"i_tariff_correct" : {
"type" : "integer",
"description" : "The unique ID of the tariff with correct pricing information entered"
},
"i_owner" : {
"type" : "integer",
"description" : "The unique ID of the specific xDR owner (i_customer or i_vendor) whose xDRs should be re-rated"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service for which xDRs should be re-rated"
},
"date_from" : {
"type" : "string",
"description" : "The start of the date-time interval for xDRs to be re-rated"
},
"i_tariff_wrong" : {
"type" : "integer",
"description" : "The unique ID of the “original” tariff with incorrect pricing information entered (all tariffs are marked as wrong if the field is left empty)"
},
"use_override_tariffs" : {
"type" : "string",
"description" : "The flag is needed to check whether the customer/reseller has an override tariff defined, and if such tariff is present, apply its rates instead of the corresponding correct tariff rates. Possible values: 'Y', 'N'"
},
"process_imported_charges" : {
"type" : "integer",
"description" : "Shows how the imported xDRs would be re-rated. Possible values: 0 - do not re-rate imported xDRs, 1 - apply charges from the correct tariff in addition to the external charges, 2 - drop external charges"
}
}
},
"TaxPluginInfo" : {
"required" : [
"i_billing_processor"
],
"type" : "object",
"properties" : {
"requires_configuration" : {
"type" : "integer",
"description" : "Shows whether the taxation plugin requires configuration. This field is only applicable if the \"catalog_based\" option is set to 1"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the taxation plugin has been assigned"
},
"catalog_based" : {
"type" : "integer",
"description" : "Defines if the taxation plugin requires special codes for any transaction (0 - no, 1 - yes)"
},
"name" : {
"type" : "string",
"description" : "The name of the taxation plugin that is displayed on the WI"
},
"i_billing_processor" : {
"type" : "integer",
"description" : "The unique ID of the taxation plugin database record"
},
"tax_plugin_parameters" : {
"$ref" : "#/components/schemas/ArrayOfTaxPluginParameterInfo"
},
"is_configured" : {
"type" : "integer",
"description" : "Shows whether the taxation plugin is configured. This field is only applicable if the \"catalog_based\" option is set to 1"
},
"can_process_prepaid_taxes" : {
"type" : "integer",
"description" : "Defines if the taxation plugin can make estimates and handle taxes for prepaid customers and debit accounts"
}
}
},
"GetCustomerRTRequestorListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The number of the records found"
},
"rt_requestor_list" : {
"$ref" : "#/components/schemas/ArrayOfRTRequestorInfo"
}
}
},
"DeletePhoneBookRecordRequest" : {
"type" : "object",
"properties" : {
"i_account_phonebook" : {
"type" : "integer",
"description" : "The unique ID of the Phone book record"
}
}
},
"ArrayOfDestGroupSetInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DestGroupSetInfo"
}
},
"UpdateRatingGroupResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 - for success; 0 - for failure"
}
}
},
"ServiceFeaturesList" : {
"type" : "object",
"properties" : {
"Customers" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureDefinition"
},
"CustomerSites" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureDefinition"
},
"Products" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureDefinition"
},
"Accounts" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureDefinition"
}
}
},
"ArrayOfAPIServiceInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/APIServiceInfo"
}
},
"CreatePortInRequestRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account the request relates to"
},
"due_date" : {
"type" : "string",
"description" : "The date by which the customer's request must be completed"
},
"request_parameters" : {
"$ref" : "#/components/schemas/ArrayOfPortingRequestParameterInfo"
},
"porting_number" : {
"type" : "string",
"description" : "The number being ported"
}
}
},
"DeleteVendorBatchRequest" : {
"required" : [
"i_dv_batch"
],
"type" : "object",
"properties" : {
"i_dv_batch" : {
"type" : "integer",
"description" : "The unique ID of the vendor DID batch record"
}
}
},
"AddVoiceQualityProfileRequest" : {
"required" : [
"profile_info"
],
"type" : "object",
"properties" : {
"profile_info" : {
"$ref" : "#/components/schemas/VoiceQualityProfileInfo"
}
}
},
"GetAllowedAddonsRequest" : {
"required" : [
"i_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "ID of main Product"
},
"detailed_info" : {
"type" : "integer",
"description" : "This flag indicates whether to fetch detailed information for add-on products"
},
"with_subscription" : {
"type" : "integer",
"description" : "Flag which indicates whether the Product subscription should be returned"
}
}
},
"InvoiceUploadInvoicePdfResponse" : {
"type" : "object",
"properties" : {
"sucess" : {
"type" : "integer",
"description" : "1 if success"
}
}
},
"DeletePreferableAccountResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "One of the following: 1 – success, 0 – failed"
}
}
},
"ArrayOfQFGrantedACL" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"GetTaxTransactionCodeInfoRequest" : {
"required" : [
"i_tax_transaction_code"
],
"type" : "object",
"properties" : {
"with_plugin_codes" : {
"type" : "integer",
"description" : "The flag shows whether to include plugin specific codes into the response"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique ID of the taxation code database record"
}
}
},
"GetDestGroupSetListResponse" : {
"type" : "object",
"properties" : {
"dest_group_set_list" : {
"$ref" : "#/components/schemas/ArrayOfDestGroupSetInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved destination group sets"
}
}
},
"AccessObjectPermission" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the access object"
},
"permission" : {
"type" : "integer",
"description" : "The permission for the access object"
},
"attributes" : {
"$ref" : "#/components/schemas/ArrayOfAccessAttributePermission"
}
}
},
"GetDiscountPlanListResponse" : {
"type" : "object",
"properties" : {
"discount_plan_list" : {
"$ref" : "#/components/schemas/ArrayOfDiscountPlanInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved volume discount plans"
}
}
},
"GetPortingRequestRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account the request relates to"
},
"i_request" : {
"type" : "integer",
"description" : "The unique ID of the number porting request"
}
}
},
"UpdateVDThresholdRequest" : {
"required" : [
"vd_threshold_info"
],
"type" : "object",
"properties" : {
"vd_threshold_info" : {
"$ref" : "#/components/schemas/VDThresholdInfo"
}
}
},
"CommitmentSaleDiscountInfo" : {
"type" : "object",
"properties" : {
"end_date" : {
"type" : "string",
"description" : "The end of the discount period. Should be earlier or the same as the commitment's 'min_terminate_date' (discount period) and should not overlap with other sale discounts associated with the recurring term. The discount is not applied for the 'end_day'. If the commitment was paused, the discount dates that go after the pause interval are shifted for the number of days the commitment was in the paused state"
},
"absolute_discount" : {
"type" : "number",
"description" : "The amount of the discount provided during this discount period"
},
"start_date" : {
"type" : "string",
"description" : "The date when the sale discount is activated. Should be later or the same as the commitment start date and should not overlap with other sale discounts associated with the recurring term. If the commitment was paused, the discount dates that go after the pause interval are shifted for the number of days the commitment was in the paused state"
}
}
},
"GetRatingGroupListResponse" : {
"type" : "object",
"properties" : {
"rating_group_list" : {
"$ref" : "#/components/schemas/ArrayOfRatingGroupInfo"
}
}
},
"DeleteUAResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"DeleteProductGroupRequest" : {
"required" : [
"i_product_group"
],
"type" : "object",
"properties" : {
"i_product_group" : {
"type" : "integer",
"description" : "The unique ID of the created/updated product group"
}
}
},
"ApplyInvoiceAdjustmentRequest" : {
"required" : [
"amount",
"refund_to_cc",
"i_invoice"
],
"type" : "object",
"properties" : {
"visible_comment" : {
"type" : "string",
"description" : "A comment on this transaction visible to the customer in the xDR browser"
},
"amount" : {
"type" : "number",
"description" : "An amount of adjustment"
},
"internal_comment" : {
"type" : "string",
"description" : "An internal comment on this transaction; not visible in the xDR browser, and accessible only from the database directly"
},
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
},
"refund_to_cc" : {
"type" : "integer",
"description" : "For fully paid invoices only. If set to 1, the adjustment amount will be refunded to the credit card. Possible values: 1 – Refund the adjustment amount to the credit card. 0 – Do not refund the adjustment amount to the credit card."
}
}
},
"ChargeAccountSubscriptionFeesResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"APIMethodACLInfo" : {
"type" : "object",
"properties" : {
"attribute" : {
"type" : "string",
"description" : "The name of the ACL attribute"
},
"object" : {
"type" : "string",
"description" : "The name of the ACL object"
},
"permission" : {
"type" : "integer",
"description" : "The permission level that is needed. Possible values: 1 - read permission is required, 2 - modify permission is required"
}
}
},
"ProductAddProductDetailedRequest" : {
"required" : [
"product_info"
],
"type" : "object",
"properties" : {
"product_info" : {
"$ref" : "#/components/schemas/RawProductInfo"
}
}
},
"CustomerSetCallQueuePromptFileRequest" : {
"required" : [
"i_c_queue"
],
"type" : "object",
"properties" : {
"i_c_queue" : {
"type" : "integer",
"description" : "ID of call queue record"
}
}
},
"CloneIvrApplicationRequest" : {
"required" : [
"i_voice_app_access_number",
"name"
],
"type" : "object",
"properties" : {
"i_voice_app_access_number" : {
"type" : "integer",
"description" : "The unique ID of the IVR application"
},
"name" : {
"type" : "string",
"description" : "The name of the IVR application"
},
"description" : {
"type" : "string",
"description" : "The description of the IVR application"
},
"move_access_numbers" : {
"$ref" : "#/components/schemas/ArrayOfAccessNumberInfo"
}
}
},
"EstimateCommitmentPriceForFirstBillingPeriodResponse" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "The full price the user has to pay for the first billing period of the commitment"
},
"iso_4217" : {
"type" : "string",
"description" : "The currency"
}
}
},
"UpdateNotificationTemplateInfoResponse" : {
"required" : [
"is_updated"
],
"type" : "object",
"properties" : {
"is_updated" : {
"type" : "integer",
"description" : "Specifies whether the notification template was updated. Possible values: 1 - The notification template was updated, 0 - The notification template was not updated"
},
"authorship" : {
"type" : "string",
"description" : "Specifies whether the template has been modified. Possible values: System - The template has not been modified, Custom - The template has been modified"
}
}
},
"DeleteCustomerBatchRequest" : {
"required" : [
"i_batch"
],
"type" : "object",
"properties" : {
"i_batch" : {
"type" : "integer",
"description" : "The unique ID of the batch"
}
}
},
"GetEnvNotificationTemplateInfoResponse" : {
"type" : "object",
"properties" : {
"bcc" : {
"type" : "string",
"description" : "An email address of the person who wants to receive a copy of this notification. You can specify more than one valid email address; make sure you separate them with commas"
},
"body" : {
"type" : "string",
"description" : "The content of the message"
},
"subject" : {
"type" : "string",
"description" : "The subject as it appears in an email to a recepient"
},
"variables" : {
"$ref" : "#/components/schemas/ArrayOfNotificationTemplateVariables"
}
}
},
"GenericGetRealmInfoResponse" : {
"type" : "object",
"properties" : {
"realm_info" : {
"$ref" : "#/components/schemas/RealmInfo"
}
}
},
"TemplateGetTemplateDataGroupListRequest" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
}
}
},
"UpdateDatesBatchRequest" : {
"required" : [
"date_list"
],
"type" : "object",
"properties" : {
"date_list" : {
"$ref" : "#/components/schemas/ArrayOfCalendarDateInfo"
}
}
},
"ArrayOfAccountXDRInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountXDRInfo"
}
},
"GetRoamingProfileListResponse" : {
"required" : [
"roaming_profile_list"
],
"type" : "object",
"properties" : {
"roaming_profile_list" : {
"$ref" : "#/components/schemas/ArrayOfRoamingProfileInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of roaming profiles found"
}
}
},
"LoginRequest" : {
"required" : [
"login"
],
"type" : "object",
"properties" : {
"password" : {
"type" : "string",
"description" : "Password, as specified on web interface"
},
"ca_token" : {
"type" : "string",
"description" : "The captcha token"
},
"enable_csrf_protection" : {
"type" : "integer",
"description" : "The flag shows whether to permanently enable CSRF protection for the session"
},
"ca_code" : {
"type" : "string",
"description" : "The captcha code"
},
"token" : {
"type" : "string",
"description" : "The API access token of a user"
},
"login" : {
"type" : "string",
"description" : "User Name, as specified on web interface"
}
}
},
"DeleteProductSubscriptionRequest" : {
"required" : [
"i_product_subscription"
],
"type" : "object",
"properties" : {
"i_product_subscription" : {
"type" : "integer",
"description" : "The ID of product subscription record"
}
}
},
"GetCustomerCustomFieldsValuesRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
}
}
},
"DIDOwnerBatchInfo" : {
"type" : "object",
"properties" : {
"free_of_charge" : {
"type" : "string",
"description" : "Indicates whether this owner batch is completely free of charge or not"
},
"is_used" : {
"type" : "string",
"description" : "Indicates whether this owner batch is in use"
},
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the DID pricing batch"
},
"total_dids_used" : {
"type" : "integer",
"description" : "The total number of DID numbers in the owner batch that are in use"
},
"name" : {
"type" : "string",
"description" : "The name of the DID pricing batch"
},
"iso_4217" : {
"type" : "string",
"description" : "The currency for the DID pricing batch"
},
"description" : {
"type" : "string",
"description" : "DID Pricing Batch Description"
},
"retention_time" : {
"type" : "integer",
"description" : "The DID owner batch retention time"
},
"total_dids" : {
"type" : "integer",
"description" : "The total number of DID numbers in the owner batch"
},
"total_dids_free" : {
"type" : "integer",
"description" : "The total number of DID numbers in the owner batch that are not in use"
},
"markup_options" : {
"$ref" : "#/components/schemas/DIDMarkupOptionsInfo"
},
"type" : {
"type" : "string",
"description" : "The type of the DID pricing batch"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller who owns the DID pricing batch"
}
}
},
"ArrayOfRTRequestorInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RTRequestorInfo"
}
},
"GetCustomerClassTaxationInfoResponse" : {
"required" : [
"taxation_info"
],
"type" : "object",
"properties" : {
"taxation_info" : {
"$ref" : "#/components/schemas/TaxationInfo"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique identifier for a tax transaction code; refers to the Tax_Transaction_Codes table"
},
"estimate_taxes" : {
"type" : "string",
"description" : "Shows whether the estimate taxes on receiving payments for the prepaid customers is enabled or disabled"
}
}
},
"AccountPaymentInfo" : {
"required" : [
"amount",
"action"
],
"type" : "object",
"properties" : {
"visible_comment" : {
"type" : "string",
"description" : "A comment on this transaction visible to the end user in the xDR browser"
},
"amount" : {
"type" : "number",
"description" : "The payment amount"
},
"save_card" : {
"type" : "string",
"description" : "Specifies whether the supplied payment method must be saved as the preferred payment method. Possible values: Y – Save the payment method as the preferred payment method; N – Do not save the payment method as the prefereed payment method"
},
"action" : {
"type" : "string",
"description" : "Possible values: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment"
},
"card_info" : {
"$ref" : "#/components/schemas/AccountPaymentMethodInfo"
},
"internal_comment" : {
"type" : "string",
"description" : "An internal comment on this transaction; not visible in the xDR browser, and accessible only from the database directly"
}
}
},
"ProductGetProductInfoDetailedResponse" : {
"required" : [
"product_info"
],
"type" : "object",
"properties" : {
"product_info" : {
"$ref" : "#/components/schemas/RawProductInfo"
}
}
},
"GetAccountPaymentTransactionListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
},
"payment_transactions" : {
"$ref" : "#/components/schemas/ArrayOfAccountTransactionInfo"
}
}
},
"ArrayOfAPIMethodACLInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/APIMethodACLInfo"
}
},
"DeleteCustomerHuntgroupResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"ArrayOfDestinationGroupInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DestinationGroupInfo"
}
},
"ArrayOfRoutingCriteriaInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RoutingCriteriaInfo"
}
},
"GetIvrOptionListResponse" : {
"type" : "object",
"properties" : {
"option_list" : {
"$ref" : "#/components/schemas/ArrayOfVoiceApplicationOptionInfo"
}
}
},
"GetUAProfileListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Pattern of the UA profile name"
},
"effective_from" : {
"type" : "string",
"description" : "The filter that allows viewing UA profiles depending on their Effective From date which can be one of the following: 'before', 'after', 'now', 'all', 'outdated', 'upcoming'"
},
"ua_profile_id" : {
"type" : "integer",
"description" : "ID of UA profile"
},
"with_shared" : {
"type" : "integer",
"description" : "If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response"
},
"effective_at" : {
"type" : "string",
"description" : "The filter enables viewing the UA profiles that were, are or will be effective at any date and time. It can work in pair with the 'effective_from' filter to view the UA profiles effective before/after/at the given date and time"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the UA profile is used or not"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved profiles"
},
"used" : {
"type" : "string",
"description" : "The filter that allows viewing UA profiles depending on their usage information. Works only when 'check_usage' parameter is passed. Possible values - 'Y', 'N'"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_customer" : {
"type" : "integer",
"description" : "Managed by"
},
"i_ua_type" : {
"type" : "integer",
"description" : "The unique ID of the UA type"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"UpdateAccountFollowMeResponse" : {
"required" : [
"i_follow_me"
],
"type" : "object",
"properties" : {
"i_follow_me" : {
"type" : "integer",
"description" : "The unique ID of the follow-me database record"
}
}
},
"DisableApiNotificationsAccountResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation has been successfully completed"
}
}
},
"GetAccountAliasListRequest" : {
"required" : [
"i_master_account"
],
"type" : "object",
"properties" : {
"i_account_role" : {
"type" : "integer",
"description" : "The unique ID of the account role to search aliases by"
},
"i_master_account" : {
"type" : "integer",
"description" : "ID of a master account record"
},
"check_did" : {
"type" : "integer",
"description" : "Pass this flag to check if the alias has an associated DID number"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved aliases"
},
"realm" : {
"type" : "string",
"description" : "The pattern to search aliases by the 'realm' field"
},
"blocked" : {
"type" : "string",
"description" : "The filter to search aliases by the 'blocked' field"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"id" : {
"type" : "string",
"description" : "The pattern to search aliases by the 'id' field"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"GetUserRTRequestorListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The number of the records found"
},
"rt_requestor_list" : {
"$ref" : "#/components/schemas/ArrayOfRTRequestorInfo"
}
}
},
"DeleteAuthzRuleResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"GetServicePoolListRequest" : {
"type" : "object"
},
"GetRoutingCriteriaDestGroupInfoResponse" : {
"type" : "object",
"properties" : {
"routing_criteria_dest_group_info" : {
"$ref" : "#/components/schemas/RoutingCriteriaDestGroupInfo"
}
}
},
"AddUpdateCustomerClassRequest" : {
"required" : [
"customer_class_info"
],
"type" : "object",
"properties" : {
"customer_class_info" : {
"$ref" : "#/components/schemas/CustomerClassInfo"
}
}
},
"UpdateTimePeriodRequest" : {
"required" : [
"time_period_info"
],
"type" : "object",
"properties" : {
"time_period_info" : {
"$ref" : "#/components/schemas/TimePeriodInfo"
}
}
},
"MediatorXDRInfoDetailed" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "The status of the xDR record"
},
"attribute_data" : {
"$ref" : "#/components/schemas/ArrayOfRadiusAttributeData"
},
"source_file" : {
"type" : "string",
"description" : "The filename of the source file"
},
"record_id" : {
"type" : "integer",
"description" : "A line number of original xDR record in the source file"
},
"origin_data" : {
"type" : "string",
"description" : "A raw xDR data from the source file"
},
"xdr_id" : {
"type" : "string",
"description" : "The ID of the xDR record"
}
}
},
"RevertXDRListRequest" : {
"required" : [
"revert_list"
],
"type" : "object",
"properties" : {
"revert_list" : {
"$ref" : "#/components/schemas/ArrayOfXDRRevertInfo"
}
}
},
"RoutingCriteriaInfo" : {
"type" : "object",
"properties" : {
"low_pdd_penalty_threshold" : {
"type" : "integer",
"description" : "The penalty threshold of the minimum acceptable PDD. The value of the field defines when the route should be penalized if the quality statistics are below the threshold value. Measured in percents"
},
"ppm_warning_threshold" : {
"type" : "number",
"description" : "The warning threshold of the profit per minute. The value of the field defines when an alert will be sent to the administrator if the quality statistics are outside of the threshold value. Measured in the monetary units of your base currency"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set DB record"
},
"asr_penalty_threshold" : {
"type" : "integer",
"description" : "The penalty threshold of the average success rate (the number of successfully connected calls divided by the total number of call attempts). The value of the field defines when the route should be penalized if the quality statistics are outside of the threshold value. Measured in percents"
},
"asr_warning_threshold" : {
"type" : "integer",
"description" : "The warning threshold of the average success rate. The value of the field defines when an alert will be sent to the administrator if the quality statistics are under the threshold. Measured in percents"
},
"high_pdd_penalty_threshold" : {
"type" : "integer",
"description" : "The penalty threshold for the maximum acceptable PDD. The value of the field defines when the route should be penalized if the quality statistics are above the threshold value. Measured in percents"
},
"high_pdd_value" : {
"type" : "integer",
"description" : "Defines the maximum acceptable PDD (Post-Dial Delay). Measured in miliseconds"
},
"calls_threshold" : {
"type" : "integer",
"description" : "The minimum required amount of calls to enable routing adjustments"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the routing criteria is used"
},
"penalty_time" : {
"type" : "integer",
"description" : "The time interval for which the connection will be “penalized” (put at the very bottom of the routing list) if a given vendor does not meet the quality criteria. Measured in minutes"
},
"low_pdd_warning_threshold" : {
"type" : "integer",
"description" : "The warning threshold of the minimum acceptable PDD. The value of the field defines when an alert will be sent to the administrator if the quality statistics are below the threshold value. Measured in percents"
},
"name" : {
"type" : "string",
"description" : "The name of the routing criteria"
},
"low_pdd_value" : {
"type" : "integer",
"description" : "Defines the minimum acceptable PDD (Post-Dial Delay). Measured in miliseconds"
},
"description" : {
"type" : "string",
"description" : "The routing criteria record description"
},
"high_pdd_warning_threshold" : {
"type" : "integer",
"description" : "The warning threshold of the maximum acceptable PDD. The value of the field defines when an alert will be sent to the administrator if the quality statistics are above the threshold value. Measured in percents"
},
"i_criteria" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria DB record"
},
"sampling_interval" : {
"type" : "integer",
"description" : "Quality measurements will be calculated for all calls in this interval. Measured in minutes"
},
"aloc_warning_threshold" : {
"type" : "integer",
"description" : "The warning threshold of the average length of call. The value of the field defines when an alert will be sent to the administrator if the quality statistics are below the threshold value. Measured in seconds"
},
"aloc_penalty_threshold" : {
"type" : "integer",
"description" : "The penalty threshold of the average length of call. The value of the field defines when the route should be penalized if the quality statistics are below the threshold value. Measured in seconds"
},
"ppm_penalty_threshold" : {
"type" : "number",
"description" : "The penalty threshold of the profit per minute. The value of the field defines when the route should be penalized if the quality statistics are outside of the threshold value. Measured in the monetary units of your base currency"
}
}
},
"UpdateCallBarringOptionsRequest" : {
"required" : [
"i_account",
"options"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"options" : {
"$ref" : "#/components/schemas/ArrayOfCallBarringRuleInfo"
}
}
},
"GetConnectionInfoResponse" : {
"required" : [
"connection_info"
],
"type" : "object",
"properties" : {
"connection_info" : {
"$ref" : "#/components/schemas/ConnectionInfo"
}
}
},
"GetCustomerClassNotificationTemplateInfoRequest" : {
"required" : [
"name",
"i_customer_class"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the either email or sms notification template as it appears in the Notifications table in the database"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
}
}
},
"DeleteServicePolicyRequest" : {
"required" : [
"i_service_policy"
],
"type" : "object",
"properties" : {
"i_service_policy" : {
"type" : "integer",
"description" : "The unique identifier of the service policy"
}
}
},
"CloseBillingPeriodResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"XDRErrorStatsInfo" : {
"type" : "object",
"properties" : {
"account_charge_error" : {
"type" : "integer",
"description" : "The number of the xDR records rejected due to account charge error"
},
"vendor_charge_error" : {
"type" : "integer",
"description" : "The number of the xDR records rejected due to vendor charge error"
},
"radius_error" : {
"type" : "integer",
"description" : "The number of the xDR records rejected due to Radius error"
},
"other_error" : {
"type" : "integer",
"description" : "The number of the xDR rejected records with not classified error"
}
}
},
"CounterInfo" : {
"type" : "object",
"properties" : {
"counter_value" : {
"type" : "number",
"description" : "Value of the counter"
},
"continued" : {
"type" : "integer",
"description" : "The amount of the used units is carried over on to the next period when counter is reset within a regular period"
},
"threshold_multiplier" : {
"type" : "number",
"description" : "The multiplication modifier for thresholds on prorated counter"
},
"rollover3" : {
"type" : "number",
"description" : "The rolled over quota amount will be expired in the +3 counter usage period"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"rate_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units used to calculate service charges"
},
"unit_counter" : {
"type" : "integer",
"description" : "The number of units"
},
"threshold_modifiers" : {
"$ref" : "#/components/schemas/CounterThresholdModifiersInfo"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"addon_priority" : {
"type" : "integer",
"description" : "The \"precedence level\" parameter of the add-on product"
},
"service_name" : {
"type" : "string",
"description" : "The name of the service"
},
"threshold_type" : {
"type" : "string",
"description" : "The type of the volume discount plan coounter threshold"
},
"dg_name" : {
"type" : "string",
"description" : "Destination group name"
},
"threshold_shift" : {
"type" : "number",
"description" : "The additive modifier for thresholds on the shifted base (rolled over) counter"
},
"i_cvd_counter" : {
"type" : "integer",
"description" : "The unique ID of the customer volume discount counter"
},
"i_avd_counter" : {
"type" : "integer",
"description" : "The unique ID of the account volume discount counter"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"money_continued" : {
"type" : "number",
"description" : "The amount of the used monetary is carried over on to the next period when counter is reset within a regular period"
},
"period_to" : {
"type" : "string",
"description" : "The end date of the counter"
},
"last_modified" : {
"type" : "string",
"description" : "The date and time when the counter was last updated"
},
"rollover2" : {
"type" : "number",
"description" : "The rolled over quota amount will be expired in the +2 counter usage period"
},
"period_from" : {
"type" : "string",
"description" : "The start date of the counter"
},
"allocated" : {
"type" : "number",
"description" : "The amount is allocated during this period and is used as a base for prorating rollovers"
},
"rollover1" : {
"type" : "number",
"description" : "The rolled over quota amount will be expired in the next counter usage period"
},
"peak_level" : {
"type" : "integer",
"description" : "ID of the Peak Level: 0 (Peak Period), 1 (Off-Peak Period), 2 (2nd Off-Peak Period)"
},
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the volume discount record (volume discount destination group record)"
},
"counter" : {
"type" : "number",
"description" : "The raw counter value"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"amounts" : {
"$ref" : "#/components/schemas/CounterAmountsInfo"
},
"rollovers" : {
"$ref" : "#/components/schemas/CounterRolloversInfo"
},
"rollover0" : {
"type" : "number",
"description" : "The rolled over quota amount will be expired in the current counter usage period"
}
}
},
"GetCustomerInvoicesResponse" : {
"type" : "object",
"properties" : {
"invoices" : {
"$ref" : "#/components/schemas/ArrayOfCustomerInvoicesListInfo"
},
"invoices_summary" : {
"$ref" : "#/components/schemas/CustomerInvoicesSummary"
},
"total" : {
"type" : "integer",
"description" : "Number of invoices"
}
}
},
"UpdateCustomerCustomFieldsValuesRequest" : {
"required" : [
"custom_fields_values"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"custom_fields_values" : {
"$ref" : "#/components/schemas/ArrayOfCustomFieldsValuesInfo"
}
}
},
"ProductPriorityInfo" : {
"required" : [
"value",
"name"
],
"type" : "object",
"properties" : {
"value" : {
"type" : "integer",
"description" : "Product priority value"
},
"name" : {
"type" : "string",
"description" : "Product priority level name"
}
}
},
"UpdateVendorDIDProviderAccountRequest" : {
"required" : [
"did_provider_account_info"
],
"type" : "object",
"properties" : {
"did_provider_account_info" : {
"$ref" : "#/components/schemas/DIDProviderAccountInfo"
}
}
},
"GetOliInfoRequest" : {
"type" : "object",
"properties" : {
"i_oli" : {
"type" : "integer",
"description" : "The unique ID of the OLI record"
}
}
},
"ArrayOfMOHInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MOHInfo"
}
},
"ConflictingAddOns" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of a product record"
},
"is_sf_enabled" : {
"type" : "integer",
"description" : "Specifies whether service features have been enabled"
},
"product_name" : {
"type" : "string",
"description" : "Product name"
}
}
},
"GetProductListResponse" : {
"required" : [
"product_list"
],
"type" : "object",
"properties" : {
"product_list" : {
"$ref" : "#/components/schemas/ArrayOfProductInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of found products"
}
}
},
"FullCounterInfo" : {
"type" : "object",
"properties" : {
"vdp_combination_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"rollover_periods" : {
"type" : "integer",
"description" : "The maximum number of usage periods that unused traffic can be rolled over (Allow no more than on the web interface). For example, if the usage period is monthly and you select 2, the unused traffic left from the first month will be rolled over to the second month and if not used completely, to the third month (2 rollovers). If unused traffic is not completely used by the end of the third month, it will expire. Note that if unused traffic from two or more usage periods is rolled over to the next one, the quota with the earliest expiration time is used first"
},
"service_ratio" : {
"type" : "integer",
"description" : "The service ratio"
},
"i_vd_type" : {
"type" : "integer",
"description" : "The unique ID of the discount type. Possible values: 1 - Discount; 2 - Quota"
},
"addon_priority" : {
"type" : "integer",
"description" : "In order to differentiate the add-on products there is also a \"precedence level\" parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Allowed values: 0 - Main Product; 10 - Low; 15 - Medium Low; 20 - Medium; 25 - Medium High; 30 - High"
},
"threshold_type" : {
"type" : "string",
"description" : "Specifies the threshold type: will you use thresholds based on the charged amount, or on the total call time? Amount means the threshold is measured in currency units (e.g. USD), and the counters will go up by the amount which the customer should have been charged for the call before the volume discount was applied. Volume means the unit is minutes, and the counters will go up by the same value as the charged call duration. Note the difference between call duration and charged call duration. For instance, if a rate specifies 5 minutes rounding and a customer has spoken for 3 minutes 42 seconds, he will be charged for 5 minutes and the counter will go up by 5 minutes as well"
},
"discount_info" : {
"type" : "string",
"description" : "Information about discount"
},
"discount_value" : {
"type" : "number",
"description" : "A value of the discount"
},
"usage_period" : {
"type" : "integer",
"description" : "This specifies how often the volume discount is reset. Possible values: Empty - One time - A volume discount is applied one time only; 1 - Daily - A volume discount is applied every day; 2 - Weekly - A volume discount is applied every week; 3 - Semimonthly - A volume discount is applied semimonthly; 4 - Monthly - A volume discount is applied every month"
},
"dg_name" : {
"type" : "string",
"description" : "A destination group name"
},
"threshold_shift" : {
"type" : "number",
"description" : "Shows how the discount threshold has shifted after rollovers. I.e., this reflects the sum of unused traffic rolled over from previous periods to the current one. Note that if a customer downgraded the volume discount plan after he had used more than the new plan offers, the sum will be negative"
},
"service_pool_info" : {
"$ref" : "#/components/schemas/ServiceInfo"
},
"next_discount_level" : {
"type" : "string",
"description" : "Next discount value"
},
"discounts" : {
"$ref" : "#/components/schemas/ArrayOfDiscounts"
},
"prev_threshold" : {
"type" : "number",
"description" : "Previous threshold value"
},
"discount_flag" : {
"type" : "string",
"description" : "Discount applicability: A - discount is available; U - not applicable (exceeded); N - excluded, e.g. when a higher priority discount prevents the use of a lower priority one"
},
"peak_level" : {
"type" : "string",
"description" : "An ID of the peak level: 0 - Peak period; 1 - Off-peak period; 2 - Second off-peak period"
},
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the discount for a specific destination group"
},
"tax_transaction_code" : {
"type" : "string",
"description" : "A tax code related to the taxation processor. Used for the service wallet top-up"
},
"used" : {
"type" : "string",
"description" : "Used discount amount"
},
"allocated_amount" : {
"type" : "number",
"description" : "The total amount of traffic (units) allocated to the customer in the current volume discount plan"
},
"threshold" : {
"type" : "string",
"description" : "Threshold value"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service"
},
"remaining" : {
"type" : "string",
"description" : "Remaining discount amount"
},
"combined_discount" : {
"type" : "number",
"description" : "Total discount to be applied. The discount_flag property must have the \"A\" value. When the discount is configured in such a way, that the discount can't be calculated in advance (only for a specific call), then this will show the maximum combined discount"
},
"service_name" : {
"type" : "string",
"description" : "The name of the service"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"period_to" : {
"type" : "string",
"description" : "Discount reset date"
},
"discount_level" : {
"type" : "string",
"description" : "Current discount value"
},
"period_from" : {
"type" : "string",
"description" : "Discount start date"
},
"unit" : {
"type" : "string",
"description" : "Units (e.g. USD, minutes)"
},
"rollover_info" : {
"$ref" : "#/components/schemas/ArrayOfRollovers"
},
"full_discount_info" : {
"$ref" : "#/components/schemas/DiscountInfo"
},
"continued_unit_amount" : {
"type" : "number",
"description" : "Shows the amount of traffic used in the current usage period before the volume discount plan change"
},
"vdp_name" : {
"type" : "string",
"description" : "The name of the volume discount plan"
},
"combining_mode" : {
"type" : "string",
"description" : "Defines the possibility of combining various discount plans when more then one discount plan is applicable for the same session (call): I - Never - the full override, when the higher priority discount prevents the use of lower priority ones; N - Always - the discount rate is summed up to 100% (we never give money back for the call). For example, two 30% discounts will result in 60% resulting discount, 70% + 40% discount rates will only result in 100% discount; Y - When discount lower than 100 is active – as long as a higher priority discount defines 100% rate, all the lower priority discounts are not applied. Only after the volume exceeds the 100% discount rate threshold of the discount, the rest of the discounts can be applied. For example, Germany 100% discounted calls for 50 minutes exclusively, followed by 1000 minutes of 50% discount rate, while another discount for EU has 30% discount rate. The EU discount will only become applicable if the 50 minutes are used up, then the total discount rate will be 30+50=80% for a call to Germany; F – After reaching the last threshold limit – the higher priority discount prevents the use of lower priority ones until the last limited threshold is reached (regardless of discount rate). For example, Germany 100% discounted calls for 50 minutes exclusively, followed by 1000 minutes of 50% discount rate, while another discount for EU has 30% discount rate. The EU discount will only become applicable if the 1050 minutes are used up"
}
}
},
"GetUATypeUsageStatisticsRequest" : {
"type" : "object"
},
"GetTrafficProfileListRequest" : {
"type" : "object",
"properties" : {
"with_extended_info" : {
"type" : "integer",
"description" : "If the field is equal to 1, the method returns the following additional fields in the response: customer_name, dest_group_set_name"
},
"name" : {
"type" : "string",
"description" : "The name of the traffic profile to search by"
},
"iso_4217" : {
"type" : "string",
"description" : "The currency of the traffic profile to search by"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The identifier of the destination group set to search traffic profiles by"
},
"check_draft" : {
"type" : "integer",
"description" : "A flag that specifies whether it needs to be checked if the traffic profiles are configured. If true - the 'is_draft' flag will be returned for each retrieved record"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the traffic profiles are in use"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"i_customer" : {
"type" : "integer",
"description" : "The identifier of the traffic profile owner to search by"
},
"with_spending_constraint" : {
"type" : "integer",
"description" : "If the field is equal to 1, the method returns additionally spending constraint info for each traffic profile"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"CustomerDIDProviderIdent" : {
"type" : "object",
"properties" : {
"reseller_batch" : {
"type" : "integer",
"description" : "The unique ID of the DID Owner Batch assigned to reseller"
},
"customer_batch" : {
"type" : "integer",
"description" : "The unique ID of the DID Owner Batch assigned to customer"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"AddUpdateFollowMeNumberResponse" : {
"required" : [
"i_follow_me_number"
],
"type" : "object",
"properties" : {
"i_follow_me_number" : {
"type" : "integer",
"description" : "ID of follow-me number database record"
}
}
},
"GetCustomerBatchInfoRequest" : {
"required" : [
"i_batch"
],
"type" : "object",
"properties" : {
"i_batch" : {
"type" : "integer",
"description" : "The unique ID of the batch"
}
}
},
"DeleteFraudConstraintRequest" : {
"required" : [
"i_ft_constraint"
],
"type" : "object",
"properties" : {
"i_ft_constraint" : {
"type" : "integer",
"description" : "The identifier of the fraud constraint"
}
}
},
"RawProductInfo" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"default_i_acl" : {
"type" : "integer",
"description" : "Which ACL should be assigned to new accounts created with this product"
},
"topup_addon" : {
"type" : "string",
"description" : "Specifies whether this is an add-on product or the main one. Possible values: Y – an add-on product, N – the main product"
},
"subscription_host" : {
"type" : "string",
"description" : "Left for backward compatibility"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for product currency"
},
"shared" : {
"type" : "string",
"description" : "Shows whether the product managed by the administrator is available to resellers"
},
"addon_effective_to" : {
"type" : "string",
"description" : "Account product addon effective to date"
},
"addon_priority" : {
"type" : "integer",
"description" : "In order to differentiate the add-on products there is also a \"precedence level\" parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Allowed values: 0 – Main Product, 10 – Low, 15 – Medium Low, 20 – Medium, 25 – Medium High, 30 – High"
},
"info_url" : {
"type" : "string",
"description" : "URL to an external website describing product features"
},
"product_subscription" : {
"$ref" : "#/components/schemas/ProductSubscriptionInfo"
},
"is_used" : {
"type" : "integer",
"description" : "Shows if product is used or not"
},
"name" : {
"type" : "string",
"description" : "Product name"
},
"description" : {
"type" : "string",
"description" : "Product description"
},
"volume_discount_plan_name" : {
"type" : "string",
"description" : "The name of the associated volume discount plan"
},
"i_product_group" : {
"type" : "integer",
"description" : "Product Group ID"
},
"gui_options" : {
"$ref" : "#/components/schemas/ANY"
},
"end_user_name" : {
"type" : "string",
"description" : "Product Name visible to End User"
},
"breakage" : {
"type" : "number",
"description" : "Used in Account Management to obtain a summary of depleted (practically unusable) accounts"
},
"is_used_by_resellers" : {
"type" : "integer",
"description" : "Shows whether the shared product is used by resellers"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Plan"
},
"realm" : {
"type" : "string",
"description" : "A custom string. An account realm enables administrators to impose a scope of uniqueness for an account ID"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "ID of an assigned volume discount plan"
},
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
},
"product_group_name" : {
"type" : "string",
"description" : "Product Group name"
},
"allowed_products" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
},
"subscription_discount_list" : {
"$ref" : "#/components/schemas/SubscriptionDiscountList"
},
"i_account_role" : {
"type" : "integer",
"description" : "The unique ID of the account role; refers to the Account_Roles table. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a topup voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID"
},
"service_flag_locks" : {
"type" : "string",
"description" : "The service flag locks"
},
"addon_effective_from" : {
"type" : "string",
"description" : "Account product addon effective from date"
},
"included_services" : {
"$ref" : "#/components/schemas/ArrayOfProductIncludedServices"
},
"end_user_description" : {
"type" : "string",
"description" : "Description visible to End User"
},
"notepad" : {
"type" : "string",
"description" : "Product notepad"
},
"managed_by_user" : {
"type" : "string",
"description" : "Can be managed by end user"
},
"i_customer" : {
"type" : "integer",
"description" : "Managed by"
},
"hidden" : {
"type" : "string",
"description" : "Indicates whether the product is hidden"
},
"fraud_protection" : {
"type" : "string",
"description" : "Overdraft Protection mode for the Product. Possible values: 'None', 'All', 'Debit'"
}
}
},
"UpdateAccessPolicyResponse" : {
"required" : [
"i_access_policy"
],
"type" : "object",
"properties" : {
"i_access_policy" : {
"type" : "integer",
"description" : "The unique ID of the access policy"
}
}
},
"ServiceFeaturesConflicts" : {
"type" : "object",
"properties" : {
"conflicting_addons" : {
"$ref" : "#/components/schemas/ArrayOfConflictingAddOns"
},
"addon_precedence" : {
"type" : "string",
"description" : "In order to differentiate the add-on products there is also a \"precedence level\" parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level"
},
"sf_name" : {
"type" : "string",
"description" : "Service feature name"
}
}
},
"ArrayOfAuthzMethodTypeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AuthzMethodTypeInfo"
}
},
"GetSIMCardListResponse" : {
"type" : "object",
"properties" : {
"card_list" : {
"$ref" : "#/components/schemas/ArrayOfSIMCardInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of retrieved SIM card data records"
}
}
},
"NetaccessUsageRecordInfo" : {
"type" : "object",
"properties" : {
"period_from" : {
"type" : "string",
"description" : "The date and the time when net access usage started according to the record"
},
"peak_level" : {
"type" : "integer",
"description" : "The ID of the peak level (0 - Peak period, 1 - Off-peak period, 2 - 2nd Off-peak period)"
},
"period_to" : {
"type" : "string",
"description" : "The date and the time when net access usage stopped according to the record"
},
"bytes_downloaded" : {
"type" : "integer",
"description" : "The number of bytes that were downloaded from 'period_from' to 'period_to'"
},
"xdr_id" : {
"type" : "integer",
"description" : "The unique ID of the xDR related to the net access usage record"
},
"bytes_uploaded" : {
"type" : "integer",
"description" : "The number of bytes that were uploaded from 'period_from' to 'period_to'"
}
}
},
"AddSIMCardRequest" : {
"required" : [
"card_info"
],
"type" : "object",
"properties" : {
"card_info" : {
"$ref" : "#/components/schemas/SIMCardInfo"
}
}
},
"GetCustomerVdCounterHistoryListResponse" : {
"type" : "object",
"properties" : {
"vd_counter_history_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerVdCounterHistoryInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"MatchDestinationGroupsResponse" : {
"type" : "object",
"properties" : {
"dest_group_list" : {
"$ref" : "#/components/schemas/ArrayOfDestinationGroupInfo"
}
}
},
"TemplateDataGroupInfo" : {
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"direction" : {
"type" : "string",
"description" : "Specifies the order the data will be sorted within the group. Possible values: ASC, DESC"
},
"group_name" : {
"type" : "string",
"description" : "The name of the data group"
},
"i_tdg" : {
"type" : "integer",
"description" : "The unique ID of the data group"
},
"is_system" : {
"type" : "integer",
"description" : "Shows whether the group is system"
},
"break_expr" : {
"type" : "string",
"description" : "Defines the group the data should belong to"
},
"group_order" : {
"type" : "integer",
"description" : "Defines the order in which the data group will be included in the invoice"
}
}
},
"RoamingCountryInfo" : {
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "A two-letter country code defined in ISO 3166-1 alpha-2"
},
"name" : {
"type" : "string",
"description" : "The roaming country name"
},
"continent_code" : {
"type" : "string",
"description" : "The code of the continent where the country is located"
}
}
},
"UpdateAccountFollowMeRequest" : {
"required" : [
"i_account",
"followme_info"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"followme_info" : {
"$ref" : "#/components/schemas/FollowMeInfo"
}
}
},
"ArrayOfDiscounts" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Discounts"
}
},
"DeleteCustomerSiteResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if success, otherwise SOAP fault"
}
}
},
"GetServiceFeaturesListResponse" : {
"type" : "object",
"properties" : {
"service_features_list" : {
"$ref" : "#/components/schemas/ServiceFeaturesList"
}
}
},
"ArrayOfAccountPerServiceInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountPerServiceInfo"
}
},
"ArrayOfCommitmentInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CommitmentInfo"
}
},
"AddQFRequest" : {
"required" : [
"qf_info"
],
"type" : "object",
"properties" : {
"qf_info" : {
"$ref" : "#/components/schemas/QFAddInfo"
}
}
},
"GetAccountSWXDRListResponse" : {
"type" : "object",
"properties" : {
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfServiceWalletXDRInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved xDRs"
}
}
},
"AddFollowMeNumberListRequest" : {
"type" : "object",
"properties" : {
"followme_numbers" : {
"$ref" : "#/components/schemas/ArrayOfFollowMeNumberInfo"
}
}
},
"ProductGetProductDiscountPlanListRequest" : {
"required" : [
"i_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The ID of the product"
}
}
},
"DownloadCollectionSkippedXDRsRequest" : {
"required" : [
"collection_name"
],
"type" : "object",
"properties" : {
"collection_name" : {
"type" : "string",
"description" : "The name of the xDR collection"
}
}
},
"UpdateNodeRequest" : {
"required" : [
"node_info"
],
"type" : "object",
"properties" : {
"node_info" : {
"$ref" : "#/components/schemas/NodeInfo"
}
}
},
"GetPaymentTransactionRequest" : {
"required" : [
"i_payment_transaction"
],
"type" : "object",
"properties" : {
"i_payment_transaction" : {
"type" : "integer",
"description" : "The unique ID of a payment transaction"
}
}
},
"GenerateUaProfileRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of an account record for which the profile will be generated"
},
"i_ua" : {
"type" : "integer",
"description" : "The unique ID of a UA record; refers to the UA table"
},
"phone_type" : {
"type" : "string",
"description" : "Type of the phone for which profile should be generated. Possible values: Onenetuno, Sipura, Linksys, Cisco, Yealink, Grandmaster, Thompson, PortaPhone(default), Polycom, Gigaset, ATA, etc."
},
"get_url" : {
"type" : "integer",
"description" : "The URL of the generated profile"
},
"ua_profile_id" : {
"type" : "integer",
"description" : "The ID of the UA profile"
}
}
},
"ArrayOfRawProductInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RawProductInfo"
}
},
"GenericGetAPISchemaRequest" : {
"type" : "object",
"properties" : {
"with_output_schema" : {
"type" : "integer",
"description" : "If set to '1', information about API methods' output structures will be shown in the response"
},
"service_name" : {
"type" : "string",
"description" : "The name of the API service"
},
"method_name" : {
"type" : "string",
"description" : "The name of the API method"
}
}
},
"GetGlobalCurrencyListRequest" : {
"type" : "object",
"properties" : {
"obsolete" : {
"type" : "string",
"description" : "Specifies what currency to fetch. Possible values are: all, actual, obsolete"
}
}
},
"AddMerchantAccountRequest" : {
"required" : [
"merchant_account"
],
"type" : "object",
"properties" : {
"detailed_response" : {
"type" : "integer",
"description" : "Specifies whether the added record will be returned in response or not"
},
"merchant_account" : {
"$ref" : "#/components/schemas/MerchantAccount"
}
}
},
"GetTimePeriodListResponse" : {
"type" : "object",
"properties" : {
"time_period_list" : {
"$ref" : "#/components/schemas/ArrayOfTimePeriodInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved time period data records"
}
}
},
"DeleteDestinationPrefixRequest" : {
"required" : [
"i_dest"
],
"type" : "object",
"properties" : {
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of a destination record"
}
}
},
"CloneDiscountPlanRequest" : {
"required" : [
"name",
"i_vd_plan"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the discount plan clone"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan to be cloned"
}
}
},
"GetFraudTrafficAlertListResponse" : {
"type" : "object",
"properties" : {
"fraud_traffic_alert_list" : {
"$ref" : "#/components/schemas/ArrayOfFraudTrafficAlertInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of retrieved records"
}
}
},
"GetUIConfigListResponse" : {
"required" : [
"ui_config_list"
],
"type" : "object",
"properties" : {
"ui_config_list" : {
"$ref" : "#/components/schemas/ArrayOfUIConfigInfo"
}
}
},
"AssignCommitmentResponse" : {
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
}
}
},
"TaxPluginParameterInfo" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The value of the taxation plugin parameter"
},
"name" : {
"type" : "string",
"description" : "The name of the taxation plugin parameter"
}
}
},
"MetricGroupingValueInfo" : {
"required" : [
"range_size"
],
"type" : "object",
"properties" : {
"range_size" : {
"type" : "string",
"description" : "The size of each group in the response. The data will be grouped into ranges of the specified size. Min value: 1"
}
}
},
"GetCustomerExtensionInfoRequest" : {
"required" : [
"i_c_ext"
],
"type" : "object",
"properties" : {
"i_c_ext" : {
"type" : "integer",
"description" : "The unique ID of the extension record. Refers to the Centrex_Extensions table"
},
"detailed_info" : {
"type" : "integer",
"description" : "Detailed information"
},
"get_prompt_file" : {
"type" : "integer",
"description" : "The prompt file associated with this extension"
}
}
},
"GetAPIErrorFileRequest" : {
"required" : [
"uuid"
],
"type" : "object",
"properties" : {
"keep_stored" : {
"type" : "integer",
"description" : "A flag that indicates whether to keep the file in the DB after fetching. Possible values: 1 - keep the file, 0 - remove it. Default value: 0"
},
"uuid" : {
"type" : "string",
"description" : "The unique identifier of the file. It usually is returned in the fault details of other API methods"
}
}
},
"DeleteCPConditionRequest" : {
"required" : [
"cp_condition_info"
],
"type" : "object",
"properties" : {
"cp_condition_info" : {
"$ref" : "#/components/schemas/CPConditionInfo"
}
}
},
"MakeVDTransactionRequest" : {
"required" : [
"i_service",
"i_dest_group",
"amount",
"peak_level",
"action",
"recipient_id"
],
"type" : "object",
"properties" : {
"verification_code" : {
"type" : "string",
"description" : "The verification code"
},
"recipient_i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the recipient's volume discount record"
},
"i_dest_group" : {
"type" : "integer",
"description" : "Unique Destination Group ID"
},
"i_service" : {
"type" : "integer",
"description" : "Unique Service ID"
},
"sender_id" : {
"type" : "integer",
"description" : "The ID of the account record that sends services"
},
"sender_i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the sender's volume discount record"
},
"visible_comment" : {
"type" : "string",
"description" : "The comment for the transaction"
},
"addon_priority" : {
"type" : "integer",
"description" : "The add-on product's precedence level. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Possible values: 0 – Main product, 10 – Low, 15 – Medium low, 20 – Medium, 25 – Medium high, 30 – High"
},
"amount" : {
"type" : "number",
"description" : "The amount of service units to transfer"
},
"peak_level" : {
"type" : "string",
"description" : "An ID of the peak level. Possible values: 0 - Peak period"
},
"with_expiration_date" : {
"type" : "integer",
"description" : "The flag shows whether to transfer the expiration date to the recipient's discount record; can be used only by administrators and resellers"
},
"action" : {
"type" : "string",
"description" : "Possible values: transfer"
},
"recipient_id" : {
"type" : "integer",
"description" : "The ID of the account record that receives services"
}
}
},
"RevertXDRListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"UpdatePreferableAccountResponse" : {
"required" : [
"i_preferable_account"
],
"type" : "object",
"properties" : {
"i_preferable_account" : {
"type" : "integer",
"description" : "The unique ID of the frequently used account"
}
}
},
"GetCustomRTTicketsListResponse" : {
"required" : [
"tickets_list"
],
"type" : "object",
"properties" : {
"tickets_list" : {
"$ref" : "#/components/schemas/ArrayOfTicketInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of retrieved reports"
}
}
},
"AddServiceAndRatingRequest" : {
"required" : [
"service_and_rating_info"
],
"type" : "object",
"properties" : {
"detailed_response" : {
"type" : "integer",
"description" : "Flag which shows whether added record should be returned in response or not"
},
"service_and_rating_info" : {
"$ref" : "#/components/schemas/ServiceAndRatingInfo"
}
}
},
"DeleteCCStaffRequest" : {
"required" : [
"i_cc_staff"
],
"type" : "object",
"properties" : {
"i_cc_staff" : {
"type" : "integer",
"description" : "The unique ID of the CC Staff record to be deleted"
}
}
},
"GetServicePoolListResponse" : {
"type" : "object",
"properties" : {
"service_pool_list" : {
"$ref" : "#/components/schemas/ArrayOfServices"
}
}
},
"ArrayOfDeleteDIDNumberInfoStatus" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DeleteDIDNumberInfoStatus"
}
},
"GetDefaultCallBarringOptionInfoResponse" : {
"type" : "object",
"properties" : {
"default_cb_option_info" : {
"$ref" : "#/components/schemas/DefaultCallBarringOptionInfo"
}
}
},
"ReturnDIDNumberResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "One of the following: 1 – success, 0 – failed"
}
}
},
"SIMCardInfo" : {
"type" : "object",
"properties" : {
"auth_key" : {
"type" : "string",
"description" : "Authentication key"
},
"hlr" : {
"type" : "string",
"description" : "The name of Home Location Register database"
},
"iccid" : {
"type" : "string",
"description" : "The Integrated Circuit Card ID"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who owns the SIM card"
},
"imsi" : {
"type" : "string",
"description" : "The International Mobile Subscriber Identity of the SIM card"
},
"description" : {
"type" : "string",
"description" : "SIM card description"
},
"opc_key" : {
"type" : "string",
"description" : "The operator key associated with and stored on the SIM card"
},
"i_account" : {
"type" : "integer",
"description" : "The ID of the account record"
},
"amf" : {
"type" : "string",
"description" : "The authentication management field"
},
"msisdn" : {
"type" : "string",
"description" : "The Mobile Subscriber Integrated Services Digital Number. This is the account ID (PIN) on the PortaBilling interface"
},
"notepad" : {
"type" : "string",
"description" : "Comments regarding this SIM card"
},
"i_sim_card" : {
"type" : "integer",
"description" : "The ID of the SIM card record"
}
}
},
"ArrayOfSessionParticipant" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SessionParticipantInfo"
}
},
"ArrayOfCustomerMetricInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerMetricInfo"
}
},
"ArrayOfCustomerClassMetricInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerClassMetricInfo"
}
},
"ArrayOfMarketingGroupInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MarketingGroupInfo"
}
},
"GetCriteriaListRequest" : {
"required" : [
"i_bd_plan"
],
"type" : "object",
"properties" : {
"i_bd_plan" : {
"type" : "integer",
"description" : "The unique ID of the Bundle Promotion Plan"
},
"with_thresholds" : {
"type" : "integer",
"description" : "Specifies whether to show the list of thresholds associated with the criteria. 1 – Show the list of thresholds. 0 – Do not show the list of thresholds."
},
"get_total" : {
"type" : "integer",
"description" : "Specifies whether to show the total number of criteria found. Then, even if, e.g. the limit property is specified, the total number of criteria that satisfy other conditions will be shown."
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetProductListRequest" : {
"type" : "object",
"properties" : {
"show_inactive" : {
"type" : "string",
"description" : "Possible values: 'Y', 'N', 'A'"
},
"search" : {
"type" : "string",
"description" : "Search products by name and description"
},
"i_product_group" : {
"type" : "integer",
"description" : "The unique ID of the product group"
},
"iso_4217" : {
"type" : "string",
"description" : "Product Currency"
},
"skip_details" : {
"type" : "integer",
"description" : "Flag which indicates whether the only basic product info will be fetched. It makes request more lightweight"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"managed_by_admin" : {
"type" : "string",
"description" : "Indicates that products are managed by admin only should be fetched. Possible values: 'Y', 'N'. The option is available for the administrator only"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"with_subscription" : {
"type" : "integer",
"description" : "Flag which indicates whether the Product subscription should be returned"
},
"with_subreseller_products" : {
"type" : "integer",
"description" : "If set to '1', enables admin to retrieve product list of subordinate resellers (second-level and deeper)"
},
"account_roles" : {
"$ref" : "#/components/schemas/ArrayOfInt"
},
"name" : {
"type" : "string",
"description" : "Refers to Product name"
},
"with_shared" : {
"type" : "integer",
"description" : "If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of Customer Record (managed by)"
},
"type" : {
"type" : "string",
"description" : "Type of products to be fetched. Possible values: 'main', 'addon'"
}
}
},
"GetAccountCustomFieldsSchemaResponse" : {
"type" : "object",
"properties" : {
"custom_fields" : {
"$ref" : "#/components/schemas/ArrayOfAccountCustomFieldsInfo"
}
}
},
"DefaultCallBarringOptionInfo" : {
"type" : "object",
"properties" : {
"i_default_cb_option" : {
"type" : "integer",
"description" : "The unique ID of the default call barring option record"
},
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the call barring rule record"
}
}
},
"UpdateVendorResponse" : {
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the created vendor"
}
}
},
"DeleteDIDNumberRequest" : {
"required" : [
"i_did_number"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "DID number to delete"
}
}
},
"UpdateAccountCustomFieldsValuesRequest" : {
"required" : [
"custom_fields_values"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"custom_fields_values" : {
"$ref" : "#/components/schemas/ArrayOfCustomFieldsValuesInfo"
}
}
},
"PaymentTransactionListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved transactions"
},
"payment_transactions" : {
"$ref" : "#/components/schemas/ArrayOfTransactionInfo"
}
}
},
"SessionParticipantInfo" : {
"type" : "object",
"properties" : {
"sip_node" : {
"type" : "string",
"description" : "The IP address of the SIP node"
},
"participant_id" : {
"type" : "string",
"description" : "The unique identifier of the participant"
},
"name" : {
"type" : "string",
"description" : "The name of the participant"
},
"alias" : {
"type" : "string",
"description" : "The alias of the participant"
},
"host" : {
"type" : "string",
"description" : "The host name of the participant"
},
"product_name" : {
"type" : "string",
"description" : "The product name of the participant"
}
}
},
"CustomerPerServiceInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"ratio" : {
"type" : "integer",
"description" : "Billing:Base Ratio. If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration"
},
"rating_base_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units in which service use is measured; this also is the smallest possible unit you use in the rating configuration (e.g. second)"
},
"credits" : {
"type" : "number",
"description" : "The sum of credit transaction amounts related to the service"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service; refers to Services table"
},
"rate_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units used to calculate service charges (e.g. message, minute)"
},
"name" : {
"type" : "string",
"description" : "The service name"
},
"charges" : {
"type" : "number",
"description" : "The sum of charge transaction amounts related to the service"
},
"total" : {
"type" : "integer",
"description" : "Subtotal for this type of transactions/service"
},
"unit" : {
"type" : "string",
"description" : "The unit in which the charged quantity is shown (e.g. second)"
},
"charged_amount" : {
"type" : "number",
"description" : "The sum of the amounts in the 'credits' and 'charges' fields"
},
"charged_quantity" : {
"type" : "integer",
"description" : "Units charged"
},
"rating_base" : {
"type" : "string",
"description" : "Specifies which particular parameter is used to calculate charges, e.g. \"session time\", \"amount of data transferred\" and the like"
},
"total_sessions" : {
"type" : "integer",
"description" : "The total number of sessions of this transactions/service type"
}
}
},
"DeleteOwnerBatchResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 – DID Pricing Batch was deleted, 0 – DID Pricing Batch was not deleted"
}
}
},
"NotificationPresetCategoryInfo" : {
"type" : "object",
"properties" : {
"send_sms" : {
"type" : "integer",
"description" : "Specifies whether this notifications will be sent by sms. Possible values: 1 - The notifications will be sent by SMS, 0 - The notifications will not be sent by SMS"
},
"send_mail" : {
"type" : "integer",
"description" : "Specifies whether this notifications will be sent by email. Possible values: 1 - The notifications will be sent by email, 0 - The notifications will not be sent by email"
},
"name" : {
"type" : "string",
"description" : "The name of the notification category"
},
"i_notification_category" : {
"type" : "integer",
"description" : "The unique ID of the notification category"
}
}
},
"DeleteRouteCategoryResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success"
}
}
},
"AccountCommitmentRecurringEstimateTermInfo" : {
"type" : "object",
"properties" : {
"fee" : {
"type" : "number",
"description" : "The estimated fee including discounts"
},
"i_recurring_term" : {
"type" : "integer",
"description" : "The unique identifier of the recurring term"
}
}
},
"GetNegotiatedFeatureListResponse" : {
"type" : "object",
"properties" : {
"negotiated_feature_list" : {
"$ref" : "#/components/schemas/ArrayOfNegotiatedFeatureInfo"
}
}
},
"GetServiceAndRatingInfoRequest" : {
"required" : [
"i_accessibility"
],
"type" : "object",
"properties" : {
"i_accessibility" : {
"type" : "integer",
"description" : "The unique ID of the rating entry record"
}
}
},
"ArrayOfCustomerBatchInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerBatchInfo"
}
},
"ReleaseDIDFromCustomerRequest" : {
"required" : [
"i_did_number"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "DID number to release"
},
"unassign_owner_batch" : {
"type" : "string",
"description" : "Specifies whether to unassign the DID number from a pricing batch. Possible values: Y – Unassign the DID number from a pricing batch; N – Do not unassign the DID number from a pricing batch. Default value is N"
}
}
},
"GetVDThresholdInfoRequest" : {
"required" : [
"i_vd_threshold"
],
"type" : "object",
"properties" : {
"i_vd_threshold" : {
"type" : "integer",
"description" : "The unique ID of a threshold from a specific discount"
}
}
},
"TemplateUpdateTemplateGroupFieldListRequest" : {
"required" : [
"i_template",
"template_group_field_list"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"template_group_field_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateGroupFieldInfo"
}
}
},
"InvoiceStatusInfo" : {
"type" : "object",
"properties" : {
"i_invoice_status" : {
"type" : "integer",
"description" : "The unique ID of the invoice status record"
},
"description" : {
"type" : "string",
"description" : "The status description"
}
}
},
"GetAccessNumberInfoRequest" : {
"required" : [
"i_ivr_an"
],
"type" : "object",
"properties" : {
"i_ivr_an" : {
"type" : "integer",
"description" : "The unique ID of the IVR access number"
}
}
},
"GetUATypeListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved UA types"
},
"ua_type_list" : {
"$ref" : "#/components/schemas/ArrayOfUATypeInfo"
}
}
},
"AccountGetTracedXdrListRequest" : {
"type" : "object"
},
"AddCustomerMigrationRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"migrate_on" : {
"type" : "string",
"description" : "The date when the customer will be migrated"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"DIDProviderInfo" : {
"type" : "object",
"properties" : {
"provider_currency" : {
"type" : "string",
"description" : "The DID provider currency. For the customer it means their actual currency used when buying the DID from the provider"
},
"i_did_provider" : {
"type" : "integer",
"description" : "The unique ID of the DID provider"
},
"name" : {
"type" : "string",
"description" : "The DID provider name"
},
"is_numbers_list_available" : {
"type" : "integer",
"description" : "The flag which indicates whether the DID provider allows to choose a particular number from the provided list"
}
}
},
"GetCustomerConsumedServiceRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"show_unsuccessful" : {
"type" : "integer",
"description" : "Show records of unsuccessful attempts"
},
"billing_model" : {
"type" : "integer",
"description" : "Indicates whether the data should be retrieved for the credit entries or for the debit ones: -1 - Debit account type; 1 - Credit account type"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"from_date" : {
"type" : "string",
"description" : "Get information recorded starting from this date"
},
"group_by_roaming" : {
"type" : "integer",
"description" : "Group xDRs by their roaming status"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved services"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"limit" : {
"type" : "integer",
"description" : "The number of servies to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"i_invoice" : {
"type" : "integer",
"description" : "Indicates what xDRs will be shown: nill - Midterm xDRs and out-of-turn xDRs; 0 - Out Of Turn xDRs; Not set - xDRs of all types"
},
"to_date" : {
"type" : "string",
"description" : "Get information recorded before this date"
}
}
},
"AccountEstimateTaxesRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"use_xdrs_from_db_up_to_date" : {
"type" : "string",
"description" : "Get transactions (xDRs) from the database instead of xdr_list. The transactions for the period starting from the previous bill_to time to the specified time will be taken. Possible values: A specific date and time in the 'YYYYMM-DD HH24:MI:SS' format; 'now'"
},
"issue_date" : {
"type" : "string",
"description" : "The date when transactions took place (xDRs were created). It is used only for the EZtax (formerly known as BillSoft EZtax) plug-in. The default value is 'now'"
},
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfEstimateTaxesXDRInfo"
},
"calc_taxes" : {
"type" : "integer",
"description" : "Specifies whether to calculate the tax or just show tax rates Possible values: 0 or undefined – return tax rates; 1 – calculate the tax for the provided xDRs"
}
}
},
"GetSubscriptionListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The number of the retrieved subscription data records"
},
"subscriptions" : {
"$ref" : "#/components/schemas/ArrayOfSubscriptionInfo"
}
}
},
"DestinationGetMCCListResponse" : {
"type" : "object",
"properties" : {
"mcc_list" : {
"$ref" : "#/components/schemas/ArrayOfMCCInfo"
}
}
},
"MetricGroupingFilterInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "A filter field name. Data points that have the same tag value will be grouped together. Possible values: connection - for connection metrics; cc_staff - for CC staff metrics; ip - for PSMSC metrics"
}
}
},
"CommitmentRecurringTermInfo" : {
"type" : "object",
"properties" : {
"i_commitment" : {
"type" : "integer",
"description" : "The identifier of the commitment record"
},
"discount_amount" : {
"type" : "number",
"description" : "The discount amount to apply to the recurring charge"
},
"i_subscription" : {
"type" : "integer",
"description" : "The identifier of the subscription"
},
"i_addon_product" : {
"type" : "integer",
"description" : "The identifier of the addon product"
},
"i_recurring_term" : {
"type" : "integer",
"description" : "The unique identifier of the commitment recurring term"
}
}
},
"SupportedLanguageInfo" : {
"type" : "object",
"properties" : {
"i_voice_application" : {
"type" : "integer",
"description" : "The ID of the corresponding voice application"
},
"iso_639_1" : {
"type" : "string",
"description" : "The ISO 639-1 code of the language"
},
"name" : {
"type" : "string",
"description" : "The name of the language"
}
}
},
"GetTrafficProfileInfoResponse" : {
"type" : "object",
"properties" : {
"traffic_profile_info" : {
"$ref" : "#/components/schemas/TrafficProfileInfo"
}
}
},
"GetEspfApiTokenRequest" : {
"type" : "object"
},
"AddRouteCategoryRequest" : {
"required" : [
"route_category_info"
],
"type" : "object",
"properties" : {
"route_category_info" : {
"$ref" : "#/components/schemas/RouteCategoryInfo"
}
}
},
"AddProductResponse" : {
"required" : [
"i_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"product_info" : {
"$ref" : "#/components/schemas/ProductInfo"
}
}
},
"ArrayOfMetricGroupingFilterInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MetricGroupingFilterInfo"
}
},
"FollowMeNumberInfo" : {
"type" : "object",
"properties" : {
"i_follow_me" : {
"type" : "integer",
"description" : "ID of the follow-me database record"
},
"max_sim_calls" : {
"type" : "integer",
"description" : "Limits simultaneous calls. When the specified number of concurrent calls has already been established (calls are in a \"connected\" state) and the account tries to place another call, that call will be rejected"
},
"period_definition" : {
"$ref" : "#/components/schemas/ArrayOfSubPeriodInfo"
},
"i_account" : {
"type" : "integer",
"description" : "The follow-me record's unique ID"
},
"domain" : {
"type" : "string",
"description" : "IP Address of the network device the call will be routed to. Applies to the Advanced Forwarding and Forward to SIP URI forward mode settings"
},
"timeout" : {
"type" : "integer",
"description" : "Number timeout, in seconds"
},
"weight" : {
"type" : "number",
"description" : "Record weight (probability)"
},
"keep_original_cld" : {
"type" : "string",
"description" : "If set to Y, the call will appear as originated by the account forwarding the call; applies to the Advanced Forwarding, Forward to SIP URI and Forward CLD forward mode settings"
},
"i_follow_order" : {
"type" : "integer",
"description" : "Serial number or follow-me entry, sequentially incremented within array of numbers"
},
"period" : {
"type" : "string",
"description" : "Period during which number can be used. Possible values: Always; Null; Time: hours, minute; The list of months: 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec'; The list of month day numbers: values from 1 to 31; The list of week days: 'su', 'mo', 'tu', 'we', 'th', 'fr', 'sa'. For instance: wd{fr},hr{5},min{35},md{5},m{jan}"
},
"redirect_number" : {
"type" : "string",
"description" : "The number's destination"
},
"period_description" : {
"type" : "string",
"description" : "Verbal description of the period seen by a user on the web interface"
},
"active" : {
"type" : "string",
"description" : "Defines use of follow-me number"
},
"name" : {
"type" : "string",
"description" : "The entry's symbolic name "
},
"keep_original_cli" : {
"type" : "string",
"description" : "Y – a call is forwarded with the phone number and the name of the original caller; N – a call is forwarded with the phone number and the name of the forwarder; I – the phone number of the caller and the forwarder name are put in the CLI of the forwarded call"
},
"use_tcp" : {
"type" : "string",
"description" : "Enables you to choose the TCP transport protocol. You can use the TCP protocol instead of UDP for SIP communications for PBXs that do not support UDP"
},
"i_follow_me_number" : {
"type" : "integer",
"description" : "The unique ID for the followme number in the table"
}
}
},
"GetCustomerBatchList" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the batch is in use"
},
"name" : {
"type" : "string",
"description" : "The name of the batch. This property is useful when it is required to retieve the list of batches which names fit a particular pattern"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved batches"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"AddUpdateCriterionRequest" : {
"required" : [
"criterion_info"
],
"type" : "object",
"properties" : {
"criterion_info" : {
"$ref" : "#/components/schemas/CriterionInfo"
}
}
},
"NegotiatedFeatureInfo" : {
"type" : "object",
"properties" : {
"i_voice_negotiate_feature" : {
"type" : "integer",
"description" : "The unique ID of the call media feature"
},
"group_name" : {
"type" : "string",
"description" : "The name of the call media feature group"
},
"name" : {
"type" : "string",
"description" : "The name of the call media feature (such as a specific codec or T.38 fax capability)"
},
"requirement" : {
"type" : "integer",
"description" : "This parameter describes the filters applied to call media features requested by the calling party"
},
"capability" : {
"type" : "integer",
"description" : "This parameter enables you to specify an end user device’s capabilities or prohibit the use of call media features for incoming calls"
}
}
},
"RPConnectionInfo" : {
"type" : "object",
"properties" : {
"hunt_order" : {
"type" : "integer",
"description" : "Specifies the place of this connection in the list of connections created to route the call according to this sequence before (or instead of) applying \"normal\" LCR routing"
},
"hunt_order_exclusive" : {
"type" : "string",
"description" : "Specifies whether this entry in the override list is a percentage-share connection pool, where each connection has a chance to be the first route proportionate to the assigned percentage value"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group record"
},
"i_rp_connection" : {
"type" : "integer",
"description" : "The unique ID of the custom routing configured for a particular destination group"
},
"weight" : {
"type" : "integer",
"description" : "A percentage value assigned to this connection pool in the override list"
},
"i_connection" : {
"type" : "integer",
"description" : "The unique ID of the connection record. The nill flag sets LCR"
},
"i_routing_plan" : {
"type" : "integer",
"description" : "The unique ID of the Routing Plan record"
}
}
},
"CPRuleInfo" : {
"type" : "object",
"properties" : {
"i_cp_rule" : {
"type" : "integer",
"description" : "The unique ID of the call screening condition record"
},
"order_number" : {
"type" : "integer",
"description" : "Read-only – ordinal number for this rule in the rule set"
},
"to_number_i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the ToNumber condition"
},
"from_number_i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the FromNumber condition"
},
"time_window_i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the TimeWindow condition"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"is_active" : {
"type" : "string",
"description" : "Whether rule is enabled (Y / N)"
},
"action" : {
"type" : "integer",
"description" : "Specifies which action should be taken if a particular phone call satisfies conditions for a rule. Possible values: 0 - Reject, 1 - Ring Only, 2 - Forward Only, 3 - Ring Then Forward, 4 - Voicemail Only, 5 - Ring Then Voicemail, 6 - Forward Then Voicemail, 7 - Ring, Forward, Voicemail"
}
}
},
"GetVendorDIDProviderAccountListRequest" : {
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"i_did_provider_acc" : {
"type" : "integer",
"description" : "The unique ID of the DID provider account"
}
}
},
"EstimateAssignedCommitmentPenaltyListRequest" : {
"required" : [
"i_account_commitment",
"finish_date"
],
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
},
"penalty_period_to" : {
"type" : "string",
"description" : "Calculate penalties until the specified date"
},
"finish_date" : {
"type" : "string",
"description" : "The date when the commitment finishes"
},
"penalty_period_from" : {
"type" : "string",
"description" : "Calculate penalties starting from the specified date"
},
"commitment_recurring_term_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountCommitmentRecurringTermInfo"
},
"commitment_one_time_term_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountCommitmentOneTimeTermInfo"
}
}
},
"ArrayOfQFFieldInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/QFFieldInfo"
}
},
"GetServiceTypeInfoRequest" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "Unique ID of the Service Type"
}
}
},
"ArrayOfNetaccessUsageRecordInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NetaccessUsageRecordInfo"
}
},
"ActivateCustomerSubscriptionsRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record"
}
}
},
"DIDAreaInfo" : {
"required" : [
"name",
"id",
"prefix"
],
"type" : "object",
"properties" : {
"req_params" : {
"$ref" : "#/components/schemas/DIDRequestParameters"
},
"name" : {
"type" : "string",
"description" : "Area name"
},
"id" : {
"type" : "integer",
"description" : "The consecutive area number in the list"
},
"prefix" : {
"type" : "string",
"description" : "Area prefix"
},
"pricing" : {
"$ref" : "#/components/schemas/DIDPricing"
}
}
},
"DeleteRoutingPlanResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"ArrayOfCustomerInvoicesListInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerInvoicesListInfo"
}
},
"GetNotificationPresetListResponse" : {
"type" : "object",
"properties" : {
"notification_preset_list" : {
"$ref" : "#/components/schemas/ArrayOfNotificationPresetInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"DestinationGetCSetGroupListResponse" : {
"type" : "object",
"properties" : {
"destination_group_list" : {
"$ref" : "#/components/schemas/ArrayOfCSetGroupInfo"
}
}
},
"ArrayOfServiceTypeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServiceTypeInfo"
}
},
"ArrayOfCreditLimitChangeCommentInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CreditLimitChangeCommentInfo"
}
},
"UpdateQFResponse" : {
"required" : [
"i_quick_form"
],
"type" : "object",
"properties" : {
"i_quick_form" : {
"type" : "integer",
"description" : "The unique ID of the quick form"
}
}
},
"AddUpdateAccountResponse" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the created/modified account record"
}
}
},
"EnableAsyncApiNotificationsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation has been successful"
}
}
},
"AddFraudConstraintRequest" : {
"required" : [
"fraud_constraint_info"
],
"type" : "object",
"properties" : {
"fraud_constraint_info" : {
"$ref" : "#/components/schemas/FraudConstraintInfo"
}
}
},
"GetCustomerClassInfoRequest" : {
"type" : "object",
"properties" : {
"check_usage_by_resellers" : {
"type" : "integer",
"description" : "If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response"
},
"name" : {
"type" : "string",
"description" : "Name of the customer class on the PortaBilling interface, unique in the environment"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class record"
}
}
},
"UpdateDestGroupRequest" : {
"required" : [
"i_dest_group"
],
"type" : "object",
"properties" : {
"delete_destinations" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"name" : {
"type" : "string",
"description" : "The destination group name"
},
"add_destinations" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
}
}
},
"DeleteExternalTemplateImageResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"ListCustomTaxOptionsRequest" : {
"type" : "object"
},
"GetVoiceApplicationListResponse" : {
"required" : [
"voice_application_list"
],
"type" : "object",
"properties" : {
"voice_application_list" : {
"$ref" : "#/components/schemas/ArrayOfVoiceApplicationInfo"
}
}
},
"GetRoutingCriteriaListRequest" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the routing criteria is used"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved routing criterias"
},
"name" : {
"type" : "string",
"description" : "Routing criteria name"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"description" : {
"type" : "string",
"description" : "Routing criteria description"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"UAProfileParameterInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"skip" : {
"type" : "string",
"description" : "The flag shows whether to skip the parameter if partial profile configuration is enabled. Possible values: Y, N"
},
"value" : {
"type" : "string",
"description" : "The UA profile parameter value"
},
"name" : {
"type" : "string",
"description" : "The UA profile parameter name"
}
}
},
"GetVoiceQualityProfileInfoResponse" : {
"type" : "object",
"properties" : {
"profile_info" : {
"$ref" : "#/components/schemas/VoiceQualityProfileInfo"
}
}
},
"GetRoutingPlanListResponse" : {
"type" : "object",
"properties" : {
"routing_plan_list" : {
"$ref" : "#/components/schemas/RoutingPlanList"
},
"total" : {
"type" : "integer",
"description" : "The total number of routing plans in the database"
}
}
},
"ArrayOfNotificationPresetInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NotificationPresetInfo"
}
},
"AddCodecConverterFileResponse" : {
"required" : [
"id"
],
"type" : "object",
"properties" : {
"storage_info" : {
"$ref" : "#/components/schemas/CodecConverterStorageInfo"
},
"id" : {
"type" : "integer",
"description" : "The unique identifier of the file"
},
"codec_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"DeleteDestGroupSetRequest" : {
"required" : [
"i_dest_group_set"
],
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set"
}
}
},
"DeleteDiscountResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"ArrayOfMCCInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MCCInfo"
}
},
"AddVDThresholdRequest" : {
"required" : [
"vd_threshold_info"
],
"type" : "object",
"properties" : {
"vd_threshold_info" : {
"$ref" : "#/components/schemas/VDThresholdInfo"
}
}
},
"SessionLogMetaInfo" : {
"type" : "object",
"properties" : {
"node_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"start_time" : {
"type" : "string",
"description" : "The start time of the session"
},
"cli_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"call_id" : {
"type" : "string",
"description" : "The ID of the service session"
},
"response_code" : {
"type" : "integer",
"description" : "The code of the response. 0 - all log messages are fetched, 1 - log messages limit is reached, 2 - timeout is reached"
},
"merged_call_id_list" : {
"$ref" : "#/components/schemas/ArrayOfSessionLogIdInfo"
},
"participant_list" : {
"$ref" : "#/components/schemas/ArrayOfSessionParticipant"
},
"cld_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"end_time" : {
"type" : "string",
"description" : "The end time of the session"
},
"session_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The ID of the billing session"
}
}
},
"GetCustomFieldInfoRequest" : {
"required" : [
"i_custom_field"
],
"type" : "object",
"properties" : {
"i_custom_field" : {
"type" : "integer",
"description" : "The unique ID of the custom field record"
}
}
},
"GetMeasuredMetricDataRequest" : {
"required" : [
"object",
"i_measured_metric",
"date_from",
"i_object"
],
"type" : "object",
"properties" : {
"date_to" : {
"type" : "string",
"description" : "The end of the date and time interval for the metric data to be fetched (the current date and time is picked if the field is left empty)"
},
"object" : {
"type" : "string",
"description" : "The type of object to which the retrieval of measurement data is applied. Possible values: 'account', 'customer'"
},
"i_measured_metric" : {
"type" : "integer",
"description" : "The unique ID of the measured metric"
},
"i_object" : {
"type" : "integer",
"description" : "The unique identifier of the object"
},
"date_from" : {
"type" : "string",
"description" : "The start of the date and time interval for the metric data to be fetched"
},
"with_child_records" : {
"type" : "integer",
"description" : "The field indicates the depth of the method retrieval, for example, for a customer, all associated account records and customer records will be returned if the value of this field is 1, otherwise only customer data records will be returned"
}
}
},
"GetRoutingCriteriaInfoResponse" : {
"type" : "object",
"properties" : {
"destination_group_list" : {
"$ref" : "#/components/schemas/ArrayOfRoutingCriteriaDestGroupInfo"
},
"routing_criteria_info" : {
"$ref" : "#/components/schemas/RoutingCriteriaInfo"
}
}
},
"ArrayOfCustomerAuxFieldInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerAuxFieldInfo"
}
},
"ArrayOfAccountInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountInfo"
}
},
"AddRouteCategoryResponse" : {
"required" : [
"i_route_category"
],
"type" : "object",
"properties" : {
"i_route_category" : {
"type" : "integer",
"description" : "The unique ID of the route category DB record"
}
}
},
"ArrayOfDestinationPrefixInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DestinationPrefixInfo"
}
},
"ArrayOfRequestDestinationPrefixInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RequestDestinationPrefixInfo"
}
},
"DeleteRoutingCriteriaResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success"
}
}
},
"GetAccessRoleInfoRequest" : {
"required" : [
"i_role"
],
"type" : "object",
"properties" : {
"with_usage" : {
"type" : "integer",
"description" : "Flag that indicates if the access role usage should be returned"
},
"i_role" : {
"type" : "integer",
"description" : "The identifier of the access role"
},
"with_permissions" : {
"type" : "integer",
"description" : "Flag that indicates if the access role permissions should be returned"
}
}
},
"UpdateFraudConstraintResponse" : {
"required" : [
"i_ft_constraint"
],
"type" : "object",
"properties" : {
"i_ft_constraint" : {
"type" : "integer",
"description" : "The identifier of the fraud constraint"
}
}
},
"ArrayOfAliasInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AliasInfo"
}
},
"GetResaleMapListRequest" : {
"type" : "object",
"properties" : {
"i_tariff_buy" : {
"type" : "integer",
"description" : "The unique ID of the wholesale tariff record (according to which the reseller is billed by a higher level reseller or service provider)"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller record: If this field is provided, then the list of mappings between the reseller's wholesale and resale tariffs is retrieved; If this field is not provided, then the list of wholesale tariffs (which should be mapped onto resale tariffs) will be retrieved"
}
}
},
"GetTariffInfoRequest" : {
"type" : "object",
"properties" : {
"check_usage_by_resellers" : {
"type" : "integer",
"description" : "If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response"
},
"name" : {
"type" : "string",
"description" : "The tariff name "
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff record"
}
}
},
"GetConferenceSettingsRequest" : {
"type" : "object"
},
"DeleteRPCategoryRequest" : {
"required" : [
"i_routing_plan_cat"
],
"type" : "object",
"properties" : {
"i_routing_plan_cat" : {
"type" : "integer",
"description" : "The unique ID of the routing plan route category record"
}
}
},
"UpdateSpendingConstraintRequest" : {
"required" : [
"spending_constraint_info"
],
"type" : "object",
"properties" : {
"spending_constraint_info" : {
"$ref" : "#/components/schemas/SpendingConstraintInfo"
}
}
},
"GetCustomFieldListRequest" : {
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The object the custom field is applicable to. Possible values: 'customer', 'account'"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the custom field was used"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who manages the Custom field record. If undefined, only custom fields managed by administrator will be returned"
},
"name" : {
"type" : "string",
"description" : "The custom field name pattern"
},
"mandatory" : {
"type" : "string",
"description" : "The flag shows whether the custom field is mandatory. Possible values: 'Y', 'N'"
},
"visible_to_end_user" : {
"type" : "string",
"description" : "The flag shows whether the custom field is visible to the end user. Possible values: 'Y', 'N'"
},
"type" : {
"type" : "string",
"description" : "The canonical name of the custom field type. Currently supported: 'text', 'list', 'date', 'number', 'datetime'"
}
}
},
"ConvertMoneyResponse" : {
"type" : "object",
"properties" : {
"converted" : {
"type" : "number",
"description" : "The amount in the target currency (the converted amount)"
}
}
},
"AddMeasuredMetricRequest" : {
"required" : [
"measured_metric_info"
],
"type" : "object",
"properties" : {
"measured_metric_info" : {
"$ref" : "#/components/schemas/MeasuredMetricInfo"
}
}
},
"DeleteCommitmentRequest" : {
"required" : [
"i_commitment"
],
"type" : "object",
"properties" : {
"i_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the commitment record"
}
}
},
"InvoiceUploadInvoicePdfRequest" : {
"required" : [
"i_invoice"
],
"type" : "object",
"properties" : {
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"UpdateServiceAndRatingResponse" : {
"type" : "object",
"properties" : {
"service_and_rating_info" : {
"$ref" : "#/components/schemas/ServiceAndRatingInfo"
},
"i_accessibility" : {
"type" : "integer",
"description" : "The unique ID of the rating entry record that was updated"
}
}
},
"AccountCommitmentOneTimeTermInfo" : {
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
},
"discount_amount" : {
"type" : "number",
"description" : "The discount amount applied to the charge"
},
"i_service" : {
"type" : "integer",
"description" : "The identifier of the service that will be used for the charge xdr"
},
"fee" : {
"type" : "number",
"description" : "The full fee for the term"
},
"apply_penalty" : {
"type" : "string",
"description" : "Specifies whether the penalties are applied for this term if it's terminated before the end of the minimum period"
},
"i_one_time_term" : {
"type" : "integer",
"description" : "The unique identifier of the one-time term"
},
"description" : {
"type" : "string",
"description" : "The description of the term that will be used as the description of the created charge xdr"
}
}
},
"ArrayOfCQInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CQInfo"
}
},
"APIServiceInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the API service"
},
"method_list" : {
"$ref" : "#/components/schemas/ArrayOfAPIMethodInfo"
}
}
},
"ArrayOfAddonLifeCycleInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AddonLifeCycleInfo"
}
},
"AddCallBarringClassResponse" : {
"required" : [
"i_cp_condition"
],
"type" : "object",
"properties" : {
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the call barring class"
}
}
},
"GetAccessRoleTypeInfoRequest" : {
"required" : [
"i_role_type"
],
"type" : "object",
"properties" : {
"i_role_type" : {
"type" : "integer",
"description" : "The unique ID of the access role type record to be fetched"
},
"with_metadata" : {
"type" : "integer",
"description" : "Specifies whether to retrieve components tree metadata for the access role type"
}
}
},
"VendorInfo" : {
"type" : "object",
"properties" : {
"firstname" : {
"type" : "string",
"description" : "Vendor's first name"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for currency in which the vendor is billed"
},
"out_date_format" : {
"type" : "string",
"description" : "Output format for date indication on the vendor's self-care interface"
},
"state" : {
"type" : "string",
"description" : "Province or state"
},
"email" : {
"type" : "string",
"description" : "Email address"
},
"password" : {
"type" : "string",
"description" : "Vendor's password for self-care web interface"
},
"opening_balance" : {
"type" : "number",
"description" : "Vendor's opening balance"
},
"billed_to" : {
"type" : "string",
"description" : "The date to which subscription charges have already been applied"
},
"out_date_time_format" : {
"type" : "string",
"description" : "Output format for full date/time indication"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the vendor has entities assigned"
},
"offset_threshold" : {
"type" : "integer",
"description" : "Defines the vendor for automatically offsetting the vendor's balance (if this vendor also sends you traffic, i.e. he is also your vendor). You may only choose a reseller or retail vendor defined with the same currency."
},
"name" : {
"type" : "string",
"description" : "Name of the vendor on the PortaBilling interface, unique in the environment"
},
"i_lang" : {
"type" : "string",
"description" : "Code of the vendor's web interface language; refers to Languages table"
},
"login" : {
"type" : "string",
"description" : "Vendor's login for self-care web interface"
},
"address_line_2" : {
"type" : "string",
"description" : "The 2nd line of the vendor's address"
},
"zip" : {
"type" : "string",
"description" : "Postal (zip) code"
},
"balance" : {
"type" : "number",
"description" : "Vendor's balance"
},
"in_date_format" : {
"type" : "string",
"description" : "Input format for date indication"
},
"phone1" : {
"type" : "string",
"description" : "Main phone number"
},
"i_time_zone" : {
"type" : "integer",
"description" : "the unique ID of the vendor's time zone; refers to Time_Zones table"
},
"tz" : {
"type" : "string",
"description" : "Name of vendor's time zone; refers to Time_Zones table"
},
"phone2" : {
"type" : "string",
"description" : "Alternative phone number"
},
"salutation" : {
"type" : "string",
"description" : "Vendor's salutation"
},
"cont1" : {
"type" : "string",
"description" : "Main contact person"
},
"midinit" : {
"type" : "string",
"description" : "Vendor's middle initial(s)"
},
"send_statistics" : {
"type" : "string",
"description" : "F - send full statistics to vendor, S - send short statistics, N - do not send statistics"
},
"lastname" : {
"type" : "string",
"description" : "Vendor's last name"
},
"connections_total" : {
"type" : "integer",
"description" : "The total number of configured connections for the vendor"
},
"refnum" : {
"type" : "string",
"description" : "Reference number (custom field)"
},
"city" : {
"type" : "string",
"description" : "City of vendor's address"
},
"out_time_format" : {
"type" : "string",
"description" : "Output format for time indication"
},
"cont2" : {
"type" : "string",
"description" : "Alternative contact person"
},
"country" : {
"type" : "string",
"description" : "Country"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"in_time_format" : {
"type" : "string",
"description" : "Input format for time indication"
},
"note" : {
"type" : "string",
"description" : "Short note (description)"
},
"bcc" : {
"type" : "string",
"description" : "BCC email address"
},
"i_billing_period" : {
"type" : "integer",
"description" : "The unique ID of the vendor's billing period; refers to Billing_Period table"
},
"notepad" : {
"type" : "string",
"description" : "Comments regarding this vendor"
},
"faxnum" : {
"type" : "string",
"description" : "Fax number"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"i_acl" : {
"type" : "integer",
"description" : "The unique ID of the vendor's access level; refers to Access_Levels table"
},
"companyname" : {
"type" : "string",
"description" : "Vendor's company name"
},
"baddr1" : {
"type" : "string",
"description" : "The 1st line of vendor's address"
}
}
},
"TemplateUpdateTemplateDataGroupListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"ArrayOfCSetGroupTreeNode" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CSetGroupTreeNode"
}
},
"GetAccessRoleTypeInfoResponse" : {
"type" : "object",
"properties" : {
"access_role_type_info" : {
"$ref" : "#/components/schemas/AccessRoleTypeInfo"
}
}
},
"MakeAccountTransactionResponse" : {
"required" : [
"balance"
],
"type" : "object",
"properties" : {
"result_code" : {
"type" : "string",
"description" : "E-Commerce operation result code"
},
"balance" : {
"type" : "number",
"description" : "Modified account balance"
},
"transaction_id" : {
"type" : "string",
"description" : "E-Commerce transaction ID"
},
"i_payment_transaction" : {
"type" : "integer",
"description" : "The unique ID of the transaction"
},
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the XDR record"
},
"authorization" : {
"type" : "string",
"description" : "E-Commerce authorization code"
}
}
},
"TraceXdrInfo" : {
"type" : "object",
"properties" : {
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the XDR record"
},
"call_id" : {
"type" : "string",
"description" : "The unique identifier of the call"
},
"mark_time" : {
"type" : "string",
"description" : "The date and time when the XDR was marked for tracing"
},
"failed" : {
"type" : "integer",
"description" : "The flag shows whether the XDR is related to failure"
}
}
},
"DeleteTariffRequest" : {
"required" : [
"i_tariff"
],
"type" : "object",
"properties" : {
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff record"
}
}
},
"DeleteAsyncRequestListRequest" : {
"required" : [
"request_list"
],
"type" : "object",
"properties" : {
"request_list" : {
"$ref" : "#/components/schemas/ArrayOfAsyncRequestInfo"
}
}
},
"SessionLogNodeInfo" : {
"type" : "object",
"properties" : {
"node" : {
"type" : "string",
"description" : "The IP address of SIP node"
}
}
},
"ArrayOfScheduledCustomerStatusChangeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ScheduledCustomerStatusChangeInfo"
}
},
"DeleteUserRequest" : {
"type" : "object",
"properties" : {
"i_user" : {
"type" : "integer",
"description" : "The unique ID of the user record"
}
}
},
"ArrayOfProductRolesInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ProductRolesInfo"
}
},
"DeleteExternalTemplateImageRequest" : {
"required" : [
"i_template",
"body_name"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"body_name" : {
"type" : "string",
"description" : "The name of the file"
}
}
},
"GetASRFileResponse" : {
"type" : "object"
},
"SubrealmsInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Subrealm name"
}
}
},
"UpdateTemplateRequest" : {
"required" : [
"template_info"
],
"type" : "object",
"properties" : {
"template_info" : {
"$ref" : "#/components/schemas/TemplateInfo"
}
}
},
"TaxationPluginParameterMetaInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The parameter name"
},
"mandatory" : {
"type" : "string",
"description" : "The flag shows whether the parameter is mandatory"
}
}
},
"DeleteCustomerAbbreviatedDialingNumberResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if success, otherwise SOAP fault"
}
}
},
"DeleteCustomerMetricRequest" : {
"required" : [
"i_measured_metric",
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"i_measured_metric" : {
"type" : "integer",
"description" : "The unique ID of the measured service"
}
}
},
"GetExtensionsListInfoRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"extension" : {
"type" : "string",
"description" : "Search pattern for extension numbers. Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character"
},
"detailed_info" : {
"type" : "integer",
"description" : "Detailed information"
},
"name" : {
"type" : "string",
"description" : "Search pattern for extension names. Use the following wildcard symbols: the percent ( % ) wildcard allows you to match any string of characters; the underscore ( _ ) wildcard allows you to match any single character"
},
"account_id" : {
"type" : "string",
"description" : "Search pattern for account IDs"
},
"get_main_office_extensions" : {
"type" : "integer",
"description" : "If set to '1', then additionally a list of main office extensions will be provided for its branch office "
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"get_published" : {
"type" : "integer",
"description" : "If specified, shows whether to retrieve only publicly available or only private extensions. Possible values: 1 – Get only the extensions that are in the public directory (in this case, the Top Management/internal extensions are not retrieved); 0 – Get only the extensions excluded from the public directory"
}
}
},
"ListPaymentProcessorsResponse" : {
"required" : [
"payment_processors"
],
"type" : "object",
"properties" : {
"payment_processors" : {
"$ref" : "#/components/schemas/ArrayOfPaymentProcessors"
}
}
},
"TestTranslationRuleRequest" : {
"required" : [
"string",
"rule"
],
"type" : "object",
"properties" : {
"rule" : {
"type" : "string",
"description" : "A translation rule to test, e.g. local_to_e164($_,{cc=>'1',ia=>'0', dp=>'1',ip=>'011',em=>'911',ex=>'411',cs=>'0'});'"
},
"string" : {
"type" : "string",
"description" : "A number to test on"
},
"is_ivr_tr_rule" : {
"type" : "integer",
"description" : "Defines whether a rule will be used by IVR applications"
}
}
},
"GetCustomerSitesRequest" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of a customer record"
},
"get_service_features" : {
"type" : "integer",
"description" : "Specifies whether the information about service features should be included into the response"
}
}
},
"DIDInventoryOptionsInfo" : {
"type" : "object",
"properties" : {
"i_usage_ttc" : {
"type" : "integer",
"description" : "The ID of the usage tax transaction code"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller who manages the inventory options"
},
"i_did_inventory_option" : {
"type" : "integer",
"description" : "The unique ID of the inventory option record"
},
"number_type" : {
"type" : "string",
"description" : "The number type; possible values: standard, toll_free"
},
"i_activation_ttc" : {
"type" : "integer",
"description" : "The ID of the activation tax transaction code"
}
}
},
"DeleteCommissionPlanRequest" : {
"required" : [
"i_commission_plan"
],
"type" : "object",
"properties" : {
"i_commission_plan" : {
"type" : "integer",
"description" : "The unique ID of the commission plan"
}
}
},
"GetSpendingCounterResponse" : {
"type" : "object",
"properties" : {
"spending_counter_info" : {
"$ref" : "#/components/schemas/SpendingCounterInfo"
}
}
},
"GetProductInfoRequest" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the Product Record"
},
"check_usage_by_resellers" : {
"type" : "integer",
"description" : "If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response"
},
"name" : {
"type" : "string",
"description" : "Name of product, or part of the name. Use % sign as wildcard"
},
"get_service_features" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"with_service_features" : {
"type" : "integer",
"description" : "Specifies whether a list of service features will be returned for the retrieved product"
}
}
},
"GetTaxPluginsListRequest" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the taxation plugin was assigned to any entity"
},
"mode" : {
"type" : "string",
"description" : "Defines which taxation plugins will be shown. Possible values: C – Show only configured taxation plugins (default), A – Show all taxation plugins"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller record"
},
"with_parameters" : {
"type" : "integer",
"description" : "If set to '1', the list of the taxation plugin parameters will be provided in the response"
}
}
},
"CustomerVdNotificationInfo" : {
"required" : [
"last_updated",
"i_service",
"i_dest_group",
"unit_counter",
"counter_id",
"peak_level",
"i_customer",
"counter"
],
"type" : "object",
"properties" : {
"last_updated" : {
"type" : "string",
"description" : "Timestamp when the notification record was last updated"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The ID of the destination group to which the counter is applicable"
},
"i_service" : {
"type" : "integer",
"description" : "Unique identifier of a service"
},
"unit_counter" : {
"type" : "integer",
"description" : "Accumulated units amount (in service rating units)"
},
"counter_id" : {
"type" : "integer",
"description" : "The identifier of the counter"
},
"peak_level" : {
"type" : "integer",
"description" : "Allow to limit the counter to specified peak level only (the unique ID ot the Time_Periods table)"
},
"i_notification" : {
"type" : "integer",
"description" : "The unique ID of the record"
},
"counter" : {
"type" : "number",
"description" : "Accumulated money amount"
},
"i_customer" : {
"type" : "integer",
"description" : "The identifier of the customer, unique in the environment"
}
}
},
"AddUpdateCommitmentResponse" : {
"type" : "object",
"properties" : {
"i_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the commitment record"
}
}
},
"ArrayOfAsyncRequestInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AsyncRequestInfo"
}
},
"RoamingPolicyHighRiskInfo" : {
"type" : "object",
"properties" : {
"action" : {
"type" : "string",
"description" : "The action that is taken in case of calls from the countries in the \"high_risk\" list. Supported actions: screen, quarantine, reject"
}
}
},
"AddAccountSubscriptionRequest" : {
"required" : [
"i_account",
"subscription_info"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"subscription_info" : {
"$ref" : "#/components/schemas/AccountSubscriptionInfo"
}
}
},
"GetAccountUAInfoRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"ZendeskOrganizationInfo" : {
"required" : [
"zendesk_organization_id"
],
"type" : "object",
"properties" : {
"zendesk_organization_id" : {
"type" : "integer",
"description" : "The Zendesk organization ID number"
},
"name" : {
"type" : "string",
"description" : "The name of the Zendesk organization"
},
"i_customer" : {
"type" : "string",
"description" : "The Zendesk organization (already existing) for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side"
}
}
},
"AddExternalTemplateResponse" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
}
}
},
"DeleteCommitmentRecurringTermRequest" : {
"required" : [
"i_recurring_term"
],
"type" : "object",
"properties" : {
"i_recurring_term" : {
"type" : "integer",
"description" : "The unique identifier of the recurring term"
}
}
},
"GetServicePolicyInfoRequest" : {
"required" : [
"i_service_policy"
],
"type" : "object",
"properties" : {
"i_service_policy" : {
"type" : "integer",
"description" : "The unique identifier of the service policy"
}
}
},
"CustomerEstimateTaxesRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"use_xdrs_from_db_up_to_date" : {
"type" : "string",
"description" : "Get transactions (xDRs) from the database instead of xdr_list. The transactions for the period starting from the previous bill_to time to the specified time will be taken. Possible values: A specific date and time in the 'YYYY-MM-DD HH24:MI:SS' format; 'now'"
},
"additional_taxes_mode" : {
"type" : "string",
"description" : "Specifies the mode for additional taxes. Possible values: 'all' or undefined - calculate all additional taxes for the invoice, 'invoice_only' - calculate only the invoice tax"
},
"issue_date" : {
"type" : "string",
"description" : "The date when transactions took place (xDRs were created). It is used only for the EZtax (formerly known as BillSoft EZtax) plugin. The default value is 'now'"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfEstimateTaxesXDRInfo"
},
"calc_additional_taxes" : {
"type" : "integer",
"description" : "\n 0 or undef -- do not calculate additional taxes;\n 1 -- calculate additional taxes;\n "
},
"save_estimates" : {
"type" : "string",
"description" : "Save estimated results; possible values: none - don't save, remote_plugin - save results on tax plugin side"
},
"calc_taxes" : {
"type" : "integer",
"description" : "Specifies whether to calculate the tax or just show tax rates. Possible values: 0 or undefined – return tax rates; 1 – calculate the tax for the provided xDRs"
}
}
},
"DeleteMeasuredMetricResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 for success, 0 in case of failure"
}
}
},
"ConnectionInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The type of service transported via this connection (voice calls, Internet connectivity, etc.)"
},
"i_dial_rule_cld" : {
"type" : "integer",
"description" : "Reference to dialing rule, which is applied for CLD"
},
"i_node" : {
"type" : "integer",
"description" : "The ID of the node used for this connection"
},
"i_rate_match_mode" : {
"type" : "integer",
"description" : "This parameter allows you to rate calls either based on their destination or the caller's number"
},
"ip_transport_protocol" : {
"type" : "string",
"description" : "Transport protocol for outgoing connections to Vendor"
},
"vendor_name" : {
"type" : "string",
"description" : "The name of the vendor"
},
"CLD" : {
"type" : "string",
"description" : "The access number the customer dialed to reach your network"
},
"utilization_balthreshold" : {
"type" : "integer",
"description" : "The threshold after which load-balancing is started"
},
"cld_prefix" : {
"type" : "string",
"description" : "CLD tech prefix helps to identify connection from several with same IP address"
},
"rtpp_level" : {
"type" : "integer",
"description" : "Describes the NAT traversal capabilities of the remote gateway (the default value is set to Optimal)"
},
"utilization_routing" : {
"type" : "string",
"description" : "Flag which indicates whether load-balancing is enabled for this connection"
},
"i_oli" : {
"type" : "integer",
"description" : "Unique oli identifier"
},
"conn_type_technology" : {
"type" : "string",
"description" : "The technology used by the connection type to perform the transport"
},
"i_connection_type" : {
"type" : "integer",
"description" : "The unique ID of the connection type record"
},
"i_service_policy" : {
"type" : "integer",
"description" : "Specifies a predefined set of options which are applied to calls going through this connection"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"remote_ip" : {
"type" : "string",
"description" : "The IP of the remote gateway, e.g. 23.45.67.89"
},
"i_dial_rule_cli" : {
"type" : "integer",
"description" : "Reference to dialing rule, which is applied for CLI"
},
"conn_type_leg_origin" : {
"type" : "integer",
"description" : "The numeric identification of the connection type origin (the meaning depends on the service type: for VOICE CALLS, 0 - originate, 1 - answer; for messaging, 0 - outgoing message, 1 - incoming message)"
},
"active" : {
"type" : "string",
"description" : "The flag shows whether the connection is active. Possible values: 'Y' - active, 'N' - not active, 'I' - internal"
},
"i_vendor_acc" : {
"type" : "integer",
"description" : "Defines the username/password used for authorization of calls via this connection"
},
"cli_trust" : {
"type" : "string",
"description" : "Describes how outgoing calls for which the caller has requested privacy are to be displayed to the vendor"
},
"description" : {
"type" : "string",
"description" : "Description of the connection"
},
"capacity" : {
"type" : "integer",
"description" : "Specifies the maximum number of simultaneous calls the connection can support"
},
"i_tariff" : {
"type" : "integer",
"description" : "The ID of the tariff used to calculate the cost of terminating calls via this connection"
},
"port" : {
"type" : "string",
"description" : "Only on PSTN-related connections. The specified port for PSTN origination or termination"
},
"i_criteria" : {
"type" : "integer",
"description" : "Defines what routing criteria will be applied to this connection"
},
"gateway_id" : {
"type" : "string",
"description" : "A distinctive name for the remote gateway"
},
"sip_specific_settings" : {
"type" : "string",
"description" : "Additional settings for some call scenarios, for example routing based on Point of Presence"
},
"i_connection" : {
"type" : "integer",
"description" : "Unique connection identifier"
}
}
},
"GetProductInfoResponse" : {
"required" : [
"product_info"
],
"type" : "object",
"properties" : {
"product_info" : {
"$ref" : "#/components/schemas/ProductInfo"
}
}
},
"GetSubdivisionsListResponse" : {
"type" : "object",
"properties" : {
"subdivisions_list" : {
"$ref" : "#/components/schemas/ArrayOfSubdivisionInfo"
}
}
},
"TransactionActionsListRequest" : {
"type" : "object",
"properties" : {
"billing_entity" : {
"type" : "string",
"description" : "Entity; enum [Vendor, RetailCustomer, WholesaleCustomer, Distributor, CreditAccount, DebitAccount, Voucher, Callshop]"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
}
}
},
"ArrayOfRateInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RateInfo"
}
},
"UpdateAccessPolicyRequest" : {
"required" : [
"access_policy_info"
],
"type" : "object",
"properties" : {
"access_policy_info" : {
"$ref" : "#/components/schemas/AccessPolicyInfo"
}
}
},
"AddDiscountResponse" : {
"required" : [
"i_vd_dg"
],
"type" : "object",
"properties" : {
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the discount for a specific destination group"
}
}
},
"AddGetDefaultCallBarringOptionRequest" : {
"required" : [
"i_cp_condition"
],
"type" : "object",
"properties" : {
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the call barring class"
}
}
},
"GetNotificationTemplateInfoRequest" : {
"required" : [
"i_notification_preset",
"name"
],
"type" : "object",
"properties" : {
"i_notification_preset" : {
"type" : "integer",
"description" : "The unique identifier of the notification preset"
},
"name" : {
"type" : "string",
"description" : "The notification template name"
}
}
},
"AddUpdateCustomerBatchResponse" : {
"required" : [
"i_batch"
],
"type" : "object",
"properties" : {
"i_batch" : {
"type" : "integer",
"description" : "The unique ID of the batch"
}
}
},
"GetAccountServiceFeaturesResponse" : {
"type" : "object",
"properties" : {
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
}
}
},
"GetAccountInfoResponse" : {
"type" : "object",
"properties" : {
"customer_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
},
"account_info" : {
"$ref" : "#/components/schemas/AccountInfo"
},
"reseller_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
}
}
},
"GetEspfApiTokenResponse" : {
"required" : [
"espf_api_token"
],
"type" : "object",
"properties" : {
"espf_api_token" : {
"type" : "string",
"description" : "The ESPF API access token of a user. Can be used to access ESPF API, such as for getting logs, generating events, etc"
}
}
},
"ProductGetSubscriptionInfoRequest" : {
"required" : [
"i_product_subscription"
],
"type" : "object",
"properties" : {
"i_product_subscription" : {
"type" : "integer",
"description" : "The ID of the product subscription"
}
}
},
"MarketingGroupInfo" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Marketing group name"
},
"id" : {
"type" : "string",
"description" : "Marketing group code on the CoSS server"
},
"i_marketing_group" : {
"type" : "integer",
"description" : "The ID of the marketing group"
},
"description" : {
"type" : "string",
"description" : "Marketing group description"
}
}
},
"CloneRoamingProfileRequest" : {
"required" : [
"name",
"i_roaming_profile"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the roaming profile clone"
},
"managed_by" : {
"type" : "integer",
"description" : "The ID of the roaming profile owner record"
},
"i_roaming_profile" : {
"type" : "integer",
"description" : "The unique ID of the roaming profile to be cloned"
}
}
},
"AddUpdateEmergencyUnitResponse" : {
"required" : [
"i_emergency_unit"
],
"type" : "object",
"properties" : {
"i_emergency_unit" : {
"type" : "integer",
"description" : "The identifier of the emergency routing unit"
}
}
},
"ArrayOfRawDiscountPlanInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RawDiscountPlanInfo"
}
},
"GetVDTopupOptionListRequest" : {
"required" : [
"i_vd_dg"
],
"type" : "object",
"properties" : {
"topup_expiry_time" : {
"type" : "integer",
"description" : "The lifetime of the top-up option, the number of days"
},
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the discount for a specific destination group"
},
"topup_amount" : {
"type" : "number",
"description" : "The amount of service units to topup"
},
"topup_fee" : {
"type" : "number",
"description" : "The amount of money an end user is charged for topup"
}
}
},
"GetCustomerCustomFieldsSchemaRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record"
}
}
},
"DownloadDGSetRequest" : {
"required" : [
"i_dest_group_set"
],
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set"
},
"file_format" : {
"type" : "string",
"description" : "This parameter enables the user to get destination group set in other formats via an attachment. Possible values: 'csv', 'xls', 'xlsx'"
}
}
},
"CustomerLastBillingDateConstraintInfo" : {
"required" : [
"i_billing_period",
"min_shift",
"max_shift"
],
"type" : "object",
"properties" : {
"i_billing_period" : {
"type" : "integer",
"description" : "The unique ID of the billing period"
},
"min_shift" : {
"type" : "string",
"description" : "The minimum allowed value for the last billing date of the billing period"
},
"max_shift" : {
"type" : "string",
"description" : "The maximum allowed value for the last billing date of the billing period"
}
}
},
"TimeZoneInfoList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TimeZoneInfo"
}
},
"AccessAttributePermission" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the access attribute"
},
"permission" : {
"type" : "integer",
"description" : "The permission for the access attribute"
}
}
},
"ChargeMethodsInfo" : {
"required" : [
"name",
"i_metric_charge_method"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the charge method"
},
"description" : {
"type" : "string",
"description" : "The description of the charge method"
},
"i_metric_charge_method" : {
"type" : "integer",
"description" : "The ID of the charge method"
}
}
},
"GetDiscountListResponse" : {
"type" : "object",
"properties" : {
"discount_list" : {
"$ref" : "#/components/schemas/ArrayOfDiscountInfo"
}
}
},
"DeleteCustomerExtensionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"ProductCloneProductResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success"
}
}
},
"DeleteServiceResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"UpdateTaxTransactionCodeResponse" : {
"required" : [
"i_tax_transaction_code"
],
"type" : "object",
"properties" : {
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique ID of the taxation code database record"
}
}
},
"GetSessionLogInfoRequest" : {
"required" : [
"session_id"
],
"type" : "object",
"properties" : {
"session_id" : {
"type" : "string",
"description" : "The h323-conf-id or call-id of the session"
},
"merged_session_id_list" : {
"$ref" : "#/components/schemas/ArrayOfSessionLogIdInfo"
},
"with_related_sessions" : {
"type" : "integer",
"description" : "Retrieve all related sessions with the given session id"
},
"from_date" : {
"type" : "string",
"description" : "Beginning of the search interval"
},
"to_date" : {
"type" : "string",
"description" : "Ending of the search interval"
}
}
},
"UpdateUIConfigListRequest" : {
"required" : [
"ui_config_list"
],
"type" : "object",
"properties" : {
"ui_config_list" : {
"$ref" : "#/components/schemas/ArrayOfUIConfigInfo"
}
}
},
"ArrayOfOverrideTariffs" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/OverrideTariffInfo"
}
},
"AddDatesBatchRequest" : {
"required" : [
"date_list"
],
"type" : "object",
"properties" : {
"date_list" : {
"$ref" : "#/components/schemas/ArrayOfCalendarDateInfo"
}
}
},
"GetCommitmentInfoResponse" : {
"type" : "object",
"properties" : {
"commitment_info" : {
"$ref" : "#/components/schemas/CommitmentInfo"
}
}
},
"GetConnectionDestinationGroupListResponse" : {
"type" : "object",
"properties" : {
"connection_destination_group_list" : {
"$ref" : "#/components/schemas/ArrayOfConnectionDestinationGroupInfo"
}
}
},
"DeleteQFResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"DeleteDatesBatchResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success"
}
}
},
"ArrayOfRepresentativeXDRInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RepresentativeXDRInfo"
}
},
"ArrayOfCPConditionNumberInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CPConditionNumberInfo"
}
},
"ArrayOfInvoiceNumber" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/InvoiceNumberInfo"
}
},
"UpdateDIDNumberListResponse" : {
"required" : [
"success",
"statuses"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
},
"statuses" : {
"$ref" : "#/components/schemas/ArrayOfUpdateDIDNumberInfoStatus"
}
}
},
"AccAliasesListInfo" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the alias record"
},
"i_master_account" : {
"type" : "integer",
"description" : "The unique ID of the main account this alias account is associated with"
},
"blocked" : {
"type" : "string",
"description" : "Block account's calls"
},
"master_account_id" : {
"type" : "string",
"description" : "The main account name that this alias account is associated with"
},
"id" : {
"type" : "string",
"description" : "ID (PIN) of the account on the PortaBilling interface, unique in the environment"
}
}
},
"EstimateDIDNumberCostInfo" : {
"type" : "object",
"properties" : {
"iso_4217" : {
"type" : "string",
"description" : "The iso currency code in which the resulting prices will be presented"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer/reseller for whom the prices will be estimated"
}
}
},
"DeleteMarketingGroupResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 - for success; 0 - for failure"
}
}
},
"VendorAccountList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VendorAccountInfo"
}
},
"DeleteCustomFieldResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation was completed"
}
}
},
"UpdateCustomerCustomFieldsValuesResponse" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"custom_fields_values" : {
"$ref" : "#/components/schemas/ArrayOfCustomFieldsValuesInfo"
}
}
},
"MeasuredMetricsInfo" : {
"required" : [
"name",
"i_measured_metric"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Measured metric name. Possible values: Active calls – Measure number of active call. This is the actual number of connected calls at a specific moment in time; Call recording storage – Measure used call recording storage; IP Centrex phone lines – Measure number of used phone lines; Allowed concurrent calls – Measure number of allowed calls. The number of concurrent calls allowed (SIP trunks)"
},
"i_measured_metric" : {
"type" : "integer",
"description" : "The unique ID of the measured metric. Possible values: 1 – Active calls. Measure number of active call. This is the actual number of connected calls at a specific moment in time; 2 – Call recording storage. Measure used call recording storage; 3 – IP Centrex phone lines. Measure number of used phone lines; 4 – Allowed concurrent calls. Measure the number of concurrent calls allowed (SIP trunks)"
},
"description" : {
"type" : "string",
"description" : "A description of the added or updated measured metric. The description can be undefined or it can be specified using the add or update API methods"
}
}
},
"GetOperationAccessIdRequest" : {
"required" : [
"operation"
],
"type" : "object",
"properties" : {
"operation" : {
"type" : "string",
"description" : "A unique operation name that requires an additional ID for access"
}
}
},
"UpdateRateGroupRequest" : {
"required" : [
"rate_info",
"i_dest_group"
],
"type" : "object",
"properties" : {
"rate_info" : {
"$ref" : "#/components/schemas/RateInfo"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
}
}
},
"ArrayOfEnvInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EnvInfo"
}
},
"SearchRateListRequest" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product DB record"
},
"country" : {
"type" : "string",
"description" : "The country name related to the rate"
},
"iso_3166_1_a2" : {
"type" : "string",
"description" : "The ISO country code related to the rate"
},
"number" : {
"type" : "string",
"description" : "The destination number. Returns only the rates that match the destination number"
},
"destination" : {
"type" : "string",
"description" : "The destination number pattern related to the rate"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff DB record"
},
"description" : {
"type" : "string",
"description" : "The description of the rate"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved rate data records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property value defined"
}
}
},
"GetRepresentativeInfoRequest" : {
"type" : "object",
"properties" : {
"i_rep" : {
"type" : "integer",
"description" : "The unique ID of the representative record"
},
"name" : {
"type" : "string",
"description" : "Name of the representative on the PortaBilling interface, unique in the environment"
},
"get_distributors_total" : {
"type" : "integer",
"description" : "Get the total number of the distributors that are related to the representative"
},
"get_customers_total" : {
"type" : "integer",
"description" : "Get the total number of the customers that are related to the representative"
},
"get_resellers_total" : {
"type" : "integer",
"description" : "Get the total number of the resellers that are related to the representative"
}
}
},
"CustomerUpdateNumberSequenceResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success"
}
}
},
"ServiceAndRatingInfoList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServiceAndRatingInfo"
}
},
"ArrayOfCloneProductInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CloneProductInfo"
}
},
"UploadMOHFileResponse" : {
"required" : [
"i_moh"
],
"type" : "object",
"properties" : {
"i_moh" : {
"type" : "integer",
"description" : "The unique ID of the MOH record"
}
}
},
"DeleteNodeRequest" : {
"required" : [
"i_node"
],
"type" : "object",
"properties" : {
"i_node" : {
"type" : "integer",
"description" : "The unique ID of the node"
}
}
},
"GetRetailCustomerXDRQualityInfoResponse" : {
"type" : "object",
"properties" : {
"quality_info" : {
"$ref" : "#/components/schemas/XDRQualityMetricInfo"
}
}
},
"GetDIDNumberInfoRequest" : {
"required" : [
"number"
],
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the DID number is in use"
},
"number" : {
"type" : "string",
"description" : "DID Number"
}
}
},
"GetUAListResponse" : {
"type" : "object",
"properties" : {
"ua_list" : {
"$ref" : "#/components/schemas/ArrayOfUAInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"UploadDGSetResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"RouteInfo" : {
"type" : "object",
"properties" : {
"appcode" : {
"type" : "string",
"description" : "IVR Application number"
},
"penalty" : {
"type" : "string",
"description" : "Reduce priority"
},
"destination" : {
"type" : "string",
"description" : "Called destination"
},
"i_route_category" : {
"type" : "integer",
"description" : "The unique ID of the Route Category record"
},
"vendor_name" : {
"type" : "string",
"description" : "Name of used vendor"
},
"sip" : {
"type" : "string",
"description" : "Is route supports SIP protocol"
},
"currency" : {
"type" : "string",
"description" : "The currency used to provide call cost value"
},
"preference" : {
"type" : "integer",
"description" : "Route preference"
},
"i_rate" : {
"type" : "integer",
"description" : "The unique ID of the Rate record"
},
"translation_rule" : {
"type" : "string",
"description" : "Connection's translation rule"
},
"t_cld" : {
"type" : "string",
"description" : "Called number with applied translation rule"
},
"cost" : {
"type" : "number",
"description" : "Call cost"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the Vendor record"
},
"tech_prefix" : {
"type" : "string",
"description" : "Connection's tech prefix"
},
"remote_ip" : {
"type" : "string",
"description" : "Remote IP to call"
},
"node_name" : {
"type" : "string",
"description" : "Name of used node"
},
"h323" : {
"type" : "string",
"description" : "Is route supports H323 protocol"
},
"huntstop" : {
"type" : "string",
"description" : "Is huntstop route"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the Tariff record"
},
"route_category_name" : {
"type" : "string",
"description" : "Routing category name"
},
"destination_country" : {
"type" : "string",
"description" : "Called destination country"
},
"tariff_name" : {
"type" : "string",
"description" : "Name of used tariff"
},
"skip_reason" : {
"type" : "string",
"description" : "The reason for skipping the route"
},
"destination_description" : {
"type" : "string",
"description" : "Called destination description"
},
"connection_name" : {
"type" : "string",
"description" : "Name of used connection"
},
"cld" : {
"type" : "string",
"description" : "Called number"
},
"i_connection" : {
"type" : "integer",
"description" : "The unique ID of the Connection record"
}
}
},
"CCStaffInfo" : {
"type" : "object",
"properties" : {
"activation_date" : {
"type" : "string",
"description" : "The date when the user's account is activated"
},
"firstname" : {
"type" : "string",
"description" : "The user's first name"
},
"refunded_today" : {
"type" : "number",
"description" : "The amount of refunds made during this day"
},
"out_date_format" : {
"type" : "string",
"description" : "Output date format"
},
"state" : {
"type" : "string",
"description" : "The name of the state"
},
"email" : {
"type" : "string",
"description" : "An email contact for the user"
},
"password" : {
"type" : "string",
"description" : "The password for this user"
},
"out_date_time_format" : {
"type" : "string",
"description" : "Output date and time format"
},
"i_callshop" : {
"type" : "integer",
"description" : "The unique ID of the callshop in which this user is operating"
},
"i_lang" : {
"type" : "string",
"description" : "The language used on the web interface for this user"
},
"transaction_allowance" : {
"type" : "number",
"description" : "The maximum amount of credit/refund per one transaction for the user"
},
"description" : {
"type" : "string",
"description" : "A short description associated with the user"
},
"login" : {
"type" : "string",
"description" : "The username for login and user identification"
},
"address_line_2" : {
"type" : "string",
"description" : "2nd line of the user's address"
},
"zip" : {
"type" : "string",
"description" : "The user's ZIP code. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash)"
},
"in_date_format" : {
"type" : "string",
"description" : "Input date format"
},
"phone1" : {
"type" : "string",
"description" : "The main phone number"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The time zone in which this user is operating"
},
"max_credit_limit_days" : {
"type" : "integer",
"description" : "The maximum period of validity of the temporary credit limit"
},
"phone2" : {
"type" : "string",
"description" : "An alternative phone number"
},
"hide_personal_info" : {
"type" : "integer",
"description" : "Shows whether personal information is hidden from the user. Can be 0 - is visible or 1 - is hidden"
},
"salutation" : {
"type" : "string",
"description" : "The user's salutation"
},
"cont1" : {
"type" : "string",
"description" : "The main contact person"
},
"daily_allowance" : {
"type" : "number",
"description" : "The maximum amount of credit/refund per day for the user"
},
"last_login" : {
"type" : "string",
"description" : "The date when the user last logged in into web interface"
},
"midinit" : {
"type" : "string",
"description" : "The user's middle name"
},
"i_cc_staff" : {
"type" : "integer",
"description" : "The unique ID of the CC staff record"
},
"lastname" : {
"type" : "string",
"description" : "The user's last name"
},
"rst" : {
"type" : "string",
"description" : "The date when the statistic was reset for the last time"
},
"city" : {
"type" : "string",
"description" : "The name of the city"
},
"senior" : {
"type" : "string",
"description" : "Specifies whether this user is a senior user"
},
"out_time_format" : {
"type" : "string",
"description" : "Output time format"
},
"cont2" : {
"type" : "string",
"description" : "The alternative contact person"
},
"country" : {
"type" : "string",
"description" : "The code of the country in the ISO 3166-1 alpha-2 format"
},
"search_counter" : {
"type" : "integer",
"description" : "The number of traced sessions"
},
"in_time_format" : {
"type" : "string",
"description" : "Input time format"
},
"password_timestamp" : {
"type" : "string",
"description" : "The date when the password was changed"
},
"expiration_date" : {
"type" : "string",
"description" : "The date when the user's account expires"
},
"max_credit_limit_increase" : {
"type" : "string",
"description" : "The maximum possible increase of the permanent credit limit"
},
"faxnum" : {
"type" : "string",
"description" : "A fax number"
},
"refunds_counter" : {
"type" : "integer",
"description" : "The number of refunds made by this user today"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller"
},
"i_acl" : {
"type" : "integer",
"description" : "The privilege level or role assigned to the user"
},
"companyname" : {
"type" : "string",
"description" : "The conventional form of the user company's name"
},
"baddr1" : {
"type" : "string",
"description" : "1st line of the user's address"
}
}
},
"AssessFraudTrafficResponse" : {
"type" : "object",
"properties" : {
"fraud_traffic_info" : {
"$ref" : "#/components/schemas/FraudTrafficInfo"
}
}
},
"GetMerchantAccountResponse" : {
"required" : [
"merchant_account"
],
"type" : "object",
"properties" : {
"merchant_account" : {
"$ref" : "#/components/schemas/MerchantAccount"
}
}
},
"ArrayOfConnectionDestinationGroupInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ConnectionDestinationGroupInfo"
}
},
"AddUpdateCustomerResponse" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "ID of created / modified customer record"
}
}
},
"GetServiceListResponse" : {
"type" : "object",
"properties" : {
"service_list" : {
"$ref" : "#/components/schemas/ArrayOfServices"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved services"
}
}
},
"GetCommitmentTermsResponse" : {
"type" : "object",
"properties" : {
"commitment_recurring_term_list" : {
"$ref" : "#/components/schemas/ArrayOfCommitmentRecurringTermInfo"
},
"commitment_one_time_term_list" : {
"$ref" : "#/components/schemas/ArrayOfCommitmentOneTimeTermInfo"
}
}
},
"AccountGetServiceFeatureMetaInfoResponse" : {
"type" : "object",
"properties" : {
"service_feature" : {
"$ref" : "#/components/schemas/ANY"
}
}
},
"CustomerSetCallQueueMohFileRequest" : {
"required" : [
"i_c_queue"
],
"type" : "object",
"properties" : {
"i_c_queue" : {
"type" : "integer",
"description" : "ID of call queue record"
},
"prompt_name" : {
"type" : "string",
"description" : "The prompt file name"
}
}
},
"AutoPaymentInfo" : {
"type" : "object",
"properties" : {
"frozen" : {
"type" : "string",
"description" : "Flag which indicates whether the auto payment was frozen"
},
"object" : {
"type" : "string",
"description" : "A type of entity (account/customer) for which the auto-payment is applied"
},
"pay_amount" : {
"type" : "number",
"description" : "When the customer's balance crosses the threshold their credit card will be charged for the amount specified in this field"
},
"i_object" : {
"type" : "integer",
"description" : "The unique ID of an account or a customer"
},
"balance_threshold" : {
"type" : "number",
"description" : "When the customer's balance crosses this threshold their credit card will be charged for the amount specified in the pay_amount field"
}
}
},
"ProductGetProductListRequest" : {
"type" : "object",
"properties" : {
"show_inactive" : {
"type" : "string",
"description" : "Possible values: 'Y', 'N', 'A'"
},
"search" : {
"type" : "string",
"description" : "Search products by name and description"
},
"i_product_group" : {
"type" : "integer",
"description" : "The unique ID of the product group"
},
"with_included_services" : {
"type" : "integer",
"description" : "Specifies whether the list of services provided to an end user with the product will be returned"
},
"iso_4217" : {
"type" : "string",
"description" : "Product Currency"
},
"skip_details" : {
"type" : "integer",
"description" : "Flag which indicates whether the only basic product info will be fetched. It makes request more lightweight"
},
"with_gui_options" : {
"type" : "integer",
"description" : "Specifies whether GUI options will be returned"
},
"check_usage" : {
"type" : "integer",
"description" : "Specifies whether to check if the product is in use"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"managed_by_admin" : {
"type" : "string",
"description" : "Indicates that only managed by admin products should be fetched. Possible values: 'Y', 'N'"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"with_subscription" : {
"type" : "integer",
"description" : "Flag which indicates whether the Product subscription should be returned"
},
"with_subreseller_products" : {
"type" : "integer",
"description" : "If set to '1', enables admin to retrieve product list of subordinate resellers (second-level and deeper)"
},
"account_roles" : {
"$ref" : "#/components/schemas/ArrayOfInt"
},
"name" : {
"type" : "string",
"description" : "Refers to Product name"
},
"with_allowed_products" : {
"type" : "integer",
"description" : "Specifies whether the list of main products that can be used in combination with the add-on product will be returned"
},
"with_shared" : {
"type" : "integer",
"description" : "If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response"
},
"type" : {
"type" : "string",
"description" : "Type of products to be fetched. Possible values: 'main', 'addon'"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of Customer Record (managed by)"
},
"with_notepad" : {
"type" : "integer",
"description" : "Specifies whether the notepad will be returned"
}
}
},
"AddUpdateRPCategoryResponse" : {
"type" : "object",
"properties" : {
"i_routing_plan_cat" : {
"type" : "integer",
"description" : "The unique ID of the routing plan route category record"
}
}
},
"GetSIMCardInfoResponse" : {
"type" : "object",
"properties" : {
"card_info" : {
"$ref" : "#/components/schemas/SIMCardInfo"
}
}
},
"UAInfo" : {
"type" : "object",
"properties" : {
"profile" : {
"type" : "string",
"description" : "UA Provisioning Profile"
},
"is_multiservice" : {
"type" : "integer",
"description" : "Indicates whether this UA supports provisioning of multiple services"
},
"shared" : {
"type" : "string",
"description" : "Shows whether the CPE managed by the administrator is available to resellers"
},
"opc_key" : {
"type" : "string",
"description" : "The Opc key"
},
"ascii_key" : {
"type" : "string",
"description" : "ASCII Key"
},
"i_ua" : {
"type" : "integer",
"description" : "ID of UA record"
},
"busy_ports" : {
"$ref" : "#/components/schemas/ArrayOfInt"
},
"is_used_by_resellers" : {
"type" : "integer",
"description" : "Shows whether the shared CPE is used by resellers"
},
"inventory_id" : {
"type" : "string",
"description" : "UA Inventory ID"
},
"mac" : {
"type" : "string",
"description" : "UA MAC address"
},
"i_ua_profile" : {
"type" : "integer",
"description" : "The ID of the UA profile record"
},
"name" : {
"type" : "string",
"description" : "UA name"
},
"description" : {
"type" : "string",
"description" : "UA description"
},
"port" : {
"type" : "string",
"description" : "UA port that is used by this account (makes sense for get_ua_info requests)"
},
"ua_profile_id" : {
"type" : "integer",
"description" : "ID of UA profile"
},
"available_ports" : {
"$ref" : "#/components/schemas/ArrayOfInt"
},
"notepad" : {
"type" : "string",
"description" : "UA notepad"
},
"used" : {
"type" : "string",
"description" : "Flag that indicates UA usage"
},
"ports_config" : {
"$ref" : "#/components/schemas/ArrayOfUAPortConfiguration"
},
"type" : {
"type" : "string",
"description" : "UA type"
},
"i_customer" : {
"type" : "integer",
"description" : "Managed by"
},
"i_ua_type" : {
"type" : "integer",
"description" : "UA Type Id (used to add new UA)"
}
}
},
"AddVendorRequest" : {
"required" : [
"vendor_info"
],
"type" : "object",
"properties" : {
"vendor_info" : {
"$ref" : "#/components/schemas/VendorInfo"
}
}
},
"ArrayOfTaxPluginTransactionCodeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TaxPluginTransactionCodeInfo"
}
},
"ArrayOfConsumedServices" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ConsumedServiceInfo"
}
},
"GetOffPeakListResponse" : {
"type" : "object",
"properties" : {
"off_peak_list" : {
"$ref" : "#/components/schemas/ArrayOfOffPeakInfo"
}
}
},
"APIMethodRealmInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the realm"
}
}
},
"CustomerTransactionInfo" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "Status of the transaction"
},
"iso_4217" : {
"type" : "string",
"description" : "Currency for the transaction"
},
"purpose" : {
"type" : "string",
"description" : "The purpose of the transaction"
},
"cdrid" : {
"type" : "string",
"description" : "XDR ID created for the transaction"
},
"unique_transaction_id" : {
"type" : "string",
"description" : "UUID based unique transaction ID. Should be used as i_payment_transaction for transactions via PayNearMe processor"
},
"x_transaction_id" : {
"type" : "string",
"description" : "The external transaction unique ID"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"i_online_payment_processor" : {
"type" : "integer",
"description" : "The unique payment processor ID for the transaction"
},
"result_code" : {
"type" : "string",
"description" : "Transaction's result code"
},
"timestamp" : {
"type" : "string",
"description" : "Timestamp of the transaction"
},
"i_payment_method" : {
"type" : "integer",
"description" : "Unique payment method ID for the transaction"
},
"i_payment_transaction_type" : {
"type" : "integer",
"description" : "The unique ID of the Transaction Type"
},
"cc_number_hash" : {
"type" : "string",
"description" : "A crypted hexadecimal code of the credit card number that was used to perform the transaction"
},
"result_message" : {
"type" : "string",
"description" : "Transaction's result message"
},
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique payment system ID for the transaction"
},
"secret" : {
"type" : "string",
"description" : "A secret code for the transaction"
},
"payment_method_info" : {
"type" : "string",
"description" : "Comment on the transaction's payment method"
},
"details" : {
"type" : "string",
"description" : "Description of the transaction"
},
"test_mode" : {
"type" : "string",
"description" : "Indicates whether the Payment Processor was in the test mode at the moment when the transaction was processed - Y/N"
},
"purpose_details" : {
"type" : "string",
"description" : "The details of the purpose"
},
"account_id" : {
"type" : "string",
"description" : "The identifier of the account (unique in the environment)"
},
"amount" : {
"type" : "number",
"description" : "Money amount for the transaction"
},
"i_payment_transaction" : {
"type" : "integer",
"description" : "The unique ID of a payment transaction"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"customer_name" : {
"type" : "string",
"description" : "The name of the customer"
}
}
},
"GetSystemMetricDataRequest" : {
"required" : [
"metric_list",
"date_from"
],
"type" : "object",
"properties" : {
"date_to" : {
"type" : "string",
"description" : "The end of the date-time interval for the metric data to be fetched (current date-time is picked if the field is left empty)"
},
"metric_list" : {
"$ref" : "#/components/schemas/ArrayOfMetricInputInfo"
},
"date_from" : {
"type" : "string",
"description" : "The start of the date-time interval for the metric data to be fetched"
}
}
},
"AddRateRequest" : {
"required" : [
"rate_info"
],
"type" : "object",
"properties" : {
"rate_info" : {
"$ref" : "#/components/schemas/RateInfo"
}
}
},
"GetCustomerClassMetricListResponse" : {
"required" : [
"metrics"
],
"type" : "object",
"properties" : {
"metrics" : {
"$ref" : "#/components/schemas/ArrayOfCustomerClassMetricInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of metrics found"
}
}
},
"OnePeriodSubscriptionPeriodicFeeInfo" : {
"required" : [
"i_billing_period",
"periods",
"fee",
"i_subscription"
],
"type" : "object",
"properties" : {
"i_billing_period" : {
"type" : "integer",
"description" : "The unique ID of the Billing Period; refers to the Billing_Period table"
},
"periods" : {
"type" : "integer",
"description" : "The number of billing periods covered by this fee"
},
"fee" : {
"type" : "number",
"description" : "The amount of the fee"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Plan record; refers to Subscriptions table"
},
"i_subscription_fee" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Fee record"
}
}
},
"DeleteDIDNumberListResponse" : {
"required" : [
"success",
"statuses"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
},
"statuses" : {
"$ref" : "#/components/schemas/ArrayOfDeleteDIDNumberInfoStatus"
}
}
},
"ExtendedDataEntryInfo" : {
"required" : [
"object",
"values",
"field"
],
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The name of the object"
},
"match" : {
"type" : "string",
"description" : "The field describes how to match the values with object field"
},
"values" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"field" : {
"type" : "string",
"description" : "The field of the object"
}
}
},
"PropertyHistoryCatalogInfo" : {
"type" : "object",
"properties" : {
"property_name" : {
"type" : "string",
"description" : "The property history catalog record name"
},
"i_property" : {
"type" : "integer",
"description" : "The unique identifier of property history catalog record"
}
}
},
"AddUpdateAuthzRuleResponse" : {
"type" : "object",
"properties" : {
"i_authz_rule" : {
"type" : "integer",
"description" : "The unique ID of the created authentication rule"
}
}
},
"AddAccountAliasResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the alias record"
},
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"GetCustomerTransactionsTotalInfoResponse" : {
"type" : "object",
"properties" : {
"count" : {
"type" : "integer",
"description" : "The total number of transactions"
},
"iso_4217" : {
"type" : "string",
"description" : "Transactions currency"
},
"sessions_count" : {
"type" : "integer",
"description" : "The total number of sessions"
},
"total_amount" : {
"type" : "number",
"description" : "Total transactions amount"
},
"per_service_info" : {
"$ref" : "#/components/schemas/ArrayOfCustomerPerServiceInfo"
},
"total_info" : {
"$ref" : "#/components/schemas/ArrayOfTotalTransInfo"
}
}
},
"EnvInfo" : {
"type" : "object",
"properties" : {
"i_env" : {
"type" : "integer",
"description" : "The unique ID of the environment"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for company's internal currency"
},
"email" : {
"type" : "string",
"description" : "Primary email contact for the company"
},
"cost_revenue_daily" : {
"type" : "string",
"description" : "Cost revenue daily date"
},
"billed_to" : {
"type" : "string",
"description" : "Billed to date"
},
"contact_i_country_subdivision" : {
"type" : "integer",
"description" : "Refers to the ID of the province or state that is printed in the invoice"
},
"name" : {
"type" : "string",
"description" : "The name of the environment"
},
"description" : {
"type" : "string",
"description" : "A short description of the env"
},
"address_line_2" : {
"type" : "string",
"description" : "The 2nd line of the company's address"
},
"lname" : {
"type" : "string",
"description" : "Proper, legally-recognized form of the company's name"
},
"laddr1" : {
"type" : "string",
"description" : "The 1st line of company's address where this company name is legally registered"
},
"i_time_zone" : {
"type" : "integer",
"description" : "ID for the environment's time zone which global reports for the environment will be generated in; refers to Time_Zones table"
},
"liso_3166_1_a2" : {
"type" : "string",
"description" : "A two-letter country code defined in ISO 3166-1 alpha-2 where the company is legally registered"
},
"iso_3166_1_a2" : {
"type" : "string",
"description" : "A two-letter country code defined in ISO 3166-1 alpha-2"
},
"contact_city" : {
"type" : "string",
"description" : "The city that is printed in the invoice"
},
"cost_revenue_weekly" : {
"type" : "string",
"description" : "Cost revenue weekly date"
},
"web" : {
"type" : "string",
"description" : "Company's web address"
},
"i_country_subdivision" : {
"type" : "integer",
"description" : "Refers to the ID of province or state where the company is registered"
},
"addr1" : {
"type" : "string",
"description" : "The 1st line of company's address"
},
"laddr2" : {
"type" : "string",
"description" : "The 2nd line of company's address where this company name is legally registered"
},
"calls_counted_time" : {
"type" : "string",
"description" : "Calls counted time"
},
"i_number_scope" : {
"type" : "integer",
"description" : "PortaBilling can generate invoices for all customers with sequential invoice numbering distributed throughout the environment. In some cases, you may want to have more than one sequence of numbers. One of the following: 1 – Individual for Environment, 2 – Individual for Reseller, 3 – Individual for Customer"
},
"lcity" : {
"type" : "string",
"description" : "City in which the company is legally registered"
},
"lzip" : {
"type" : "string",
"description" : "Postal code for the company's registered location. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash)"
},
"phone" : {
"type" : "string",
"description" : "Company's phone number"
},
"tax_info" : {
"type" : "string",
"description" : "The configured taxation method options. For example: business=0;incorporated=0; federal_exempt=1;state_exempt=1; county_exempt=1; May contain all taxation method options or only those that need to be passed"
},
"i_billing_period" : {
"type" : "integer",
"description" : "ID for billing period; refers to Billing_Period table"
},
"faxnum" : {
"type" : "string",
"description" : "Company's fax number"
},
"cost_revenue_monthly" : {
"type" : "string",
"description" : "Cost revenue monthly date"
},
"contact_zip" : {
"type" : "string",
"description" : "The postal code for the company's registered location that is printed in the invoice"
},
"contact_email" : {
"type" : "string",
"description" : "The contact email that is printed in the invoice"
},
"tax_id" : {
"type" : "string",
"description" : "Tax ID"
},
"companyname" : {
"type" : "string",
"description" : "The name of the company"
}
}
},
"AddNodeRequest" : {
"required" : [
"node_info"
],
"type" : "object",
"properties" : {
"node_info" : {
"$ref" : "#/components/schemas/NodeInfo"
}
}
},
"GetDestinationPrefixListResponse" : {
"type" : "object",
"properties" : {
"destination_list" : {
"$ref" : "#/components/schemas/ArrayOfDestinationPrefixInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved destination data records"
}
}
},
"ArrayOfFullCounterInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FullCounterInfo"
}
},
"CustomerClassMetricInfo" : {
"required" : [
"i_customer_class"
],
"type" : "object",
"properties" : {
"destination" : {
"type" : "string",
"description" : "The destination name. Only certain special destinations are applicable. In-built special destinations (rate codes) that are applicable for available measured services: ACTIVECALLS – Covers charges for the actual number of concurrent calls made by a particular customer's accounts; ALLOWEDCALLS – Covers charges for the number of concurrent calls allowed for a particular customer. Other special destinations can be created and used as well, but they must not associate with any country. Note that specified destination doesn't impact measurement base. The destination is used only for information purpose in xDRs and statistics"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service type. Note that specified service type does not impact measurement base. The service type value is used only for information purpose in xDRs and statistics. E.g. if API user specifies ID of the Voice Calls service here, an xDR with charges for active calls will have the Voice Calls service type"
},
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination. Only certain special destinations are applicable"
},
"apply_charge" : {
"type" : "string",
"description" : "Defines whether this service is free of charge or not. Possible values: 'Y', 'N'"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
},
"i_metric_charge_method" : {
"type" : "integer",
"description" : "The ID of the charge method"
},
"free_items" : {
"type" : "integer",
"description" : "The amount of free items"
},
"i_measured_metric" : {
"type" : "integer",
"description" : "The ID of the measured metric"
},
"price" : {
"type" : "number",
"description" : "The price for each consumed service item"
}
}
},
"GetZendeskOrganizationInfoRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The Zendesk organization (already existing) for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side"
}
}
},
"UpdateSIMCardListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"ArrayOfUpdateDIDNumberInfoStatus" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UpdateDIDNumberInfoStatus"
}
},
"AddTrafficProfileRequest" : {
"required" : [
"traffic_profile_info"
],
"type" : "object",
"properties" : {
"traffic_profile_info" : {
"$ref" : "#/components/schemas/TrafficProfileInfo"
}
}
},
"GetExtendedDataListRequest" : {
"required" : [
"data"
],
"type" : "object",
"properties" : {
"get_total" : {
"type" : "integer",
"description" : "Flag shows whether to include the total number of found items into the response"
},
"data" : {
"$ref" : "#/components/schemas/ArrayOfExtendedDataObjectInfo"
},
"filters" : {
"$ref" : "#/components/schemas/ArrayOfExtendedDataFilterInfo"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"DeleteVendorDIDProviderAccountResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"CustomerGetCustomerAccountsSubscriptionsRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"exclude_not_active" : {
"type" : "integer",
"description" : "The flag that shows whether to exclude inactive subscriptions from the response"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"DeleteCriterionRequest" : {
"required" : [
"i_bd_criteria"
],
"type" : "object",
"properties" : {
"i_bd_criteria" : {
"type" : "integer",
"description" : "The unique ID of the bundle promotion criterion"
}
}
},
"GetUATypeUsageStatisticsResponse" : {
"type" : "object",
"properties" : {
"ua_type_usage_statistics_list" : {
"$ref" : "#/components/schemas/ArrayOfUATypeUsageInfo"
}
}
},
"PaymentTransactionListRequest" : {
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The type of entity (account/customer) for which the payment transaction is applied"
},
"search" : {
"type" : "string",
"description" : "A pattern that enables searching by the 'x_transaction_id', 'payment_method_info' fields"
},
"status" : {
"type" : "string",
"description" : "Status of the Transaction"
},
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique Payment System ID for the Transaction"
},
"from_date" : {
"type" : "string",
"description" : "Get information recorded starting from this date"
},
"test_mode" : {
"type" : "string",
"description" : "Indicates whether the Payment Processor was in the test mode at the moment when the transaction was processed - Y/N"
},
"i_customer_type" : {
"type" : "integer",
"description" : "The unique identifier of a customer. Possible values: 1 (retail customer or subcustomer), 2 (reseller), 3 (distributor)"
},
"i_payment_method" : {
"type" : "integer",
"description" : "Unique ID of the payment method"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved transactions"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_payment_transaction" : {
"type" : "integer",
"description" : "The unique ID of a payment transaction"
},
"hide_restricted" : {
"type" : "integer",
"description" : "Specifies whether to remove payment transactions of terminated entities from the response"
},
"i_object" : {
"type" : "integer",
"description" : "The unique ID of an account or a customer"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"to_date" : {
"type" : "string",
"description" : "Get information recorded before this date"
}
}
},
"UpdateDIDNumberRequest" : {
"required" : [
"number_info"
],
"type" : "object",
"properties" : {
"number_info" : {
"$ref" : "#/components/schemas/DIDNumberInfo"
}
}
},
"AccountProvisioningStatusInfo" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"last_updated" : {
"type" : "string",
"description" : "The date and time when the field was last updated"
},
"i_group" : {
"type" : "integer",
"description" : "The unique ID of the account provisioning group"
},
"status" : {
"type" : "integer",
"description" : "The status of the provisioning. Possible values: 0 - success, 1 - failed and retrying, 2 - failed completely"
},
"error_list" : {
"type" : "string",
"description" : "The stringed list of errors for the unsuccessful provisioning"
},
"event_variables" : {
"type" : "string",
"description" : "The object with event variables in JSON format used for unsuccessful provisioning"
}
}
},
"DisableApiNotificationsCustomerRequest" : {
"required" : [
"event"
],
"type" : "object",
"properties" : {
"i_main_office" : {
"type" : "integer",
"description" : "The unique ID of a сustomer's record with headquarters office type"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"event" : {
"type" : "string",
"description" : "The event name"
}
}
},
"GetMyAclForObjectsRequest" : {
"required" : [
"objects"
],
"type" : "object",
"properties" : {
"objects" : {
"$ref" : "#/components/schemas/ArrayOfAclObjects"
}
}
},
"AssignCommitmentRequest" : {
"required" : [
"i_account",
"i_commitment"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The identifier of the account record"
},
"i_commitment" : {
"type" : "integer",
"description" : "The identifier of the commitment record"
},
"start_date" : {
"type" : "string",
"description" : "The date when the commitment services are enabled. The charges activation may be postponed by the config option 'Commitments.ActivationDelay'"
},
"min_terminate_date" : {
"type" : "string",
"description" : "The end date of the minimum period after which the commitment can be terminated without penalties"
},
"sale_discount_configuration_list" : {
"$ref" : "#/components/schemas/ArrayOfSaleDiscountConfigurationInfo"
}
}
},
"UpdateAllowedLocationRequest" : {
"type" : "object",
"properties" : {
"allowed_location_info" : {
"$ref" : "#/components/schemas/AllowedLocationInfo"
}
}
},
"GetRoutingCriteriaInfoRequest" : {
"required" : [
"i_criteria"
],
"type" : "object",
"properties" : {
"i_criteria" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria DB record"
},
"with_destination_group_list" : {
"type" : "integer",
"description" : "If with_destination_group_list = 1 then return information about the routing criteria destination groups"
}
}
},
"AccountTraceXdrResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if success, 0 otherwise"
}
}
},
"ArrayOfAccessPolicyPhaseInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccessPolicyPhaseInfo"
}
},
"ModifySpendingLimitResponse" : {
"type" : "object",
"properties" : {
"constraint_amount" : {
"type" : "number",
"description" : "The initial amount of money that the customer can spend on services in the period"
},
"extra_amount" : {
"type" : "number",
"description" : "The additional credit for the period - temporarily amount that increases the customer's spending limit"
},
"i_c_spend_counter" : {
"type" : "integer",
"description" : "The unique ID of the customer's spending counter"
},
"spent_amount" : {
"type" : "number",
"description" : "The amount actually spent"
}
}
},
"AssignDIDToAccountRequest" : {
"required" : [
"i_did_number",
"i_master_account"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique ID of the DID number record"
},
"i_master_account" : {
"type" : "integer",
"description" : "The unique ID of the account this DID number is assigned to"
}
}
},
"UpdateUserUIConfigListRequest" : {
"required" : [
"ui_config_list"
],
"type" : "object",
"properties" : {
"ui_config_list" : {
"$ref" : "#/components/schemas/ArrayOfUIConfigInfo"
}
}
},
"GetMeasuredMetricsListResponse" : {
"required" : [
"metrics_list"
],
"type" : "object",
"properties" : {
"metrics_list" : {
"$ref" : "#/components/schemas/ArrayOfMeasuredMetricsInfo"
}
}
},
"UpdateUAResponse" : {
"required" : [
"i_ua"
],
"type" : "object",
"properties" : {
"i_ua" : {
"type" : "integer",
"description" : "ID of UA record"
}
}
},
"GetDestGroupListResponse" : {
"type" : "object",
"properties" : {
"dest_group_list" : {
"$ref" : "#/components/schemas/ArrayOfDestinationGroupInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved destination groups"
}
}
},
"AddCPConditionRequest" : {
"required" : [
"cp_condition_info"
],
"type" : "object",
"properties" : {
"cp_condition_info" : {
"$ref" : "#/components/schemas/CPConditionInfo"
}
}
},
"GetDestinationInfoRequest" : {
"required" : [
"i_account",
"destination"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account. Not mandatory when the method that requires this structure is executed from the account realm"
},
"destination" : {
"type" : "string",
"description" : "The destination number"
},
"operator_id" : {
"type" : "integer",
"description" : "The unique ID of the destination mobile network"
}
}
},
"GetVDTopupOptionInfoResponse" : {
"type" : "object",
"properties" : {
"topup_option_info" : {
"$ref" : "#/components/schemas/VDTopupOptionInfo"
}
}
},
"DeleteRoutingCriteriaRequest" : {
"required" : [
"i_criteria"
],
"type" : "object",
"properties" : {
"i_criteria" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria DB record"
}
}
},
"UpdateEnvInfoRequest" : {
"required" : [
"env_info"
],
"type" : "object",
"properties" : {
"env_info" : {
"$ref" : "#/components/schemas/EnvInfo"
}
}
},
"GetCallRecordingResponse" : {
"type" : "object"
},
"MetricAggregatorInfo" : {
"required" : [
"unit",
"value",
"name"
],
"type" : "object",
"properties" : {
"unit" : {
"type" : "string",
"description" : "The name of the sampling time unit for the aggregation function. Possible values: year, month, week, day, hour, min, sec, msec"
},
"value" : {
"type" : "integer",
"description" : "The value of the sampling time unit for the aggregation function. Min value: 1"
},
"name" : {
"type" : "string",
"description" : "The name of an aggregation function to be applied to data points that fit in the same time intervals. Possible values:
max - returns the largest value in the interval
min - returns the smallest value in the interval
sum - sums all values
first - returns the first data point for the interval
least_squares - returns two points for the range which represent the best fit line through the set of points
avg - computes average value
last - returns the last data point for the interval
gaps - marks gaps in data according to sampling rate with a null data point
rate - returns the rate of change between a pair of data points."
}
}
},
"NotificationTemplateInfo" : {
"type" : "object",
"properties" : {
"bcc" : {
"type" : "string",
"description" : "An email address of the person who wants to receive a copy of this notification. You can specify more than one valid email address, make sure they are separated with commas"
},
"body" : {
"type" : "string",
"description" : "The content of the message"
},
"i_notification_preset" : {
"type" : "integer",
"description" : "The identifier of the notification preset"
},
"subject" : {
"type" : "string",
"description" : "The subject as it appears in an email to a recepient"
},
"name" : {
"type" : "string",
"description" : "The notification name"
},
"variables" : {
"$ref" : "#/components/schemas/ArrayOfNotificationTemplateVariables"
},
"default" : {
"type" : "string",
"description" : "The flag shows whether the notification is default. Possible values are: Y, N"
}
}
},
"ArrayOfServices" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServiceInfo"
}
},
"UpdateDIDGroupResponse" : {
"required" : [
"i_group"
],
"type" : "object",
"properties" : {
"i_group" : {
"type" : "integer",
"description" : "The unique ID of the DID group"
}
}
},
"SyncXratesRequest" : {
"type" : "object"
},
"GetDIDAreasListResponse" : {
"type" : "object",
"properties" : {
"areas_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDAreaInfo"
}
}
},
"GetMyInfoResponse" : {
"required" : [
"customer_info"
],
"type" : "object",
"properties" : {
"customer_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
}
}
},
"ObtainAccessNumberResponse" : {
"required" : [
"i_ivr_an"
],
"type" : "object",
"properties" : {
"i_ivr_an" : {
"type" : "integer",
"description" : "The unique ID of the IVR access number record"
}
}
},
"GetDIDGroupListResponse" : {
"required" : [
"group_list"
],
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of records in the list"
},
"group_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDGroupInfo"
}
}
},
"TariffInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the related service type"
},
"i_service" : {
"type" : "integer",
"description" : "Refers to ID of the service type for which this tariff will be used"
},
"i_tariff_template_upload" : {
"type" : "integer",
"description" : "Refers to ID of upload template"
},
"shared" : {
"type" : "string",
"description" : "Shows whether the tariff managed by the administrator is available to resellers"
},
"currency" : {
"type" : "string",
"description" : "Tariff currency"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "Refers to ID of destination groups"
},
"usage_update" : {
"type" : "string",
"description" : "Usage update. One of the following: Always, Billable"
},
"formula" : {
"type" : "string",
"description" : "Call rating formula that applies to new rates"
},
"login_fee" : {
"type" : "number",
"description" : "Amount to be charged immediately after the first user authentication"
},
"post_call_surcharge" : {
"type" : "number",
"description" : "Increases the total call cost by the given value"
},
"is_used_by_resellers" : {
"type" : "integer",
"description" : "Shows whether the shared tariff is used by resellers"
},
"obsolete_from" : {
"type" : "string",
"description" : "The date a tariff is obsolete from"
},
"routing_ext" : {
"type" : "string",
"description" : "Flag that inform if the tariff contains information about the carrier's routing preferences"
},
"is_used" : {
"type" : "string",
"description" : "Shows whether the tariff is in use"
},
"period" : {
"type" : "string",
"description" : "Discontinued"
},
"connect_fee" : {
"type" : "number",
"description" : "Amount to be charged for each successful call"
},
"name" : {
"type" : "string",
"description" : "The tariff name"
},
"i_tariff_template_download" : {
"type" : "integer",
"description" : "Refers to ID of download template"
},
"free_sec" : {
"type" : "integer",
"description" : "Number of free seconds granted for each call"
},
"i_tariff" : {
"type" : "integer",
"description" : "ID of the tariff record"
},
"description" : {
"type" : "string",
"description" : "Tariff description"
},
"i_offpeak" : {
"type" : "integer",
"description" : "Refers to ID of the off_peak period record"
},
"rating_mode" : {
"type" : "string",
"description" : "Left for backward compatibility"
},
"rate_format" : {
"type" : "string",
"description" : "Determines which numbering format rates could be added to the tariff"
},
"short_description" : {
"type" : "string",
"description" : "Short tariff description"
},
"notepad" : {
"type" : "string",
"description" : "Comments regarding this tariff"
},
"rounding" : {
"type" : "integer",
"description" : "Quantity of digits after point for rounding"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"type" : {
"type" : "string",
"description" : "Designates whom this tariff is applied to. One of the following: Customer, Vendor, Reseller"
},
"authorized_email_list" : {
"$ref" : "#/components/schemas/ArrayOfAuthorizedEmailInfo"
}
}
},
"VoidInvoiceRequest" : {
"required" : [
"i_invoice"
],
"type" : "object",
"properties" : {
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"UpdateDatesBatchResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success"
}
}
},
"AsyncRequestInfo" : {
"type" : "object",
"properties" : {
"update_time" : {
"type" : "string",
"description" : "The date and time when the request was last updated"
},
"status" : {
"type" : "string",
"description" : "The status of the request"
},
"progress" : {
"type" : "number",
"description" : "The progress of the request"
},
"start_time" : {
"type" : "string",
"description" : "The date and time when the request started"
},
"stop_time" : {
"type" : "string",
"description" : "The date and time when the request was completed"
},
"i_async_request" : {
"type" : "integer",
"description" : "The unique ID of the request"
},
"method" : {
"type" : "string",
"description" : "The name of the request method"
},
"arguments" : {
"type" : "string",
"description" : "The input arguments used to start the request"
}
}
},
"GetUserRTRequestorListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The pattern to search requestors by in the 'name' field"
},
"get_total" : {
"type" : "integer",
"description" : "Flag shows whether to include the total number of found items"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"ArrayOfAssignMultiserviceUAPortInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AssignMultiserviceUAPortInfo"
}
},
"CustomerSetCallQueuePromptFileResponse" : {
"required" : [
"i_c_queue"
],
"type" : "object",
"properties" : {
"i_c_queue" : {
"type" : "integer",
"description" : "ID of call queue record"
}
}
},
"GetCustomTaxOptionRequest" : {
"required" : [
"i_option"
],
"type" : "object",
"properties" : {
"i_option" : {
"type" : "integer",
"description" : "The unique ID of the custom tax"
}
}
},
"ArrayOfAclInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AclInfo"
}
},
"DeleteCommitmentResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "The result of the operation, or an exception in case of failure"
}
}
},
"CloseAccountSubscriptionResponse" : {
"required" : [
"i_account_subscription"
],
"type" : "object",
"properties" : {
"i_account_subscription" : {
"type" : "integer",
"description" : "The unique identifier of the account's subscription record"
}
}
},
"ArrayOfIPTVChannelPackage" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IPTVChannelPackage"
}
},
"GetOperationAccessIdResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 on success"
}
}
},
"GetRouteCategoryListRequest" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Checks whether the route categories are in use"
},
"name" : {
"type" : "string",
"description" : "A route category name"
},
"get_total" : {
"type" : "integer",
"description" : "1 to return 'total' field in the method response"
},
"default" : {
"type" : "string",
"description" : "Filter by the 'default' field. Possible values: 'Y', 'N'"
},
"limit" : {
"type" : "integer",
"description" : "Number of rows to retrieve"
},
"description" : {
"type" : "string",
"description" : "A route category description"
},
"offset" : {
"type" : "integer",
"description" : "Number of rows to skip at the beginning of the response list"
}
}
},
"GetTaxPluginCodesListResponse" : {
"type" : "object",
"properties" : {
"transaction_codes" : {
"$ref" : "#/components/schemas/ArrayOfTaxationCodes"
}
}
},
"AddVDTopupOptionResponse" : {
"type" : "object",
"properties" : {
"i_vd_topup" : {
"type" : "integer",
"description" : "The unique ID of the volume discount topup record"
}
}
},
"UpdateCallQueueRequest" : {
"type" : "object",
"properties" : {
"callqueue_info" : {
"$ref" : "#/components/schemas/CQInfo"
}
}
},
"DeleteAutoPaymentRequest" : {
"required" : [
"i_object"
],
"type" : "object",
"properties" : {
"i_object" : {
"type" : "integer",
"description" : "The unique ID of an account or a customer. Not mandatory when the method that requires this structure is executed from the retail customer realm"
}
}
},
"GetRetailCustomerSWXDRListResponse" : {
"type" : "object",
"properties" : {
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfServiceWalletXDRInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved xDRs"
}
}
},
"ServicePolicyAttributeValues" : {
"required" : [
"i_sp_attribute"
],
"type" : "object",
"properties" : {
"group_name" : {
"type" : "string",
"description" : "The name used to group service policy attributes. The field is applicable only to getters"
},
"name" : {
"type" : "string",
"description" : "The name of the service policy attribute. The field is applicable only to getters"
},
"values" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"i_sp_attribute" : {
"type" : "integer",
"description" : "The unique id of service policy attribute"
}
}
},
"TopupAccountResponse" : {
"required" : [
"billing_model",
"customer_balance",
"currency",
"amount",
"breakage",
"balance",
"customer_credit_limit",
"credit_limit"
],
"type" : "object",
"properties" : {
"billing_model" : {
"type" : "string",
"description" : "Shows the account type"
},
"available_funds" : {
"type" : "number",
"description" : "For debit accounts, this is equal to the h323-credit-amount. For credit accounts, this returns the actual amount of available funds (the difference between the credit limit and the current balance with respect to the credit limits for the individual account and customer). This field is not present in the response for accounts with the unlimited available funds"
},
"customer_balance" : {
"type" : "number",
"description" : "The customer's balance"
},
"currency" : {
"type" : "string",
"description" : "Shows the account currency"
},
"amount" : {
"type" : "number",
"description" : "Amount by which the account's balance will increase"
},
"breakage" : {
"type" : "number",
"description" : "The breakage amount of the account's product"
},
"balance" : {
"type" : "number",
"description" : "The current amount of the account's balance"
},
"customer_credit_limit" : {
"type" : "number",
"description" : "The customer's credit limit value"
},
"credit_limit" : {
"type" : "number",
"description" : "The account's credit limit value"
}
}
},
"ExtendedDataObjectInfo" : {
"required" : [
"fields"
],
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The name of the object"
},
"fields" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"MakeVendorTransactionResponse" : {
"required" : [
"balance",
"i_xdr"
],
"type" : "object",
"properties" : {
"balance" : {
"type" : "number",
"description" : "Vendor's modified balance"
},
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the xDR record"
}
}
},
"UpdateResaleMapRecordResponse" : {
"type" : "object",
"properties" : {
"i_resale_tariff_mapping" : {
"type" : "integer",
"description" : "The unique ID of the tariff mapping record"
}
}
},
"DeleteDIDNumberInfoStatus" : {
"required" : [
"i_did_number",
"status"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique ID of the DID number record"
},
"status" : {
"type" : "string",
"description" : "The status that shows whether the operation was successful. Possible values: 'failure', 'success'"
}
}
},
"CustomerUpdateNumberSequenceRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_number_scope" : {
"type" : "integer",
"description" : "The number scope. Possible values: 1 - env, 2 - reseller, 3 - customer"
},
"last_invoice_number" : {
"type" : "integer",
"description" : "The last invoice number"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record"
}
}
},
"DeleteAllowedLocationResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"DeleteRoamingProfileRequest" : {
"required" : [
"i_roaming_profile"
],
"type" : "object",
"properties" : {
"i_roaming_profile" : {
"type" : "integer",
"description" : "The unique ID of the roaming profile"
}
}
},
"CancelRequestResponse" : {
"type" : "object",
"properties" : {
"porting_request_info" : {
"$ref" : "#/components/schemas/PortingRequestInfo"
}
}
},
"ArrayOfNotificationTemplateVariables" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NotificationTemplateVariable"
}
},
"DisallowedProducts" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of a product record which can't be assigned to an account together with the main product"
}
}
},
"SendMeCustomerClassNotificationSampleRequest" : {
"required" : [
"messaging_service_type",
"name",
"i_customer_class"
],
"type" : "object",
"properties" : {
"messaging_service_type" : {
"type" : "string",
"description" : "The type of the notification. Possible values: SMS, Mail"
},
"name" : {
"type" : "string",
"description" : "The name of the notification"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
}
}
},
"GetDIDProviderListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The DID provider name pattern"
}
}
},
"GetCodecConverterFileResponse" : {
"type" : "object",
"properties" : {
"i_owner" : {
"type" : "integer",
"description" : "The owner id"
},
"file_name" : {
"type" : "string",
"description" : "The file name"
},
"error_message" : {
"type" : "string",
"description" : "The error message"
},
"status" : {
"type" : "string",
"description" : "The file status"
},
"owner_type" : {
"type" : "string",
"description" : "The owner type"
},
"name" : {
"type" : "string",
"description" : "The file name"
},
"id" : {
"type" : "integer",
"description" : "The unique identifier of the file"
}
}
},
"GetUserInfoResponse" : {
"required" : [
"user_info"
],
"type" : "object",
"properties" : {
"user_info" : {
"$ref" : "#/components/schemas/UserInfo"
}
}
},
"ArrayOfPortingRequestParameterInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PortingRequestParameterInfo"
}
},
"CustomerAuxFieldInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The field value"
},
"name" : {
"type" : "string",
"description" : "The field name"
}
}
},
"UpdateVDThresholdResponse" : {
"type" : "object",
"properties" : {
"i_vd_threshold" : {
"type" : "integer",
"description" : "The unique ID of the volume discount threshold object"
}
}
},
"GetDIDNumberListResponse" : {
"type" : "object",
"properties" : {
"number_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDNumberInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of retrieved DID numbers"
}
}
},
"MOHInfo" : {
"type" : "object",
"properties" : {
"converted" : {
"type" : "string",
"description" : "Indicates whether the MOH was converted"
},
"tries" : {
"type" : "integer",
"description" : "Left for backward compatibility"
},
"name" : {
"type" : "string",
"description" : "MOH record name"
},
"i_moh" : {
"type" : "integer",
"description" : "The unique ID of the MOH record"
}
}
},
"CalendarDateInfo" : {
"type" : "object",
"properties" : {
"i_calendar_day" : {
"type" : "integer",
"description" : "The unique ID of the calendar date record"
},
"day" : {
"type" : "string",
"description" : "The date value of the calendar date record (e.g. \"2020-01-25\")"
},
"type" : {
"type" : "string",
"description" : "The date type of the calendar date record. Possible values: working, non-working"
},
"description" : {
"type" : "string",
"description" : "The description of the calendar date record, to store any additional information about this date"
}
}
},
"GetCreditLimitHistoryResponse" : {
"type" : "object",
"properties" : {
"credit_limit_history" : {
"$ref" : "#/components/schemas/ArrayOfCreditLimitChangeInfo"
}
}
},
"ReleaseDIDFromOwnerBatchRequest" : {
"required" : [
"i_did_number"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique DID Number identifier"
}
}
},
"GetCustomerClassNotificationCategoryListResponse" : {
"type" : "object",
"properties" : {
"notification_category_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerClassNotificationCategoryInfo"
}
}
},
"ScheduleCommitmentRecordReplacementResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "The result of the operation, or an exception in case of failure"
}
}
},
"UnpauseAssignedCommitmentRecordResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "The result of the operation, or an exception in case of failure"
}
}
},
"DeleteCommitmentOneTimeTermRequest" : {
"required" : [
"i_one_time_term"
],
"type" : "object",
"properties" : {
"i_one_time_term" : {
"type" : "integer",
"description" : "The unique identifier of the one-time term"
}
}
},
"ArrayOfCRInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CRInfo"
}
},
"UpdateMerchantAccountRequest" : {
"required" : [
"merchant_account"
],
"type" : "object",
"properties" : {
"detailed_response" : {
"type" : "integer",
"description" : "Specifies whether updated record will be returned in response or not"
},
"merchant_account" : {
"$ref" : "#/components/schemas/MerchantAccount"
}
}
},
"GetOwnerBatchInfoRequest" : {
"required" : [
"i_do_batch"
],
"type" : "object",
"properties" : {
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the DID Pricing Batch"
},
"get_did_total_usage" : {
"type" : "integer",
"description" : "Get the usage of DID numbers for a DID owner batch in the response"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the owner batch is in use"
},
"get_did_total" : {
"type" : "integer",
"description" : "Get the total number of DID numbers for a DID owner batch in the response"
},
"with_markup" : {
"type" : "integer",
"description" : "If with_markup == 1 then return information about markup"
}
}
},
"RawAccessObjectPermission" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the access object"
},
"permission" : {
"type" : "integer",
"description" : "The permission for the access object"
},
"attributes" : {
"$ref" : "#/components/schemas/ArrayOfRawAccessAttributePermission"
}
}
},
"UpdateTemplateDataFieldListRequest" : {
"required" : [
"i_template",
"template_data_field_list"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"template_data_field_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateDataFieldInfo"
}
}
},
"MetricInputInfo" : {
"required" : [
"aggregator_list",
"name"
],
"type" : "object",
"properties" : {
"aggregator_list" : {
"$ref" : "#/components/schemas/ArrayOfMetricAggregatorInfo"
},
"name" : {
"type" : "string",
"description" : "The name of the metric. Possible values:
system_load.psmsc_load.active_registrations - the number of registered accounts (available tags: ip).
system_load.psmsc_load.calls_counter - the number of processed call attempts (available tags: ip).
system_load.psmsc_load.active_calls - the number of calls in progress (available tags: ip).
system_load.psmsc_load.registrations_counter - the number of processed registration attempts (available tags: ip).
system_load.connection_load - the number of calls via the connection (available tags: connection).
system_load.connection_load.setup_time - the average setup time in milliseconds (available tags: connection).
system_load.connection_load.asr - the average success rate (percent) (available tags: connection).
system_load.total_calls.calls - the number of calls per minute.
system_load.total_calls.zero_calls - the number of zero-duration calls per minute.
system_load.daily_calls - the total calls duration (minutes) at a given day.
system_load.cc_staff.search_counter - the number of traced sessions (available tags: cc_staff).
system_load.cc_staff.refunds_counter - the number of balance adjustments made by the staff (available tags: cc_staff).
system_load.cc_staff.refunded_today - the total amount of money refunded by the staff (available tags: cc_staff)"
},
"grouping_list" : {
"$ref" : "#/components/schemas/ArrayOfMetricGroupingInfo"
},
"filter_list" : {
"$ref" : "#/components/schemas/ArrayOfMetricFilterInfo"
}
}
},
"AddCurrencyRequest" : {
"required" : [
"currency_info"
],
"type" : "object",
"properties" : {
"currency_info" : {
"$ref" : "#/components/schemas/CurrencyInfo"
}
}
},
"GetCPConditionInfoResponse" : {
"type" : "object",
"properties" : {
"cp_condition_info" : {
"$ref" : "#/components/schemas/CPConditionInfo"
}
}
},
"GetAccountFollowMeRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"with_period_definition" : {
"type" : "integer",
"description" : "If set, each follow-me number will contain a 'period_definition' field in the response"
},
"i_follow_me" : {
"type" : "integer",
"description" : "ID of the Follow_Me record"
}
}
},
"GetInvoiceListResponse" : {
"type" : "object",
"properties" : {
"invoice_list" : {
"$ref" : "#/components/schemas/ArrayOfInvoiceInfo"
},
"invoices_summary" : {
"$ref" : "#/components/schemas/CustomerInvoicesSummary"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved invoices"
}
}
},
"UpdateDIDInventoryOptionsRequest" : {
"required" : [
"option_list"
],
"type" : "object",
"properties" : {
"option_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDInventoryOptionsInfo"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller"
}
}
},
"RoutingOptionInfo" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The routing option value"
},
"name" : {
"type" : "string",
"description" : "The routing option name"
}
}
},
"DeleteRPConnectionRequest" : {
"required" : [
"i_rp_connection"
],
"type" : "object",
"properties" : {
"i_rp_connection" : {
"type" : "integer",
"description" : "The unique ID of the custom routing configured for a particular destination group"
}
}
},
"ScheduledCustomerStatusChangeInfo" : {
"required" : [
"time_stamp",
"status_name",
"generate_invoice_earlier",
"i_status"
],
"type" : "object",
"properties" : {
"time_stamp" : {
"type" : "string",
"description" : "The timestamp when the status will be applied to the customer"
},
"status_name" : {
"type" : "string",
"description" : "The human-readable name of the status"
},
"generate_invoice_earlier" : {
"type" : "string",
"description" : "Defines whether an invoice will be generated before the end of the billing period"
},
"i_status" : {
"type" : "integer",
"description" : "The unique ID of the scheduled customer status change"
}
}
},
"UpdateCommitmentRecurringTermResponse" : {
"type" : "object",
"properties" : {
"i_recurring_term" : {
"type" : "integer",
"description" : "The unique identifier of the record"
}
}
},
"MediaAttributeValueInfo" : {
"type" : "object",
"properties" : {
"editor_value" : {
"type" : "string",
"description" : "The value of the attribute shown on the Web Interface"
},
"value" : {
"type" : "string",
"description" : "The value of the attribute"
}
}
},
"ProductGroupInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Shows whether the product group is used by some product"
},
"i_product_group" : {
"type" : "integer",
"description" : "The ID of the group record"
},
"name" : {
"type" : "string",
"description" : "The name of the product group"
},
"i_customer" : {
"type" : "integer",
"description" : "The ID of the Customer to which the group belongs"
},
"products_total" : {
"type" : "integer",
"description" : "The total number of products that are in the group"
},
"included_products" : {
"$ref" : "#/components/schemas/ArrayOfGroupIncludedProductInfo"
}
}
},
"GetSubrealmsListResponse" : {
"required" : [
"subrealms_list"
],
"type" : "object",
"properties" : {
"subrealms_list" : {
"$ref" : "#/components/schemas/ArrayOfSubrealmsInfo"
}
}
},
"DeleteCallBarringClassResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception error message in case of failure"
}
}
},
"SendMeNotificationSampleResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"RecalculateInvoicesRequest" : {
"required" : [
"from_date"
],
"type" : "object",
"properties" : {
"customer_list" : {
"$ref" : "#/components/schemas/ArrayOfInt"
},
"from_date" : {
"type" : "string",
"description" : "Recalculate invoices with 'period_from' starting from this date"
},
"void_closed_invoices" : {
"type" : "integer",
"description" : "Void closed invoices and create them anew, has an effect if the 'only_pdf' option is false"
},
"only_pdf" : {
"type" : "integer",
"description" : "Generate new .pdf files according to the current template settings, no figures will be affected"
}
}
},
"DeleteUserResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"ArrayOfDIDCountryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DIDCountryInfo"
}
},
"GetRouteCategoryListResponse" : {
"type" : "object",
"properties" : {
"route_category_list" : {
"$ref" : "#/components/schemas/ArrayOfRouteCategoryInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved route category records"
}
}
},
"AddUpdateAutoPaymentInfoRequest" : {
"required" : [
"auto_payment_info"
],
"type" : "object",
"properties" : {
"auto_payment_info" : {
"$ref" : "#/components/schemas/AutoPaymentInfo"
}
}
},
"GetCustomerDIDNumbersRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the master account record"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who owns DID numbers"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of a retail customer record"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property specified within the API request"
}
}
},
"AddUpdateZendeskOrganizationResponse" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The Zendesk organization (already existing) for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side"
}
}
},
"ConsumedServiceInfo" : {
"type" : "object",
"properties" : {
"roaming" : {
"type" : "integer",
"description" : "Specifies the xDR's roaming status"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"rate_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units used to calculate service charges"
},
"total" : {
"type" : "integer",
"description" : "The Total number of records"
},
"unit" : {
"type" : "string",
"description" : "A customer-visible name for the units in which service use is measured"
},
"service_name" : {
"type" : "string",
"description" : "The name of the service"
},
"charged_amount" : {
"type" : "string",
"description" : "Amount charged"
},
"charged_quantity" : {
"type" : "integer",
"description" : "The number of charged units in which service is measured"
},
"total_sessions" : {
"type" : "integer",
"description" : "The total number of the sessions"
},
"rating_base" : {
"type" : "string",
"description" : "Specifies which particular parameter is used to calculate charges, e.g. \"session time\", \"amount of data transferred\" and the like"
}
}
},
"GetAutoPaymentInfoResponse" : {
"required" : [
"auto_payment_info"
],
"type" : "object",
"properties" : {
"auto_payment_info" : {
"$ref" : "#/components/schemas/AutoPaymentInfo"
}
}
},
"GetTemplateInfoRequest" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"with_body" : {
"type" : "integer",
"description" : "If set, the bodies of the template will be added to the response"
},
"generate_preview" : {
"type" : "integer",
"description" : "If set, the template preview file will be added to the response"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the template is in use"
},
"with_body_content" : {
"type" : "integer",
"description" : " If 'with_body' is not set, this parameter is ignored. Otherwise, if it is set, body content will be added to the response"
}
}
},
"GetInvoiceTypeInfoRequest" : {
"required" : [
"i_invoice_type"
],
"type" : "object",
"properties" : {
"i_invoice_type" : {
"type" : "integer",
"description" : "The unique ID of the invoice status record"
}
}
},
"CustomerMakeTaxTransactionResponse" : {
"type" : "object",
"properties" : {
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the xdr record"
}
}
},
"SearchRateListResponse" : {
"type" : "object",
"properties" : {
"rate_list" : {
"$ref" : "#/components/schemas/ArrayOfRateInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved rate data records"
}
}
},
"RawProductSubscriptionInfo" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"iso_4217" : {
"type" : "string",
"description" : "The currency for the subscription plan"
},
"minimum_period" : {
"type" : "integer",
"description" : "Time interval (in months) during which the subscription must remain uninterrupted so as to avoid penalties"
},
"activation_mode" : {
"type" : "integer",
"description" : "If the subscription is assigned to an account, this parameter specifies the date upon which the subscription charges will apply. Possible values: 1 - at the given start date, 2 - upon the account's first usage"
},
"i_product_subscription" : {
"type" : "integer",
"description" : "The unique ID of the product subscription record"
},
"i_subscription" : {
"type" : "integer",
"description" : "The ID for subscription plan, refers to the Subscriptions table"
},
"charge_model" : {
"type" : "integer",
"description" : "Defines the way subscription charges are applied to a customer's account. Possible values: 0 - progressively, 1 - at the end of the billing period, 2 - in advance"
},
"i_managed_by" : {
"type" : "integer",
"description" : "The ID of the customer who manages the subscription"
},
"advance_periods" : {
"type" : "integer",
"description" : "Only available for subscription plans charged in advance; specifies for how many periods advance charges should be made"
},
"invoice_description" : {
"type" : "string",
"description" : "The subscription plan name that is visible to the end user"
},
"name" : {
"type" : "string",
"description" : "The name of the subscription plan"
},
"inherited_invoice_description" : {
"type" : "string",
"description" : "The inherited subscription plan name"
},
"description" : {
"type" : "string",
"description" : "The subscription plan description"
},
"own_invoice_description" : {
"type" : "string",
"description" : "The invoice description configured on the product level"
},
"rounding" : {
"type" : "integer",
"description" : "A pattern that defines the rounding of the amount charged for a billing period"
},
"cancel_penalty" : {
"type" : "number",
"description" : "A one-time fee applied when the subscription is cancelled earlier than the minimum subscription period"
},
"multiple" : {
"type" : "integer",
"description" : "The flag shows whether this subscription can be applied more than once"
},
"i_customer" : {
"type" : "integer",
"description" : "The ID of the customer who manages the subscription"
},
"activation_fee" : {
"type" : "number",
"description" : "A one-time fee applied when the subscription is activated"
}
}
},
"ArrayOfServiceAttributeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServiceAttributeInfo"
}
},
"GetDiscountPlanInfoRequest" : {
"required" : [
"i_vd_plan"
],
"type" : "object",
"properties" : {
"check_usage_by_resellers" : {
"type" : "integer",
"description" : "If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response"
},
"check_complete_status" : {
"type" : "integer",
"description" : "If set to '1', the 'is_complete' field will be returned in the response"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan"
}
}
},
"CustomerVDTopupRequest" : {
"required" : [
"i_service",
"i_dest_group",
"topup_amount",
"peak_level",
"i_customer"
],
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group to apply the top-up to"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of a service; refers to the Services table"
},
"topup_expires" : {
"type" : "string",
"description" : "A date and time in UTC when the topped up volume discount becomes expired (YYYY-MM-DD HH24:MI:SS)"
},
"topup_amount" : {
"type" : "number",
"description" : "The top-up amount"
},
"peak_level" : {
"type" : "integer",
"description" : "Possible values: 0 - Peak Period, 1 - Off-Peak Period, 2 - 2nd Off-Peak Period"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"h323_conf_id" : {
"type" : "string",
"description" : "Custom data for third-party application processing"
},
"payment_info" : {
"$ref" : "#/components/schemas/PaymentInfo"
}
}
},
"ServicePolicyInfo" : {
"type" : "object",
"properties" : {
"i_service_policy" : {
"type" : "integer",
"description" : "The unique ID of the service policy"
},
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"is_used" : {
"type" : "integer",
"description" : "Shows if the service policy is used or not"
},
"generated_by" : {
"type" : "string",
"description" : "Shows by which entity this service policy was generated by"
},
"name" : {
"type" : "string",
"description" : "The name of the service policy"
},
"description" : {
"type" : "string",
"description" : "The description of the service policy"
},
"match_priority" : {
"type" : "integer",
"description" : "This is only used for policies that match dynamically. If more than one service policy corresponds to the caller’s user agent name, the one with the highest priority will be used"
},
"match_pattern" : {
"type" : "string",
"description" : "If this field is not empty the service policy is considered dynamically matched and will be attempted for every new call initiated by internal accounts"
},
"id" : {
"type" : "string",
"description" : "The internal ID of the service policy"
},
"attributes" : {
"$ref" : "#/components/schemas/ArrayOfServicePolicyAttributeValues"
}
}
},
"UpdateServiceRequest" : {
"type" : "object",
"properties" : {
"service_info" : {
"$ref" : "#/components/schemas/ServiceInfo"
}
}
},
"ArrayOfPermittedSipProxiesInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PermittedSipProxiesInfo"
}
},
"DisableAsyncApiNotificationsRequest" : {
"type" : "object"
},
"UpdateDestinationPrefixResponse" : {
"required" : [
"i_dest"
],
"type" : "object",
"properties" : {
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of a destination record"
}
}
},
"UpdateServicePolicyResponse" : {
"required" : [
"i_service_policy"
],
"type" : "object",
"properties" : {
"i_service_policy" : {
"type" : "integer",
"description" : "The unique identifier of the service policy"
}
}
},
"TemplateAddBuildInTemplateRequest" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"page_representation" : {
"type" : "string",
"description" : "The template page representation"
},
"name" : {
"type" : "string",
"description" : "Template name"
},
"custom_description" : {
"type" : "string",
"description" : "Template description"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller"
}
}
},
"DeletePhoneBookRecordResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "One of the following: 1 – success, 0 – failed"
}
}
},
"GetMOHFileRequest" : {
"required" : [
"i_moh"
],
"type" : "object",
"properties" : {
"i_moh" : {
"type" : "integer",
"description" : "The unique ID of the MOH record"
}
}
},
"DeleteUAProfileRequest" : {
"required" : [
"i_ua_profile"
],
"type" : "object",
"properties" : {
"i_ua_profile" : {
"type" : "integer",
"description" : "The unique ID of the UA Profile record"
}
}
},
"PauseAssignedCommitmentRecordResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "The result of the operation, or an exception in case of failure"
}
}
},
"GetIvrApplicationListResponse" : {
"required" : [
"ivr_application_list"
],
"type" : "object",
"properties" : {
"ivr_application_list" : {
"$ref" : "#/components/schemas/ArrayOfIvrApplicationInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the records"
}
}
},
"UpdateDiscountResponse" : {
"required" : [
"i_vd_dg"
],
"type" : "object",
"properties" : {
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the discount for a specific destination group"
}
}
},
"VerifyOtpResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Indicates whether the verification one-time-password was: 1 – successful, 0 – unsuccessful"
}
}
},
"GetRepresentativeTransactionsTotalInfoResponse" : {
"type" : "object",
"properties" : {
"count" : {
"type" : "integer",
"description" : "The total number of transactions"
},
"iso_4217" : {
"type" : "string",
"description" : "Transactions currency"
},
"total_commission" : {
"type" : "number",
"description" : "Total commission transactions amount"
},
"total_payout" : {
"type" : "number",
"description" : "Total payout transactions amount"
}
}
},
"GetHGInfoRequest" : {
"required" : [
"i_c_group"
],
"type" : "object",
"properties" : {
"i_c_group" : {
"type" : "integer",
"description" : "The unique ID of the huntgroup record"
},
"get_prompt_file" : {
"type" : "integer",
"description" : "The prompt file associated with this huntgroup"
}
}
},
"GetCodecListRequest" : {
"type" : "object"
},
"ReapplyProductSubscriptionsRequest" : {
"required" : [
"i_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The ID of product record"
}
}
},
"GetVoiceQualityProfileInfoRequest" : {
"required" : [
"i_vq_profile"
],
"type" : "object",
"properties" : {
"i_vq_profile" : {
"type" : "integer",
"description" : "The ID of the voice quality profile"
},
"check_usage" : {
"type" : "integer",
"description" : "Checks whether the voice quality profile is in use"
}
}
},
"DeleteTaxTransactionCodeRequest" : {
"required" : [
"i_tax_transaction_code"
],
"type" : "object",
"properties" : {
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique ID of the taxation code database record"
}
}
},
"ArrayOfTemplateDataGroupInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TemplateDataGroupInfo"
}
},
"GetAccountFollowMeResponse" : {
"type" : "object",
"properties" : {
"default_followme_numbers_timeout" : {
"type" : "integer",
"description" : "The default number of seconds to wait until a call is answered"
},
"followme_numbers" : {
"$ref" : "#/components/schemas/ArrayOfFollowMeNumberInfo"
},
"followme_info" : {
"$ref" : "#/components/schemas/FollowMeInfo"
}
}
},
"VerifyOtpRequest" : {
"required" : [
"one_time_password"
],
"type" : "object",
"properties" : {
"operation" : {
"type" : "string",
"description" : "A unique operation name that requires an additional ID for access"
},
"one_time_password" : {
"type" : "string",
"description" : "The password that was sent by email/mobile to the requestor"
}
}
},
"GetCriterionInfoResponse" : {
"type" : "object",
"properties" : {
"criterion_info" : {
"$ref" : "#/components/schemas/CriterionInfo"
}
}
},
"ArrayOfAclObjects" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"InvoiceTypeInfo" : {
"type" : "object",
"properties" : {
"i_invoice_type" : {
"type" : "integer",
"description" : "The unique ID of the invoice status record"
},
"name" : {
"type" : "string",
"description" : "The invoice type name"
}
}
},
"GetTransferInfoRequest" : {
"required" : [
"i_account",
"transaction_id"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account. Not mandatory when the method that requires this structure is executed from the account realm"
},
"transaction_id" : {
"type" : "integer",
"description" : "The unique ID of the remittance transaction"
}
}
},
"GetProductGroupListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the product group"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of product groups"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the Customer record"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"get_included_products" : {
"type" : "integer",
"description" : "If set to '1', included_products for every product group will be calculated and provided in the response"
}
}
},
"GetAssignedCommitmentRecordListRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique identifier of the account"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"UpdateRateRequest" : {
"type" : "object",
"properties" : {
"rate_info" : {
"$ref" : "#/components/schemas/RateInfo"
}
}
},
"AddCallBarringClassRequest" : {
"required" : [
"call_barring_class_info"
],
"type" : "object",
"properties" : {
"call_barring_class_info" : {
"$ref" : "#/components/schemas/CallBarringClassInfo"
}
}
},
"CustomerMakeTaxTransactionRequest" : {
"required" : [
"amount",
"i_customer"
],
"type" : "object",
"properties" : {
"visible_comment" : {
"type" : "string",
"description" : "A comment on this transaction visible to the customer in the xDR browser"
},
"amount" : {
"type" : "number",
"description" : "The amount by which the customer's balance will increase / decrease. The number of digits depends on the maximum number of decimal places allowed by the currency"
},
"cli" : {
"type" : "string",
"description" : "Additional information about transaction origins"
},
"mark_xdr_out_of_turn" : {
"type" : "integer",
"description" : "The flag shows whether to mark transaction for an out-of-turn invoice"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"internal_comment" : {
"type" : "string",
"description" : "An internal comment on this transaction; not visible in the xDR browser and accessible only from the database directly"
}
}
},
"TestTranslationRuleResponse" : {
"required" : [
"translated_string"
],
"type" : "object",
"properties" : {
"translated_string" : {
"type" : "string",
"description" : "A string with the result of the translation"
}
}
},
"ArrayOfExtendedDataRecordInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ExtendedDataRecordInfo"
}
},
"DeleteAccessPolicyRequest" : {
"required" : [
"i_access_policy"
],
"type" : "object",
"properties" : {
"i_access_policy" : {
"type" : "integer",
"description" : "The unique ID of the access policy"
}
}
},
"GetSubscriptionListRequest" : {
"type" : "object",
"properties" : {
"charge_model" : {
"type" : "integer",
"description" : "Defines the way subscription charges are applied to a customer's account. Possible values: 0 - progressively, 1 - at the end of the billing period, 2 - in advance"
},
"search" : {
"type" : "string",
"description" : "Search pattern in the name, description and invoice description of the subscription plan"
},
"iso_4217" : {
"type" : "string",
"description" : "Currency for the Subscription"
},
"name" : {
"type" : "string",
"description" : "The name of the subscription plan"
},
"description" : {
"type" : "string",
"description" : "The description of the subscription plan"
},
"with_shared" : {
"type" : "integer",
"description" : "If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the subscription plan is in use"
},
"with_discounts" : {
"type" : "integer",
"description" : "Specifies whether a list of discounts will be returned for the retrieved subscriptions"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved subscriptions"
},
"managed_by_admin" : {
"type" : "string",
"description" : "Indicates that only managed by admin Subscriptions should be fetched"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_customer" : {
"type" : "integer",
"description" : "The ID of the reseller who manages the Subscription"
},
"multiple" : {
"type" : "string",
"description" : "Specifies whether the same subscription can be applied multiple times to one account. Possible values: N - subscription can be applied only once, Y - subscription can be applied multiple times"
},
"with_fees" : {
"type" : "integer",
"description" : "Specifies whether a list of periodic fees will be returned for the retrieved subscriptions"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"ArrayOfDIDAreaInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DIDAreaInfo"
}
},
"AddQFResponse" : {
"required" : [
"i_quick_form"
],
"type" : "object",
"properties" : {
"i_quick_form" : {
"type" : "integer",
"description" : "The unique ID of the quick form"
}
}
},
"PaymentInfo" : {
"required" : [
"amount",
"action"
],
"type" : "object",
"properties" : {
"visible_comment" : {
"type" : "string",
"description" : "A comment on this transaction visible to the end user in the xDR browser"
},
"amount" : {
"type" : "number",
"description" : "The payment amount"
},
"save_card" : {
"type" : "string",
"description" : "Specifies whether the supplied payment method must be saved as the preferred payment method. Possible values: Y – Save the payment method as the preferred payment method; N – Do not save the payment method as the prefereed payment method"
},
"action" : {
"type" : "string",
"description" : "Possible values: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment"
},
"card_info" : {
"$ref" : "#/components/schemas/PaymentMethodInfo"
},
"internal_comment" : {
"type" : "string",
"description" : "An internal comment on this transaction; not visible in the xDR browser, and accessible only from the database directly"
}
}
},
"UpdateAccessNumberRequest" : {
"required" : [
"access_number_info"
],
"type" : "object",
"properties" : {
"access_number_info" : {
"$ref" : "#/components/schemas/AccessNumberInfo"
}
}
},
"CloneDiscountPlanResponse" : {
"required" : [
"i_vd_plan"
],
"type" : "object",
"properties" : {
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan clone"
}
}
},
"ActivateAccountSubscriptionsRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
}
}
},
"RoamingPolicyInfo" : {
"type" : "object",
"properties" : {
"suspicious" : {
"$ref" : "#/components/schemas/RoamingPolicySuspiciousInfo"
},
"high_risk" : {
"$ref" : "#/components/schemas/RoamingPolicyHighRiskInfo"
}
}
},
"GetServiceInfoResponse" : {
"type" : "object",
"properties" : {
"service_info" : {
"$ref" : "#/components/schemas/ServiceInfo"
}
}
},
"GetCustomerMetricListRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer for which list of measured services should be retrieved. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"MNCInfo" : {
"type" : "object",
"properties" : {
"network" : {
"type" : "string",
"description" : "Mobile network name"
},
"mnc" : {
"type" : "string",
"description" : "Mobile Network Code"
},
"mcc" : {
"type" : "string",
"description" : "Mobile Country Code"
}
}
},
"ArrayOfCPPeriodInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CPPeriodInfo"
}
},
"GetActiveSessionsResponse" : {
"type" : "object",
"properties" : {
"active_session_list" : {
"$ref" : "#/components/schemas/ArrayOfActiveSessionInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved sessions"
}
}
},
"TransactionCodes" : {
"required" : [
"value",
"name"
],
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The value of the transaction code"
},
"name" : {
"type" : "string",
"description" : "The name of the transaction code"
}
}
},
"ArrayOfSubPeriodInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SubPeriodInfo"
}
},
"TaxationOptionsSureTax" : {
"type" : "object",
"properties" : {
"sales_type" : {
"type" : "string",
"description" : "The type of a customer involved in the transaction. Possible values: B – The customer pays taxes as a legal entity; I – Transactions are made at an industrial business; L – Transactions are made by the customer granted a subsidy; R – The customer pays taxes as a private individua; default – The customer class settings apply"
},
"tax_exemption" : {
"type" : "string",
"description" : "The name of the tax exemption as specified in the SureTax_Exemption_C odes table in the database. Default – The customer class settings apply"
},
"regulatory_code" : {
"type" : "string",
"description" : "Regulatory code. Possible values: 00 – ILEC; 01 – IXC; 02 – CLEC; 03 – VOIP (used when 'default' is specified); 04 – ISP; 05 – Wireless; 99 – Non-Telecom; default – The customer class settings apply"
},
"exemption_codes" : {
"$ref" : "#/components/schemas/ArrayOfExemptionCodes"
},
"summary_type" : {
"type" : "string",
"description" : "Specifies whether federal, state and local taxes are displayed summarized. Possible values: 0 – federal, state and local taxes are displayed separately; 1 – federal, state and local taxes are displayed summarized; default – The customer class settings apply"
},
"transaction_codes" : {
"$ref" : "#/components/schemas/ArrayOfTransactionCodes"
},
"decimal_digits" : {
"type" : "integer",
"description" : "The number of decimal digits for rounding the taxes. Possible values: 2; 3; 4; 5; no value – The customer class settings apply"
}
}
},
"ArrayOfScopedTemplateInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ScopedTemplateInfo"
}
},
"AddVendorAccountResponse" : {
"type" : "object",
"properties" : {
"i_vendor_acc" : {
"type" : "integer",
"description" : "The unique ID of the vendor account record"
}
}
},
"AddDatesBatchResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success"
}
}
},
"AliasInfo" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of an account (alias)"
},
"i_did_number" : {
"type" : "integer",
"description" : "The unique identifier of the assigned DID number"
},
"i_master_account" : {
"type" : "integer",
"description" : "ID of parent account record"
},
"i_account_role" : {
"type" : "integer",
"description" : "The unique ID of the account role; refers to the Account_Roles table. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID"
},
"blocked" : {
"type" : "string",
"description" : "Block the account's calls. The default value is: N"
},
"realm" : {
"type" : "string",
"description" : "A custom string. An account realm allows administrators to impose a scope of uniqueness for an account ID"
},
"id" : {
"type" : "string",
"description" : "Alias ID"
}
}
},
"GetUAInfoRequest" : {
"type" : "object",
"properties" : {
"i_ua" : {
"type" : "integer",
"description" : "ID of UA record"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record. This field will be ignored if 'i_ua' is provided"
},
"check_usage_by_resellers" : {
"type" : "integer",
"description" : "If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response"
},
"get_effective_values" : {
"type" : "integer",
"description" : "The flag shows whether to fetch effective values"
}
}
},
"DeleteTaxTransactionCodeResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation was completed"
}
}
},
"GetPayRequiredInvoicesSummaryResponse" : {
"type" : "object",
"properties" : {
"limitation_delayed_till" : {
"type" : "string",
"description" : "Defines if a limitation is delayed and the customer will be limited later than on 'limitation_on' date"
},
"suspension_delayed_till" : {
"type" : "string",
"description" : "Defines if a suspension is delayed and the customer will be suspended later than on 'suspension_on' date"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for customer's currency"
},
"suspension_by_invoice" : {
"type" : "integer",
"description" : "The number of the invoice, due to which customer's status can be changed to 'Suspended' after invoice became overdue"
},
"outstanding_balance" : {
"type" : "number",
"description" : "The outstanding balance"
},
"suspension_on" : {
"type" : "string",
"description" : "The date when the customer will be suspended due to an overdue invoice"
},
"limitation_by_invoice" : {
"type" : "integer",
"description" : "The number of the invoice, due to which customer's status can be changed to 'Limited' after invoice became overdue"
},
"limitation_on" : {
"type" : "string",
"description" : "The date when the customer will be Limited due to an overdue invoice"
},
"overdue_balance" : {
"type" : "number",
"description" : "The amount which is overdue"
},
"last_payment_amount" : {
"type" : "number",
"description" : "The amount of the last payment applied to an invoice"
},
"last_payment_date" : {
"type" : "string",
"description" : "The date of the last payment applied to an invoice"
},
"last_amount_due" : {
"type" : "number",
"description" : "The amount due of the last invoice issued"
},
"last_due_date" : {
"type" : "string",
"description" : "The due date of the last invoice issued"
}
}
},
"ArrayOfDIDProviderAccountInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DIDProviderAccountInfo"
}
},
"MetricDataInfo" : {
"required" : [
"value",
"date"
],
"type" : "object",
"properties" : {
"date" : {
"type" : "string",
"description" : "The timestamp of the measurement. For example, if the data is measured 12 times an hour, it makes 12 * 24 = 288 measurements per day, which may be not easy for a browser to show on the chart. Thus, scale-function is applied, and only 24 values per day will be returned. For each of these 24 values the date property shows the when the first measurement of 12 made during corresponding hour period has begun"
},
"value" : {
"type" : "number",
"description" : "The number that characterizes the measurement result, can be changed by adding measured data with the same date"
}
}
},
"GetUserRTTicketListRequest" : {
"type" : "object",
"properties" : {
"priority" : {
"type" : "integer",
"description" : "Ticket priority"
},
"last_updated" : {
"type" : "string",
"description" : "Last date when ticket has been updated"
},
"i_user" : {
"type" : "integer",
"description" : "The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"subject" : {
"type" : "string",
"description" : "Ticket subject"
},
"status" : {
"type" : "string",
"description" : "Ticket status"
},
"created" : {
"type" : "string",
"description" : "Ticket creation date"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved tickets"
},
"id" : {
"type" : "integer",
"description" : "Ticket number"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"role" : {
"type" : "string",
"description" : "User role regarding RT tickets"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetUAInventoryUsageStatisticsResponse" : {
"required" : [
"total_free",
"total_used"
],
"type" : "object",
"properties" : {
"total_free" : {
"type" : "integer",
"description" : "The total number of available UA devices"
},
"total_used" : {
"type" : "integer",
"description" : "The total number of the UA devices in use"
}
}
},
"ArrayOfChargeUnitInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ChargeUnitInfo"
}
},
"CreateOtpResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Indicates whether the request for creating one-time-password was: 1 – successful, 0 – unsuccessful"
}
}
},
"GetScheduledCommitmentRecordReplacementResponse" : {
"type" : "object",
"properties" : {
"account_commitment_replacement_info" : {
"$ref" : "#/components/schemas/ScheduledCommitmentReplacementInfo"
}
}
},
"GetCustomerTaxationInfoResponse" : {
"required" : [
"taxation_info"
],
"type" : "object",
"properties" : {
"taxation_info" : {
"$ref" : "#/components/schemas/TaxationInfo"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique identifier for a tax transaction code; refers to the Tax_Transaction_Codes table"
},
"estimate_taxes" : {
"type" : "string",
"description" : "Shows whether the estimate taxes on receiving payments for the prepaid customers is enabled or disabled"
}
}
},
"MediatorXDRId" : {
"required" : [
"xdr_id"
],
"type" : "object",
"properties" : {
"xdr_id" : {
"type" : "string",
"description" : "The ID of the xDR record"
}
}
},
"ArrayOfPreferableAccountInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PreferableAccountInfo"
}
},
"GetDestGroupInfoResponse" : {
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "Destination Group Set ID"
},
"i_dest_group" : {
"type" : "integer",
"description" : "Destination Group ID"
},
"destination_list" : {
"$ref" : "#/components/schemas/ArrayOfDestinationPrefixInfo"
},
"name" : {
"type" : "string",
"description" : "The destination group name"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved destinations"
},
"description" : {
"type" : "string",
"description" : "Destination Group description"
}
}
},
"UpdateDiscountRequest" : {
"required" : [
"discount_info"
],
"type" : "object",
"properties" : {
"discount_info" : {
"$ref" : "#/components/schemas/DiscountInfo"
}
}
},
"ArrayOfAuthorizedEmailInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AuthorizedEmailInfo"
}
},
"GetConnectionTypeListResponse" : {
"required" : [
"connection_type_list"
],
"type" : "object",
"properties" : {
"connection_type_list" : {
"$ref" : "#/components/schemas/ArrayOfConnectionTypeInfo"
}
}
},
"ArrayOfCustomerLastBillingDateConstraintInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerLastBillingDateConstraintInfo"
}
},
"GetFraudConstraintListRequest" : {
"required" : [
"i_traffic_profile"
],
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The identifier of the destination group"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the traffic profile fraud constraints are in use"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"with_fraud_traffic_info" : {
"type" : "integer",
"description" : "If the field is equal to 1, the method returns additionally fraud traffic information for each fraud constraint"
},
"i_customer" : {
"type" : "integer",
"description" : "The identifier of the customer"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"accumulation_period" : {
"type" : "string",
"description" : "The name of the accumulation period. Possible periods: [hour, day]"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"SampleDialingRulesInfo" : {
"type" : "object",
"properties" : {
"options" : {
"$ref" : "#/components/schemas/DialingRuleOptionsInfo"
},
"name" : {
"type" : "string",
"description" : "Sample dialing rule name"
},
"rule" : {
"type" : "string",
"description" : "Dialing rule in a string format"
},
"description" : {
"type" : "string",
"description" : "Text description for the dialing rule"
},
"i_dialing_rule" : {
"type" : "integer",
"description" : "The unique ID of the dialing rule record"
}
}
},
"GetBundlePromotionListResponse" : {
"required" : [
"bundle_promotion_list"
],
"type" : "object",
"properties" : {
"bundle_promotion_list" : {
"$ref" : "#/components/schemas/ArrayOfBundlePromotionInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of bundle promotion plans found"
}
}
},
"GetCallBarringClassListRequest" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the call barring class is in use"
},
"number" : {
"type" : "string",
"description" : "The call barring class number pattern"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of records in the DB"
},
"name" : {
"type" : "string",
"description" : "Call barring class name"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"matching_type" : {
"type" : "string",
"description" : "The mode of number selection for the call barring class. Possible values: 'excluding' - bar numbers that do not fit the patterns defined in the number_pattern_list, 'including' - bar numbers that fit the patterns defined in the number_pattern_list"
}
}
},
"GenericGetConfigDataResponse" : {
"type" : "object",
"properties" : {
"config_data" : {
"$ref" : "#/components/schemas/ANY"
}
}
},
"ArrayOfTraceSessionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TraceSessionInfo"
}
},
"GetProviderInfoResponse" : {
"type" : "object",
"properties" : {
"provider_info" : {
"$ref" : "#/components/schemas/DIDProviderInfo"
}
}
},
"ArrayOfProductIncludedServices" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"GetAccessNumberListRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"number_pattern" : {
"type" : "string",
"description" : "The pattern for matching the CLD"
},
"check_usage" : {
"type" : "integer",
"description" : "Check the usage of the IVR access number"
},
"i_voice_app_access_number" : {
"type" : "integer",
"description" : "The ID of the corressponding IVR application"
},
"get_total" : {
"type" : "integer",
"description" : "Include the total number of the records"
},
"limit" : {
"type" : "integer",
"description" : "The number of records to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of records to skip at the beginning"
}
}
},
"GetMeasuredMetricDataResponse" : {
"type" : "object",
"properties" : {
"measured_metric_data_list" : {
"$ref" : "#/components/schemas/ArrayOfMetricDataInfo"
}
}
},
"AddUpdateCustomTaxOptionResponse" : {
"required" : [
"i_option"
],
"type" : "object",
"properties" : {
"i_option" : {
"type" : "integer",
"description" : "The unique ID of the custom tax"
}
}
},
"GetOwnerBatchListResponse" : {
"required" : [
"owner_batch_list"
],
"type" : "object",
"properties" : {
"owner_batch_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDOwnerBatchInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of retrieved records"
}
}
},
"DeleteVDTopupOptionRequest" : {
"required" : [
"i_vd_topup"
],
"type" : "object",
"properties" : {
"i_vd_topup" : {
"type" : "integer",
"description" : "The unique ID of the volume discount topup record"
}
}
},
"MakeCustomerTransactionResponse" : {
"required" : [
"balance"
],
"type" : "object",
"properties" : {
"result_code" : {
"type" : "string",
"description" : "E-Commerce operation result code"
},
"balance" : {
"type" : "number",
"description" : "Customer's modified balance"
},
"transaction_id" : {
"type" : "string",
"description" : "E-Commerce transaction ID"
},
"i_payment_transaction" : {
"type" : "integer",
"description" : "The unique ID of the transaction"
},
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the xdr record"
},
"authorization" : {
"type" : "string",
"description" : "E-Commerce authorization code"
}
}
},
"UpdateCCStaffRequest" : {
"required" : [
"cc_staff_info"
],
"type" : "object",
"properties" : {
"cc_staff_info" : {
"$ref" : "#/components/schemas/CCStaffInfo"
}
}
},
"AddUpdateCriterionResponse" : {
"type" : "object",
"properties" : {
"i_bd_criteria" : {
"type" : "integer",
"description" : "The unique ID of the bundle promotion criterion"
}
}
},
"AccountXDRInfo" : {
"type" : "object",
"properties" : {
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination record"
},
"CLD" : {
"type" : "string",
"description" : "Called Line Identification"
},
"i_xdr" : {
"type" : "integer",
"description" : "ID of XDR record"
},
"beneficiary_account_id" : {
"type" : "string",
"description" : "The unique ID of the beneficiary account if the service was consumed by a beneficiary. Otherwise, this value is the same as 'account_id'"
},
"i_account" : {
"type" : "integer",
"description" : "The unique identifier of the account in the system"
},
"connect_time" : {
"type" : "string",
"description" : "Call connect time"
},
"charged_amount" : {
"type" : "number",
"description" : "Amount charged"
},
"bit_flags" : {
"type" : "integer",
"description" : "Extended information how the service was used; the integer field that should be treated as a bit-map. Each currently used bit is listed in the Transaction_Flag_Types table (bit_offset indicates position)"
},
"bytes_uploaded" : {
"type" : "integer",
"description" : "The quantity of uploaded bytes for the xDR. Available only for xDRs with netaccess service. The field is returned by 'with_netaccess_usage' in the request"
},
"unix_connect_time" : {
"type" : "integer",
"description" : "Call connect time (expressed in: Unix time format – seconds since epoch)"
},
"history" : {
"type" : "string",
"description" : "Additional information about XDR"
},
"bill_status" : {
"type" : "string",
"description" : "Call bill status"
},
"cr_download_ids" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"call_id" : {
"type" : "string",
"description" : "The unique identifier of the call"
},
"description" : {
"type" : "string",
"description" : "Destination description"
},
"account_id" : {
"type" : "string",
"description" : "The identifier of the account related to the xDR, unique in the environment"
},
"h323_incoming_conf_id" : {
"type" : "string",
"description" : "The unique ID of the incoming session (if exists) used for interrelating xDRs, when the charged session is established as a result of a previous session (possibly having its own xDR)"
},
"aux_xdrs" : {
"$ref" : "#/components/schemas/ArrayOfAuxXDRInfo"
},
"setup_time" : {
"type" : "integer",
"description" : "The time (in ms) between first provisional response and connect_time"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The unique identifier of the session"
},
"disconnect_time" : {
"type" : "string",
"description" : "Call disconnect time"
},
"disconnect_reason" : {
"type" : "string",
"description" : "Call disconnect reason"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"subdivision" : {
"type" : "string",
"description" : "Country Subdivision"
},
"failed" : {
"type" : "integer",
"description" : "xDR call failed status"
},
"CLI" : {
"type" : "string",
"description" : "Calling Line Identification"
},
"split_order" : {
"type" : "integer",
"description" : "The sequential number in case the XDR is part of a group of XDRs resulting from the same session"
},
"i_rate" : {
"type" : "integer",
"description" : "The unique ID of the rate record"
},
"bill_time" : {
"type" : "string",
"description" : "Call bill time"
},
"is_split" : {
"type" : "string",
"description" : "Shows whether the xDR is splitted"
},
"country" : {
"type" : "string",
"description" : "Country"
},
"bytes_downloaded" : {
"type" : "integer",
"description" : "The quantity of downloaded bytes for the xDR. Available only for xDRs with netaccess service. The field is returned by 'with_netaccess_usage' in the request"
},
"unix_disconnect_time" : {
"type" : "integer",
"description" : "Call disconnect time (expressed in: Unix time format – seconds since epoch)"
},
"charged_quantity" : {
"type" : "integer",
"description" : "Units charged"
},
"disconnect_cause" : {
"type" : "string",
"description" : "The code of disconnect cause"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique identifier of the customer in the system"
}
}
},
"GetRPCategoryListResponse" : {
"type" : "object",
"properties" : {
"routing_plan_category_list" : {
"$ref" : "#/components/schemas/ArrayOfRoutingPlanCategoryInfo"
}
}
},
"CustomerRegisterTransactionResponse" : {
"type" : "object",
"properties" : {
"transaction" : {
"$ref" : "#/components/schemas/TransactionInfo"
}
}
},
"DIDProviderAccountInfo" : {
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor"
},
"i_node" : {
"type" : "integer",
"description" : "The unique ID of the node on which calls from this vendor will be accepted"
},
"vendor_name" : {
"type" : "string",
"description" : "The name of the vendor related to the DID provider account"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff"
},
"api_key" : {
"type" : "string",
"description" : "This key will be used for the authentication of API sessions"
},
"username" : {
"type" : "string",
"description" : "This user name will be used for the authentication of API sessions"
},
"i_dv_batch" : {
"type" : "integer",
"description" : "The unique ID of the vendor batch"
},
"i_did_provider" : {
"type" : "integer",
"description" : "The unique ID of the DID provider"
},
"i_did_provider_acc" : {
"type" : "integer",
"description" : "The unique ID of the DID provider account"
},
"server_address" : {
"type" : "string",
"description" : "The DID provider server address, is used only for PortaSwitch providers"
}
}
},
"GetBillingPeriodListResponse" : {
"required" : [
"billing_period_list"
],
"type" : "object",
"properties" : {
"billing_period_list" : {
"$ref" : "#/components/schemas/ArrayBillingPeriodInfo"
}
}
},
"CountryInfo" : {
"required" : [
"iso_3166_1_a2",
"name"
],
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "A two-letter country code defined in ISO 3166-1 alpha-2"
},
"name" : {
"type" : "string",
"description" : "Country name"
}
}
},
"MeasuredMetricInfo" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The field that contains the unique name of the measured metric and can be used to retrieve and save the metric data to the system. When the name of a metric is changed, it may become impossible to retrieve the stored data associated with this metric"
},
"i_measured_metric" : {
"type" : "integer",
"description" : "The unique ID of the measured metric"
},
"description" : {
"type" : "string",
"description" : "A description of the added or updated measured metric. The description can be undefined or it can be specified using the add or update API methods"
}
}
},
"UnblockConnectionDestinationGroupRequest" : {
"required" : [
"i_dest_group",
"i_connection"
],
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique identifier of the destination group"
},
"i_connection" : {
"type" : "integer",
"description" : "The unique identifier of the connection"
}
}
},
"TestTimePeriodRequest" : {
"required" : [
"definition_list",
"time",
"date"
],
"type" : "object",
"properties" : {
"definition_list" : {
"$ref" : "#/components/schemas/ArrayOfTimePeriodDefinitionInfo"
},
"date" : {
"type" : "string",
"description" : "The date to test the period definitions"
},
"time" : {
"type" : "string",
"description" : "The time to test the period definitions"
}
}
},
"ArrayOfCustomerDIDNumberInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerDIDNumberInfo"
}
},
"NodeTypeInfo" : {
"type" : "object",
"properties" : {
"voip_dynamic_routing" : {
"type" : "string",
"description" : "Specifies whether the node type supports VoIP dynamic routing. Possible values: Y, N"
},
"h323_support" : {
"type" : "string",
"description" : "Specifies whether the node type supports H323. Possible values: Y, N"
},
"i_node_type" : {
"type" : "integer",
"description" : "The unique ID of the node type"
},
"radius_support" : {
"type" : "string",
"description" : "Specifies whether the node type supports RADIUS protocol. Possible values: Y, N"
},
"radius_dictionary" : {
"type" : "string",
"description" : "The dictionary used in RADIUS packets"
},
"sip_support" : {
"type" : "string",
"description" : "Specifies whether the node type supports SIP protocol. Possible values: Y, N"
},
"manufacturer" : {
"type" : "string",
"description" : "The manufacturer of the node"
},
"diameter_support" : {
"type" : "string",
"description" : "Specifies whether the node type supports DIAMETER protocol. Possible values: Y, N"
},
"type_code" : {
"type" : "string",
"description" : "The code of the node type"
},
"type" : {
"type" : "string",
"description" : "The node type"
},
"pod_support" : {
"type" : "string",
"description" : "Specifies whether the node type supports Packet of Disconnect. Possible values: Y, N"
}
}
},
"ArrayOfTaxTransactionCode" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TaxTransactionCode"
}
},
"GenerateCaptchaRequest" : {
"type" : "object"
},
"CloseBillingPeriodRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"SubscriptionDiscountInfo" : {
"type" : "object",
"properties" : {
"rate" : {
"type" : "number",
"description" : "Only for the fixed amount discount type; the amount of discount"
},
"number_of_months" : {
"type" : "integer",
"description" : "The number of months covered by this discount"
},
"percent" : {
"type" : "number",
"description" : "Only for the percentage discount type; the amount of discount"
},
"standard_fee" : {
"type" : "number",
"description" : "The standard fee for the number of months"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Plan record"
},
"discount_fee" : {
"type" : "number",
"description" : "A fee with applied discount for the number of months"
},
"i_subscription_discount" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Discount record"
}
}
},
"AddUpdateAutoPaymentInfoResponse" : {
"required" : [
"i_object"
],
"type" : "object",
"properties" : {
"i_object" : {
"type" : "integer",
"description" : "The unique ID of either an account or a customer"
}
}
},
"ArrayOfCountryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CountryInfo"
}
},
"PauseAssignedCommitmentRecordRequest" : {
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
},
"pause_to_date" : {
"type" : "string",
"description" : "Specifies the end date of the pause"
},
"pause_from_date" : {
"type" : "string",
"description" : "Specifies the start date of the pause"
}
}
},
"ResultBatchAddRateInfo" : {
"type" : "object",
"properties" : {
"i_rate" : {
"type" : "integer",
"description" : "The unique ID of the rate record"
}
}
},
"GetRateListResponse" : {
"type" : "object",
"properties" : {
"rate_list" : {
"$ref" : "#/components/schemas/ArrayOfRateInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved rate data records"
}
}
},
"GenericGetNotificationTemplateVariableFormatListResponse" : {
"required" : [
"total"
],
"type" : "object",
"properties" : {
"format_list" : {
"$ref" : "#/components/schemas/ArrayOfNotificationTemplateVariableFormats"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved template variable format records"
}
}
},
"EmergencyUnitRoutingNumberRuleInfo" : {
"type" : "object",
"properties" : {
"routing_number" : {
"type" : "string",
"description" : "Routing number"
},
"cld_number" : {
"type" : "string",
"description" : "Emergency number dialed"
}
}
},
"GetProductSubscriptionsRequest" : {
"required" : [
"i_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The ID of product record"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the subscription associated with this product"
},
"with_fees" : {
"type" : "integer",
"description" : "Indicates whether the periodic fees for the subscription should be returned"
}
}
},
"GetCQMohFileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
},
"moh_error" : {
"type" : "string",
"description" : "Error message, if any"
},
"moh_status" : {
"type" : "string",
"description" : "Status of MOH conversion"
}
}
},
"ArrayOfVoiceApplicationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VoiceApplicationInfo"
}
},
"AddUpdateCustomerExtensionResponse" : {
"required" : [
"i_c_ext"
],
"type" : "object",
"properties" : {
"i_c_ext" : {
"type" : "integer",
"description" : "ID of the created extension"
}
}
},
"GetSessionContextResponse" : {
"type" : "object",
"properties" : {
"euuid" : {
"type" : "string",
"description" : "The unique identifier of the environment"
}
}
},
"ArrayOfServiceFeatureInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServiceFeatureInfo"
}
},
"AccessNumberInfo" : {
"type" : "object",
"properties" : {
"cld_match" : {
"type" : "string",
"description" : "The CLD match pattern. Can contain only the following symbols: a-d, A-D, 0-9; also, '*', '#'; '%', '_' or 'x' can be used as the final symbol only (no other symbols can be used after it)"
},
"is_used" : {
"type" : "integer",
"description" : "Check usage of the IVR access number"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"i_ivr_an" : {
"type" : "integer",
"description" : "The unique ID of the IVR access number"
},
"i_voice_app_access_number" : {
"type" : "integer",
"description" : "The ID of the corressponding IVR application"
},
"description" : {
"type" : "string",
"description" : "The description of an IVR access number"
}
}
},
"GetTaxTransactionCodeListResponse" : {
"type" : "object",
"properties" : {
"tax_transaction_codes" : {
"$ref" : "#/components/schemas/ArrayOfTaxTransactionCode"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved transaction codes"
}
}
},
"GetAccountUsedVdDestGroupListRequest" : {
"required" : [
"i_account",
"date_from"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the owner account"
},
"date_to" : {
"type" : "string",
"description" : "The end of the date-time interval to search for the volume discount destination groups (leave empty for current date-time)"
},
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"date_from" : {
"type" : "string",
"description" : "The start of the date-time interval to search for the volume discount destination groups"
}
}
},
"UpdateCCStaffResponse" : {
"type" : "object",
"properties" : {
"i_cc_staff" : {
"type" : "integer",
"description" : "The unique ID of the updated CC staff record"
}
}
},
"UpdateCustomerServiceFeaturesResponse" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
}
}
},
"DeleteAccessRoleRequest" : {
"required" : [
"i_role"
],
"type" : "object",
"properties" : {
"i_role" : {
"type" : "integer",
"description" : "The identifier of the access role"
}
}
},
"ArrangeFollowMeNumbersResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"ProductSubscriptionInfo" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"generate_daily_charge" : {
"type" : "string",
"description" : "Specifies whether to keep the total charge only or to generate daily charges. Possible values: Y – Generate daily charges; N – Keep the total charge only"
},
"iso_4217" : {
"type" : "string",
"description" : "The currency for the Subscription Plan"
},
"effective_fee" : {
"type" : "number",
"description" : "Effective subscription fee value for current billing period"
},
"minimum_period" : {
"type" : "integer",
"description" : "Time interval (in months) during which the subscription must remain uninterrupted so as to avoid penalties"
},
"i_product_subscription" : {
"type" : "integer",
"description" : "The unique ID of the product subscription record"
},
"activation_mode" : {
"type" : "integer",
"description" : "If the subscription is assigned to an account, this parameter specifies the date upon which the subscription charges will apply. Possible values: 1 - at the given start date, 2 - upon the account's first usage"
},
"i_subscription" : {
"type" : "integer",
"description" : "The ID for subscription plan, refers to Subscriptions table"
},
"charge_model" : {
"type" : "integer",
"description" : "Defines the way subscription charges are applied to a customer's account. Possible values: 0 - progressively, 1 - at the end of the billing period, 2 - in advance"
},
"advance_periods" : {
"type" : "integer",
"description" : "Only available for subscription plans charged in advance; specifies for how many periods advance charges should be made"
},
"invoice_description" : {
"type" : "string",
"description" : "The subscription plan name that is visible to the end user"
},
"name" : {
"type" : "string",
"description" : "The name of the subscription plan"
},
"periodic_fees" : {
"$ref" : "#/components/schemas/SubscriptionPeriodicFeeList"
},
"description" : {
"type" : "string",
"description" : "The Subscription Plan description"
},
"rounding" : {
"type" : "integer",
"description" : "A pattern that defines the rounding of the amount charged for a billing period"
},
"multiple" : {
"type" : "integer",
"description" : "Can this Subscription be applied more than once"
},
"cancel_penalty" : {
"type" : "number",
"description" : "A one-time fee applied when the subscription is cancelled earlier than the minimum subscription period"
},
"activation_fee" : {
"type" : "number",
"description" : "A one-time fee applied when the subscription is activated"
}
}
},
"VendorAccountInfo" : {
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record which this account belongs to"
},
"password" : {
"type" : "string",
"description" : "A password provided to you by your termination partner, which will be used to authorize every outgoing call from your network to this vendor"
},
"del" : {
"type" : "integer",
"description" : "Indicates whether this vendor account can be deleted or not"
},
"i_vendor_acc" : {
"type" : "integer",
"description" : "The unique ID of the vendor account record"
},
"name" : {
"type" : "string",
"description" : "A vendor account name"
},
"login" : {
"type" : "string",
"description" : "A username/login provided to you by your termination partner, which will be used to authorize every outgoing call from your network to this vendor"
}
}
},
"CPConditionInfo" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"is_used" : {
"type" : "string",
"description" : "Read-only – whether the condition is used in a rule (Y / N)"
},
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the call screening condition record"
},
"numbers" : {
"$ref" : "#/components/schemas/ArrayOfCPConditionNumberInfo"
},
"name" : {
"type" : "string",
"description" : "Name of condition"
},
"type" : {
"type" : "string",
"description" : "One of the following: ToNumber, FromNumber, TimeWindow"
},
"time_window" : {
"$ref" : "#/components/schemas/CPConditionTimeWindowInfo"
}
}
},
"AddTimePeriodRequest" : {
"required" : [
"time_period_info"
],
"type" : "object",
"properties" : {
"time_period_info" : {
"$ref" : "#/components/schemas/TimePeriodInfo"
}
}
},
"AccountVdCounterHistoryInfo" : {
"required" : [
"counter_delta",
"modification_date",
"unit_counter_delta",
"i_avd_counter"
],
"type" : "object",
"properties" : {
"counter_delta" : {
"type" : "number",
"description" : "The amount of money that was applied to the counter"
},
"unit_counter" : {
"type" : "integer",
"description" : "The unit number of the counter after the delta was applied"
},
"i_xdr" : {
"type" : "integer",
"description" : "The ID of the XDR record from the CDR_Accounts table"
},
"discount" : {
"type" : "number",
"description" : "The calculated discount applied to XDR"
},
"modification_date" : {
"type" : "string",
"description" : "The timestamp when the counter was updated"
},
"unit_counter_delta" : {
"type" : "integer",
"description" : "The number of units that was applied to the counter"
},
"i_history" : {
"type" : "integer",
"description" : "The unique ID of the record"
},
"counter" : {
"type" : "number",
"description" : "The money amount of the counter after the delta was applied"
},
"i_avd_counter" : {
"type" : "integer",
"description" : "The ID of the counter record from the Account_VD_Counters table"
}
}
},
"GetAccessRoleListRequest" : {
"type" : "object",
"properties" : {
"complex_ordering" : {
"$ref" : "#/components/schemas/ComplexOrderingList"
},
"i_role_type" : {
"type" : "integer",
"description" : "The type of the access role"
},
"name" : {
"type" : "string",
"description" : "The name of the access role"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved access roles"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"with_usage" : {
"type" : "integer",
"description" : "Flag that indicates if the access role usage should be returned"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"DeleteRatingGroupResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 - for success; 0 - for failure"
}
}
},
"ChangeCustomerPasswordRequest" : {
"required" : [
"old_password",
"new_password"
],
"type" : "object",
"properties" : {
"old_password" : {
"type" : "string",
"description" : "Old password"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"new_password" : {
"type" : "string",
"description" : "New password"
}
}
},
"UIConfigInfo" : {
"type" : "object",
"properties" : {
"section_name" : {
"type" : "string",
"description" : "The name of the UI config section"
},
"value" : {
"type" : "string",
"description" : "The value for the UI config section"
}
}
},
"ArrayOfCallBarringRuleInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CallBarringRuleInfo"
}
},
"GetUAInfoResponse" : {
"type" : "object",
"properties" : {
"ua_info" : {
"$ref" : "#/components/schemas/UAInfo"
}
}
},
"ArrayOfUnsignedLong" : {
"type" : "array",
"items" : {
"type" : "integer"
}
},
"GetDIDInventoryOptionsResponse" : {
"type" : "object",
"properties" : {
"option_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDInventoryOptionsInfo"
}
}
},
"ArrayOfCustomerInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerInfo"
}
},
"GetCustomerListResponse" : {
"type" : "object",
"properties" : {
"customer_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved customers"
}
}
},
"CPSubscriptionInfo" : {
"required" : [
"periods"
],
"type" : "object",
"properties" : {
"one_time_commission" : {
"type" : "number",
"description" : "The amount of the one-time commission"
},
"periods" : {
"$ref" : "#/components/schemas/ArrayOfCPPeriodInfo"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the subscription"
},
"i_cp_subscription" : {
"type" : "integer",
"description" : "The unique ID of the commission plan subscription"
}
}
},
"UpdateAccountAliasResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"NetnumberInfo" : {
"required" : [
"p_number",
"action"
],
"type" : "object",
"properties" : {
"p_number" : {
"type" : "string",
"description" : "The number to update the information for in the NetNumber database"
},
"action" : {
"type" : "string",
"description" : "The action performed with this number. Possible values: A (added), D (deleted)"
}
}
},
"ArrayOfDisallowedProducts" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DisallowedProducts"
}
},
"DeleteCustomerPaymentMethodResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"DeleteCurrencyRequest" : {
"required" : [
"iso_4217"
],
"type" : "object",
"properties" : {
"i_ma_currency" : {
"type" : "integer",
"description" : "The unique merchant account currency identifier"
},
"iso_4217" : {
"type" : "string",
"description" : "The unique ID of the Currency record"
}
}
},
"AddSpendingConstraintResponse" : {
"required" : [
"i_sp_constraint"
],
"type" : "object",
"properties" : {
"i_sp_constraint" : {
"type" : "integer",
"description" : "The identifier of the spending constraint"
}
}
},
"RearrangeAuthzRuleListRequest" : {
"required" : [
"authz_rule_list"
],
"type" : "object",
"properties" : {
"authz_rule_list" : {
"$ref" : "#/components/schemas/ArrayOfRearrangeAuthzRuleInfo"
}
}
},
"UpdateMarketingGroupRequest" : {
"required" : [
"marketing_group_info"
],
"type" : "object",
"properties" : {
"marketing_group_info" : {
"$ref" : "#/components/schemas/MarketingGroupInfo"
}
}
},
"GetAccountXDRListResponse" : {
"type" : "object",
"properties" : {
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountXDRInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved xDRs"
}
}
},
"GetSIMCardListRequest" : {
"type" : "object",
"properties" : {
"iccid" : {
"type" : "string",
"description" : "The search pattern for the Integrated Circuit Card Id"
},
"status" : {
"type" : "string",
"description" : "Search for SIM cards based on their status. Possible values: free; used"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who owns the SIM card"
},
"imsi" : {
"type" : "string",
"description" : "The search pattern for the International Mobile Subscriber Identity"
},
"start_imsi" : {
"type" : "string",
"description" : "Starting International Mobile Subscriber Identity. This field is used to get a list starting with a specific template or a specific IMSI. For example: to get a list starting from number 380930000010777 for list (..., 380930000009777, 380930000010777, 380930000011777, ...), enter 380930000010777 in this field."
},
"i_account" : {
"type" : "integer",
"description" : "The ID of the account record"
},
"msisdn" : {
"type" : "string",
"description" : "The search pattern for the Mobile Subscriber Integrated Services Digital Number"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of all retrieved SIM card records"
},
"with_effective_hlr" : {
"type" : "integer",
"description" : "Get the effective home location register (hlr)"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"file_format" : {
"type" : "string",
"description" : "This parameter enables the user to get sim cards in other formats via an attachment. Possible values: 'csv', 'xls', 'xlsx'"
}
}
},
"EstimatedCallPriceInfo" : {
"type" : "object",
"properties" : {
"currency" : {
"type" : "string",
"description" : "ISO 4217 code of the tariff currency"
},
"discount_price" : {
"type" : "number",
"description" : "A rate (currency/unit, e.g. USD/minute) with volume discount applied"
},
"unit" : {
"type" : "string",
"description" : "Units (e.g. USD, messages, minutes)"
},
"discount_time" : {
"type" : "integer",
"description" : "The call length covered by the volume discount (in untis, e.g. 'minute'). null stands for 'unlimited'"
},
"general_price" : {
"type" : "number",
"description" : "A general rate (currency/unit, e.g. USD/minute) without volume discounts applied"
}
}
},
"AddCCStaffResponse" : {
"type" : "object",
"properties" : {
"i_cc_staff" : {
"type" : "integer",
"description" : "The unique ID of the created CC staff record"
}
}
},
"CustomXdrReportType" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of a custom xDR report type"
}
}
},
"XDRCollectionInfo" : {
"type" : "object",
"properties" : {
"add_date" : {
"type" : "string",
"description" : "The datetime when the collection was added to the processing queue"
},
"finish_date" : {
"type" : "string",
"description" : "The datetime when processing of the xDR collection was finished"
},
"status" : {
"type" : "string",
"description" : "The status of the xDR collection (enum: any, new, processing, finished)"
},
"xdr_stats_info" : {
"$ref" : "#/components/schemas/XDRStatsInfo"
},
"collection_name" : {
"type" : "string",
"description" : "The name of the xDR collection"
},
"i_collection" : {
"type" : "integer",
"description" : "The ID of the xDR collection"
}
}
},
"ArrayOfSessionNodeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SessionNodeInfo"
}
},
"ConnectionInfoList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ConnectionInfo"
}
},
"CustomerRegisterTransactionRequest" : {
"required" : [
"amount",
"i_payment_method"
],
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "The amount for payment"
},
"i_payment_method" : {
"type" : "integer",
"description" : "Unique ID of the chosen Payment Method"
},
"i_customer" : {
"type" : "integer",
"description" : "Unique ID of the Customer for which the transaction will be registered"
}
}
},
"GetMetricsDataRequest" : {
"required" : [
"i_metric",
"agg",
"i_customer"
],
"type" : "object",
"properties" : {
"i_metric" : {
"type" : "integer",
"description" : "The unique ID of the measured service"
},
"agg" : {
"type" : "string",
"description" : "The name of the data aggregation method. Possible values: MIN - Minimal value of the service consumption; MAX - Maximal value of the service consumption is used; AVG - Average value of the service consumption is used"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer. Not mandatory when the method that requires this structure is executed from the retail customer realm"
}
}
},
"ArrayOfCommissionPlanInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CommissionPlanInfo"
}
},
"TemplateGroupFieldInfo" : {
"type" : "object",
"properties" : {
"document_order" : {
"type" : "integer",
"description" : "Defines the position of the field in the document"
},
"editor_order" : {
"type" : "integer",
"description" : "Defines the order of the field in the editor"
},
"symbolic_id" : {
"type" : "string",
"description" : "The name of the variable used for the field in the template"
},
"i_format" : {
"type" : "integer",
"description" : "The unique ID of the format of the field"
},
"rule" : {
"type" : "string",
"description" : "The format rule used if the format is set to 'Other'"
},
"sample_data" : {
"type" : "string",
"description" : "The value of the field shown in the 'Preview' mode"
},
"total_rule" : {
"type" : "string",
"description" : "Defines the rule for the value of the field shown in group footers. If a system rule is used then one of the 'Sum', 'Count' or 'Last value' types will be returned instead of the rule"
},
"i_tg_field" : {
"type" : "integer",
"description" : "The unique ID of the group field"
},
"format" : {
"type" : "string",
"description" : "The format of the field"
},
"i_format_type" : {
"type" : "integer",
"description" : "The unique ID of the format type of the field"
},
"i_tdg" : {
"type" : "integer",
"description" : "The unique ID of the data group"
},
"format_type_name" : {
"type" : "string",
"description" : "The name of the format type"
},
"editor_name" : {
"type" : "string",
"description" : "The name of the field"
},
"type" : {
"type" : "string",
"description" : "Defines whether the field belongs to group header or footer"
},
"pp_rule" : {
"type" : "string",
"description" : "The post-processing rule for the field"
}
}
},
"GetDIDProviderInfoResponse" : {
"type" : "object",
"properties" : {
"provider_info" : {
"$ref" : "#/components/schemas/DIDProviderInfo"
}
}
},
"EstimateSubscriptionPriceForFirstBillingPeriodRequest" : {
"required" : [
"i_subscription"
],
"type" : "object",
"properties" : {
"i_billing_period" : {
"type" : "integer",
"description" : "The ID of the customer's billing period; refers to Billing_Period table"
},
"no_activation_charge" : {
"type" : "integer",
"description" : "The flag specifies if the activation fee should be excluded from the estimated price"
},
"discount_amount" : {
"type" : "number",
"description" : "The fixed discount amount"
},
"i_subscription" : {
"type" : "integer",
"description" : "The identifier of the subscription"
}
}
},
"UploadDGSetRequest" : {
"required" : [
"i_dest_group_set"
],
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set"
}
}
},
"GetXDRListResponse" : {
"type" : "object",
"properties" : {
"collection_stat_info" : {
"$ref" : "#/components/schemas/XDRCollectionDetailedInfo"
},
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfMediatorXDRInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"AddAccessNumberListRequest" : {
"required" : [
"access_number_list",
"i_voice_app_access_number"
],
"type" : "object",
"properties" : {
"access_number_list" : {
"$ref" : "#/components/schemas/ArrayOfAccessNumberInfo"
},
"i_voice_app_access_number" : {
"type" : "integer",
"description" : "The unique ID of the IVR application"
}
}
},
"GetOffPeakListRequest" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller record (managed by)"
}
}
},
"TransactionInfo" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "Status of the Transaction"
},
"iso_4217" : {
"type" : "string",
"description" : "Currency for the Transaction"
},
"purpose" : {
"type" : "string",
"description" : "The Purpose transaction is made for"
},
"cdrid" : {
"type" : "string",
"description" : "XDR ID created for the Transaction"
},
"unique_transaction_id" : {
"type" : "string",
"description" : "UUID based universally unique transaction ID. Should be used as i_payment_transaction for transactions via PayNearMe processor"
},
"x_transaction_id" : {
"type" : "string",
"description" : "The external transaction unique ID"
},
"i_account" : {
"type" : "integer",
"description" : "The unique Account ID for the Transaction"
},
"i_online_payment_processor" : {
"type" : "integer",
"description" : "The unique Payment Processor ID for the Transaction"
},
"result_code" : {
"type" : "string",
"description" : "Result code of the Transaction"
},
"timestamp" : {
"type" : "string",
"description" : "Timestamp of the Transaction"
},
"i_payment_method" : {
"type" : "integer",
"description" : "Unique Payment Method ID for the Transaction"
},
"i_payment_transaction_type" : {
"type" : "integer",
"description" : "The unique ID of the Transaction Type"
},
"cc_number_hash" : {
"type" : "string",
"description" : "A crypted hexadecimal code of the credit card number that was used to perform the transaction"
},
"result_message" : {
"type" : "string",
"description" : "Result message of the Transaction"
},
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique Payment System ID for the Transaction"
},
"secret" : {
"type" : "string",
"description" : "A secret code for the Transaction"
},
"payment_method_info" : {
"type" : "string",
"description" : "Comment on Transaction's Payment Method"
},
"details" : {
"type" : "string",
"description" : "Description of the Transaction"
},
"test_mode" : {
"type" : "string",
"description" : "Indicates whether the Payment Processor was in the test mode at the moment when the transaction was processed - Y/N"
},
"purpose_details" : {
"type" : "string",
"description" : "The details of the purpose"
},
"account_id" : {
"type" : "string",
"description" : "The identifier of the account (unique in environment)"
},
"amount" : {
"type" : "number",
"description" : "Money ammount for the Transaction"
},
"i_payment_transaction" : {
"type" : "integer",
"description" : "The unique ID of the Transaction"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique Customer ID for the Transaction"
},
"customer_name" : {
"type" : "string",
"description" : "The name of the customer"
}
}
},
"NetworkConnectivityInfo" : {
"required" : [
"name",
"i_network_connectivity"
],
"type" : "object",
"properties" : {
"overhead_bits" : {
"type" : "integer",
"description" : "Overhead bits for the network connectivity profile"
},
"i_env" : {
"type" : "integer",
"description" : "The unique ID of the environment for the network connectivity profile"
},
"name" : {
"type" : "string",
"description" : "The name of the network connectivity profile"
},
"i_network_connectivity" : {
"type" : "integer",
"description" : "The unique ID of the network connectivity profile"
},
"mtu" : {
"type" : "integer",
"description" : "Maximum transmission unit for the network connectivity profile"
}
}
},
"ArrayOfUATypeUsageInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UATypeUsageInfo"
}
},
"GenericTriggerEventResponse" : {
"type" : "object",
"properties" : {
"i_event" : {
"type" : "integer",
"description" : "The ID of the event"
}
}
},
"SpendingConstraintInfo" : {
"type" : "object",
"properties" : {
"notify_ratio" : {
"type" : "integer",
"description" : "The warning threshold of the spending constraint, %"
},
"amount" : {
"type" : "string",
"description" : "The spending limit of the spending constraint"
},
"send_notification" : {
"type" : "string",
"description" : "Specifies whether to notify the user when the spending limit is reached. Possible values: N - do not notify, Y - notify"
},
"limit_funds_allocation" : {
"type" : "string",
"description" : "Shows if the spending constraint limits funds for new calls. Possible values: 'Y', 'N'"
},
"i_sp_constraint" : {
"type" : "integer",
"description" : "The identifier of the spending constraint"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
}
}
},
"AccountFindRecipientResponse" : {
"type" : "object",
"properties" : {
"funds_transfer_allowed" : {
"type" : "integer",
"description" : "Shows whether the funds transfer is allowed"
},
"discount_match_list" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
},
"recipient_info" : {
"$ref" : "#/components/schemas/AccountRecipientInfo"
}
}
},
"GetQFFieldsListRequest" : {
"required" : [
"i_quick_form"
],
"type" : "object",
"properties" : {
"i_quick_form" : {
"type" : "integer",
"description" : "The unique ID of the quick form"
},
"entity_number" : {
"type" : "integer",
"description" : "The number of the entity the fields belong to"
},
"name" : {
"type" : "string",
"description" : "The quick form field name pattern"
}
}
},
"AddNetnumberInfoRequest" : {
"required" : [
"numbers_list"
],
"type" : "object",
"properties" : {
"numbers_list" : {
"$ref" : "#/components/schemas/ArrayOfNetnumberInfo"
}
}
},
"GetDIDProviderListResponse" : {
"type" : "object",
"properties" : {
"provider_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDProviderInfo"
}
}
},
"AddUpdateDestGroupSetRequest" : {
"required" : [
"dest_group_set_info"
],
"type" : "object",
"properties" : {
"dest_group_set_info" : {
"$ref" : "#/components/schemas/DestGroupSetInfo"
}
}
},
"RawDestinationGroupInfo" : {
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set to which the current destination group belongs"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"name" : {
"type" : "string",
"description" : "The destination group set name"
},
"description" : {
"type" : "string",
"description" : "The destination group set description"
},
"parent_i_dest_group" : {
"type" : "integer",
"description" : "The parent destination group"
}
}
},
"TransactionActionInfo" : {
"required" : [
"name",
"description",
"default_comment",
"i_manual_transaction"
],
"type" : "object",
"properties" : {
"default_amount" : {
"type" : "integer",
"description" : "The default amount for the transaction"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"name" : {
"type" : "string",
"description" : "One of the following: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment"
},
"i_manual_transaction" : {
"type" : "integer",
"description" : "The unique ID of the manual transaction record"
},
"default_comment" : {
"type" : "string",
"description" : "A comment on this transaction visible to the customer in the xDR browser"
},
"description" : {
"type" : "string",
"description" : "Transaction description"
}
}
},
"RateGetRateMatchModeInfoResponse" : {
"type" : "object",
"properties" : {
"rate_match_mode_info" : {
"$ref" : "#/components/schemas/RateMatchModeInfo"
}
}
},
"GetCustomerCallBarringOptionsRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"GenerateUaProfileResponse" : {
"required" : [
"remote_url",
"filename"
],
"type" : "object",
"properties" : {
"filename" : {
"type" : "string",
"description" : "The name for the new generated UA profile"
},
"profile_string_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"remote_url" : {
"type" : "string",
"description" : "The URL for a new generated UA profile ( server name + file name )"
}
}
},
"ArrayOfCustomXdrReportInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomXdrReportInfo"
}
},
"ArrayOfProductSubscriptionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ProductSubscriptionInfo"
}
},
"UpdateFollowMeNumberRequest" : {
"required" : [
"number_info",
"i_follow_me_number"
],
"type" : "object",
"properties" : {
"number_info" : {
"$ref" : "#/components/schemas/FollowMeNumberInfo"
},
"i_follow_me_number" : {
"type" : "integer",
"description" : "ID of follow-me number database record to be updated"
}
}
},
"ArrayOfMetricGroupingInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MetricGroupingInfo"
}
},
"ProductGetSubscriptionInfoResponse" : {
"type" : "object",
"properties" : {
"subscription_info" : {
"$ref" : "#/components/schemas/RawProductSubscriptionInfo"
}
}
},
"MakeCustomerTransactionRequest" : {
"required" : [
"amount",
"action",
"i_customer"
],
"type" : "object",
"properties" : {
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record; refers to the Services table"
},
"save_card" : {
"type" : "string",
"description" : "Indicates whether the supplied payment method should be saved as preferred. The default value is N"
},
"date_inside_billing_period" : {
"type" : "string",
"description" : "A date associated with the manual charge/credit. For example, you can specify a date for manual credit action for when an item is credited"
},
"datetime_inside_billing_period" : {
"type" : "string",
"description" : "A date and time associated with the manual charge/credit. For example, you can specify a date for manual credit action for when an item is credited"
},
"internal_comment" : {
"type" : "string",
"description" : "An internal comment on this transaction; not visible in the xDR browser, and accessible only from the database directly"
},
"suppress_notification" : {
"type" : "integer",
"description" : "One of the following: 1 - do not send email notifications to the customer, 0 - send the notifications"
},
"delay_invoice_payment" : {
"type" : "integer",
"description" : "When you create an outof-turn invoice and choose to pay it immedientely, then the PortaBilling first proceeds the payment and only after that generates the invoice. Generally, PortaBilling applies the payment received to the oldest unpaid invoice, thus in case you want to use the payment to cover the freshly generated out-ofturn invoice, you must explicitly indicate it. This option specifies whether the payment must be immedietlely applied to the existing unpaid invoices or the system must wait and apply the payment to the first out-of-turn invoice generated after the paymemnt. Possible values: 1 - Apply the payment to the out-of-turn invoice generated after the payment; 2 - Aplly the payment to the existing unpaid invoices"
},
"visible_comment" : {
"type" : "string",
"description" : "A comment on this transaction visible to the customer in the xDR browser"
},
"amount" : {
"type" : "number",
"description" : "Amount by which the customer's balance will increase / decrease. The number of digits depends on the maximum number of decimal places allowed by the currency"
},
"transaction_id" : {
"type" : "string",
"description" : "Applicable to Capture payment and E-Commerce refund transactions. Must contain ID of a previously issued Authorization only / E-commerce payment transaction"
},
"card_info" : {
"$ref" : "#/components/schemas/PaymentMethodInfo"
},
"action" : {
"type" : "string",
"description" : "Same as those available on the Balance Adjustments tab of the Customer edit interface, including e-commerce transactions. One of the following: Refund; Manual charge; Manual credit; Manual payment; Promotional credit; E-commerce payment; E-commerce refund; Authorization only; Capture payment"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"h323_conf_id" : {
"type" : "string",
"description" : "Optional tax transaction code that should be applied to transaction"
},
"enable_balance_fraud_protection" : {
"type" : "integer",
"description" : "Indicates whether to perform balance fraud checks to make sure the charged amount never exceeds the available balance"
}
}
},
"ArrayOfCustomTaxOptionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomTaxOptionInfo"
}
},
"RoamingPolicySuspiciousInfo" : {
"type" : "object",
"properties" : {
"action" : {
"type" : "string",
"description" : "The action that is taken in case of calls from the countries in the \"suspicious\" list. Supported actions: screen, reject"
},
"attempts" : {
"type" : "integer",
"description" : "Defines how many calls a customer can make without screening from the countries in the \"suspicious\" list when the \"action\" is set to \"screen\""
}
}
},
"CustomerClassNotificationCategoryInfo" : {
"type" : "object",
"properties" : {
"send_sms" : {
"type" : "integer",
"description" : "Specifies whether this notifications will be sent by sms. Possible values: 1 – The nofications will be sent by email, 0 – The notifications will not be sent by email."
},
"send_mail" : {
"type" : "integer",
"description" : "Specifies whether this notifications will be sent by email. Possible values: 1 – The nofications will be sent by email, 0 – The notifications will not be sent by email."
},
"name" : {
"type" : "string",
"description" : "The name of the notification category"
},
"i_notification_category" : {
"type" : "integer",
"description" : "The unique ID of the notification category"
}
}
},
"TemplateGetTemplateScopedListResponse" : {
"type" : "object",
"properties" : {
"template_list" : {
"$ref" : "#/components/schemas/ArrayOfScopedTemplateInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved templates"
}
}
},
"GetDIDNumberInfoResponse" : {
"type" : "object",
"properties" : {
"number_info" : {
"$ref" : "#/components/schemas/DIDNumberInfo"
}
}
},
"UpdateTaxTransactionCodeRequest" : {
"required" : [
"tax_transaction_code_info"
],
"type" : "object",
"properties" : {
"tax_transaction_code_info" : {
"$ref" : "#/components/schemas/TaxTransactionCode"
}
}
},
"GetFullVDCounterListInfoResponse" : {
"type" : "object",
"properties" : {
"counter_list" : {
"$ref" : "#/components/schemas/ArrayOfFullCounterInfo"
}
}
},
"AddNumberResponse" : {
"required" : [
"i_did_number"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique ID of the DID number"
},
"warning_list" : {
"$ref" : "#/components/schemas/ArrayOfWarningInfo"
}
}
},
"ReviewInvoiceListRequest" : {
"required" : [
"invoice_list"
],
"type" : "object",
"properties" : {
"invoice_list" : {
"$ref" : "#/components/schemas/ArrayOfReviewInvoiceInfo"
}
}
},
"ReprocessMediatorXDRListRequest" : {
"required" : [
"xdr_id_list",
"collection_name"
],
"type" : "object",
"properties" : {
"xdr_id_list" : {
"$ref" : "#/components/schemas/ArrayOfMediatorXDRId"
},
"collection_name" : {
"type" : "string",
"description" : "The name of the xDR collection"
}
}
},
"DestinationListCSetGroupDestsRequest" : {
"required" : [
"i_dest_group"
],
"type" : "object",
"properties" : {
"filter_by" : {
"type" : "string",
"description" : "The additional filter name. Possible values: 'prefix', 'country', 'description', 'group'"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"filter_value" : {
"type" : "string",
"description" : "The additional filter value"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"DeleteCustomerSubscriptionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"DestinationGetMNCListResponse" : {
"type" : "object",
"properties" : {
"mnc_list" : {
"$ref" : "#/components/schemas/ArrayOfMNCInfo"
}
}
},
"DeleteMerchantAccountResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"AccountUpdateBoothRequest" : {
"required" : [
"i_account",
"action"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"detailed_response" : {
"type" : "integer",
"description" : "Indicates whether to show the updated record in the response"
},
"action" : {
"type" : "string",
"description" : "The action to be applied to the account. Possible values: 'unlock', 'lock', 'disconnect'"
}
}
},
"GetAssignedCommitmentRecordListResponse" : {
"type" : "object",
"properties" : {
"account_commitment_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountCommitmentInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of found records"
}
}
},
"GetUATypeListRequest" : {
"type" : "object",
"properties" : {
"only_available" : {
"type" : "integer",
"description" : "Return only UA types with configured UAs that have free ports"
},
"with_shared" : {
"type" : "integer",
"description" : "If set to '1' and the reseller's data is requested, available shared entities managed by the administrator will be added to the response. The filter is applicable only if the 'only_available' flag is active"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved UA types"
},
"with_hidden" : {
"type" : "integer",
"description" : "The flag shows whether to include hidden UA types into the response"
},
"i_customer" : {
"type" : "integer",
"description" : "Returns UA types with configured UAs that have free ports and belong to the reseller (i_customer). The filter is applicable only if 'only_available' flag is active"
}
}
},
"ArrayOfIvrApplicationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IvrApplicationInfo"
}
},
"ArrayOfNegotiatedFeatureInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NegotiatedFeatureInfo"
}
},
"TerminateAccountRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"release_assigned_did" : {
"type" : "integer",
"description" : "The flag specifies whether the previously assigned DID number should be released to the pool (true by default)"
},
"force" : {
"type" : "integer",
"description" : "The flag specifies whether associated non-disconnectable active sessions should be ignored"
}
}
},
"GetXDRCollectionListResponse" : {
"type" : "object",
"properties" : {
"xdr_collection_list" : {
"$ref" : "#/components/schemas/ArrayOfXDRCollectionInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"GetCustomerPaymentTransactionListRequest" : {
"type" : "object",
"properties" : {
"search" : {
"type" : "string",
"description" : "A pattern that enables searching by the 'x_transaction_id', 'payment_method_info' fields"
},
"status" : {
"type" : "string",
"description" : "Status of the transaction"
},
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique Payment System ID for the transaction"
},
"from_date" : {
"type" : "string",
"description" : "Get records starting from this date"
},
"test_mode" : {
"type" : "string",
"description" : "Indicates whether the Payment Processor was in the test mode at the moment when the transaction was processed - Y/N"
},
"i_customer_type" : {
"type" : "integer",
"description" : "The unique identifier of a customer. Possible values: 1 (retail customer or subcustomer), 2 (reseller), 3 (distributor)"
},
"i_payment_method" : {
"type" : "integer",
"description" : "Unique ID of the payment method"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved transactions"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"i_payment_transaction" : {
"type" : "integer",
"description" : "The unique ID of a payment transaction"
},
"hide_restricted" : {
"type" : "integer",
"description" : "Specifies whether it is necessary to remove the payment transactions of the terminated entities from the response"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"to_date" : {
"type" : "string",
"description" : "Get records before this date"
}
}
},
"ArrayOfTemplateDataFieldInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TemplateDataFieldInfo"
}
},
"GetDefaultDestinationPrefixListRequest" : {
"required" : [
"format",
"file_format"
],
"type" : "object",
"properties" : {
"format" : {
"type" : "string",
"description" : "The destination prefix format. Possible values: 'e164', 'e212'"
},
"file_format" : {
"type" : "string",
"description" : "The file format of the response spreadsheet attachment. Possible values: 'csv', 'xls', 'xlsx'"
}
}
},
"ArrayOfServicePolicyAttributePossibleValue" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServicePolicyAttributePossibleValue"
}
},
"ArrayOfTariffInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TariffInfo"
}
},
"ArrayOfCPRuleInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CPRuleInfo"
}
},
"SubPeriodInfo" : {
"type" : "object",
"properties" : {
"end_time" : {
"type" : "string",
"description" : "The time when the sub-period ends"
},
"month_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"start_time" : {
"type" : "string",
"description" : "The time when the sub-period starts"
},
"weekday_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"monthday_list" : {
"$ref" : "#/components/schemas/ArrayOfInt"
}
}
},
"ArrayOfAccountCommitmentInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountCommitmentInfo"
}
},
"ArrayOfSystemMetricDataInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SystemMetricDataInfo"
}
},
"ArrayOfAuxXDRTypeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AuxXDRTypeInfo"
}
},
"TemplateGroupFieldList" : {
"required" : [
"group_footer_fields"
],
"type" : "object",
"properties" : {
"group_footer_fields" : {
"$ref" : "#/components/schemas/ArrayOfTemplateGroupFieldInfo"
},
"i_tdg" : {
"type" : "integer",
"description" : "The unique ID of the data group"
},
"group_header_fields" : {
"$ref" : "#/components/schemas/ArrayOfTemplateGroupFieldInfo"
}
}
},
"ArrayOfTaxationPluginParameterMetaInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TaxationPluginParameterMetaInfo"
}
},
"InvoiceNumberInfo" : {
"required" : [
"invoice_number"
],
"type" : "object",
"properties" : {
"invoice_number" : {
"type" : "integer",
"description" : "Refers to Invoice Number – unique identifier of the invoice"
}
}
},
"CustomerInfo" : {
"type" : "object",
"properties" : {
"inclusive_taxation" : {
"type" : "string",
"description" : "Identifies that taxes are included in rates for a Customer (Y, N)"
},
"commission_plan_effective_from" : {
"type" : "string",
"description" : "The date and time when the commission plan was assigned"
},
"i_parent" : {
"type" : "integer",
"description" : "Omit for a direct customer; i_customer of the reseller for a subcustomer"
},
"out_date_format" : {
"type" : "string",
"description" : "Output format for date indication on customer's self-care interface"
},
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the customer's regular invoice template; refers to the Templates table. If undefined, the template defined in the customer class is used; if 0, invoices are not created"
},
"email" : {
"type" : "string",
"description" : "Email address"
},
"password" : {
"type" : "string",
"description" : "Customer's password for self-care web interface"
},
"onetime_invoice_generation_enabled" : {
"type" : "integer",
"description" : "Specfies whether out-ofturn invoice generation is enabled. Possible values: 1 - Out-of-turn invoice generation is enabled; 0 - Out-of-turn invoice generation is disabled"
},
"send_invoices" : {
"type" : "string",
"description" : "Defines whether a regular invoice should be automatically sent to the customer as soon as it is created. Possible values: Y - Send invoice; N - Do not send invoice. If undefined, the settings defined in the customer class are applied"
},
"aux_fields" : {
"$ref" : "#/components/schemas/ArrayOfCustomerAuxFieldInfo"
},
"billed_to" : {
"type" : "string",
"description" : "The customer's \"billed to\" date"
},
"blocked" : {
"type" : "string",
"description" : "Block customer's calls"
},
"i_commission_plan" : {
"type" : "integer",
"description" : "The ID of the overridden commission plan for this customer"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the customer has entities assigned"
},
"bill_status" : {
"type" : "string",
"description" : "O - the customer is open, S - the customer is suspended due to an overdue invoice, C - the customer is closed due to an unpaid invoice, E - the customer is exported"
},
"name" : {
"type" : "string",
"description" : "The ID of the customer on the PortaBilling® interface, unique in the billing environment"
},
"scheduled_status_change_list" : {
"$ref" : "#/components/schemas/ArrayOfScheduledCustomerStatusChangeInfo"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the customer's tariff; refers to Tariffs table; applies to resellers only"
},
"i_role" : {
"type" : "integer",
"description" : "The unique ID of the customer's access role; refers to the Roles table"
},
"login" : {
"type" : "string",
"description" : "Customer's login for self-care web interface"
},
"max_abbreviated_length" : {
"type" : "integer",
"description" : "Maximum allowed length of customer's abbreviated numbers; applies to retail customers only"
},
"pdf_generation_mode" : {
"type" : "string",
"description" : "Generate Invoice PDF: C - At the end of the billing period; R - Postponed, based on resource availability; D - On demand"
},
"creation_date" : {
"type" : "string",
"description" : "Date and time when the customer was created"
},
"in_date_format" : {
"type" : "string",
"description" : "Input format for date indication"
},
"phone1" : {
"type" : "string",
"description" : "Main phone number"
},
"ui_time_zone_name" : {
"type" : "string",
"description" : "The unique ID of the customer's user interface time zone; refers to the Time_Zones table"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the customer's time zone; refers to Time_Zones table"
},
"i_number_scope_reseller" : {
"type" : "integer",
"description" : "The identifier of the invoice sequence numbers scope for the reseller"
},
"i_balance_control_type" : {
"type" : "integer",
"description" : "Customer balance control type. Possible values: 1 - Postpaid (default); 2 - Prepaid"
},
"phone2" : {
"type" : "string",
"description" : "Alternative phone number"
},
"credit_exceed" : {
"type" : "integer",
"description" : "Specifies if customer's credit limit has been exceeded"
},
"salutation" : {
"type" : "string",
"description" : "Customer's salutation"
},
"ot_send_invoices" : {
"type" : "string",
"description" : "Defines whether an out-of-turn invoice should be automatically sent to the customer as soon as it is created. Possible values: Y – Send invoice, N – Do not send invoice. The default value is Y"
},
"send_statistics" : {
"type" : "string",
"description" : "Defines what kind of xDR statistics should be delivered to the customer by email: F - send full statistics to customer; S - send short statistics; N - do not send statistics. If undefined, the settings defined in the customer class are applied"
},
"i_tariff_incoming" : {
"type" : "integer",
"description" : "The unique ID of the customer's incoming tariff; refers to Tariffs table; applies to resellers only"
},
"login_allowed_ip_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"i_customer_type" : {
"type" : "integer",
"description" : "Customer type: 1 (retail customer or subcustomer), 2 (reseller), 3 (distributor)"
},
"i_billing_processor" : {
"type" : "integer",
"description" : "The unique ID of the taxation method. If blank then the taxation method defined for the customer class is used. 0 means that taxes are included in the rate"
},
"refnum" : {
"type" : "string",
"description" : "Reference number (custom field)"
},
"callshop_enabled" : {
"type" : "string",
"description" : "Enable callshop features on customer's self-care interface"
},
"deactivate_on" : {
"type" : "string",
"description" : "The date when the customer will be deactivated"
},
"country" : {
"type" : "string",
"description" : "The code of the country in the ISO 3166-1 alpha-2 format"
},
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the Owner DID Batch used for DID numbers auto-provisioning"
},
"i_distributor" : {
"type" : "integer",
"description" : "The unique ID of the distributor record associated with the customer"
},
"generate_invoice_earlier" : {
"type" : "string",
"description" : "Defines whether an invoice will be generated before the end of the billing period (Y, N)"
},
"payment_method_info" : {
"$ref" : "#/components/schemas/PaymentMethodInfo"
},
"tax_info" : {
"type" : "string",
"description" : "The configured taxation method options. For example: vat_exempt=no;vat_percen t=20;vat_cdr_per_service= 0"
},
"invoice_generation_enabled" : {
"type" : "integer",
"description" : "Specifies whether invoice generation is enabled"
},
"notepad" : {
"type" : "string",
"description" : "When making changes in the customer record, the administrator can use the Notepad tab to provide a comment detailing the reason for these changes (for example, \"product changed, credited $50\")"
},
"credit_limit_until" : {
"type" : "string",
"description" : "Date and time when the temporarily extended credit limit will be automatically reverted to the original value"
},
"tax_id" : {
"type" : "string",
"description" : "Tax ID"
},
"shifted_billing_date" : {
"type" : "string",
"description" : "This is applicable only for \"monthly anniversary\" and 30-day billing periods; allows you to set the billing date to a different day of the month in the future (used only in requests)"
},
"firstname" : {
"type" : "string",
"description" : "Customer's first name"
},
"credit_limit_warning" : {
"$ref" : "#/components/schemas/ArrayOfBalanceWarningThresholds"
},
"bp_closure_delayed_info" : {
"$ref" : "#/components/schemas/BillingPeriodClosureDelayedInfo"
},
"new_i_billing_period" : {
"type" : "integer",
"description" : "The unique ID of the customer's future billing period; refers to the Billing_Period table"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for currency in which the customer is billed"
},
"suspension_delay_date" : {
"type" : "string",
"description" : "The date when the customer will be suspended"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class; refers to Customer_Classes table"
},
"state" : {
"type" : "string",
"description" : "Province or state"
},
"opening_balance" : {
"type" : "number",
"description" : "Customer's initial balance"
},
"has_custom_fields" : {
"type" : "integer",
"description" : "Shows that the customer has additional information stored in custom fields"
},
"out_date_time_format" : {
"type" : "string",
"description" : "Output format for full date/time indication"
},
"temp_credit_limit" : {
"type" : "integer",
"description" : "Value by which the customer's credit limit will be temporarily increased. Allows to extend the customer’s credit limit until a certain date"
},
"rt_auth_info" : {
"$ref" : "#/components/schemas/RTAuthInfo"
},
"ip_filter" : {
"type" : "string",
"description" : "The list of IP addresses the customer can log into PortaBilling from"
},
"time_zone_name" : {
"type" : "string",
"description" : "The name of the customer's time zone"
},
"i_lang" : {
"type" : "string",
"description" : "Code for customer's web language; refers to Languages table"
},
"bill_suspension_delayed" : {
"type" : "integer",
"description" : "Shows whether suspension of customer's services has been delayed"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
},
"address_line_2" : {
"type" : "string",
"description" : "The 2nd line of the customer's address"
},
"bp_charge_cc" : {
"type" : "string",
"description" : "Automatically charge customer's credit card when billing period is closed. \"As defined by the Customer Class\" is used if empty"
},
"zip" : {
"type" : "string",
"description" : "Postal (zip) code. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash)"
},
"balance" : {
"type" : "number",
"description" : "Customer's balance"
},
"subreseller_status" : {
"type" : "integer",
"description" : "Current Subreseller status"
},
"discount_rate" : {
"type" : "number",
"description" : "The value of customer's subscription discount; a percentage"
},
"estimate_taxes" : {
"type" : "integer",
"description" : "Marks that Customer configured taxes to apply at the moment of payment"
},
"cont1" : {
"type" : "string",
"description" : "Main contact person"
},
"midinit" : {
"type" : "string",
"description" : "Customer's middle initial(s)"
},
"ot_i_template" : {
"type" : "integer",
"description" : "The unique ID of the template for the out-of-turn invoice"
},
"sale_commission_rate" : {
"type" : "number",
"description" : "The commission that is applied when an account is created or a distributor is assigned (only applicable to distributor)"
},
"status" : {
"type" : "string",
"description" : "The status of the customer"
},
"balance_transfer_allowed" : {
"type" : "string",
"description" : "Defines if balance transfer is enabled for a Customer (Y, N)"
},
"scheduled_billing_change" : {
"type" : "string",
"description" : "A date when the billing period will close and a new billing period and a new time zone will be applied"
},
"terminate_on" : {
"type" : "string",
"description" : "The date when the customer will be terminated"
},
"lastname" : {
"type" : "string",
"description" : "Customer's last name"
},
"unallocated_payments" : {
"type" : "number",
"description" : "The customer's unallocated payments"
},
"perm_credit_limit" : {
"type" : "number",
"description" : "Customer's original credit limit"
},
"i_main_office" : {
"type" : "integer",
"description" : "The unique ID of the main office (customer record with office type 3)"
},
"city" : {
"type" : "string",
"description" : "City of customer's address"
},
"restore_on" : {
"type" : "string",
"description" : "The date when the customer status will be returned to Open"
},
"i_ui_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the customer's user interface time zone; refers to the Time_Zones table"
},
"cont2" : {
"type" : "string",
"description" : "Alternative contact person"
},
"out_time_format" : {
"type" : "string",
"description" : "Output format for time indication"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the customer's discount plan; refers to Volume_Discount_Plans table"
},
"email_from" : {
"type" : "string",
"description" : "Email Address for Reseller to use as Sender Email for Customer Notifications"
},
"new_i_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the customer's future time zone; refers to the Time_Zones table"
},
"password_lifetime" : {
"type" : "integer",
"description" : "Customer's self-care WI password life time (in seconds)"
},
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
},
"euuid" : {
"type" : "string",
"description" : "The unique identifier of the environment"
},
"override_tariffs_enabled" : {
"type" : "string",
"description" : "Specifies whether the Override Tariffs feature is enabled: Y - enabled, N - disabled"
},
"suspend_on_insuff_funds" : {
"type" : "string",
"description" : "Specifies whether to suspend the customer on insufficient funds for charging subscriptions: Y - automatically suspend prepaid customers whose funds are not sufficient to cover pending subscription charges; N - do not suspend customers; Empty - the settings defined in the customer class are applied"
},
"in_time_format" : {
"type" : "string",
"description" : "Input format for time indication"
},
"i_rep" : {
"type" : "integer",
"description" : "The unique ID of the customer's representative; refers to Representatives table "
},
"password_timestamp" : {
"type" : "string",
"description" : "Date when the password was changed"
},
"i_number_scope" : {
"type" : "integer",
"description" : "PortaBilling can generate invoices for all customers with sequential invoice numbering distributed throughout the environment. In some cases, you may want to have more than one sequence of numbers. One of the following: 1 – Individual for Environment, 2 – Individual for Reseller, 3 – Individual for Customer"
},
"service_flags" : {
"type" : "string",
"description" : "Customer's service features settings. Note that this property is read-only (the add_customer and update_customer methods ignore it) and it is used in the get_customer_info and get_customer_list responses as informative. To change customer's service features use the service_features property"
},
"i_office_type" : {
"type" : "integer",
"description" : "The unique ID of the Office_Types record. Possible values: 1 – none; 2 – branch_office; 3 – main_office"
},
"next_billed_to" : {
"type" : "string",
"description" : "The date of the end of the current billing period for the customer"
},
"note" : {
"type" : "string",
"description" : "Short note (description)"
},
"i_billing_period" : {
"type" : "integer",
"description" : "The unique ID of the customer's billing period; refers to Billing_Period table"
},
"bcc" : {
"type" : "string",
"description" : "BCC email address"
},
"purge_after_months" : {
"type" : "integer",
"description" : "Shows when customer personal data will be deleted. -1 - functionality is disabled, 0 - immediately, N - delete in N months, NULL - inherited from the customer class"
},
"faxnum" : {
"type" : "string",
"description" : "Fax number"
},
"payment_commission_rate" : {
"type" : "number",
"description" : "The commition applied when payment is entered (only applicable to distributor)"
},
"api_token" : {
"type" : "string",
"description" : "The API token of the customer. You can use tokens instead of the standard login-password pairs for authenticating your applications integrated with PortaBilling via API"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"i_acl" : {
"type" : "integer",
"description" : "The unique ID of the customer's access level; refers to the Access_Levels table"
},
"bundle_billed_to" : {
"type" : "string",
"description" : "Any bundles earlier than this date and time are already calculated"
},
"baddr1" : {
"type" : "string",
"description" : "1st line of customer's address"
},
"companyname" : {
"type" : "string",
"description" : "Customer's company name"
},
"credit_limit" : {
"type" : "number",
"description" : "Customer's credit limit value. Note that this property may be used with the nil attribute set to true, in which case the credit limit will not be enforced"
}
}
},
"AddCustomerSiteRequest" : {
"required" : [
"site_info"
],
"type" : "object",
"properties" : {
"site_info" : {
"$ref" : "#/components/schemas/CustomerSiteInfo"
}
}
},
"DeleteCustomerAbbreviatedDialingNumberRequest" : {
"required" : [
"i_ab_dialing"
],
"type" : "object",
"properties" : {
"i_ab_dialing" : {
"type" : "integer",
"description" : "ID of abbreviated dialing number record"
}
}
},
"GetServicePolicyAttributeListResponse" : {
"type" : "object",
"properties" : {
"attribute_list" : {
"$ref" : "#/components/schemas/ArrayOfServicePolicyAttributeInfo"
}
}
},
"GetCommissionPlanBaseListResponse" : {
"required" : [
"commission_plan_base_list"
],
"type" : "object",
"properties" : {
"commission_plan_base_list" : {
"$ref" : "#/components/schemas/ArrayOfCommissionPlanBaseInfo"
}
}
},
"ServiceWalletXDRInfo" : {
"type" : "object",
"properties" : {
"account_discount" : {
"type" : "number",
"description" : "An amount of discount used by an account"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination record"
},
"i_xdr" : {
"type" : "integer",
"description" : "The ID of XDR record"
},
"CLD" : {
"type" : "string",
"description" : "Additional info"
},
"beneficiary_account_id" : {
"type" : "string",
"description" : "The unique ID of the beneficiary account if the service was consumed by a beneficiary. Otherwise, this value is the same as the 'account_id'"
},
"CLI" : {
"type" : "string",
"description" : "Additional information about the XDR"
},
"charged_amount" : {
"type" : "number",
"description" : "An amount of money in currency units"
},
"bill_time" : {
"type" : "string",
"description" : "Date and time when operation was done"
},
"history" : {
"type" : "string",
"description" : "Additional information about XDR"
},
"i_dest_group" : {
"type" : "integer",
"description" : "ID of a destination group"
},
"used_quantity" : {
"type" : "number",
"description" : "A number of used service units"
},
"h323_incoming_conf_id" : {
"type" : "string",
"description" : "The group ID for records withing a single operation, UUID, e.g. for e-commerce topup few records: payment topup + tax records"
},
"peak_level" : {
"type" : "integer",
"description" : "The ID of a peak level"
},
"aux_xdrs" : {
"$ref" : "#/components/schemas/ArrayOfAuxXDRInfo"
},
"charged_quantity" : {
"type" : "number",
"description" : "A number of charged service units"
},
"customer_discount" : {
"type" : "number",
"description" : "An amount of discount used by a customer"
}
}
},
"ArrayOfTimePeriodInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TimePeriodInfo"
}
},
"DestinationMoveCSetGroupDestsRequest" : {
"required" : [
"i_dest_group",
"destinations"
],
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"destinations" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
}
}
},
"UpdateTrafficProfileRequest" : {
"required" : [
"traffic_profile_info"
],
"type" : "object",
"properties" : {
"traffic_profile_info" : {
"$ref" : "#/components/schemas/TrafficProfileInfo"
}
}
},
"GetVoiceQualityProfileListRequest" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Checks whether the voice quality profiles are in use"
},
"managed_by" : {
"type" : "integer",
"description" : "The ID of the reseller who manages the required voice quality profiles. If undefined, only profiles managed by the administrator will be returned"
},
"name" : {
"type" : "string",
"description" : "The name pattern of the voice quality profiles to retrieve"
},
"get_total" : {
"type" : "integer",
"description" : "Gets the total number of the retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory if the offset property is specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property value defined"
}
}
},
"ModifyRequestRequest" : {
"type" : "object",
"properties" : {
"porting_request_info" : {
"$ref" : "#/components/schemas/PortingRequestInfo"
}
}
},
"GetCustomFieldListResponse" : {
"type" : "object",
"properties" : {
"custom_fields" : {
"$ref" : "#/components/schemas/ArrayOfCustomFieldsInfo"
}
}
},
"AddZendeskOrganizationRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"custom_domain" : {
"type" : "string",
"description" : "Override the domain for this Organization with the value specified here. If empty, the domain will be automatically calculated by the system based on the customer's email address"
},
"i_customer" : {
"type" : "integer",
"description" : "Create or update the Zendesk organization for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side"
}
}
},
"GetVendorListRequest" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The type of service the connection is used to transport (voice calls, internet connectivity, etc.)"
},
"search" : {
"type" : "string",
"description" : "Pattern that allows to search by vendor's personal information (name, companyname, firstname, lastname, baddr1, address_line_2, city, zip, cont1, cont2, phone1, phone2, email, note). Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character"
},
"conn_type_leg_origin" : {
"type" : "integer",
"description" : "The numeric identification of the vendor's connection origin (the meaning depends on the service type, e.g. for VOICE CALLS, 0 - originate, 1 - answer)"
},
"name" : {
"type" : "string",
"description" : "Search pattern for vendor"
},
"iso_4217" : {
"type" : "string",
"description" : "The ISO4217 code for the currency in which the vendor is billed"
},
"get_connections_total" : {
"type" : "string",
"description" : "Get the total number of the connections configured for every vendor"
},
"email" : {
"type" : "string",
"description" : "Vendor's email address"
},
"conn_type_technology" : {
"type" : "string",
"description" : "The technology used to perform the vendor's connection transport"
},
"get_total" : {
"type" : "string",
"description" : "Get the total number of the retrieved vendors"
},
"limit" : {
"type" : "integer",
"description" : "Limit for the number of returned vendors. Mandatory for an API request with the offset property specified. The default value is read from the 'Vendors.Pager' configuration parameter"
},
"companyname" : {
"type" : "string",
"description" : "Vendor's company name"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"AccountPaymentMethodInfo" : {
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "ISO 3166 two-letter country code"
},
"number" : {
"type" : "string",
"description" : "Credit card number without spaces, e.g. 4444333322221111"
},
"account_number" : {
"type" : "string",
"description" : "Bank account number. Applicable to the Check and DirectDebitNL methods"
},
"processing_type" : {
"type" : "string",
"description" : "Processing type of the payment method"
},
"refnum" : {
"type" : "string",
"description" : "Reference number (custom field)"
},
"city" : {
"type" : "string",
"description" : "Name of the city of the cardholder"
},
"i_country_subdivision" : {
"type" : "integer",
"description" : "ID for cardholder's state; refers to Country_Subdivision table"
},
"i_payment_method" : {
"type" : "integer",
"description" : "Unique ID of the payment method"
},
"address" : {
"type" : "string",
"description" : "Address of the cardholder"
},
"start_date" : {
"type" : "string",
"description" : "Card activation date. Applicable to the Switch method"
},
"token" : {
"type" : "string",
"description" : "A reference to the payment information (which is stored by the Payment Processor only)"
},
"bank_number" : {
"type" : "string",
"description" : "Bank routing number. Applicable to the Check method"
},
"available_for_refund" : {
"type" : "number",
"description" : "The amount available for refund"
},
"exp_date" : {
"type" : "string",
"description" : "Card expiration date. Applicable to all credit card methods"
},
"issue_no" : {
"type" : "string",
"description" : "Card issue number. Applicable to the Switch method"
},
"name" : {
"type" : "string",
"description" : "Name of the cardholder (owner of a bank account, etc.)"
},
"phone_number" : {
"type" : "string",
"description" : "Phone number in E.164 format for validating the Credit Card"
},
"number_hash" : {
"type" : "string",
"description" : "A crypted hexadecimal code of the credit card number"
},
"payment_method" : {
"type" : "string",
"description" : "Name of the payment method, one of the following: Cash, Cheque, American Express, Discover, MasterCard, VISA, Maestro, Check, DirectDebitNL. Pass undefined value in order to dismiss payment method"
},
"zip" : {
"type" : "string",
"description" : "Postal code of the cardholder. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash)"
},
"csc_required" : {
"type" : "integer",
"description" : "Shows whether card security code is required or not"
},
"cvv" : {
"type" : "string",
"description" : "Card security code (CVV, CVS, etc.). Applicable to all credit card methods"
}
}
},
"GetVendorXDRListResponse" : {
"type" : "object",
"properties" : {
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfVendorXDRInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved xDRs"
}
}
},
"LoginResponse" : {
"required" : [
"session_id"
],
"type" : "object",
"properties" : {
"session_id" : {
"type" : "string",
"description" : "The unique ID of the newly opened session"
}
}
},
"AssignSIMCardResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 if the SIM card was assigned to an account"
}
}
},
"GetCCStaffListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved CC staff records"
},
"cc_staff_list" : {
"$ref" : "#/components/schemas/ArrayOfCCStaffInfo"
}
}
},
"GetSiteInfoRequest" : {
"required" : [
"i_customer_site"
],
"type" : "object",
"properties" : {
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of a customer site"
}
}
},
"GetUAListRequest" : {
"type" : "object",
"properties" : {
"profile" : {
"type" : "string",
"description" : "Search pattern for UA profile "
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved records"
},
"inventory_id" : {
"type" : "string",
"description" : "Search pattern for UA inventory ID"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"mac" : {
"type" : "string",
"description" : "Search pattern for UA MAC address"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"usage" : {
"type" : "string",
"description" : "U - used (at least one port), C - completely used (all ports), F - not used, A - any state (default value)"
},
"name" : {
"type" : "string",
"description" : "Search pattern for UA name"
},
"description" : {
"type" : "string",
"description" : "Search pattern for UA description"
},
"with_shared" : {
"type" : "integer",
"description" : "If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response"
},
"get_effective_values" : {
"type" : "integer",
"description" : "The flag shows whether to fetch effective values"
},
"type" : {
"type" : "string",
"description" : "Search pattern for UA type"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller record (specify 0 or empty field value to return only admin's records)"
},
"with_available_ports" : {
"type" : "integer",
"description" : "Specifies if available ports are included into the list. Possible values: 1 - include available ports into the list; 0 - don't include available ports into the list"
},
"i_ua_type" : {
"type" : "integer",
"description" : "The unique ID of the UA type record"
},
"with_busy_ports" : {
"type" : "integer",
"description" : "Specifies if busy ports are included into the list. Possible values: 1 - include busy ports into the list; 0 - don't include busy ports into the list"
}
}
},
"SubscriptionConflicts" : {
"type" : "object",
"properties" : {
"addons" : {
"$ref" : "#/components/schemas/ArrayOfConflictingAddOns"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the subscription plan record"
},
"name" : {
"type" : "string",
"description" : "The subscription plan name"
}
}
},
"GetCustomerInfoRequest" : {
"type" : "object",
"properties" : {
"effective_values" : {
"type" : "integer",
"description" : "Get customer info (including the values that were overridden or inherited from other entities)"
},
"detailed_info" : {
"type" : "integer",
"description" : "Specifies whether detailed information will be returned in the response"
},
"name" : {
"type" : "string",
"description" : "The ID of the customer on the PortaBilling interface, unique in the environment"
},
"get_main_office_info" : {
"type" : "integer",
"description" : "If set to '1', information will be provided for the requested Branch Office (site) customer about the Main Office (HQ) customer which is linked with it"
},
"with_reseller_info" : {
"type" : "integer",
"description" : "If with_reseller_info == 1 then return information about reseller"
},
"login" : {
"type" : "string",
"description" : "User Name, as specified on web interface"
},
"get_auth_info" : {
"type" : "integer",
"description" : "If set to '1', the information about the customer's authorization parameters will be provided in the response"
},
"refnum" : {
"type" : "string",
"description" : "Reference number (custom field)"
},
"get_time_zone_name" : {
"type" : "integer",
"description" : "If set to '1', the customer's time zone will be provided in the response; refers to Time_Zones table"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"get_rt_auth_info" : {
"type" : "integer",
"description" : "If set to '1', the customer's RT information will be provided in the response"
},
"aux_field_names" : {
"$ref" : "#/components/schemas/ArrayOfAuxFieldNames"
}
}
},
"DeleteCustomerHuntgroupRequest" : {
"required" : [
"i_c_group"
],
"type" : "object",
"properties" : {
"i_c_ext" : {
"type" : "integer",
"description" : "Obsolete. The unique ID of the extension"
},
"i_c_group" : {
"type" : "integer",
"description" : "The unique ID of the created extension"
},
"i_customer" : {
"type" : "integer",
"description" : "Obsolete. The unique ID of the customer record"
}
}
},
"UserNotificationCategoryInfo" : {
"type" : "object",
"properties" : {
"send_sms" : {
"type" : "integer",
"description" : "Specifies whether this notifications will be sent by sms. Possible values: 1 – The nofications will be sent by email, 0 – The notifications will not be sent by email."
},
"send_mail" : {
"type" : "integer",
"description" : "Specifies whether this notifications will be sent by email. Possible values: 1 – The nofications will be sent by email, 0 – The notifications will not be sent by email."
},
"name" : {
"type" : "string",
"description" : "The name of the notification category"
},
"i_notification_category" : {
"type" : "integer",
"description" : "The unique ID of the notification category"
}
}
},
"GetAccountListRequest" : {
"required" : [
"i_master_account"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "Refers to the product record which is assigned to the account"
},
"firstname" : {
"type" : "string",
"description" : "Account owner's first name"
},
"batch_name" : {
"type" : "string",
"description" : "The batch name to which the account belongs"
},
"state" : {
"type" : "string",
"description" : "Province or state"
},
"email" : {
"type" : "string",
"description" : "Account's email address"
},
"get_only_real_accounts" : {
"type" : "integer",
"description" : "Get only accounts and skip account aliases"
},
"id" : {
"type" : "string",
"description" : "Search pattern for account IDs"
},
"get_service_features" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"subscriber_email" : {
"type" : "string",
"description" : "Subscriber's email address"
},
"get_statuses" : {
"type" : "integer",
"description" : "Get the statuses of the accounts"
},
"bill_status" : {
"type" : "string",
"description" : "The billing status of the account to search by. Possible values: O – open; I – inactive; C – terminated"
},
"expand_alias" : {
"type" : "integer",
"description" : "For account aliases: indicates whether the information should be retrieved from the alias or from the related master account"
},
"account_role_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountRoleInfo"
},
"login" : {
"type" : "string",
"description" : "User login for self-care web interface"
},
"zip" : {
"type" : "string",
"description" : "Postal (zip) code"
},
"phone1" : {
"type" : "string",
"description" : "Main phone number"
},
"i_addon_product" : {
"type" : "integer",
"description" : "The unique ID of the record of the addon product that is assigned to the account"
},
"phone2" : {
"type" : "string",
"description" : "Alternative phone number"
},
"legal_intercept_only" : {
"type" : "integer",
"description" : "Get only accounts with \"Legal Intercept\" enabled"
},
"midinit" : {
"type" : "string",
"description" : "Account owner's middle initial(s)"
},
"cont1" : {
"type" : "string",
"description" : "Main contact person"
},
"salutation" : {
"type" : "string",
"description" : "Account owner's salutation"
},
"billing_model" : {
"type" : "integer",
"description" : "The account type. Possible values: -1 – Debit; 0 – Recharge voucher; 1 – Credit"
},
"lastname" : {
"type" : "string",
"description" : "Account owner's last name"
},
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of the customer site"
},
"city" : {
"type" : "string",
"description" : "City of account owner's address"
},
"with_addon_products" : {
"type" : "integer",
"description" : "A flag that indicates whether the add-on products of the account will be returned. Possible values: 1 - supplement account information with the list of add-on products, 0 - the list of addon products will not be included in the response. Default value: 0"
},
"callshop_enabled" : {
"type" : "string",
"description" : "Set this value to filter Accounts whose customers have callshop feature enabled or disabled. Possible values: Y – enabled, N – disabled"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved accounts"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"cont2" : {
"type" : "string",
"description" : "Alternative contact person"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"country" : {
"type" : "string",
"description" : "Country code"
},
"i_batch" : {
"type" : "integer",
"description" : "Refers to batch record to which the account belongs"
},
"custom_fields_values" : {
"$ref" : "#/components/schemas/ArrayOfCustomFieldsValuesInfo"
},
"get_not_closed_accounts" : {
"type" : "integer",
"description" : "Get only accounts with statuses different from \"closed\""
},
"note" : {
"type" : "string",
"description" : "Short note (description)"
},
"sip_status" : {
"type" : "integer",
"description" : "Indicates whether the account is used by a SIP phone to register with a PortaSIP server: 1 – online (the account is used by a SIP phone to register with a PortaSIP server); 0 – offline"
},
"i_account_balance_control_type" : {
"type" : "integer",
"description" : "The unique ID of the account's balance control type"
},
"i_master_account" : {
"type" : "integer",
"description" : "The internal ID of the master account record"
},
"control_number_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountControlNumberInfo"
},
"faxnum" : {
"type" : "string",
"description" : "Fax number"
},
"control_number" : {
"type" : "integer",
"description" : "The sequential number of the account in the batch"
},
"free_of_extension" : {
"type" : "integer",
"description" : "Get only the accounts that aren't assigned to any extension"
},
"i_customer" : {
"type" : "integer",
"description" : "Refers to the customer record to which the account belongs"
},
"companyname" : {
"type" : "string",
"description" : "Account owner's company name"
}
}
},
"VendorPerServiceInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"ratio" : {
"type" : "integer",
"description" : "Billing:Base Ratio. If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration"
},
"rating_base_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units in which service use is measured; this also is the smallest possible unit you use in the rating configuration (e.g. second)"
},
"credits" : {
"type" : "number",
"description" : "The sum of credit transaction amounts related to the service"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service; refers to Services table"
},
"rate_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units used to calculate service charges (e.g. message, minute)"
},
"name" : {
"type" : "string",
"description" : "The service name"
},
"charges" : {
"type" : "number",
"description" : "The sum of charge transaction amounts related to the service"
},
"total" : {
"type" : "integer",
"description" : "Subtotal for this type of transactions/service"
},
"unit" : {
"type" : "string",
"description" : "The unit in which the charged quantity is shown (e.g. second)"
},
"charged_amount" : {
"type" : "number",
"description" : "The sum of the amounts in the 'credits' and 'charges' fields"
},
"charged_quantity" : {
"type" : "integer",
"description" : "Units charged"
},
"rating_base" : {
"type" : "string",
"description" : "Specifies which particular parameter is used to calculate charges, e.g. \"session time\", \"amount of data transferred\" and the like"
},
"total_sessions" : {
"type" : "integer",
"description" : "The total number of sessions of this transactions/service type"
}
}
},
"AddUpdateAccessRoleResponse" : {
"required" : [
"i_role"
],
"type" : "object",
"properties" : {
"i_role" : {
"type" : "integer",
"description" : "The identifier of the access role"
}
}
},
"ProductUpdateProductDetailedResponse" : {
"type" : "object",
"properties" : {
"product_info" : {
"$ref" : "#/components/schemas/RawProductInfo"
}
}
},
"AddCommissionPlanRequest" : {
"required" : [
"commission_plan_info"
],
"type" : "object",
"properties" : {
"commission_plan_info" : {
"$ref" : "#/components/schemas/CommissionPlanInfo"
}
}
},
"GetAccountSubscriptionsRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"i_commitment" : {
"type" : "integer",
"description" : "The unique ID of the commitment"
},
"commitment_name" : {
"type" : "string",
"description" : "The commitment name"
}
}
},
"GetAccountPermittedProxyInfoRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
}
}
},
"TransactionActionsListResponse" : {
"required" : [
"manual_transactions"
],
"type" : "object",
"properties" : {
"manual_transactions" : {
"$ref" : "#/components/schemas/ArrayOfTransactionActions"
}
}
},
"GetDestGroupSetInfoResponse" : {
"type" : "object",
"properties" : {
"dest_group_set_info" : {
"$ref" : "#/components/schemas/DestGroupSetInfo"
}
}
},
"FraudTrafficInfo" : {
"type" : "object",
"properties" : {
"duration_avg" : {
"type" : "integer",
"description" : "The average traffic duration"
},
"duration_max" : {
"type" : "integer",
"description" : "The maximum traffic duration"
},
"duration_min" : {
"type" : "integer",
"description" : "The minimum traffic duration"
}
}
},
"CustomerSetCallQueueMohFileResponse" : {
"required" : [
"i_c_queue"
],
"type" : "object",
"properties" : {
"i_c_queue" : {
"type" : "integer",
"description" : "ID of call queue record"
}
}
},
"GetCustomerInfoResponse" : {
"type" : "object",
"properties" : {
"customer_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
},
"main_office_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
},
"reseller_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
}
}
},
"UpdateCurrencyResponse" : {
"required" : [
"iso_4217"
],
"type" : "object",
"properties" : {
"i_ma_currency" : {
"type" : "integer",
"description" : "The unique merchant account currency identifier"
},
"iso_4217" : {
"type" : "string",
"description" : "The unique ID of the Currency record"
}
}
},
"UpdateServiceAndRatingRequest" : {
"required" : [
"service_and_rating_info"
],
"type" : "object",
"properties" : {
"detailed_response" : {
"type" : "integer",
"description" : "Flag which shows whether updated record should be returned in response or not"
},
"service_and_rating_info" : {
"$ref" : "#/components/schemas/ServiceAndRatingInfo"
}
}
},
"APIMethodFieldInfo" : {
"required" : [
"access_list",
"type",
"mandatory"
],
"type" : "object",
"properties" : {
"access_list" : {
"$ref" : "#/components/schemas/ArrayOfAPIMethodACLInfo"
},
"object_field_list" : {
"$ref" : "#/components/schemas/ArrayOfAPIMethodFieldInfo"
},
"name" : {
"type" : "string",
"description" : "The name of the API method field"
},
"array_item" : {
"$ref" : "#/components/schemas/APIMethodFieldInfo"
},
"mandatory" : {
"type" : "integer",
"description" : "Shows whether the field in the structure is mandatory"
},
"type" : {
"type" : "string",
"description" : "The data type of the API method field"
}
}
},
"ArrayOfUAProfileInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UAProfileInfo"
}
},
"BillingPeriodHistoryInfo" : {
"type" : "object",
"properties" : {
"period_from" : {
"type" : "string",
"description" : "The start date and time of the billing period"
},
"billing_period_closed" : {
"type" : "string",
"description" : "The date and time when billing period becomes closed"
},
"period_to" : {
"type" : "string",
"description" : "The end date and time of the billing period"
},
"i_history" : {
"type" : "integer",
"description" : "The unique ID of the history record"
},
"stat_calculated" : {
"type" : "string",
"description" : "The date and time when statistics is calculated"
}
}
},
"TaxationPluginGetTaxPluginParametersMetaInfoResponse" : {
"required" : [
"tax_plugin_parameters_metainfo"
],
"type" : "object",
"properties" : {
"tax_plugin_parameters_metainfo" : {
"$ref" : "#/components/schemas/ArrayOfTaxationPluginParameterMetaInfo"
}
}
},
"GetAccountVdCounterInfoResponse" : {
"type" : "object",
"properties" : {
"vd_counter_info" : {
"$ref" : "#/components/schemas/CounterInfo"
}
}
},
"DIDGroupInfo" : {
"type" : "object",
"properties" : {
"total_dids" : {
"type" : "integer",
"description" : "The total number of DID numbers in the group"
},
"total_dids_used" : {
"type" : "integer",
"description" : "The total number of DID numbers in the group that are in use"
},
"i_group" : {
"type" : "integer",
"description" : "The unique ID of the DID group"
},
"name" : {
"type" : "string",
"description" : "The name of the DID group"
},
"total_dids_free" : {
"type" : "integer",
"description" : "The total number of DID numbers in the group that are not in use"
},
"description" : {
"type" : "string",
"description" : "The DID group description"
}
}
},
"TraceSessionInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"cli" : {
"type" : "string",
"description" : "The calling line phone number"
},
"i_disconnect_cause_class" : {
"type" : "integer",
"description" : "The unique ID of the disconnect cause class"
},
"status" : {
"type" : "string",
"description" : "The status of the session"
},
"vendor_name" : {
"type" : "string",
"description" : "Name of the vendor on the PortaBilling interface"
},
"parent_h323_conf_id" : {
"type" : "string",
"description" : "The h323-conf-id of the parent session"
},
"source_ip" : {
"type" : "string",
"description" : "The IP address of the entity"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"service_type_name" : {
"type" : "string",
"description" : "The logical name of the Service Type"
},
"to_date" : {
"type" : "string",
"description" : "The end of the search interval"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor"
},
"quantity" : {
"type" : "integer",
"description" : "The number of service units used"
},
"duration" : {
"type" : "integer",
"description" : "The session length (number of seconds) from the moment when the session was started"
},
"from_date" : {
"type" : "string",
"description" : "The beginning of the search interval"
},
"call_id" : {
"type" : "string",
"description" : "The call-id of the session"
},
"account_id" : {
"type" : "string",
"description" : "The ID of the account the extension is assigned to"
},
"connection_name" : {
"type" : "string",
"description" : "Name of used connection"
},
"disconnect_cause" : {
"type" : "integer",
"description" : "The code of disconnect cause"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"h323_conf_id" : {
"type" : "string",
"description" : "h323-conf-id of the session"
},
"cld" : {
"type" : "string",
"description" : "The called line phone number"
},
"i_connection" : {
"type" : "integer",
"description" : "The unique ID of the connection"
},
"customer_name" : {
"type" : "string",
"description" : "The name of the customer"
}
}
},
"TimePeriodInfo" : {
"type" : "object",
"properties" : {
"usage" : {
"type" : "string",
"description" : "The field describes how PortaBilling uses the time period. The field applies only for the 'offpeak' type. Possible values: 'start' - session starts during the period; 'stop' - session finishes during the period; 'startstop' - session starts and stops during the period"
},
"definition_list" : {
"$ref" : "#/components/schemas/ArrayOfTimePeriodDefinitionInfo"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the time period is in use"
},
"name" : {
"type" : "string",
"description" : "The name of the time period"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller record (managed by)"
},
"period_type" : {
"type" : "string",
"description" : "The type of the time period. Possible values: 'offpeak', 'access_policy', 'intrazone'"
},
"i_offpeak" : {
"type" : "integer",
"description" : "The unique ID of the time period"
}
}
},
"SendMeEnvNotificationSampleRequest" : {
"required" : [
"messaging_service_type",
"name"
],
"type" : "object",
"properties" : {
"messaging_service_type" : {
"type" : "string",
"description" : "The type of the notification. Possible values: SMS, Mail"
},
"name" : {
"type" : "string",
"description" : "The name of the notification"
}
}
},
"ArrayOfUATypeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UATypeInfo"
}
},
"DestinationGetCSetGroupListRequest" : {
"required" : [
"i_dest_group_set"
],
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set"
}
}
},
"GetNetaccessUsageRecordListResponse" : {
"type" : "object",
"properties" : {
"netaccess_usage_record_list" : {
"$ref" : "#/components/schemas/ArrayOfNetaccessUsageRecordInfo"
}
}
},
"GetAllowedAddonsResponse" : {
"required" : [
"product_list"
],
"type" : "object",
"properties" : {
"product_list" : {
"$ref" : "#/components/schemas/ArrayOfProductInfo"
}
}
},
"GetAuthzMethodTypeListResponse" : {
"required" : [
"authz_method_type_list"
],
"type" : "object",
"properties" : {
"authz_method_type_list" : {
"$ref" : "#/components/schemas/ArrayOfAuthzMethodTypeInfo"
}
}
},
"TemplateUpdateTemplateGroupFieldListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"CustomerPrepareCustomerForExportResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success"
},
"warnings" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"AddUpdateVoiceQualityProfileResponse" : {
"required" : [
"i_vq_profile"
],
"type" : "object",
"properties" : {
"i_vq_profile" : {
"type" : "integer",
"description" : "The ID of the voice quality profile"
}
}
},
"DisconnectSessionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success"
}
}
},
"ReleaseDIDNumberResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 - success, 0 - failure"
}
}
},
"AddUpdateBundlePromotionResponse" : {
"type" : "object",
"properties" : {
"i_bd_plan" : {
"type" : "integer",
"description" : "The unique ID of the Bundle Promotion Plan"
}
}
},
"UpdateVendorRequest" : {
"required" : [
"vendor_info"
],
"type" : "object",
"properties" : {
"vendor_info" : {
"$ref" : "#/components/schemas/VendorInfo"
}
}
},
"CustomerSiteInfo" : {
"required" : [
"i_customer_site"
],
"type" : "object",
"properties" : {
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of the customer site"
},
"name" : {
"type" : "string",
"description" : "The name of the customer site"
},
"used" : {
"type" : "integer",
"description" : "Shows whether site is used by account or not"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
}
}
},
"DIDNumberOrderInfo" : {
"required" : [
"is_success"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "Provisioned number ID in the DID inventory"
},
"area_name" : {
"type" : "string",
"description" : "Area name"
},
"country_name" : {
"type" : "string",
"description" : "Country name"
},
"did_number" : {
"type" : "string",
"description" : "Provisioned DID number"
},
"fault_code" : {
"type" : "string",
"description" : "Error code"
},
"fault_string" : {
"type" : "string",
"description" : "Error description"
},
"order_id" : {
"type" : "string",
"description" : "Order ID on DID provider side"
},
"is_success" : {
"type" : "integer",
"description" : "A flag that informs if the order request has been successfully processed"
},
"did_status" : {
"type" : "string",
"description" : "DID number status"
},
"pricing" : {
"$ref" : "#/components/schemas/DIDPricing"
}
}
},
"AddAccessNumberResponse" : {
"required" : [
"i_ivr_an"
],
"type" : "object",
"properties" : {
"i_ivr_an" : {
"type" : "integer",
"description" : "The unique ID of the IVR access number"
}
}
},
"ArrayOfResultBatchAddRateInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ResultBatchAddRateInfo"
}
},
"ArrayOfSessionLogMessage" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SessionLogMessage"
}
},
"GetAccountPaymentTransactionListRequest" : {
"type" : "object",
"properties" : {
"search" : {
"type" : "string",
"description" : "A pattern that enables searching by the 'x_transaction_id', 'payment_method_info' fields"
},
"status" : {
"type" : "string",
"description" : "Status of the transaction"
},
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique payment system ID for the transaction"
},
"from_date" : {
"type" : "string",
"description" : "Get records starting from this date"
},
"test_mode" : {
"type" : "string",
"description" : "Indicates whether the payment processor was in the test mode at the moment when the transaction was processed - Y/N"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"i_payment_method" : {
"type" : "integer",
"description" : "Unique ID of the payment method"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved transactions"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_payment_transaction" : {
"type" : "integer",
"description" : "The unique ID of a payment transaction"
},
"hide_restricted" : {
"type" : "integer",
"description" : "Specifies whether it is necessary to remove the payment transactions of the terminated entities from the response"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"to_date" : {
"type" : "string",
"description" : "Get records before this date"
}
}
},
"UpdateAccessNumberResponse" : {
"required" : [
"i_ivr_an"
],
"type" : "object",
"properties" : {
"i_ivr_an" : {
"type" : "integer",
"description" : "The unique ID of the IVR access number"
}
}
},
"ArrayOfAuxFieldNames" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"CustomerBatchInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Possibe values: 1 – If the batch is used; 0 – If the batch is not used"
},
"i_batch" : {
"type" : "integer",
"description" : "The unique ID of the batch"
},
"payment_commission_rate" : {
"type" : "number",
"description" : "The commission (in %) paid to a distributor for topping up the balance of this batch's existing account"
},
"sale_commission_rate" : {
"type" : "number",
"description" : "A commission (in %) paid to a distributor when a new account is created"
},
"iso_4217" : {
"type" : "string",
"description" : "The ISO4217 code for the customer currency"
},
"name" : {
"type" : "string",
"description" : "The name of the batch"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the batches owner"
}
}
},
"SuspendCustomerResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"GenerateAccountsRequest" : {
"required" : [
"i_product",
"batch",
"i_customer"
],
"type" : "object",
"properties" : {
"activation_date" : {
"type" : "string",
"description" : "The date when the account becomes usable"
},
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"gen_method" : {
"type" : "string",
"description" : "The accounts generation method: R – Random; S – Sequential; D – DID Inventory"
},
"inactive" : {
"type" : "string",
"description" : "Shows whether account will be inactive after creation. Only for Debit accounts and Recharge vouchers. The default value is: Y"
},
"gen_credentials_method" : {
"type" : "string",
"description" : "Method of login and password generation: empty, auto"
},
"out_date_format" : {
"type" : "string",
"description" : "Output format for date indication"
},
"opening_balance" : {
"type" : "number",
"description" : "The initial balance of the account"
},
"gen_start_did" : {
"type" : "string",
"description" : "Starting DID number. Only for the DID Inventory method"
},
"blocked" : {
"type" : "string",
"description" : "Shows whether account will be blocked after creation; default: N"
},
"gen_start_id" : {
"type" : "string",
"description" : "Account's start ID. Only for Sequential method"
},
"out_date_time_format" : {
"type" : "string",
"description" : "Output format for full date/time indication"
},
"check_available_sim_cards" : {
"type" : "integer",
"description" : "If the account role is set to 'Mobile' and the field is set to '1', the method will check available SIM cards and raise an error if the number of available SIM cards is less than the value in the 'gen_amount' field"
},
"gen_h323_length" : {
"type" : "integer",
"description" : "Length of service password to generate for method auto_digits; default: defined by cfg option Cardissue.NumericH323PasswordLength"
},
"life_time" : {
"type" : "integer",
"description" : "Accounts will expire on the first usage time + lifetime days"
},
"i_role" : {
"type" : "integer",
"description" : "The unique ID of the account's access role; refers to the Roles table"
},
"in_date_format" : {
"type" : "string",
"description" : "Input format for date indication"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the time zone record"
},
"billing_model" : {
"type" : "integer",
"description" : "One of the following: -1 – Debit; 0 – Recharge Voucher;1 – Credit "
},
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of a customer site record"
},
"gen_id_prefix" : {
"type" : "string",
"description" : "Account ID prefix. Only for the Random method"
},
"check_available_dids" : {
"type" : "integer",
"description" : "If 'gen_method' is set to 'D' and the field is set to '1', the method will check available numbers and fall with an error if the number of available numbers is less than the value in the 'gen_amount' field"
},
"out_time_format" : {
"type" : "string",
"description" : "Output format for time indication"
},
"gen_h323_method" : {
"type" : "string",
"description" : "Method of service password generation: empty, auto, auto_digits. Only for Debit accounts and Recharge vouchers"
},
"gen_id_length" : {
"type" : "integer",
"description" : "Account ID length. Only for the Random method"
},
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
},
"ecommerce_enabled" : {
"type" : "string",
"description" : "Allow the account's owner to make online payments or set up periodical payments on the account's self-care interface"
},
"i_batch" : {
"type" : "integer",
"description" : "The unique ID of the batch to which the account belongs"
},
"i_account_role" : {
"type" : "integer",
"description" : "The unique ID of the account role; refers to the Account_Roles table. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID"
},
"gen_i_do_batch" : {
"type" : "integer",
"description" : "ID of DID owner batch to use DID numbers from. Only for DID Inventory method"
},
"language" : {
"type" : "string",
"description" : "The accounts' language"
},
"i_distributor" : {
"type" : "integer",
"description" : "The unique ID of the distributor. Only for Debit accounts and Recharge vouchers"
},
"in_time_format" : {
"type" : "string",
"description" : "Input format for time indication"
},
"expiration_date" : {
"type" : "string",
"description" : "The date when the account become unusable"
},
"addon_products" : {
"$ref" : "#/components/schemas/ArrayOfInt"
},
"gen_amount" : {
"type" : "integer",
"description" : "Amount of accounts to generate"
},
"i_account_balance_control_type" : {
"type" : "integer",
"description" : "The unique ID of the Account_Balance_Control_Types record (the Balance Control field on the PortaBilling web interface)"
},
"batch" : {
"type" : "string",
"description" : "Name of existing batch or new one"
},
"gen_start_imsi" : {
"type" : "string",
"description" : "Starting IMSI SIM number. Only for the Mobile account role"
},
"inactivity_expire_time" : {
"type" : "integer",
"description" : "Specifies the number of days the account remains active after its last use or recharge"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"i_acl" : {
"type" : "integer",
"description" : "The unique ID for the account's access level; refers to the Access_Levels table"
},
"credit_limit" : {
"type" : "number",
"description" : "Account's credit limit value. Only for credit accounts; default: 0"
}
}
},
"GetCustomerCustomFieldsSchemaResponse" : {
"type" : "object",
"properties" : {
"custom_fields" : {
"$ref" : "#/components/schemas/ArrayOfCustomerCustomFieldsInfo"
}
}
},
"CreditLimitChangeCommentInfo" : {
"type" : "object",
"properties" : {
"comment" : {
"type" : "string",
"description" : "A comment on the credit limit change"
}
}
},
"UpdateCustomerClassTaxationResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"ActiveCallInfoList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ActiveCallInfo"
}
},
"ArrayOfPriceListInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PriceListInfo"
}
},
"RadiusAttributeData" : {
"required" : [
"value",
"name"
],
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The value of the Radius attribute"
},
"name" : {
"type" : "string",
"description" : "The name of the Radius attribute"
}
}
},
"GetActiveSessionsRequest" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"cli" : {
"type" : "string",
"description" : "The calling line phone number"
},
"with_resale_hierarchy" : {
"type" : "integer",
"description" : "Specifies whether the information about the resellers hierarchy should be included in the response"
},
"on_net" : {
"type" : "string",
"description" : "Filter the session list by the on-net status. Possible values: 'on-net_only' - Include only on-net sessions; 'exclude' - Do not include on-net sessions; 'exclude_incoming' - Do not include incoming on-net sessions"
},
"i_node" : {
"type" : "integer",
"description" : "The unique ID of the node"
},
"i_parent" : {
"type" : "integer",
"description" : "Omit for a direct customer; i_customer of the reseller for a subcustomer"
},
"source_ip" : {
"type" : "string",
"description" : "The IP address of the entity"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved active session records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"with_cld_country" : {
"type" : "integer",
"description" : "Specifies whether the information about country and subdivision of CLD should be included in the response"
},
"call_id" : {
"type" : "string",
"description" : "The call-id of the session"
},
"account_id" : {
"type" : "string",
"description" : "The ID (PIN) of the account on the PortaBilling interface, unique in the environment"
},
"parent_session_id" : {
"type" : "string",
"description" : "The parent session ID"
},
"with_nodes" : {
"type" : "integer",
"description" : "Specifies whether the information about used nodes should be included in the response"
},
"hotlined" : {
"type" : "string",
"description" : "The flag that shows whether the session is hotlined (Internet sessions only)"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The h323-conf-id of the session"
},
"cld" : {
"type" : "string",
"description" : "The called line phone number"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"i_connection" : {
"type" : "integer",
"description" : "The unique ID of the connection"
}
}
},
"AddUAProfileResponse" : {
"required" : [
"i_ua_profile"
],
"type" : "object",
"properties" : {
"i_ua_profile" : {
"type" : "integer",
"description" : "The unique ID of the UA Profile record"
},
"ua_profile_id" : {
"type" : "integer",
"description" : "The ID of the UA profile"
}
}
},
"GetServicePoolInfoRequest" : {
"required" : [
"i_pooling_service"
],
"type" : "object",
"properties" : {
"i_pooling_service" : {
"type" : "integer",
"description" : "The ID of the service pool"
}
}
},
"DeleteDiscountPlanResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"UpdateCallBarringClassRequest" : {
"required" : [
"call_barring_class_info"
],
"type" : "object",
"properties" : {
"call_barring_class_info" : {
"$ref" : "#/components/schemas/CallBarringClassInfo"
}
}
},
"GetTimePeriodListRequest" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the time period is in use"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved time periods"
},
"name" : {
"type" : "string",
"description" : "The name of the time period"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller record (managed by)"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"period_type" : {
"type" : "string",
"description" : "The type of the time period. Possible values: 'offpeak', 'access_policy', 'intrazone'"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"DeleteTimePeriodRequest" : {
"required" : [
"i_offpeak"
],
"type" : "object",
"properties" : {
"i_offpeak" : {
"type" : "integer",
"description" : "The unique ID of the time period"
}
}
},
"CleanupPersonalDataRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The ID of the customer record to be cleaned up"
}
}
},
"ValidateAccountInfoResponse" : {
"type" : "object",
"properties" : {
"account_info" : {
"$ref" : "#/components/schemas/AccountInfo"
}
}
},
"ArrayOfVoiceQualityProfileInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VoiceQualityProfileInfo"
}
},
"RegenerateInvoiceResponse" : {
"required" : [
"i_invoice"
],
"type" : "object",
"properties" : {
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"GetServicePolicyListResponse" : {
"type" : "object",
"properties" : {
"service_policy_list" : {
"$ref" : "#/components/schemas/ArrayOfServicePolicyInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved records"
}
}
},
"DIDCostsInfo" : {
"type" : "object",
"properties" : {
"activation" : {
"type" : "number",
"description" : "A fee applied for a DID number allocation"
},
"periodic" : {
"type" : "number",
"description" : "A periodic fee applied for the DID number usage"
},
"free_of_charge" : {
"type" : "string",
"description" : "Indicates whether this number is completely free of charge or not"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO 4217 code of the currency in which the fee is applied"
}
}
},
"DeleteFollowMeNumberRequest" : {
"required" : [
"i_follow_me_number"
],
"type" : "object",
"properties" : {
"i_follow_me_number" : {
"type" : "integer",
"description" : "ID of follow-me number database record to be deleted"
}
}
},
"GetDestinationPrefixInfoRequest" : {
"required" : [
"i_dest"
],
"type" : "object",
"properties" : {
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of a destination record"
}
}
},
"AbbreviatedDialingNumberInfo" : {
"type" : "object",
"properties" : {
"number_to_dial" : {
"type" : "string",
"description" : "Number to dial"
},
"abbreviated_number" : {
"type" : "string",
"description" : "Abbreviated number"
},
"description" : {
"type" : "string",
"description" : "Text description for this entry"
},
"i_ab_dialing" : {
"type" : "integer",
"description" : "ID of abbreviated dialing number record"
}
}
},
"GetCPRuleListRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved rate data records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"UpdateAssignedCommitmentRecordResponse" : {
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
}
}
},
"ArrayOfFraudConstraintInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FraudConstraintInfo"
}
},
"ListPaymentProcessorsRequest" : {
"type" : "object",
"properties" : {
"remittance" : {
"type" : "integer",
"description" : "Specifies whether a payment or a payment remittance system is to be shown"
}
}
},
"UpdateConnectionResponse" : {
"required" : [
"i_connection"
],
"type" : "object",
"properties" : {
"i_connection" : {
"type" : "integer",
"description" : "The unique ID of the vendor connection record"
}
}
},
"ProductGetProductListDetailedResponse" : {
"required" : [
"product_list"
],
"type" : "object",
"properties" : {
"product_list" : {
"$ref" : "#/components/schemas/ArrayOfRawProductInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of found products"
}
}
},
"ArrayOfPortingRequestInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PortingRequestInfo"
}
},
"GetCustomerSubscriptionsRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record"
}
}
},
"ArrangeCPRulesResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "One of the following: 1 – success, 0 – failed"
}
}
},
"TemplateGetTemplateDataGroupListResponse" : {
"type" : "object",
"properties" : {
"template_data_group_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateDataGroupInfo"
}
}
},
"GetDialRuleSamplesRequest" : {
"type" : "object"
},
"ReleaseUAResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"GetCustomerAbbreviatedDialingNumberListResponse" : {
"required" : [
"total"
],
"type" : "object",
"properties" : {
"abbreviated_dialing_number_list" : {
"$ref" : "#/components/schemas/ArrayOfAbbreviatedDialingNumberInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved abbreviated dialing number objects"
}
}
},
"UpdateConnectionRequest" : {
"required" : [
"connection_info"
],
"type" : "object",
"properties" : {
"connection_info" : {
"$ref" : "#/components/schemas/ConnectionInfo"
}
}
},
"GetAccountProvisioningStatusListResponse" : {
"type" : "object",
"properties" : {
"provisioning_status_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountProvisioningStatusInfo"
}
}
},
"DeleteDatesBatchRequest" : {
"required" : [
"date_list"
],
"type" : "object",
"properties" : {
"date_list" : {
"$ref" : "#/components/schemas/ArrayOfCalendarDateInfo"
}
}
},
"GetVDTopupOptionListResponse" : {
"type" : "object",
"properties" : {
"topup_option_list" : {
"$ref" : "#/components/schemas/ArrayOfVDTopupOptionInfo"
}
}
},
"ChargeCustomerSubscriptionFeesRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"immediately_in_advance" : {
"type" : "integer",
"description" : "Amount of periods that should be charged in advance"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record to be charged"
}
}
},
"GetBillingPeriodListRequest" : {
"type" : "object"
},
"CodecConverterFileInfo" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "The file status"
},
"name" : {
"type" : "string",
"description" : "The file name"
},
"id" : {
"type" : "integer",
"description" : "The unique identifier of the file"
},
"own" : {
"type" : "integer",
"description" : "The flag that shows whether the file is owned by the current user"
}
}
},
"AddIvrApplicationResponse" : {
"required" : [
"i_voice_app_access_number"
],
"type" : "object",
"properties" : {
"i_voice_app_access_number" : {
"type" : "integer",
"description" : "The unique ID of the IVR application"
}
}
},
"ArrayOfCodecInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CodecInfo"
}
},
"GetNotificationPresetInfoResponse" : {
"type" : "object",
"properties" : {
"notification_preset_info" : {
"$ref" : "#/components/schemas/NotificationPresetInfo"
}
}
},
"ArrayOfCloneTariffInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CloneTariffInfo"
}
},
"ArrayOfObjectPermissions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ObjectPermissions"
}
},
"ArrayOfCPConditionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CPConditionInfo"
}
},
"VendorInfoList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VendorInfo"
}
},
"ArrayOfAccAliasesListInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccAliasesListInfo"
}
},
"ArrayOfTemplateGroupFieldInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TemplateGroupFieldInfo"
}
},
"AccountGetBoothsResponse" : {
"type" : "object",
"properties" : {
"booth_list" : {
"$ref" : "#/components/schemas/ArrayOfBoothInfo"
}
}
},
"UpdateVDTopupOptionResponse" : {
"type" : "object",
"properties" : {
"i_vd_topup" : {
"type" : "integer",
"description" : "The unique ID of the volume discount topup record"
}
}
},
"ArrayOfRoutingCriteriaDestGroupInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RoutingCriteriaDestGroupInfo"
}
},
"DeleteAccountAliasRequest" : {
"required" : [
"alias_info"
],
"type" : "object",
"properties" : {
"alias_info" : {
"$ref" : "#/components/schemas/AliasInfo"
},
"release_assigned_did" : {
"type" : "integer",
"description" : "The flag specifies whether the previously assigned DID number should be released to the pool (true by default)"
},
"force" : {
"type" : "integer",
"description" : "The flag specifies whether associated non-disconnectable active sessions should be ignored"
}
}
},
"GetCustomerConsumedServiceResponse" : {
"type" : "object",
"properties" : {
"consumed_service_list" : {
"$ref" : "#/components/schemas/ArrayOfConsumedServices"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved services"
}
}
},
"UpdateAccessRoleRequest" : {
"required" : [
"access_role_info"
],
"type" : "object",
"properties" : {
"access_role_info" : {
"$ref" : "#/components/schemas/AccessRoleInfo"
}
}
},
"UpdateMeasuredMetricResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 for success, 0 in case of failure"
}
}
},
"GetAsyncRequestListRequest" : {
"type" : "object"
},
"GetOverrideTariffListResponse" : {
"type" : "object",
"properties" : {
"override_tariff_list" : {
"$ref" : "#/components/schemas/ArrayOfOverrideTariffs"
}
}
},
"PortingRequestInfo" : {
"type" : "object",
"properties" : {
"provider" : {
"type" : "string",
"description" : "The provider to which the number belongs or will belong depending on the request type"
},
"status" : {
"type" : "string",
"description" : "The current processing status of the porting request"
},
"i_request" : {
"type" : "integer",
"description" : "The unique ID of the number porting request"
},
"request_parameters" : {
"$ref" : "#/components/schemas/ArrayOfPortingRequestParameterInfo"
},
"porting_number" : {
"type" : "string",
"description" : "The number being ported"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account which the request relates to"
},
"due_date" : {
"type" : "string",
"description" : "The date and the time by which the customer's request must be completed"
},
"request_id" : {
"type" : "string",
"description" : "The number porting request"
},
"id" : {
"type" : "integer",
"description" : "The account the request relates to"
},
"type" : {
"type" : "string",
"description" : "The porting request type. Possible values: PORTIN (default); PORTOUT"
}
}
},
"AddDIDGroupRequest" : {
"required" : [
"group_info"
],
"type" : "object",
"properties" : {
"group_info" : {
"$ref" : "#/components/schemas/DIDGroupInfo"
}
}
},
"GetPromptFileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
},
"prompt_error" : {
"type" : "string",
"description" : "Error message, if any"
},
"prompt_status" : {
"type" : "string",
"description" : "Status of prompt conversion"
}
}
},
"GetServicePolicyInfoResponse" : {
"type" : "object",
"properties" : {
"service_policy_info" : {
"$ref" : "#/components/schemas/ServicePolicyInfo"
}
}
},
"UAGetUAProfileMetaInfoResponse" : {
"type" : "object",
"properties" : {
"ua_profile_metainfo" : {
"$ref" : "#/components/schemas/ANY"
}
}
},
"OutOfTurnXDRInfo" : {
"required" : [
"owner_type",
"i_xdr"
],
"type" : "object",
"properties" : {
"owner_type" : {
"type" : "string",
"description" : "An xDR owner entity. One of the following: Customer; Account"
},
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the xDR record"
}
}
},
"ArrayOfAccessObjectPermission" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccessObjectPermission"
}
},
"UploadDestResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 for success, exception on failure"
}
}
},
"DeleteVDTopupOptionResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 – The topup option is successfully deleted; 0 – The topup option is not deleted"
}
}
},
"UAGetUAProfileMetaInfoRequest" : {
"required" : [
"i_ua_profile"
],
"type" : "object",
"properties" : {
"group_tabs" : {
"type" : "integer",
"description" : "This flag specifies whether related tabs should be grouped."
},
"i_ua_profile" : {
"type" : "integer",
"description" : "The unique ID of the UA Profile record"
}
}
},
"GetCustomerDIDNumbersResponse" : {
"type" : "object",
"properties" : {
"number_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerDIDNumberInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of records"
}
}
},
"UAPortApplicableServiceInfo" : {
"required" : [
"i_service_type"
],
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The service type"
}
}
},
"ArrayOfTransactionActions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TransactionActionInfo"
}
},
"AddUpdateRoamingProfileResponse" : {
"required" : [
"i_roaming_profile"
],
"type" : "object",
"properties" : {
"i_roaming_profile" : {
"type" : "integer",
"description" : "The unique ID of the roaming profile"
}
}
},
"UploadMeasuredMetricDataResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 in case of failure"
}
}
},
"ArrayOfWebLogInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/WebLogInfo"
}
},
"GetCustomerAbbreviatedDialingNumberListRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"DeleteAsyncRequestListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation has been successful"
}
}
},
"UpdateVendorAccountResponse" : {
"type" : "object",
"properties" : {
"i_vendor_acc" : {
"type" : "integer",
"description" : "The unique ID of the vendor account record"
}
}
},
"GetDIDGroupListRequest" : {
"type" : "object",
"properties" : {
"get_did_total_usage" : {
"type" : "integer",
"description" : "Get the usage of DID numbers for every DID group in list"
},
"name" : {
"type" : "string",
"description" : "The name of the DID group"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved DID groups"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"description" : {
"type" : "string",
"description" : "DID group description"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"AddTimePeriodResponse" : {
"required" : [
"i_offpeak"
],
"type" : "object",
"properties" : {
"i_offpeak" : {
"type" : "integer",
"description" : "The unique ID of the time period"
}
}
},
"GetCallBarringClassInfoResponse" : {
"type" : "object",
"properties" : {
"call_barring_class_info" : {
"$ref" : "#/components/schemas/CallBarringClassInfo"
}
}
},
"DeleteVendorRequest" : {
"required" : [
"i_vendor"
],
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of vendor record"
}
}
},
"TaxationOptionsGST" : {
"type" : "object",
"properties" : {
"certificate" : {
"type" : "string",
"description" : "The relief certificate code that applies a 0% tax to goods"
},
"transaction_codes" : {
"$ref" : "#/components/schemas/ArrayOfTransactionCodes"
},
"expiration_date" : {
"type" : "string",
"description" : "Indicates when the relief certificate expires"
},
"goods" : {
"type" : "string",
"description" : "The goods that fall under the relief certificate with the 0% tax"
}
}
},
"GetCustomRTTicketsListRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"priority" : {
"type" : "integer",
"description" : "Ticket priority"
},
"last_updated" : {
"type" : "string",
"description" : "Last date when ticket has been updated"
},
"subject" : {
"type" : "string",
"description" : "Ticket subject"
},
"status" : {
"type" : "string",
"description" : "Ticket status"
},
"created" : {
"type" : "string",
"description" : "Ticket creation time"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved tickets"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"id" : {
"type" : "integer",
"description" : "Ticket number"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetPaymentMethodsForOwnerRequest" : {
"type" : "object",
"properties" : {
"i_owner" : {
"type" : "integer",
"description" : "The unique ID of the entity (e.g. i_account, i_customer). Used to get results for another entity"
},
"owner_type" : {
"type" : "string",
"description" : "A symbolic title of system entity. Used when calling entity wants to get result for other entity. Possible values: 'Customer', 'Account'"
}
}
},
"GetIPTVServicePackageListRequest" : {
"type" : "object"
},
"GetCCStaffListRequest" : {
"type" : "object",
"properties" : {
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved CC staff records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"login" : {
"type" : "integer",
"description" : "A login pattern"
}
}
},
"GetProductSubscriptionsResponse" : {
"type" : "object",
"properties" : {
"subscriptions" : {
"$ref" : "#/components/schemas/ArrayOfProductSubscriptionInfo"
}
}
},
"ArrayOfCustomerClassNotificationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerClassNotificationInfo"
}
},
"GetOwnerBatchInfoResponse" : {
"type" : "object",
"properties" : {
"owner_batch_info" : {
"$ref" : "#/components/schemas/DIDOwnerBatchInfo"
}
}
},
"GetRoutingCriteriaListResponse" : {
"type" : "object",
"properties" : {
"routing_criteria_list" : {
"$ref" : "#/components/schemas/ArrayOfRoutingCriteriaInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"OverrideTariffInfo" : {
"type" : "object",
"properties" : {
"i_tariff_original" : {
"type" : "integer",
"description" : "The unique ID of the original tariff"
},
"original_tariff_name" : {
"type" : "string",
"description" : "The original tariff name"
},
"i_tariff_override" : {
"type" : "integer",
"description" : "The unique ID of the override tariff"
},
"override_tariff_name" : {
"type" : "string",
"description" : "The override tariff name"
},
"i_customer_override_tariff" : {
"type" : "integer",
"description" : "The unique override tariff rule ID. This field is only used for update request"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"TrafficProfileInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Shows whether the traffic profile is in use"
},
"dest_group_set_name" : {
"type" : "string",
"description" : "The destination group set name assigned to the traffic profile. Filled when the 'with_extended_info' field in the method info is equal to 1"
},
"name" : {
"type" : "string",
"description" : "The name of the traffic profile"
},
"iso_4217" : {
"type" : "string",
"description" : "The currency of the traffic profile"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
},
"description" : {
"type" : "string",
"description" : "The description of the traffic profile"
},
"spending_constraint_info" : {
"$ref" : "#/components/schemas/SpendingConstraintInfo"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The identifier of the traffic profile destination group set"
},
"is_draft" : {
"type" : "integer",
"description" : "Shows whether the traffic profile is configured or is a draft profile"
},
"i_customer" : {
"type" : "integer",
"description" : "The identifier of the traffic profile owner"
},
"customer_name" : {
"type" : "string",
"description" : "The name of the customer who owns the traffic profile. Filled when the 'with_extended_info' field in the method info is equal to 1"
}
}
},
"OliInfo" : {
"type" : "object",
"properties" : {
"i_oli" : {
"type" : "integer",
"description" : "The unique ID of the OLI record"
},
"oli" : {
"type" : "integer",
"description" : "The OLI value"
},
"description" : {
"type" : "string",
"description" : "The OLI description"
}
}
},
"FollowMeInfo" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account database record"
},
"sequence" : {
"type" : "string",
"description" : "Order of use of numbers: Order - as listed, Random - random order, Simultaneous - all at once"
},
"mode" : {
"type" : "string",
"description" : "Deprecated: See Using Service Feature Methods to Change FollowMe Settings in the Appendix"
},
"timeout" : {
"type" : "integer",
"description" : "Timeout, in seconds"
},
"i_follow_me" : {
"type" : "integer",
"description" : "The unique ID of the follow-me database record"
},
"max_forwards" : {
"type" : "integer",
"description" : "For follow-me or advanced call forwarding, you must also provide a value for the Maximum Forwards parameter, so as to limit the number of concurrently active forwarding destinations allowed. Please note that you do not have to limit the total number of phone numbers entered, but rather the number of phone numbers active at any given moment of time. For instance, a user may have a list of 20 numbers, each active in its own time period, some temporarily turned off, and so on. When call forwarding is done, PortaBillingwill compute a list of numbers which may be used at that moment, and choose only the first N in the list, where N is the number specified here. The maximum value is 99"
}
}
},
"GetRequestListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
},
"porting_request_list" : {
"$ref" : "#/components/schemas/ArrayOfPortingRequestInfo"
}
}
},
"GetRateListRequest" : {
"required" : [
"limit",
"offset",
"i_tariff"
],
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "The ISO 3166 two-letter country code"
},
"discontinued" : {
"type" : "string",
"description" : "Indicates that rate is discontinued"
},
"network" : {
"type" : "string",
"description" : "The name of the mobile network"
},
"destination" : {
"type" : "string",
"description" : "The pattern of the destination prefix"
},
"extended_info" : {
"type" : "integer",
"description" : "Specifies whether to get extended information like destination group for the rates"
},
"effective_from" : {
"type" : "string",
"description" : "The filter that allows viewing rates depending on their Effective From date. One of the following: 'before', 'after', 'now', 'all'"
},
"order_by" : {
"type" : "string",
"description" : "Allows to sort the resulting rate list by a specific field"
},
"combined_status" : {
"type" : "integer",
"description" : "\n Indicates that combined status is used for lookup.\n When enabled, the 'y' and 'n' values are allowed for the 'discontinued', 'forbidden' and 'hidden' filters.\n These specify that the logical OR operator is used for the corresponding field when the combined status filter is prepared\n "
},
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the rate download template"
},
"reverse_rating" : {
"type" : "string",
"description" : "Indicates whether rate is marked reverse or not"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved rate data records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property value defined"
},
"country" : {
"type" : "string",
"description" : "Country name"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group DB record"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff; refers to Tariffs table"
},
"complex_ordering" : {
"$ref" : "#/components/schemas/ComplexOrderingList"
},
"effective_at" : {
"type" : "string",
"description" : "The filter enables viewing rates that were, are or will be effective at any date and time. It can work in pair with the 'effective_from' filter to view rates effective before/after the given date and time"
},
"get_simple_info" : {
"type" : "integer",
"description" : "Specifies whether to get simple information for the rates. Filtering and ordering is limited in 'simple' mode"
},
"forbidden" : {
"type" : "string",
"description" : "Indicates that no calls are authorized for the particular destination"
},
"effective_from_datetime" : {
"type" : "string",
"description" : "Return rates with the effective_from value later than the value in the field"
},
"destination_list" : {
"$ref" : "#/components/schemas/ArrayOfRequestDestinationPrefixInfo"
},
"type" : {
"type" : "string",
"description" : "The type of search. One of the following: number, prefix. Default: \"prefix\""
},
"hidden" : {
"type" : "string",
"description" : "Indicates that the rate is excessive and may be omitted when making the list of rates"
},
"order_direction" : {
"type" : "string",
"description" : "Specifies whether to sort the records in a descending or ascending order"
},
"file_format" : {
"type" : "string",
"description" : "This parameter enables the user to get rates in other formats via an attachment. Possible values: 'csv', 'xls', 'xlsx'"
}
}
},
"IptvChannelPackageFilter" : {
"required" : [
"i_channel_package"
],
"type" : "object",
"properties" : {
"i_channel_package" : {
"type" : "integer",
"description" : "Get the IPTV channel package with the specified i_channel_package"
}
}
},
"CallBarringClassInfo" : {
"type" : "object",
"properties" : {
"barred_by_default" : {
"type" : "string",
"description" : "'Y' - to activate this call barring class in an account’s Call barring settings by default"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the call barring class is in use"
},
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of call barring class"
},
"name" : {
"type" : "string",
"description" : "The call barring class name"
},
"number_pattern_list" : {
"$ref" : "#/components/schemas/ArrayOfCBCNumberPatternInfo"
},
"matching_type" : {
"type" : "string",
"description" : "The mode of number selection for the call barring class. Possible values: 'excluding' - bar numbers that do not fit the patterns defined in the number_pattern_list, 'including' - bar numbers that fit the patterns defined in the number_pattern_list"
}
}
},
"DeleteRoamingProfileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 – The roaming profile was deleted. 0 – The roaming profile was not deleted"
}
}
},
"ArrayOfServicePolicyInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServicePolicyInfo"
}
},
"DestinationAddUpdateCSetGroupRequest" : {
"required" : [
"dest_group_info"
],
"type" : "object",
"properties" : {
"dest_group_info" : {
"$ref" : "#/components/schemas/RawDestinationGroupInfo"
}
}
},
"PortingRequestParameterInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "Value, porting request parameter specific"
},
"is_editable" : {
"type" : "integer",
"description" : "Value of porting request parameter that can be modified"
},
"name" : {
"type" : "string",
"description" : "Name of the porting request parameter"
},
"is_advanced" : {
"type" : "integer",
"description" : "Porting request parameter for advanced users"
}
}
},
"GetCodecConverterFileListRequest" : {
"required" : [
"handler"
],
"type" : "object",
"properties" : {
"i_owner" : {
"type" : "integer",
"description" : "The unique identifier of the owner"
},
"handler" : {
"type" : "string",
"description" : "The handler name"
},
"owner_type" : {
"type" : "string",
"description" : "The owner type"
}
}
},
"DisableApiNotificationsAccountRequest" : {
"required" : [
"event"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"i_ivr_an" : {
"type" : "integer",
"description" : "The unique ID of the IVR access number"
},
"event" : {
"type" : "string",
"description" : "The event name"
}
}
},
"AddAccessRoleRequest" : {
"required" : [
"access_role_info"
],
"type" : "object",
"properties" : {
"access_role_info" : {
"$ref" : "#/components/schemas/AccessRoleInfo"
}
}
},
"GetCodecListResponse" : {
"type" : "object",
"properties" : {
"codec_list" : {
"$ref" : "#/components/schemas/ArrayOfCodecInfo"
}
}
},
"AddUpdateFollowMeNumberListResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Follow-Me numbers are saved and valid"
}
}
},
"DIDNumberInfo" : {
"type" : "object",
"properties" : {
"iso_4217" : {
"type" : "string",
"description" : "ISO 4217 code of the currency"
},
"vendor_name" : {
"type" : "string",
"description" : "The name of the vendor who owns the DID Number"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account this number was assigned to"
},
"city_name" : {
"type" : "string",
"description" : "The area that this number belongs to"
},
"vendor_batch_name" : {
"type" : "string",
"description" : "Name of the vendor batch this number belongs to"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the DID number is in use"
},
"free_of_charge" : {
"type" : "string",
"description" : "Indicates whether this number is completely free of charge or not"
},
"i_did_number" : {
"type" : "integer",
"description" : "The unique ID of the DID number record"
},
"country_name" : {
"type" : "string",
"description" : "Name of the country that this number belongs to"
},
"released" : {
"type" : "string",
"description" : "Date and time when the number was de-assigned from an account (account was terminated or its id changed)"
},
"description" : {
"type" : "string",
"description" : "DID number description"
},
"i_reseller_group" : {
"type" : "integer",
"description" : "The unique ID of the reseller DID group"
},
"i_dv_batch" : {
"type" : "integer",
"description" : "ID of the vendor batch this DID belongs to"
},
"i_ivr_an" : {
"type" : "integer",
"description" : "The ID of the IVR access number this DID is assigned to"
},
"reseller_name" : {
"type" : "string",
"description" : "The name of the reseller that can manage this DID number"
},
"assigned" : {
"type" : "string",
"description" : "Date and time when the number was assigned to an account"
},
"reserved_stamp" : {
"type" : "string",
"description" : "Date and time when this number was reserved"
},
"reserved" : {
"type" : "string",
"description" : "Date and time when this number was reserved"
},
"customer_name" : {
"type" : "string",
"description" : "The name of the customer who owns the DID Number"
},
"activation_fee" : {
"type" : "number",
"description" : "A one-time amount paid to the vendor for the DID number activation"
},
"activation_cost" : {
"type" : "number",
"description" : "A one-time amount paid by the API method caller for the activation of the DID number"
},
"number" : {
"type" : "string",
"description" : "DID number"
},
"estimated_cost_list" : {
"$ref" : "#/components/schemas/ArrayOfEstimatedDIDNumberPricingParameterInfo"
},
"i_group" : {
"type" : "integer",
"description" : "The unique ID of the DID group"
},
"owner_batch_individual" : {
"type" : "string",
"description" : "Shows whether the related DID pricing batch is individual"
},
"recurring_cost" : {
"type" : "number",
"description" : "A monthly amount paid by the API method caller for using this DID number"
},
"activation_revenue" : {
"type" : "number",
"description" : "A one-time amount paid to the API method caller for the activation of the DID number"
},
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the DID pricing batch"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor who owns the DID Number"
},
"group_name" : {
"type" : "string",
"description" : "The name of the DID group to which this number belongs"
},
"moved" : {
"type" : "string",
"description" : "Indicates whether the number was moved to a different env/system"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who owns the DID Number"
},
"recurring_revenue" : {
"type" : "number",
"description" : "A monthly amount paid to the API method caller for using this DID number"
},
"external" : {
"type" : "integer",
"description" : "Shows whether the DID number is received from an external DID provider (like DIDx/DIDww)"
},
"reseller_group_name" : {
"type" : "string",
"description" : "The name of the reseller DID group to which this number belongs"
},
"frozen" : {
"type" : "string",
"description" : "Indicates whether this number is frozen or not"
},
"country_iso" : {
"type" : "string",
"description" : "The country that this number belongs to; two-letter country code (ISO 3166-1 alpha-2)"
},
"periodic_fee" : {
"type" : "number",
"description" : "A monthly amount charged by the vendor for the provisioned DID number"
},
"owner_batch_name" : {
"type" : "string",
"description" : "Name of the owner batch this number belongs to"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer who owns the DID number"
}
}
},
"UpdateCustomFieldRequest" : {
"required" : [
"custom_field_info"
],
"type" : "object",
"properties" : {
"custom_field_info" : {
"$ref" : "#/components/schemas/CustomFieldsInfo"
}
}
},
"ArrayOfTransactionCodes" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TransactionCodes"
}
},
"AccessPolicyInfo" : {
"type" : "object",
"properties" : {
"i_service_policy" : {
"type" : "integer",
"description" : "The unique ID of the Service Policy. The field is applicable only to the get_access_policy_info() and get_access_policy_list() methods"
},
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the related service type. The field is applicable only to the get_access_policy_info() and get_access_policy_list() methods"
},
"access_phases" : {
"$ref" : "#/components/schemas/ArrayOfAccessPolicyPhaseInfo"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the access policy is used. The field is applicable only to the get_access_policy_info() and get_access_policy_list() methods"
},
"hotline_ip" : {
"type" : "string",
"description" : "Redirect user to this IP if 'hotline condition' is true"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who owns the Access Policy"
},
"name" : {
"type" : "string",
"description" : "The name of the Access Policy"
},
"hotline_condition" : {
"type" : "string",
"description" : "In what case user should be redirected to the 'hotline_url' or 'hotline_ip'. Possible values: Off, Funds, Denied, Always"
},
"description" : {
"type" : "string",
"description" : "The Access Policy description"
},
"i_access_policy" : {
"type" : "integer",
"description" : "The unique ID of the Access Policy"
},
"hotline_url" : {
"type" : "string",
"description" : "Redirect user to this URL if 'hotline condition' is true"
},
"attributes" : {
"$ref" : "#/components/schemas/ArrayOfServicePolicyAttributeValues"
}
}
},
"GetTemplateListResponse" : {
"type" : "object",
"properties" : {
"template_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved templates"
}
}
},
"ArrayOfExemptionCodes" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ExemptionCodeInfo"
}
},
"ArrayOfBalanceWarningThresholds" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BalanceWarningThreshold"
}
},
"UpdateNegotiatedFeatureListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"CQInfo" : {
"type" : "object",
"properties" : {
"average_duration" : {
"type" : "integer",
"description" : "The average expected processing time in minutes for each call (used to calculate the estimated waiting time)"
},
"intro_prompt" : {
"type" : "string",
"description" : "SOAP attachment name to be used as intro announcement for the call queue. The first attachment is used if this property is not defined"
},
"announce_estimated_wait_time" : {
"type" : "string",
"description" : "Specifies whether the announcement of the current estimated waiting time in the call queue is enabled"
},
"incoming_capacity" : {
"type" : "integer",
"description" : "The maximum number of calls that can be placed on hold within this queue"
},
"intro_prompt_action" : {
"type" : "string",
"description" : "One of the following: set - Sets MoH for the queue; unset - Removes MoH if it is already set"
},
"moh" : {
"type" : "string",
"description" : "SOAP attachment name to be used as MoH for the queue. The first attachment is used if this property is not defined"
},
"moh_action" : {
"type" : "string",
"description" : "One of the following: set - Sets MoH for the queue; unset - Removes MoH if it is already set"
},
"i_moh" : {
"type" : "integer",
"description" : "The unique ID for the \"music on hold\" record used for this call queue. Refers to the Audio_Files table. Corresponding binary files can be downloaded using the Customer.get_prompt_file method"
},
"group_name" : {
"type" : "string",
"description" : "The name of the huntgroup the call queue is configured for"
},
"announcement_interval" : {
"type" : "integer",
"description" : "Announcement replay interval (in minutes)"
},
"i_c_queue" : {
"type" : "integer",
"description" : "The unique ID of the call queue record"
},
"capacity" : {
"type" : "integer",
"description" : "The maximum number of calls in the call queue"
},
"group_id" : {
"type" : "string",
"description" : "The number (destination) of the huntgroup the call queue is configured for"
},
"i_intro_prompt" : {
"type" : "integer",
"description" : "The unique ID of the audio file to be used as intro announcement for the call queue. Refers to the Audio_Files table. Corresponding binary files can be downloaded using the Customer.get_prompt_file method"
},
"moh_file_name" : {
"type" : "string",
"description" : "Saved MoH file name"
},
"i_c_group" : {
"type" : "integer",
"description" : "The unique ID of the huntgroup record the call queue is configured for"
},
"announce_number_of_callers" : {
"type" : "string",
"description" : "Specifies whether the announcement of the current number of callers in the call queue is enabled"
}
}
},
"CommitmentOneTimeTermInfo" : {
"type" : "object",
"properties" : {
"i_commitment" : {
"type" : "integer",
"description" : "The identifier of the commitment record"
},
"discount_amount" : {
"type" : "number",
"description" : "The discount amount to apply to the full fee"
},
"i_service" : {
"type" : "integer",
"description" : "The identifier of the service that will be used for the charge xdr"
},
"fee" : {
"type" : "number",
"description" : "The full one-time fee to charge"
},
"i_one_time_term" : {
"type" : "integer",
"description" : "The unique identifier of the commitment one-time term"
},
"description" : {
"type" : "string",
"description" : "The description of the term that will be used as the description of the created charge xdr"
}
}
},
"GetProviderInfoRequest" : {
"type" : "object",
"properties" : {
"did_provider_info" : {
"$ref" : "#/components/schemas/CustomerDIDProviderIdent"
}
}
},
"DeleteIvrApplicationRequest" : {
"required" : [
"i_voice_app_access_number"
],
"type" : "object",
"properties" : {
"i_voice_app_access_number" : {
"type" : "integer",
"description" : "The unique ID of the IVR access number"
}
}
},
"CPPeriodInfo" : {
"required" : [
"periods",
"commission"
],
"type" : "object",
"properties" : {
"periods" : {
"type" : "integer",
"description" : "The boundary number of the period for which the commission is effective"
},
"i_cp_period" : {
"type" : "integer",
"description" : "The unique ID of the commission plan period"
},
"commission" : {
"type" : "number",
"description" : "The commission used for period of the commission plan"
}
}
},
"AddCustomFieldRequest" : {
"required" : [
"custom_field_info"
],
"type" : "object",
"properties" : {
"custom_field_info" : {
"$ref" : "#/components/schemas/CustomFieldsInfo"
}
}
},
"AddExternalTemplateRequest" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Template name"
},
"custom_description" : {
"type" : "string",
"description" : "Template description"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller"
}
}
},
"ProcessCollectionRequest" : {
"required" : [
"collection_list"
],
"type" : "object",
"properties" : {
"collection_list" : {
"$ref" : "#/components/schemas/ArrayOfXDRCollectionInfo"
}
}
},
"ProductCloneProductRequest" : {
"required" : [
"name",
"i_parent_product"
],
"type" : "object",
"properties" : {
"i_account_role" : {
"type" : "integer",
"description" : "The unique ID of the account role; refers to the Account_Roles table. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a topup voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID"
},
"name" : {
"type" : "string",
"description" : "The name of the product"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for product currency"
},
"clone_subscriptions" : {
"type" : "string",
"description" : "The flag shows whether to clone subscriptions. Possible values: 'Y', 'N'"
},
"ex_rate" : {
"type" : "number",
"description" : "The multiplier for cloned rates"
},
"clone_tariffs" : {
"type" : "string",
"description" : "The flag shows whether to clone tariffs. Possible values: 'Y', 'N'"
},
"clone_rates" : {
"type" : "string",
"description" : "The flag shows whether to clone rates. Possible values: 'Y', 'N'"
},
"clone_discount_plan" : {
"type" : "string",
"description" : "The flag shows whether to clone discount plan. Possible values: 'Y', 'N'"
},
"i_customer" : {
"type" : "integer",
"description" : "The ID of the reseller"
},
"i_parent_product" : {
"type" : "integer",
"description" : "The ID of the product to be cloned"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The ID of the volume discount plan"
}
}
},
"GetAllowedLocationListResponse" : {
"type" : "object",
"properties" : {
"allowed_location_list" : {
"$ref" : "#/components/schemas/ArrayOfAllowedLocationInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved records"
}
}
},
"GetIPTVChannelPackageListResponse" : {
"required" : [
"package_list"
],
"type" : "object",
"properties" : {
"package_list" : {
"$ref" : "#/components/schemas/ArrayOfIPTVChannelPackage"
}
}
},
"AddUpdateCustomerMetricResponse" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"AccessRoleTypeInfo" : {
"type" : "object",
"properties" : {
"i_role_type" : {
"type" : "integer",
"description" : "The identifier of the access role type"
},
"name" : {
"type" : "string",
"description" : "The name of the access role type"
},
"metadata" : {
"$ref" : "#/components/schemas/AccessComponentPermission"
}
}
},
"GetXrateListResponse" : {
"type" : "object",
"properties" : {
"exchange_rate_list" : {
"$ref" : "#/components/schemas/XrateList"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved exchange rate data records"
}
}
},
"GetCommitmentInfoRequest" : {
"required" : [
"i_commitment"
],
"type" : "object",
"properties" : {
"i_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the commitment record"
},
"check_usage" : {
"type" : "integer",
"description" : "Flag specifies whether it is necessary to check if the commitment is assigned to one account at least"
}
}
},
"LoginToRealmResponse" : {
"required" : [
"session_id"
],
"type" : "object",
"properties" : {
"session_id" : {
"type" : "string",
"description" : "The unique ID of the newly opened session"
}
}
},
"DeleteNotificationPresetRequest" : {
"required" : [
"i_notification_preset"
],
"type" : "object",
"properties" : {
"i_notification_preset" : {
"type" : "integer",
"description" : "The unique identifier of the notification preset"
}
}
},
"DiscountPlanInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Shows whether the discount plan is used or not"
},
"reset_period" : {
"type" : "string",
"description" : "The discount plan lifetime period"
},
"dest_group_set_name" : {
"type" : "string",
"description" : "The destination group set name"
},
"iso_4217" : {
"type" : "string",
"description" : "The volume discount plan currency"
},
"managed_by" : {
"type" : "string",
"description" : "The name of the customer who manages the volume discount plan"
},
"name" : {
"type" : "string",
"description" : "The volume discount plan name"
},
"description" : {
"type" : "string",
"description" : "A description of this volume discount plan"
},
"destination_lookup" : {
"type" : "string",
"description" : "Destination lookup strategy"
},
"is_complete" : {
"type" : "integer",
"description" : "Shows whether the discount plan is complete and ready for assigning to other entities"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set associated with this discount plan"
},
"shared" : {
"type" : "string",
"description" : "Shows whether the discount plan managed by the administrator is available to resellers"
},
"is_used_by_resellers" : {
"type" : "integer",
"description" : "Shows whether the shared discount plan is used by resellers"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer to whom the volume discount plan record is assigned"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan"
}
}
},
"SetAccountStateRequest" : {
"required" : [
"i_account",
"value"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"service_type" : {
"type" : "string",
"description" : "The name of the service type. Possible values: INTERNAL, SESSION, VOICE, DATA, NETACCESS, QUANTITY, WIFI, DIALUP, MSG, CONFERENCE. This property is mandatory if i_acc_state_type is not specified"
},
"i_acc_state_type" : {
"type" : "integer",
"description" : "The unique ID of the account state type: 1 – voice_fraud_suspicion This property is mandatory if state_name and service_type are not specified"
},
"state_name" : {
"type" : "string",
"description" : "The name of the account state type. Possible value: voice_fraud_suspicion service_type. This property is mandatory if i_acc_state_type is not specified"
},
"value" : {
"type" : "integer",
"description" : "The state of the account. Possible values: 0 – ACTIVE; 1 – SCREENED – Allow calls only via the Screening IVR; 2 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user once; 3 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user twice; 4 – SCREENED – Allow calls only via the Screening IVR. A caller failed to validate that they are an authorized user three times; 5 – QUARANTINED – Disallow all calls"
},
"notify_users" : {
"type" : "integer",
"description" : "Specifies whether the state change notification should be triggered for administrators (the notification for customers is always triggered)."
}
}
},
"DeleteMeasuredMetricRequest" : {
"required" : [
"i_measured_metric"
],
"type" : "object",
"properties" : {
"i_measured_metric" : {
"type" : "integer",
"description" : "The unique ID of the measured metric"
}
}
},
"GetRPConnectionInfoRequest" : {
"required" : [
"i_rp_connection"
],
"type" : "object",
"properties" : {
"i_rp_connection" : {
"type" : "integer",
"description" : "The unique ID of a custom routing record"
}
}
},
"UpdateCommissionPlanRequest" : {
"required" : [
"commission_plan_info"
],
"type" : "object",
"properties" : {
"commission_plan_info" : {
"$ref" : "#/components/schemas/CommissionPlanInfo"
}
}
},
"UpdateCPRuleResponse" : {
"required" : [
"i_cp_rule"
],
"type" : "object",
"properties" : {
"i_cp_rule" : {
"type" : "integer",
"description" : "The unique ID of the call screening rule record"
}
}
},
"ServicePolicyAttributeInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"group_name" : {
"type" : "string",
"description" : "The name used to group service policy attributes"
},
"name" : {
"type" : "string",
"description" : "The name of the service policy attribute"
},
"possible_values" : {
"$ref" : "#/components/schemas/ArrayOfServicePolicyAttributePossibleValue"
},
"i_sp_attribute" : {
"type" : "integer",
"description" : "The unique ID of the service policy attribute"
},
"value_type" : {
"type" : "string",
"description" : "The type of attribute value"
},
"multiple" : {
"type" : "string",
"description" : "Indicates whether multiple value entries are allowed"
},
"default_values" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"GetInvoiceStatusInfoResponse" : {
"type" : "object",
"properties" : {
"status_info" : {
"$ref" : "#/components/schemas/InvoiceStatusInfo"
}
}
},
"MakeRepresentativeTransactionRequest" : {
"required" : [
"i_rep",
"amount",
"action"
],
"type" : "object",
"properties" : {
"i_service" : {
"type" : "integer",
"description" : "The service for which the manual charge is made"
},
"i_rep" : {
"type" : "integer",
"description" : "The unique ID of the representative record"
},
"internal_comment" : {
"type" : "string",
"description" : "An internal comment on this transaction; not visible in the xDR browser and accessible only directly from the database"
},
"visible_comment" : {
"type" : "string",
"description" : "A comment on this transaction that is visible in the xDR browser"
},
"amount" : {
"type" : "number",
"description" : "The amount the representative's balance will be increased/decreased by"
},
"transaction_date" : {
"type" : "string",
"description" : "A date and time associated with the transaction. For example, you can specify a date for transaction action for when an item is charged"
},
"action" : {
"type" : "string",
"description" : "One of the following: manual charge, manual payment"
},
"i_customer" : {
"type" : "integer",
"description" : "The ID of the customer to whom the representative is assigned"
}
}
},
"MakeTransferRequest" : {
"required" : [
"i_account",
"output_currency",
"destination",
"product"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account. Not mandatory when the method that requires this structure is executed from the account realm"
},
"output_currency" : {
"type" : "string",
"description" : "The currency in the destination country"
},
"destination" : {
"type" : "string",
"description" : "The destination number"
},
"operator_id" : {
"type" : "integer",
"description" : "The unique ID of the destination mobile network"
},
"product" : {
"type" : "string",
"description" : "The amount to be added to the balance of the mobile recipient for this remittance transaction"
}
}
},
"MarkXdrOutOfTurnRequest" : {
"required" : [
"i_xdr"
],
"type" : "object",
"properties" : {
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the XDR record"
}
}
},
"AddEmergencyUnitRequest" : {
"required" : [
"emergency_unit_info"
],
"type" : "object",
"properties" : {
"emergency_unit_info" : {
"$ref" : "#/components/schemas/EmergencyUnitInfo"
}
}
},
"UserInfoList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UserInfo"
}
},
"GlobalCurrencyInfoList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/GlobalCurrencyInfo"
}
},
"GetDIDCountriesListResponse" : {
"type" : "object",
"properties" : {
"countries_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDCountryInfo"
}
}
},
"CancelRequestRequest" : {
"required" : [
"i_request"
],
"type" : "object",
"properties" : {
"i_request" : {
"type" : "integer",
"description" : "The unique ID of the number porting request"
}
}
},
"RequestDestinationPrefixInfo" : {
"type" : "object",
"properties" : {
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination prefix record"
}
}
},
"MetricFilterInfo" : {
"required" : [
"value",
"name"
],
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The value of the filter field"
},
"name" : {
"type" : "string",
"description" : "A tag name. Data points that have the same tag value will be grouped together. Possible values: connection - for connection metrics; cc_staff - for CC staff metrics; ip - for PSMSC metrics"
}
}
},
"GetAccountAliasListResponse" : {
"type" : "object",
"properties" : {
"alias_list" : {
"$ref" : "#/components/schemas/ArrayOfAliasInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved aliases"
}
}
},
"UpdateCallBarringClassResponse" : {
"required" : [
"i_cp_condition"
],
"type" : "object",
"properties" : {
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the call barring class"
}
}
},
"ProvisionDIDResponse" : {
"type" : "object",
"properties" : {
"did_order_info" : {
"$ref" : "#/components/schemas/DIDNumberOrderInfo"
}
}
},
"GetUserNotificationListResponse" : {
"required" : [
"total"
],
"type" : "object",
"properties" : {
"notification_list" : {
"$ref" : "#/components/schemas/ArrayOfNotificationInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved notification records"
}
}
},
"ScheduleCommitmentRecordReplacementRequest" : {
"required" : [
"account_commitment_replacement_info"
],
"type" : "object",
"properties" : {
"account_commitment_replacement_info" : {
"$ref" : "#/components/schemas/ScheduledCommitmentReplacementInfo"
}
}
},
"UploadMOHFileRequest" : {
"required" : [
"object",
"name",
"i_object"
],
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The type of entity (account/customer) to which the MOH file is applied"
},
"name" : {
"type" : "string",
"description" : "MOH record name"
},
"i_object" : {
"type" : "integer",
"description" : "The unique ID of an account or a customer"
}
}
},
"AddRateGroupRequest" : {
"required" : [
"rate_info",
"i_dest_group"
],
"type" : "object",
"properties" : {
"rate_info" : {
"$ref" : "#/components/schemas/RateInfo"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
}
}
},
"CustomerInvoicesSummary" : {
"type" : "object",
"properties" : {
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for customer’s currency"
},
"last_payment_amount" : {
"type" : "number",
"description" : "The amount of the last payment applied to an invoice"
},
"overdue_balance" : {
"type" : "number",
"description" : "The amount which is overdue"
},
"last_payment_date" : {
"type" : "string",
"description" : "The date of the last payment applied to an invoice"
},
"last_amount_due" : {
"type" : "number",
"description" : "The amount due of the last invoice issued"
},
"outstanding_balance" : {
"type" : "number",
"description" : "The outstanding balance"
},
"last_due_date" : {
"type" : "string",
"description" : "The due date of the last invoice issued"
}
}
},
"ArrayOfExtensionsInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ExtensionsInfo"
}
},
"LogoutResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"DeleteCustomerMetricResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 – If success, 0 – In case of failure"
}
}
},
"GetSystemMetricDataResponse" : {
"type" : "object",
"properties" : {
"system_metric_data_list" : {
"$ref" : "#/components/schemas/ArrayOfSystemMetricDataInfo"
}
}
},
"GetDateListRequest" : {
"type" : "object",
"properties" : {
"to" : {
"type" : "string",
"description" : "Get all calendar date records up to and including this date"
},
"from" : {
"type" : "string",
"description" : "Get all calendar date records starting from this date"
},
"type" : {
"type" : "string",
"description" : "Get only calendar date records of a specific type. Possible values: working, non-working"
}
}
},
"UpdateCustomerTaxationResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"MediatorXDRInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The ID of the service type"
},
"error_explanation" : {
"type" : "string",
"description" : "The error explanation message"
},
"cli" : {
"type" : "string",
"description" : "Calling line identification"
},
"status" : {
"type" : "string",
"description" : "The status of the xDR record"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"vendor_name" : {
"type" : "string",
"description" : "The name of the vendor"
},
"vendor_charge" : {
"type" : "number",
"description" : "An amount of money of the vendor charge in currency units"
},
"i_account" : {
"type" : "integer",
"description" : "The ID of the account"
},
"service_name" : {
"type" : "string",
"description" : "The name of the service"
},
"connect_time" : {
"type" : "string",
"description" : "Time when connection was initiated"
},
"service_type_name" : {
"type" : "string",
"description" : "The name of the service type"
},
"xdr_id" : {
"type" : "string",
"description" : "The ID of the xDR record"
},
"service_units" : {
"type" : "string",
"description" : "The service type charge units"
},
"i_vendor" : {
"type" : "integer",
"description" : "The ID of the vendor"
},
"customer_charge" : {
"type" : "number",
"description" : "An amount of money of the customer charge in currency units"
},
"customer_currency" : {
"type" : "string",
"description" : "ISO 4217 code for currency of the customer"
},
"user_name" : {
"type" : "string",
"description" : "The name of the user"
},
"charged_quantity" : {
"type" : "integer",
"description" : "A number of used service units"
},
"i_customer" : {
"type" : "integer",
"description" : "The ID of the customer"
},
"vendor_currency" : {
"type" : "string",
"description" : "ISO 4217 code for currency of the vendor"
},
"cld" : {
"type" : "string",
"description" : "Calling line destination"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The ID of the billing session"
},
"customer_name" : {
"type" : "string",
"description" : "The name of the customer"
}
}
},
"AddUpdateCommitmentRequest" : {
"required" : [
"commitment_info"
],
"type" : "object",
"properties" : {
"commitment_info" : {
"$ref" : "#/components/schemas/CommitmentInfo"
}
}
},
"ArrayOfDIDRequestParametersInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DIDRequestParameters"
}
},
"DeleteProductRequest" : {
"required" : [
"i_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
}
}
},
"UploadDIDNumbersResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"ArrayOfServicePolicyAttributeValues" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServicePolicyAttributeValues"
}
},
"TestTariffRatingResponse" : {
"type" : "object",
"properties" : {
"announced_credit_quantity" : {
"type" : "string",
"description" : "The announced calculated amount of service units that can be used for the entered \"available_funds\". Works only for test mode \"2\""
},
"unit_amount" : {
"type" : "number",
"description" : "The amount of service units for which the charged amount was calculated. Works only for test mode \"1\""
},
"announced_charge_history" : {
"type" : "string",
"description" : "A short description of how the announced result values were calculated. Works only for test mode \"2\""
},
"charge_history" : {
"type" : "string",
"description" : "A short description of how the result values were calculated"
},
"credit_quantity" : {
"type" : "string",
"description" : "The calculated amount of service units that can be used for the entered \"available_funds\". Works only for test mode \"2\""
},
"formula" : {
"type" : "string",
"description" : "The rating formula used for the given destination"
},
"charged_amount" : {
"type" : "number",
"description" : "The amount of money that would be charged for the entered \"unit_quantity\". Works only for test mode \"1\""
},
"expanded_formula" : {
"type" : "string",
"description" : "The rating formula with the real interval and price values"
}
}
},
"GetCustomerClassNotificationListResponse" : {
"required" : [
"total"
],
"type" : "object",
"properties" : {
"notification_list" : {
"$ref" : "#/components/schemas/ArrayOfNotificationInfo"
},
"total" : {
"type" : "integer",
"description" : "The total amount of notifications"
}
}
},
"MakeAccountTransactionRequest" : {
"required" : [
"i_account",
"amount",
"action"
],
"type" : "object",
"properties" : {
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the Service record; refers to the Services table"
},
"save_card" : {
"type" : "string",
"description" : "Indicates whether the supplied payment method should be saved as preferred"
},
"date_inside_billing_period" : {
"type" : "string",
"description" : "A date associated with the manual charge/credit transaction. For example, you can specify a date for a manual credit transaction for when an account was credited"
},
"datetime_inside_billing_period" : {
"type" : "string",
"description" : "A date and time associated with the manual charge/credit. For example, you can specify a date for manual credit action for when an item is credited"
},
"internal_comment" : {
"type" : "string",
"description" : "An internal comment on this transaction; not visible in the xDR browser, and accessible only directly from the database"
},
"suppress_notification" : {
"type" : "integer",
"description" : "1 - do not send email notifications to the customer, 0 - send the notifications"
},
"visible_comment" : {
"type" : "string",
"description" : "A comment on this transaction visible in the xDR browser"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"amount" : {
"type" : "number",
"description" : "Amount by which the customer's balance will increase / decrease. The number of digits depends on the maximum number of decimal places allowed by the currency. Note: for a manual charge transaction applied to a debit account, the amount must not exceed the account's balance"
},
"transaction_id" : {
"type" : "string",
"description" : "Applicable to Capture payment and E-Commerce refund transactions. Must contain the ID of a previously issued Authorization only / E-commerce payment transaction"
},
"card_info" : {
"$ref" : "#/components/schemas/AccountPaymentMethodInfo"
},
"action" : {
"type" : "string",
"description" : "Possible values: Manual Charge, Manual Credit, Manual Payment, Promotional Credit, E-Commerce Payment, E-Commerce Refund, Authorization Only, Capture Payment, Transfer Funds"
},
"h323_conf_id" : {
"type" : "string",
"description" : "Optional tax transaction code that should be applied to transaction"
},
"recipient_id" : {
"type" : "integer",
"description" : "The unique ID of the recipient account record for transactions between accounts"
},
"enable_balance_fraud_protection" : {
"type" : "integer",
"description" : "Indicates whether to perform balance fraud checks to make sure the charged amount never exceeds the available balance"
}
}
},
"GetZendeskTicketListResponse" : {
"type" : "object",
"properties" : {
"zendesk_ticket_list" : {
"$ref" : "#/components/schemas/ArrayOfZendeskTicketInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of retrieved Zendesk tickets"
}
}
},
"AddUpdateOverrideTariffRequest" : {
"type" : "object",
"properties" : {
"override_tariff_info" : {
"$ref" : "#/components/schemas/OverrideTariffInfo"
}
}
},
"GetPresetCategoryListResponse" : {
"type" : "object",
"properties" : {
"category_list" : {
"$ref" : "#/components/schemas/ArrayOfNotificationPresetCategoryInfo"
}
}
},
"AssignDIDToAccountResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 – success, 0 – failed"
}
}
},
"PhoneBookRecInfo" : {
"type" : "object",
"properties" : {
"dial_id" : {
"type" : "string",
"description" : "Abbreviated dial assigned"
},
"favorite_rating" : {
"type" : "string",
"description" : "Flag which indicates is phone record is privillidged record or not (Y, N); default is N"
},
"lock_type" : {
"type" : "string",
"description" : "Lock type of phonebook record (None, Number, Full); default is None"
},
"name" : {
"type" : "string",
"description" : "Contact name"
},
"phone_number" : {
"type" : "string",
"description" : "Contact phone number"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of an account record (used only for adding a new record)"
},
"i_account_phonebook" : {
"type" : "integer",
"description" : "The unique ID of a Phonebook record (used only for updating an existing record)"
},
"phone_type" : {
"type" : "string",
"description" : "Type of phone record (work, home, mobile, other)"
},
"unlock_time" : {
"type" : "string",
"description" : "Time when Phonebook record will be unlocked"
}
}
},
"PaymentProcessor" : {
"type" : "object",
"properties" : {
"processor" : {
"type" : "string",
"description" : "Processor name"
},
"name" : {
"type" : "string",
"description" : "The payment processor name visible to the end-user"
},
"supported_payment_methods" : {
"$ref" : "#/components/schemas/ArrayOfPaymentMethods"
},
"web_link" : {
"type" : "string",
"description" : "Link to the official site"
},
"email_auth" : {
"type" : "string",
"description" : "Shows whether processor requires email authorization or not"
},
"remote_cc_storage" : {
"type" : "string",
"description" : "Shows whether processor supports storing of payment data on its side or not"
},
"obsolete" : {
"type" : "string",
"description" : "Shows whether processor is obsolete or not"
},
"i_online_payment_processor" : {
"type" : "integer",
"description" : "Unique ID of Online_Payment_Processors record"
},
"handler" : {
"type" : "string",
"description" : "Handler page for processors with external authorization"
},
"ext_auth" : {
"type" : "string",
"description" : "Shows whether processor requires external authorization or not"
},
"remittance" : {
"type" : "string",
"description" : "Shows whether processor is remittance or payment"
},
"callback" : {
"type" : "string",
"description" : "Callback page for processors with external authorization"
},
"post_processing" : {
"type" : "string",
"description" : "Shows whether processor post-processing actions or not"
}
}
},
"PreferableAccountInfo" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"firstname" : {
"type" : "string",
"description" : "Account owner's first name"
},
"group_name" : {
"type" : "string",
"description" : "The name used to group frequently used accounts"
},
"id" : {
"type" : "string",
"description" : "ID (PIN) of the account on the PortaBilling interface, unique in the environment"
},
"lastname" : {
"type" : "string",
"description" : "Account owner's last name"
},
"i_preferable_account" : {
"type" : "integer",
"description" : "The unique ID of the frequently used account"
},
"i_owner_account" : {
"type" : "integer",
"description" : "The unique ID of the owner account for a frequently used account"
}
}
},
"ArrayOfCommitmentRecurringTermInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CommitmentRecurringTermInfo"
}
},
"SessionChangePasswordResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "string",
"description" : "1 is case of success, exception error message in case of failure"
}
}
},
"DeleteSubscriptionRequest" : {
"required" : [
"i_subscription"
],
"type" : "object",
"properties" : {
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Plan"
}
}
},
"GetVendorDIDProviderAccountListResponse" : {
"type" : "object",
"properties" : {
"did_provider_account_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDProviderAccountInfo"
}
}
},
"AccountRegisterTransactionRequest" : {
"required" : [
"amount",
"i_payment_method"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "Unique ID of the Account for which a transaction will be registered"
},
"amount" : {
"type" : "number",
"description" : "The amount for payment"
},
"i_payment_method" : {
"type" : "integer",
"description" : "Unique ID of the chosen Payment Method"
}
}
},
"AddVendorBatchResponse" : {
"type" : "object",
"properties" : {
"i_dv_batch" : {
"type" : "integer",
"description" : "The unique ID of the vendor DID batch record"
}
}
},
"BoothInfo" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"calls" : {
"$ref" : "#/components/schemas/ANY"
},
"active_call" : {
"$ref" : "#/components/schemas/ANY"
},
"management_number" : {
"type" : "string",
"description" : "A custom identifier of the account (optional)"
},
"blocked" : {
"type" : "string",
"description" : "Block account's calls"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record to which the account belongs"
},
"id" : {
"type" : "string",
"description" : "ID (PIN) of the account on the PortaBilling interface, unique in the environment"
}
}
},
"GetTrafficProfileInfoRequest" : {
"required" : [
"i_traffic_profile"
],
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the traffic profile is in use"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
},
"with_spending_constraint" : {
"type" : "integer",
"description" : "If the field is equal to 1, the method returns additionally spending constraint info for each traffic profile"
}
}
},
"DeleteUARequest" : {
"required" : [
"i_ua"
],
"type" : "object",
"properties" : {
"i_ua" : {
"type" : "integer",
"description" : "ID of UA record"
}
}
},
"GetNodeTypeListResponse" : {
"type" : "object",
"properties" : {
"node_type_list" : {
"$ref" : "#/components/schemas/ArrayOfNodeTypeInfo"
}
}
},
"MerchantAccount" : {
"type" : "object",
"properties" : {
"available_payment_methods" : {
"$ref" : "#/components/schemas/ArrayOfPaymentMethods"
},
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique ID of the Merchant_Account record"
},
"csc_policy" : {
"type" : "string",
"description" : "Shows whether transactions via merchant require credit card security code or not"
},
"name" : {
"type" : "string",
"description" : "Merchant account name"
},
"remote_cc_storage" : {
"type" : "string",
"description" : "Shows whether the payment information is stored in PortaBilling or not"
},
"test_mode" : {
"type" : "string",
"description" : "Shows whether merchant works in test mode or not"
},
"url_suffix" : {
"type" : "string",
"description" : "An URL suffix required to determine transaction for a processor with post-processing"
},
"login" : {
"type" : "string",
"description" : "Merchant account login"
},
"i_online_payment_processor" : {
"type" : "integer",
"description" : "The unique ID of the Online_Payment_Processor record"
},
"password" : {
"type" : "string",
"description" : "Merchant account password"
},
"assigned_payment_methods" : {
"$ref" : "#/components/schemas/ArrayOfPaymentMethods"
},
"used" : {
"type" : "integer",
"description" : "Shows whether merchant account is used for some currency or not"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the Customer record (reseller)"
}
}
},
"GetChargeMethodsListResponse" : {
"required" : [
"charge_methods_list"
],
"type" : "object",
"properties" : {
"charge_methods_list" : {
"$ref" : "#/components/schemas/ArrayOfChargeMethodsInfo"
}
}
},
"AccountDeleteAccountRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
}
}
},
"BatchDeleteCallRecordingResponse" : {
"required" : [
"success",
"result_list"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 on success, exception on failure"
},
"result_list" : {
"$ref" : "#/components/schemas/ArrayOfBatchDeleteCRStatusInfo"
}
}
},
"TemplateGetTemplateGroupFieldListResponse" : {
"type" : "object",
"properties" : {
"template_group_field_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateGroupFieldList"
}
}
},
"AddSubresellerRequest" : {
"type" : "object",
"properties" : {
"generate_web_password" : {
"type" : "integer",
"description" : "Specifies whether to autogenerate a password for the customer self-care interface. Possible values: 1 - Generate a password; 0 - Do not generate a password"
},
"customer_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
},
"clone_product_list" : {
"$ref" : "#/components/schemas/ArrayOfCloneProductInfo"
},
"clone_tariff_list" : {
"$ref" : "#/components/schemas/ArrayOfCloneTariffInfo"
}
}
},
"UpdateUserNotificationListRequest" : {
"required" : [
"notification_list",
"i_user"
],
"type" : "object",
"properties" : {
"notification_list" : {
"$ref" : "#/components/schemas/ArrayOfUserNotificationInfo"
},
"i_user" : {
"type" : "integer",
"description" : "The ID of the user record"
}
}
},
"ServiceAttributeInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"effective_values" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"name" : {
"type" : "string",
"description" : "Name of the service feature"
},
"values" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"ArrayOfAccessRoleTypeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccessRoleTypeInfo"
}
},
"DisconnectReasonInfo" : {
"required" : [
"disconnect_class",
"disconnect_text",
"disconnect_cause"
],
"type" : "object",
"properties" : {
"disconnect_class" : {
"type" : "string",
"description" : "The human-readable description of the disconnect reason class for the disconnect reason"
},
"disconnect_cause" : {
"type" : "integer",
"description" : "The unique ID of the disconnect reason"
},
"disconnect_text" : {
"type" : "string",
"description" : "The human-readable description of the disconnect reason"
}
}
},
"TriggerEventDataInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The value of the field"
},
"name" : {
"type" : "string",
"description" : "The name of the field"
}
}
},
"GetVendorAccountListRequest" : {
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record this account belongs to"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Works if the API request has the limit property specified"
}
}
},
"GetOverrideTariffListRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record for retrieving the override tariff list"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetXrateListRequest" : {
"type" : "object",
"properties" : {
"only_active" : {
"type" : "integer",
"description" : "Get only active exchange rates"
},
"get_total" : {
"type" : "integer",
"description" : "Get total amount of exchange rates"
},
"iso_4217" : {
"type" : "string",
"description" : "Get only exchange rates for provided iso_4217"
},
"limit" : {
"type" : "integer",
"description" : "Limit of response list"
},
"offset" : {
"type" : "integer",
"description" : "Offset of response list"
}
}
},
"AccessRoleGetMyAccessRolePermissionsRequest" : {
"type" : "object"
},
"ArrayOfAPIMethodFieldInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/APIMethodFieldInfo"
}
},
"TestTimePeriodResponse" : {
"required" : [
"matched_subperiod"
],
"type" : "object",
"properties" : {
"matched_subperiod" : {
"type" : "integer",
"description" : "The number of the matched subperiod"
}
}
},
"ArrayOfMetricInputInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MetricInputInfo"
}
},
"GetCustomerClassNotificationListRequest" : {
"type" : "object",
"properties" : {
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
}
}
},
"UpdateRoutingCriteriaRequest" : {
"required" : [
"routing_criteria_info"
],
"type" : "object",
"properties" : {
"routing_criteria_info" : {
"$ref" : "#/components/schemas/RoutingCriteriaInfo"
}
}
},
"GetTariffListResponse" : {
"type" : "object",
"properties" : {
"tariff_list" : {
"$ref" : "#/components/schemas/ArrayOfTariffInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved tariffs"
}
}
},
"GetEmergencyUnitListRequest" : {
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "A two-letter country code defined in ISO 3166-1 alpha-2"
},
"routing_number_rule" : {
"$ref" : "#/components/schemas/ArrayOfEmergencyUnitRoutingNumberRuleInfo"
},
"emergency_unit_id" : {
"type" : "string",
"description" : "The canonical path of the administrative unit. Delimiter \".\" (dot)"
},
"name" : {
"type" : "string",
"description" : "The name of the emergency administrative unit. The field is unique for \"i_env\" and \"country\""
},
"with_universal" : {
"type" : "integer",
"description" : "If set to \"1\" or more, the list will include universal administrative units"
},
"i_emergency_unit" : {
"type" : "integer",
"description" : "The identifier of the administrative unit"
},
"routing_number" : {
"type" : "string",
"description" : "The (default) routing number, when the cld rule is not specified"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of records to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetNegotiatedFeatureListRequest" : {
"required" : [
"object"
],
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The entity the negotiated features belong to. Possible values: connection, routing_plan"
},
"i_object" : {
"type" : "integer",
"description" : "The unique ID of a routing plan or connection"
}
}
},
"DeleteSIMCardResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"ExtendedDataRecordInfo" : {
"type" : "object",
"properties" : {
"tax_method" : {
"type" : "integer",
"description" : "Taxation method"
},
"default_i_acl" : {
"type" : "integer",
"description" : "Which ACL should be assigned to new accounts created with this product"
},
"previous_balance" : {
"type" : "number",
"description" : "Previous balance. Balance reported in the last invoice"
},
"i_parent" : {
"type" : "integer",
"description" : "Omit for a direct customer; i_customer of the reseller for a subcustomer"
},
"out_date_format" : {
"type" : "string",
"description" : "Output format for date indication on the self-care interface"
},
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the invoice template"
},
"email" : {
"type" : "string",
"description" : "Email address"
},
"password" : {
"type" : "string",
"description" : "The password for the self-care web interface"
},
"i_business_model" : {
"type" : "integer",
"description" : "The unique identifier for a business model; refers to the Business_Models table"
},
"send_invoices" : {
"type" : "string",
"description" : "Defines whether a regular invoice should be automatically sent to the customer as soon as it is created"
},
"last_resend_date" : {
"type" : "string",
"description" : "Last resend date. The date the invoice was resent to the customer"
},
"billed_to" : {
"type" : "string",
"description" : "The customer's \"billed to\" date"
},
"blocked" : {
"type" : "string",
"description" : "Block customer's calls"
},
"mac" : {
"type" : "string",
"description" : "The MAC address of the CPE associated with this account"
},
"use_external_billing" : {
"type" : "integer",
"description" : "Shows whether an external billing is used by the customer class's postpaid customers"
},
"bill_status" : {
"type" : "string",
"description" : "The bill status"
},
"name" : {
"type" : "string",
"description" : "The name"
},
"life_time" : {
"type" : "integer",
"description" : "Defines the number of days the account remains active after the date of its first use. The account will expire on the first usage date + life time days"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the customer's tariff; applies to resellers only"
},
"login" : {
"type" : "string",
"description" : "Customer's login for self-care web interface"
},
"creation_date" : {
"type" : "string",
"description" : "The date and time when the customer was created"
},
"i_invoice_status" : {
"type" : "integer",
"description" : "The unique ID of the invoice status"
},
"phone1" : {
"type" : "string",
"description" : "Main phone number"
},
"i_customer_type" : {
"type" : "integer",
"description" : "The customer type"
},
"i_billing_processor" : {
"type" : "integer",
"description" : "The unique ID of the taxation plugin"
},
"refnum" : {
"type" : "string",
"description" : "Reference number (custom field)"
},
"manual_charges" : {
"type" : "number",
"description" : "Manual charges. Non-service related charges"
},
"realm" : {
"type" : "string",
"description" : "A custom string. A realm enables administrators to impose a scope of uniqueness for an account ID"
},
"deactivate_on" : {
"type" : "string",
"description" : "The date when the customer will be deactivated"
},
"amount_due" : {
"type" : "number",
"description" : "The amount the customer is supposed to pay for this period"
},
"last_suspension_date" : {
"type" : "string",
"description" : "Last suspension date. The date the customer was suspended after an invoice became overdue"
},
"calls" : {
"type" : "number",
"description" : "Service charges (e.g. call charges)"
},
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the owner DID Batch used for DID numbers auto-provisioning"
},
"closing_days_after_terminated" : {
"type" : "integer",
"description" : "In how many days after provisional termination the customer’s account will be permanently closed (if the administrator does not manually restore this customer within this period)"
},
"i_account_role" : {
"type" : "integer",
"description" : "The unique ID of the account role"
},
"i_distributor" : {
"type" : "integer",
"description" : "The unique ID of the distributor record associated with the customer"
},
"last_closing_date" : {
"type" : "string",
"description" : "Last closing date. The date the customer's account was closed after an invoice became overdue"
},
"period_to" : {
"type" : "string",
"description" : "The end date of the billing period"
},
"tax_info" : {
"type" : "string",
"description" : "The configured taxation method options"
},
"i_master_account" : {
"type" : "integer",
"description" : "Applicable only to the alias account type; the main account this alias is associated with"
},
"managed_by_user" : {
"type" : "string",
"description" : "Flag shows whether product can be managed by end user"
},
"tax_id" : {
"type" : "string",
"description" : "Tax ID"
},
"inactivity_expire_time" : {
"type" : "integer",
"description" : "Specifies the number of days the account remains active after its last use or recharge"
},
"rounding_step" : {
"type" : "number",
"description" : "The rounding step for callshops"
},
"shifted_billing_date" : {
"type" : "string",
"description" : "This is applicable only for \"monthly anniversary\" and 30-day billing periods; allows you to set the billing date to a different day of the month in the future (used only in requests)"
},
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"activation_date" : {
"type" : "string",
"description" : "The date from which the account is usable"
},
"new_i_billing_period" : {
"type" : "integer",
"description" : "The unique ID of the customer's future billing period"
},
"baddr2" : {
"type" : "string",
"description" : "2nd line of the customer's address"
},
"iso_4217" : {
"type" : "string",
"description" : "The ISO4217 code for the currency"
},
"suspension_delay_date" : {
"type" : "string",
"description" : "The date when the customer will be suspended"
},
"last_warning_date" : {
"type" : "string",
"description" : "Last warning date. The date the notification email was sent to the customer informing about service suspension"
},
"subscriptions" : {
"type" : "number",
"description" : "Subscription fee"
},
"shared" : {
"type" : "string",
"description" : "Shows whether the product managed by the administrator is available to resellers"
},
"i_account" : {
"type" : "integer",
"description" : "Account balance control type"
},
"id" : {
"type" : "string",
"description" : "The ID (PIN) of the account on the PortaBilling interface, unique in the environment"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique identifier for a tax transaction code"
},
"baddr4" : {
"type" : "string",
"description" : "4th line of the customer's address"
},
"out_date_time_format" : {
"type" : "string",
"description" : "Output format for full date/time indication"
},
"last_usage" : {
"type" : "string",
"description" : "The date on which the account was last used"
},
"redirect_number" : {
"type" : "string",
"description" : "Associated number specifies the number to be sent back to the IVR in an authorization confirmation. For example, this might be a redirect to a technical support number in an IVR application"
},
"i_invoice_type" : {
"type" : "integer",
"description" : "The unique ID of the invoice type"
},
"h323_password" : {
"type" : "string",
"description" : "The VoIP password used to authenticate calls made using the account"
},
"management_number" : {
"type" : "string",
"description" : "A custom identifier of the account (optional)"
},
"effective_to" : {
"type" : "string",
"description" : "Account product add-on effective to date"
},
"i_lang" : {
"type" : "string",
"description" : "The code for the web interface language"
},
"measured_services" : {
"type" : "number",
"description" : "Measured service charges"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
},
"recollect_days" : {
"type" : "string",
"description" : "Regular invoice re-collect intervals"
},
"zip" : {
"type" : "string",
"description" : "Postal (zip) code"
},
"due_date" : {
"type" : "string",
"description" : "The date by which payment must be received"
},
"bp_closure_delay_days" : {
"type" : "integer",
"description" : "Max days to delay billing period closure"
},
"is_void" : {
"type" : "string",
"description" : "Specifies whether the invoice is void (i.e. there is a new invoice with actual data)"
},
"previous_credit_limit" : {
"type" : "number",
"description" : "Customer's original credit limit value"
},
"i_addon_product" : {
"type" : "integer",
"description" : "The unique ID of the assigned product add-on record"
},
"discount_rate" : {
"type" : "number",
"description" : "The value of customer's subscription discount; a percentage"
},
"i_subscriber" : {
"type" : "integer",
"description" : "The unique ID of the account's subscriber record"
},
"estimate_taxes" : {
"type" : "string",
"description" : "If set, enables taxes estimation on receiving payments for prepaid customers"
},
"taxes" : {
"type" : "number",
"description" : "Calculated taxes. The amount of taxes for this period"
},
"balance_transfer_allowed" : {
"type" : "string",
"description" : "Defines if balance transfer is enabled for a customer class"
},
"scheduled_billing_change" : {
"type" : "string",
"description" : "The date when the billing period will close and a new billing period and a new time zone will be applied"
},
"terminate_on" : {
"type" : "string",
"description" : "The date when the customer will be terminated"
},
"zero_balance_date" : {
"type" : "string",
"description" : "Applicable only to debit accounts; specifies when the account has used up all of its available funds"
},
"lastname" : {
"type" : "string",
"description" : "Customer's last name"
},
"unallocated_payments" : {
"type" : "number",
"description" : "The customer's unallocated payments"
},
"reset_customer_balance" : {
"type" : "integer",
"description" : "Shows whether related customers' balances are reset to 0 at the end of the billing period. This option is related to the 'use_external_billing' option and can be enabled only together with it"
},
"city" : {
"type" : "string",
"description" : "City of the customer's address"
},
"i_main_office" : {
"type" : "integer",
"description" : "The unique ID of the main office"
},
"restore_on" : {
"type" : "string",
"description" : "The date when the customer status will be returned to open"
},
"grace_period" : {
"type" : "integer",
"description" : "Regular invoice grace period, i.e. for how many days after invoice generation the payment is expected"
},
"hide_reset_balance_xdr" : {
"type" : "integer",
"description" : "Shows whether the reset balance XDR is hidden from the end user. This option is related to the 'reset_customer_balance' option and can be enabled only together with it"
},
"default_class" : {
"type" : "string",
"description" : "The flag that designates the default customer class"
},
"cont2" : {
"type" : "string",
"description" : "Alternative contact person"
},
"closed" : {
"type" : "string",
"description" : "Indicates whether the invoice is closed (sent to the customer)"
},
"adjustments" : {
"type" : "number",
"description" : "The adjusted amount the customer is supposed to pay you for this period"
},
"first_usage_time" : {
"type" : "string",
"description" : "The date and time when the account was first used"
},
"i_rep" : {
"type" : "integer",
"description" : "The unique ID of the customer's representative"
},
"in_time_format" : {
"type" : "string",
"description" : "Input format for time indication"
},
"expiration_date" : {
"type" : "string",
"description" : "The date from which the account will become unusable"
},
"new_style" : {
"type" : "integer",
"description" : "Defines whether the invoice includes the previous balance"
},
"note" : {
"type" : "string",
"description" : "Short note (description)"
},
"bcc" : {
"type" : "string",
"description" : "BCC email address"
},
"i_account_balance_control_type" : {
"type" : "integer",
"description" : "Account balance control type"
},
"faxnum" : {
"type" : "string",
"description" : "Fax number"
},
"last_recharge" : {
"type" : "string",
"description" : "The date on which the account was last recharged using IVR, web self-care, SMS, etc."
},
"hidden" : {
"type" : "string",
"description" : "Indicates whether the product is hidden"
},
"bundle_billed_to" : {
"type" : "string",
"description" : "Any bundles earlier than this date and time are already calculated"
},
"baddr1" : {
"type" : "string",
"description" : "1st line of the customer's address"
},
"extra_invoice" : {
"type" : "string",
"description" : "Separate Invoice for Recurring Fees"
},
"warning_days" : {
"type" : "integer",
"description" : "How many days before the suspension date a notification of possible suspension of services should be sent to the customer if the regular invoice is still unpaid"
},
"closing_days" : {
"type" : "integer",
"description" : "In how many days after the due date the customer's account will be closed if the regular invoice is still unpaid"
},
"payments" : {
"type" : "number",
"description" : "Payments. Sum of all charges"
},
"inclusive_taxation" : {
"type" : "string",
"description" : "Identifies that taxes are included in the rates for a customer class"
},
"collection_threshold" : {
"type" : "number",
"description" : "If no payment is made, the balance is applied to the next invoice(s) until the amount due on a new invoice crosses this threshold"
},
"disable_statistics" : {
"type" : "integer",
"description" : "Defines if the customers of this class will be processed by the statistics task"
},
"addon_priority" : {
"type" : "integer",
"description" : "In order to differentiate between add-on products, there is also a \"precedence level\" parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level"
},
"additional_invoices" : {
"type" : "number",
"description" : "The balance of all previous invoices"
},
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
},
"ua_profile_id" : {
"type" : "integer",
"description" : "The unique ID for the UA profile; indicates the IP phone assigned to the account"
},
"description" : {
"type" : "string",
"description" : "The description"
},
"pdf_generation_mode" : {
"type" : "string",
"description" : "Generate invoice PDF"
},
"max_abbreviated_length" : {
"type" : "integer",
"description" : "Maximum allowed length of customer's abbreviated numbers; applies to retail customers only"
},
"in_date_format" : {
"type" : "string",
"description" : "Input format for date indication"
},
"i_number_scope_reseller" : {
"type" : "integer",
"description" : "The identifier of the invoice sequence numbers scope for the reseller"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the customer's time zone"
},
"phone2" : {
"type" : "string",
"description" : "Alternative phone number"
},
"i_balance_control_type" : {
"type" : "integer",
"description" : "Customer balance control type"
},
"salutation" : {
"type" : "string",
"description" : "Customer's salutation"
},
"i_product_group" : {
"type" : "integer",
"description" : "The unique ID of the product group record"
},
"billing_model" : {
"type" : "integer",
"description" : "The account type"
},
"send_statistics" : {
"type" : "string",
"description" : "Defines what kind of xDR statistics should be delivered to the customer by email"
},
"i_tariff_incoming" : {
"type" : "integer",
"description" : "The unique ID of the customer's incoming tariff; applies to resellers only"
},
"effective_from" : {
"type" : "string",
"description" : "Account product add-on effective from date"
},
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of the customer site"
},
"suspension_days" : {
"type" : "integer",
"description" : "In how many days after the due date the customer's services will be suspended if the regular invoice is still unpaid"
},
"breakage" : {
"type" : "number",
"description" : "Used in account management to obtain a summary of depleted (practically unusable) accounts"
},
"callshop_enabled" : {
"type" : "string",
"description" : "Enable callshop features on customer's self-care interface"
},
"last_notific_date" : {
"type" : "string",
"description" : "The date the invoice was first sent to the customer"
},
"country" : {
"type" : "string",
"description" : "The code of the country in the ISO 3166-1 alpha-2 format"
},
"i_batch" : {
"type" : "integer",
"description" : "The unique ID of the batch to which the account belongs"
},
"generate_invoice_earlier" : {
"type" : "string",
"description" : "Defines whether an invoice will be generated before the end of the billing period (Y, N)"
},
"amount_net" : {
"type" : "number",
"description" : "The sum of all charges for this period minus credits/refunds"
},
"service_flag_locks" : {
"type" : "string",
"description" : "Specifies whether values for each service feature are allowed to be changed by administrator and end user"
},
"closing_warning_days" : {
"type" : "integer",
"description" : "How many days before the closing date a notification of possible closing should be sent to the customer if the regular invoice is still unpaid"
},
"end_user_description" : {
"type" : "string",
"description" : "Description visible to the end user"
},
"last_recollect_date" : {
"type" : "string",
"description" : "Last recollect date. The date the collection attempt was made (attempt to charge the customer's credit card on file for the amount due)"
},
"credit_limit_until" : {
"type" : "string",
"description" : "The date and time when the temporarily extended credit limit will be automatically reverted to the original value"
},
"firstname" : {
"type" : "string",
"description" : "Customer's first name"
},
"resend_days" : {
"type" : "string",
"description" : "Regular invoice re-sending intervals"
},
"iso_639_1" : {
"type" : "string",
"description" : "The language the user prefers when interacting with an IVR application"
},
"timer" : {
"type" : "string",
"description" : "Booth timer (for accounts of a callshop reseller)"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
},
"state" : {
"type" : "string",
"description" : "Province or state"
},
"opening_balance" : {
"type" : "number",
"description" : "The initial balance"
},
"info_url" : {
"type" : "string",
"description" : "The URL to an external website describing product features"
},
"prior_balance_paid" : {
"type" : "number",
"description" : "Prior balance paid"
},
"baddr3" : {
"type" : "string",
"description" : "3rd line of the customer's address"
},
"bp_charge_cc" : {
"type" : "string",
"description" : "Automatically charge customer's credit card when a billing period is closed"
},
"baddr5" : {
"type" : "string",
"description" : "5th line of the customer's address"
},
"balance" : {
"type" : "number",
"description" : "The balance"
},
"notific_days" : {
"type" : "string",
"description" : "Regular invoice notification intervals"
},
"special_rounding" : {
"type" : "string",
"description" : "With this option you can use a special rounding up behaviour"
},
"cont1" : {
"type" : "string",
"description" : "Main contact person"
},
"midinit" : {
"type" : "string",
"description" : "Customer's middle initial(s)"
},
"review_term_days" : {
"type" : "integer",
"description" : "Days to hold invoice for review"
},
"pdf_created" : {
"type" : "string",
"description" : "The date when the PDF file was created for this invoice"
},
"amount_paid" : {
"type" : "number",
"description" : "The amount already paid by the customer "
},
"sale_commission_rate" : {
"type" : "number",
"description" : "The commission that is applied when an account is created or a distributor is assigned (only applicable to distributors"
},
"end_user_name" : {
"type" : "string",
"description" : "Product name visible to the end user"
},
"i_ui_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the user interface time zone"
},
"out_time_format" : {
"type" : "string",
"description" : "Output format for time indication"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the discount plan"
},
"email_from" : {
"type" : "string",
"description" : "Email address for reseller to use as sender email for customer notifications"
},
"invoice_rounding_precision" : {
"type" : "integer",
"description" : "The number of digits after decimal point for rounding"
},
"new_i_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the customer's future time zone"
},
"prior_balance" : {
"type" : "number",
"description" : "Prior balance"
},
"ecommerce_enabled" : {
"type" : "string",
"description" : "Allow the account's owner to make online payments or set up periodical payments on the account's self-care page"
},
"override_tariffs_enabled" : {
"type" : "string",
"description" : "Specifies whether the Override Tariffs feature is enabled"
},
"suspend_on_insuff_funds" : {
"type" : "string",
"description" : "Specifies whether to suspend the customer on insufficient funds for charging subscriptions"
},
"i_number_scope" : {
"type" : "integer",
"description" : "PortaBilling can generate invoices for all customers with sequential invoice numbering distributed throughout the environment. In some cases, you may want to have more than one sequence of numbers. One of the following: 1 – Individual for Environment, 2 – Individual for Reseller, 3 – Individual for Customer"
},
"password_timestamp" : {
"type" : "string",
"description" : "The date when the password was changed"
},
"service_flags" : {
"type" : "string",
"description" : "The service features settings"
},
"invoice_number" : {
"type" : "integer",
"description" : "Invoice Number - the unique identifier of the invoice"
},
"i_office_type" : {
"type" : "integer",
"description" : "The unique ID of the Office_Types record"
},
"i_billing_period" : {
"type" : "integer",
"description" : "The unique ID of the customer's billing period; refers to the Billing_Period table"
},
"period_from" : {
"type" : "string",
"description" : "The start date of the billing period"
},
"issue_date" : {
"type" : "string",
"description" : "The date when the record was created"
},
"payment_commission_rate" : {
"type" : "number",
"description" : "The commission applied when a payment is entered (only applicable to distributors)"
},
"control_number" : {
"type" : "integer",
"description" : "The sequential number of the account in the batch"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"i_acl" : {
"type" : "integer",
"description" : "The unique ID of the access level"
},
"companyname" : {
"type" : "string",
"description" : "Customer's company name"
},
"fraud_protection" : {
"type" : "string",
"description" : "Overdraft Protection mode for the product. Possible values: 'None', 'All', 'Debit'"
},
"review_invoices" : {
"type" : "string",
"description" : "Send invoices \"via\" email after review and approval by admin. Days to hold the invoice for: \"review\""
},
"credit_limit" : {
"type" : "number",
"description" : "Customer's credit limit value. Please note that this property may be used with the nil attribute set to true, in which case the credit limit will not be enforced"
}
}
},
"RegenerateInvoicePDFInfo" : {
"required" : [
"i_invoice"
],
"type" : "object",
"properties" : {
"i_invoice" : {
"type" : "integer",
"description" : "The unique identifier of the invoice"
}
}
},
"UpdateUserResponse" : {
"type" : "object",
"properties" : {
"i_user" : {
"type" : "integer",
"description" : "The unique ID of the user record"
}
}
},
"RepresentativeXDRInfo" : {
"type" : "object",
"properties" : {
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination record"
},
"used_quantity" : {
"type" : "number",
"description" : "A number of used service units"
},
"i_xdr" : {
"type" : "integer",
"description" : "The ID of XDR record"
},
"CLD" : {
"type" : "string",
"description" : "Additional info"
},
"account_id" : {
"type" : "string",
"description" : "The ID (PIN) of the account"
},
"i_account" : {
"type" : "integer",
"description" : "The unique identifier of the account"
},
"charged_amount" : {
"type" : "number",
"description" : "An amount of money in currency units"
},
"charged_quantity" : {
"type" : "number",
"description" : "A number of charged service units"
},
"bill_time" : {
"type" : "string",
"description" : "Date and time when operation was done"
},
"i_rate" : {
"type" : "integer",
"description" : "The unique ID of the rate record"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique identifier of the customer"
},
"customer_name" : {
"type" : "string",
"description" : "The name of the customer"
}
}
},
"AddDestGroupRequest" : {
"required" : [
"i_dest_group_set",
"name"
],
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set"
},
"name" : {
"type" : "string",
"description" : "The destination group name"
},
"add_destinations" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
}
}
},
"AddDiscountPlanRequest" : {
"required" : [
"discount_plan_info"
],
"type" : "object",
"properties" : {
"discount_plan_info" : {
"$ref" : "#/components/schemas/DiscountPlanInfo"
}
}
},
"AddNoteResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
},
"note_info" : {
"$ref" : "#/components/schemas/WebLogInfo"
}
}
},
"InvoiceInfo" : {
"type" : "object",
"properties" : {
"payments" : {
"type" : "number",
"description" : "Payments. Sum of all charges"
},
"tax_method" : {
"type" : "integer",
"description" : "Taxation method"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for the invoice currency"
},
"previous_balance" : {
"type" : "number",
"description" : "Previous balance. Balance reported in the last invoice"
},
"i_parent" : {
"type" : "integer",
"description" : "The unique ID of the reseller (for subcustomer)"
},
"last_warning_date" : {
"type" : "string",
"description" : "Last warning date. Date the notification email was sent to the customer informing about service suspension"
},
"subscriptions" : {
"type" : "number",
"description" : "Subscription fee"
},
"last_resend_date" : {
"type" : "string",
"description" : "Last resend date. Date the invoice was resent to the customer"
},
"additional_invoices" : {
"type" : "number",
"description" : "The balance of all previous invoices"
},
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
},
"i_invoice_type" : {
"type" : "integer",
"description" : "The unique ID of the invoice type"
},
"prior_balance_paid" : {
"type" : "number",
"description" : "Prior Balance Paid"
},
"measured_services" : {
"type" : "number",
"description" : "Measured service charges"
},
"is_pdf_exists" : {
"type" : "integer",
"description" : "Indicates whether the PDF file exists for this invoice"
},
"due_date" : {
"type" : "string",
"description" : "Date by which payment must be received"
},
"i_invoice_status" : {
"type" : "integer",
"description" : "Refers to the invoice status record"
},
"is_void" : {
"type" : "string",
"description" : "Specifies whether the invoice is void (i.e. there is a new invoice with actual data) "
},
"customer_name" : {
"type" : "string",
"description" : "Customer name to which the invoice belongs"
},
"taxes" : {
"type" : "number",
"description" : "Calculated taxes. Amount of taxes for this period"
},
"invoice_status" : {
"type" : "string",
"description" : "Invoice status"
},
"pdf_created" : {
"type" : "string",
"description" : "The date when the PDF file was created for this invoice"
},
"amount_paid" : {
"type" : "number",
"description" : "Amount paid by the customer already"
},
"i_billing_processor" : {
"type" : "integer",
"description" : "Refers to Billing Processor record"
},
"manual_charges" : {
"type" : "number",
"description" : "Manual charges. Non-service related charges"
},
"amount_due" : {
"type" : "number",
"description" : "Amount the customer is supposed to pay for this period"
},
"last_suspension_date" : {
"type" : "string",
"description" : "Last suspension date. Date the customer was suspended after an invoice became overdue"
},
"prior_balance" : {
"type" : "number",
"description" : "Prior Balance"
},
"closed" : {
"type" : "string",
"description" : "Indicates whether the invoice is closed (sent to the customer) or not"
},
"last_notific_date" : {
"type" : "string",
"description" : "Date the invoice was first sent to the customer"
},
"calls" : {
"type" : "number",
"description" : "Service charges (e.g. call charges)"
},
"adjustments" : {
"type" : "number",
"description" : "Adjusted amount the customer is supposed to pay you for this period"
},
"last_closing_date" : {
"type" : "string",
"description" : "Last closing date. Date the customer's account was closed after an invoice became overdue"
},
"amount_net" : {
"type" : "number",
"description" : "Sum of all charges in this period minus credits/refunds"
},
"period_to" : {
"type" : "string",
"description" : "End date of the billing period"
},
"new_style" : {
"type" : "integer",
"description" : "Defines whether the invoice includes the previous balance or not"
},
"invoice_number" : {
"type" : "integer",
"description" : "Invoice Number - unique identifier of the invoice"
},
"period_from" : {
"type" : "string",
"description" : "Start date of the billing period"
},
"issue_date" : {
"type" : "string",
"description" : "Date when the invoice was generated"
},
"last_recollect_date" : {
"type" : "string",
"description" : "Last recollect date. Date the collection attempt was made (attempt to charge the customer's credit card on file for the amount due)"
},
"i_customer" : {
"type" : "integer",
"description" : "Refers to customer record to which the invoice belongs"
}
}
},
"AddProductSubscriptionRequest" : {
"required" : [
"subscription_info"
],
"type" : "object",
"properties" : {
"detailed_response" : {
"type" : "integer",
"description" : "Shows whether added record should be returned in response or not"
},
"subscription_info" : {
"$ref" : "#/components/schemas/ProductSubscriptionInfo"
}
}
},
"TaxationOptionsVat" : {
"required" : [
"exempt"
],
"type" : "object",
"properties" : {
"percent" : {
"type" : "number",
"description" : "VAT percentage"
},
"transaction_codes" : {
"$ref" : "#/components/schemas/ArrayOfTransactionCodes"
},
"exempt" : {
"type" : "string",
"description" : "Exempt From Tax - Y/N"
},
"xdr_per_service" : {
"type" : "integer",
"description" : "This allows you to calculate taxes per service (and respectively show them in the invoices)"
}
}
},
"RawAccessComponentPermission" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"objects" : {
"$ref" : "#/components/schemas/ArrayOfRawAccessObjectPermission"
},
"name" : {
"type" : "string",
"description" : "The name of the access component"
},
"permission" : {
"type" : "integer",
"description" : "The permission for the access component"
},
"components" : {
"$ref" : "#/components/schemas/ArrayOfRawAccessComponentPermission"
}
}
},
"GetActiveCallsResponse" : {
"required" : [
"active_calls_list"
],
"type" : "object",
"properties" : {
"active_calls_list" : {
"$ref" : "#/components/schemas/ActiveCallInfoList"
}
}
},
"UpdateRateResponse" : {
"required" : [
"i_rate"
],
"type" : "object",
"properties" : {
"i_rate" : {
"type" : "integer",
"description" : "ID of the modified rate record"
}
}
},
"AddVendorAccountRequest" : {
"required" : [
"vendor_account_info"
],
"type" : "object",
"properties" : {
"vendor_account_info" : {
"$ref" : "#/components/schemas/VendorAccountInfo"
}
}
},
"GetRouteListRequest" : {
"required" : [
"number"
],
"type" : "object",
"properties" : {
"effective_time" : {
"type" : "string",
"description" : "The search can be performed in real time or simulate any date and time"
},
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"number" : {
"type" : "string",
"description" : "Type either a full number or a prefix into this field to see the resulting list of routes for this number"
},
"i_node" : {
"type" : "integer",
"description" : "The unique ID of a node record. You may select either Generic Routing (to see all the routes outside of the network) by skipping this property in a request or a specific node (to see the routes available when a call is handled by this node)"
},
"transport_protocol" : {
"type" : "string",
"description" : "\n A transport protocol to be used in the simulation.\n Posible values: 'SIP', 'SMPP'\n "
},
"apply_penalties" : {
"type" : "integer",
"description" : "Allows to see the resulting list of routes regardless of the currently applied adaptive routing penalties"
},
"i_routing_plan" : {
"type" : "integer",
"description" : "The unique ID of a routing plan to be used for a dialplan test. The system will offer a different set of routes depending on the routing plan. Skip this property in a request to test dialplan for all available routes"
}
}
},
"GetEmergencyUnitInfoResponse" : {
"type" : "object",
"properties" : {
"emergency_unit_info" : {
"$ref" : "#/components/schemas/EmergencyUnitInfo"
}
}
},
"ArrayOfOliInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/OliInfo"
}
},
"AddRoutingCriteriaDestGroupRequest" : {
"required" : [
"routing_criteria_dest_group_info"
],
"type" : "object",
"properties" : {
"routing_criteria_dest_group_info" : {
"$ref" : "#/components/schemas/RoutingCriteriaDestGroupInfo"
}
}
},
"GetAccountPaymentMethodInfoRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"empty_if_not_configured" : {
"type" : "integer",
"description" : "Set this flag to receive undef value if payment method not configured. When it's not provided error returns"
}
}
},
"ArrayOfAccountRoleInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountRoleInfo"
}
},
"CustomerGetCustomerNumberSequenceInfoRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"IPTVServicePackage" : {
"required" : [
"i_service_package"
],
"type" : "object",
"properties" : {
"provider" : {
"type" : "string",
"description" : "The name of the provider of the channel"
},
"i_service_package" : {
"type" : "integer",
"description" : "The unique ID of the IPTV service package in PortaBilling"
},
"external_id" : {
"type" : "integer",
"description" : "The unique ID of the IPTV service package in the external system"
},
"name" : {
"type" : "string",
"description" : "The name of the IPTV service package"
},
"description" : {
"type" : "string",
"description" : "The description of the IPTV service package"
}
}
},
"MOHListInfo" : {
"type" : "object",
"properties" : {
"customer_defined_moh_list" : {
"$ref" : "#/components/schemas/ArrayOfMOHInfo"
},
"is_moh_update_disabled" : {
"type" : "integer",
"description" : "Indicates whether the MOH update is allowed"
},
"system_default_i_moh" : {
"type" : "integer",
"description" : "Default system MOH object"
},
"aggregated_moh_list" : {
"$ref" : "#/components/schemas/ArrayOfMOHInfo"
},
"default_moh_list" : {
"$ref" : "#/components/schemas/ArrayOfMOHInfo"
}
}
},
"AddSubscriptionResponse" : {
"required" : [
"i_subscription"
],
"type" : "object",
"properties" : {
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Plan"
}
}
},
"UploadDestRequest" : {
"type" : "object",
"properties" : {
"allow_update" : {
"type" : "integer",
"description" : "Allow update while uploading if a destination already exists"
},
"default_set" : {
"type" : "integer",
"description" : "1 for uploading the default destinations set"
},
"number_format" : {
"type" : "string",
"description" : "The destination number format (enum 'e164', 'e212', 'custom')"
}
}
},
"GetMediatorXDRInfoDetailedResponse" : {
"type" : "object",
"properties" : {
"xdr_info" : {
"$ref" : "#/components/schemas/MediatorXDRInfoDetailed"
}
}
},
"ArrayOfMediatorXDRId" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MediatorXDRId"
}
},
"AccountVdNotificationInfo" : {
"required" : [
"last_updated",
"i_service",
"i_dest_group",
"unit_counter",
"counter_id",
"i_account",
"peak_level",
"counter"
],
"type" : "object",
"properties" : {
"last_updated" : {
"type" : "string",
"description" : "Timestamp when the notification record was last updated"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The ID of the destination group to which the counter is applicable"
},
"i_service" : {
"type" : "integer",
"description" : "Unique identifier of a service"
},
"unit_counter" : {
"type" : "integer",
"description" : "Accumulated units amount (in service rating units)"
},
"counter_id" : {
"type" : "integer",
"description" : "The identifier of the account-level counter"
},
"addon_priority" : {
"type" : "integer",
"description" : "The add-on level for discount counter"
},
"i_account" : {
"type" : "integer",
"description" : "The identifier of the account, unique in the environment"
},
"peak_level" : {
"type" : "integer",
"description" : "Allow to limit the counter to specified peak level only (the unique ID ot the Time_Periods table)"
},
"i_notification" : {
"type" : "integer",
"description" : "The unique ID of the record"
},
"counter" : {
"type" : "number",
"description" : "Accumulated money amount"
}
}
},
"CloneProductInfo" : {
"type" : "object",
"properties" : {
"clone_rates" : {
"type" : "string",
"description" : "Specifies whether rates should be cloned while cloning the product: Y - enabled, N - disabled"
},
"clone_subscription" : {
"type" : "string",
"description" : "Specifies whether subscriptions should be cloned while cloning the product: Y - enabled, N - disabled"
},
"clone_discount_plan" : {
"type" : "string",
"description" : "Specifies whether discount plan should be cloned while cloning the product: Y - enabled, N - disabled"
},
"exchange_rate" : {
"type" : "string",
"description" : "A custom exchange rate"
},
"name" : {
"type" : "string",
"description" : "The name of the new cloned product"
},
"i_parent" : {
"type" : "integer",
"description" : "The unique ID of the parent Product Record"
}
}
},
"NotificationPresetInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "The flag shows whether the notification preset was used"
},
"i_notification_preset" : {
"type" : "integer",
"description" : "The unique identifier of the notification preset"
},
"name" : {
"type" : "string",
"description" : "The notification preset name"
},
"managed_by" : {
"type" : "string",
"description" : "The name of the reseller who manages the notification preset"
},
"type" : {
"type" : "string",
"description" : "The type of the preset. Possible values are: user, customer_class"
},
"i_customer" : {
"type" : "integer",
"description" : "The identifier of the reseller who manages the preset"
}
}
},
"GetCustomXdrReportResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"GetNetaccessUsageRecordListRequest" : {
"type" : "object",
"properties" : {
"xdr_id_list" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
},
"format" : {
"type" : "string",
"description" : "This parameter enables the user to get xDRs in other formats via a SOAP attachment. Currently only the \"csv\" format is supported"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The unique identifier of the session. At least one of the following fields is mandatory in the request: xdr_id_list, h323_conf_id"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"CustomerInvoicesListInfo" : {
"type" : "object",
"properties" : {
"invoice_status_desc" : {
"type" : "string",
"description" : "Invoice status"
},
"amount_paid" : {
"type" : "string",
"description" : "Amount paid by the customer already"
},
"amount_net" : {
"type" : "string",
"description" : "Sum of all charges in this period minus credits / refunds"
},
"period_to" : {
"type" : "string",
"description" : "End date of the billing period"
},
"is_pdf_exists" : {
"type" : "integer",
"description" : "Indicates whether the PDF file exists"
},
"invoice_number" : {
"type" : "integer",
"description" : "Invoice Number – unique identifier of the invoice"
},
"period_from" : {
"type" : "string",
"description" : "Start date of the billing period"
},
"issue_date" : {
"type" : "string",
"description" : "Date when the invoice was generated"
},
"i_invoice_status" : {
"type" : "integer",
"description" : "Refers to the invoice status record"
},
"due_date" : {
"type" : "string",
"description" : "Date by which payment must be received"
},
"is_void" : {
"type" : "string",
"description" : "This flag is set to 'Y' if the invoice is void (i.e. there is a new invoice with new data)"
},
"amount_due" : {
"type" : "string",
"description" : "Amount the customer is supposed to pay for this period"
},
"i_customer" : {
"type" : "integer",
"description" : "Refers to customer record which the invoice belongs to"
},
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"AddCustomerHuntgroupRequest" : {
"required" : [
"name",
"i_customer",
"id"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Huntgroup name"
},
"add_callqueue" : {
"$ref" : "#/components/schemas/CQInfo"
},
"prompt_action" : {
"type" : "string",
"description" : "Name of action to perform with prompt. Supported values: 'set', 'unset'"
},
"hunt_keep_original_cli" : {
"type" : "string",
"description" : "\n 'Y' - The call is redirected with the phone number and name of the original caller.\n 'N' - The call is redirected with the phone number and name of the huntgroup.\n 'I' - Id Only, The call is redirected with the phone number of the original caller and name of the huntgroup.\n Supported values: 'Y', 'N', 'I'.\n "
},
"add_extensions" : {
"$ref" : "#/components/schemas/ArrayOfAssignedExtensionsInfo"
},
"hunt_sequence" : {
"type" : "string",
"description" : "Ringing strategy; one of the following: Order, Random, Simultaneous, LeastUsed"
},
"i_ringback_tone" : {
"type" : "integer",
"description" : "The unique ID of the assigned ringback tone file"
},
"id" : {
"type" : "string",
"description" : "Huntgroup number"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"pickup_allowed" : {
"type" : "string",
"description" : "Allows extensions inside this huntgroup to pick up calls"
}
}
},
"GetAccountTransactionsTotalInfoResponse" : {
"type" : "object",
"properties" : {
"count" : {
"type" : "integer",
"description" : "The total number of transactions"
},
"iso_4217" : {
"type" : "string",
"description" : "Transactions currency"
},
"sessions_count" : {
"type" : "integer",
"description" : "The total number of sessions"
},
"total_amount" : {
"type" : "number",
"description" : "Total transactions amount"
},
"per_service_info" : {
"$ref" : "#/components/schemas/ArrayOfAccountPerServiceInfo"
},
"total_info" : {
"$ref" : "#/components/schemas/ArrayOfTotalTransInfo"
}
}
},
"GetTemplateDataFieldListResponse" : {
"type" : "object",
"properties" : {
"template_data_field_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateDataFieldInfo"
}
}
},
"ArrayOfRawAccessObjectPermission" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RawAccessObjectPermission"
}
},
"AddCommissionPlanResponse" : {
"required" : [
"i_commission_plan"
],
"type" : "object",
"properties" : {
"i_commission_plan" : {
"type" : "integer",
"description" : "The unique ID of the commission plan"
}
}
},
"CancelDIDAssignmentRequest" : {
"required" : [
"i_did_number",
"i_customer"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique ID of the DID number record"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of a customer record to which the account belongs. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"dont_release_to_pool" : {
"type" : "integer",
"description" : "If set, the flag shows that the DID number should not be released into the pool"
}
}
},
"GetRequestListRequest" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "The current processing status of the porting request to search by"
},
"porting_number" : {
"type" : "string",
"description" : "The number being ported to search the porting request by"
},
"account_id" : {
"type" : "string",
"description" : "The ID of the account to search the porting request by"
},
"due_date_to" : {
"type" : "string",
"description" : "Search requests with the due_date before this date and time"
},
"due_date_from" : {
"type" : "string",
"description" : "Search requests with the due_date starting from this date and time"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved records"
},
"type" : {
"type" : "string",
"description" : "Porting request type Possible values: PORTIN (default); PORTOUT"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"GetConnectionInfoRequest" : {
"required" : [
"i_connection"
],
"type" : "object",
"properties" : {
"i_connection" : {
"type" : "integer",
"description" : "The unique ID of the vendor connection record"
}
}
},
"ArrayOfPaymentMethods" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PaymentMethod"
}
},
"GetCustomerExtensionInfoResponse" : {
"type" : "object",
"properties" : {
"extension_info" : {
"$ref" : "#/components/schemas/ExtensionsInfo"
}
}
},
"ArrayOfCBCNumberPatternInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CBCNumberPatternInfo"
}
},
"UpdateDIDInventoryOptionsResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if the operation is successful"
}
}
},
"GetUserInfoListResponse" : {
"type" : "object",
"properties" : {
"user_list" : {
"$ref" : "#/components/schemas/UserInfoList"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved users"
}
}
},
"GetSpendingCounterRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"AccountCommitmentRecurringTermInfo" : {
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
},
"addon_product_name" : {
"type" : "string",
"description" : "The name of the addon product"
},
"i_recurring_term" : {
"type" : "integer",
"description" : "The unique identifier of the recurring term"
},
"apply_sale_discount_penalty" : {
"type" : "string",
"description" : "The flag shows whether the penalty for the applied sale discounts should be applied. If set to 'Y', the sum of all sale discounts applied to this recurring term will be added to the total penalty. Requires the general recurring term penalty to be enabled (the 'apply_penalty' flag ). Can be specified only in the commitment record termination configuration in the Account.terminate_assigned_commitment_record method. The penalties won't be applied if the commitment discount period is over (min_terminate_date is passed). Possible values: Y (default), N."
},
"sale_discount_list" : {
"$ref" : "#/components/schemas/ArrayOfCommitmentSaleDiscountInfo"
},
"discount_amount" : {
"type" : "number",
"description" : "The discount amount to apply to the recurring charge"
},
"apply_penalty" : {
"type" : "string",
"description" : "The flag that specifies whether the penalties should be applied for this term if the commitment is terminated before the minimum period end. Can be specified only in the commitment record termination configuration in the Account.terminate_assigned_commitment_record method. The penalties won't be applied if the commitment discount period is over (min_terminate_date is passed). Possible values: Y (default), N."
},
"i_addon_product" : {
"type" : "integer",
"description" : "The identifier of the addon product"
},
"i_subscription" : {
"type" : "integer",
"description" : "The identifier of the subscription"
},
"subscription_name" : {
"type" : "string",
"description" : "The name of the subscription"
}
}
},
"UpdateZendeskOrganizationRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"zendesk_organization_id" : {
"type" : "integer",
"description" : "The Zendesk organization ID number. If you want to bind the Zendesk organization with the Customer, it is needed to pass the organization identifier in this field"
},
"custom_domain" : {
"type" : "string",
"description" : "Override the domain for this Organization with the value specified here. If empty, the domain will be automatically calculated by the system based on the customer's email address"
},
"i_customer" : {
"type" : "integer",
"description" : "Create or update the Zendesk organization for the Customer with this ID. Note: this parameter will be used as an external_id on the Zendesk side"
}
}
},
"RecalculateInvoicesResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Specifies whether the invoice has been recalculated. Possible values: 1– The invoice has been successfully recalculated; 0 – The invoice has not been recalculated"
}
}
},
"UpdateCustomerClassNotificationCategoryListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation was completed"
}
}
},
"GetWebLogListRequest" : {
"type" : "object",
"properties" : {
"i_entity" : {
"type" : "integer",
"description" : "The unique ID of the entity to which the changes were applied"
},
"i_user" : {
"type" : "integer",
"description" : "The unique ID of the user"
},
"ip" : {
"type" : "string",
"description" : "The IP address of the user"
},
"description" : {
"type" : "string",
"description" : "The description of the web log record"
},
"action_type" : {
"type" : "string",
"description" : "The type of the action (e.g. modify or read) that was applied to the entity"
},
"entity_name" : {
"type" : "string",
"description" : "The name of the entity to which the changes were applied"
},
"fields" : {
"$ref" : "#/components/schemas/ArrayOfWebLogFieldInfo"
},
"to_time" : {
"type" : "string",
"description" : "Get web log records dated before or on this date and time"
},
"realm" : {
"type" : "string",
"description" : "The unique name of the realm (e.g. admin, accounts, customer, etc.). Mandatory for an API request with the i_user property specified"
},
"entity_type" : {
"type" : "string",
"description" : "The type of the entity (e.g. Accounts, Customers, etc.). Mandatory for an API request with the i_entity/entity_name property specified"
},
"from_time" : {
"type" : "string",
"description" : "Get web log records dated on or after this date and time"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetTimeZoneInfoResponse" : {
"required" : [
"time_zone_info"
],
"type" : "object",
"properties" : {
"time_zone_info" : {
"$ref" : "#/components/schemas/TimeZoneInfo"
}
}
},
"GetRouteListResponse" : {
"type" : "object",
"properties" : {
"route_list" : {
"$ref" : "#/components/schemas/RouteList"
}
}
},
"GetDialRuleSamplesResponse" : {
"type" : "object",
"properties" : {
"dial_rule_samples_list" : {
"$ref" : "#/components/schemas/ArrayOfSampleDialingRulesInfo"
}
}
},
"AddCustomerExtensionRequest" : {
"required" : [
"id",
"i_customer"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"published" : {
"type" : "string",
"description" : "Indicates whether the extensions is accessible via dial-by-name"
},
"name" : {
"type" : "string",
"description" : "Extension name"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"id" : {
"type" : "string",
"description" : "Extension number"
},
"prompt_action" : {
"type" : "string",
"description" : "Possible values: set – Add (or replace) a prompt for an extension. The sound file is sent in a MIME attachment to the API request; unset – Remove existing prompt. Note that the Apache Cassandra database must be enabled for this method property to work"
}
}
},
"CriterionInfo" : {
"type" : "object",
"properties" : {
"analyzed_parameter" : {
"type" : "string",
"description" : "The parameter to check for the analyzed service. Valid values are: 'charged_sum', 'used_volume' ('charged_sum' is used by default)"
},
"i_bd_plan" : {
"type" : "integer",
"description" : "The unique ID of the Bundle Promotion Plan"
},
"inv_comment" : {
"type" : "string",
"description" : "The invoice comment"
},
"bundle_discount_threshold_list" : {
"$ref" : "#/components/schemas/BundleDiscountThresholdList"
},
"i_service_apply" : {
"type" : "integer",
"description" : "The unique ID of the entity to apply the promotion to - a service, the whole bill, taxes, credits / adjustments or subscriptions (all or one in particular)"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group associated with this criteria"
},
"i_service_used" : {
"type" : "integer",
"description" : "The unique ID of the service which will be used to analyze how much money the customer has spent on services during the billing period to credit or charge the customer accordingly"
},
"amount_type" : {
"type" : "string",
"description" : "Valid values are: 'fixed', 'percentage'; the default value is 'fixed'"
},
"charge_type" : {
"type" : "string",
"description" : "Valid values are: 'credit', 'charge'; the default value is 'credit'"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the subscription associated with this bundle promotion criterion. If blank, the promotion is apllied to the customer’s own subscriptions and all of their credit accounts’ subscriptions"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The tax transaction code ID"
},
"i_bd_criteria" : {
"type" : "integer",
"description" : "The unique ID of the bundle promotion criterion. This parameter is mandatory for the update_criterion method"
}
}
},
"UpdateUAProfileResponse" : {
"required" : [
"i_ua_profile"
],
"type" : "object",
"properties" : {
"i_ua_profile" : {
"type" : "integer",
"description" : "The unique ID of the UA Profile record"
},
"ua_profile_id" : {
"type" : "integer",
"description" : "The ID of the UA profile"
}
}
},
"CustomerRestoreCustomerAfterImportResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
},
"warnings" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"AssessFraudTrafficRequest" : {
"required" : [
"i_dest_group",
"accumulation_period"
],
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The identifier of the destination group"
},
"i_customer" : {
"type" : "integer",
"description" : "The identifier of the customer"
},
"accumulation_period" : {
"type" : "string",
"description" : "The name of the accumulation period. Possible periods: [hour, day]"
}
}
},
"GetSIMCardInfoRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The ID of the account record"
},
"iccid" : {
"type" : "string",
"description" : "The Integrated Circuit Card Identifier of the SIM card record"
},
"i_sim_card" : {
"type" : "integer",
"description" : "The ID of the SIM card record"
},
"with_effective_hlr" : {
"type" : "integer",
"description" : "Get the effective home location register (hlr)"
},
"imsi" : {
"type" : "string",
"description" : "The International Mobile Subscriber Identity of the SIM card record"
}
}
},
"AddUpdateProductGroupResponse" : {
"required" : [
"i_product_group"
],
"type" : "object",
"properties" : {
"i_product_group" : {
"type" : "integer",
"description" : "The unique ID of the created/updated product group"
},
"group_info" : {
"$ref" : "#/components/schemas/ProductGroupInfo"
}
}
},
"GetUserNotificationListRequest" : {
"type" : "object",
"properties" : {
"i_user" : {
"type" : "integer",
"description" : "The unique ID of the user record"
}
}
},
"UpdateQFFieldsResponse" : {
"required" : [
"i_quick_form"
],
"type" : "object",
"properties" : {
"i_quick_form" : {
"type" : "integer",
"description" : "The unique ID of the quick form"
}
}
},
"ArrayOfSaleDiscountConfigurationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SaleDiscountConfigurationInfo"
}
},
"ArrayOfMediatorXDRInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MediatorXDRInfo"
}
},
"GetCustomerBillingPeriodsHistoryRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"include_current" : {
"type" : "integer",
"description" : "Specifies whether to include the current open billing period or not. Possible values: 1 – Include the current open billing period, 0 – Do not include the current open billing period"
},
"only_periods" : {
"type" : "integer",
"description" : "Specifies whether to show only the period_from and period_to dates of the billing period or include additional information as well (all information about the history record). Possible values: 1 – Show only the period_from and period_to dates, 0 – Include additional information as well"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer. Not mandatory when the method that requires this structure is executed from the retail customer realm"
}
}
},
"ResetPasswordResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"UpdateRoutingCriteriaResponse" : {
"required" : [
"i_criteria"
],
"type" : "object",
"properties" : {
"i_criteria" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria DB record"
}
}
},
"RegenerateInvoicePDFListRequest" : {
"required" : [
"invoice_list"
],
"type" : "object",
"properties" : {
"invoice_list" : {
"$ref" : "#/components/schemas/ArrayOfRegenerateInvoicePDFInfo"
}
}
},
"GetCCStaffInfoResponse" : {
"type" : "object",
"properties" : {
"cc_staff_info" : {
"$ref" : "#/components/schemas/CCStaffInfo"
}
}
},
"DeleteIvrApplicationResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success"
}
}
},
"AccountGetAllowedAddonsResponse" : {
"type" : "object",
"properties" : {
"allowed_addons" : {
"$ref" : "#/components/schemas/ANY"
}
}
},
"ArrayOfTransactionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TransactionInfo"
}
},
"GetCallBarringOptionsRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"get_effective_values" : {
"type" : "integer",
"description" : "Possible values: 1 – Retreive the call barring rules defined at the customer level; 0 – Retreive only those call barring rules that were defined for the account"
}
}
},
"GetPaymentProcessorResponse" : {
"required" : [
"payment_processor"
],
"type" : "object",
"properties" : {
"payment_processor" : {
"$ref" : "#/components/schemas/PaymentProcessor"
}
}
},
"GetRoutingPlanInfoRequest" : {
"required" : [
"i_routing_plan"
],
"type" : "object",
"properties" : {
"with_route_categories" : {
"type" : "integer",
"description" : "If set to '1', route categories assigned to the routing plan will be added to the response"
},
"i_routing_plan" : {
"type" : "integer",
"description" : "The unique ID of the routing plan record"
},
"with_rp_connections" : {
"type" : "integer",
"description" : "If set to '1', the routing plan connections assigned to the routing plan will be added to the response"
}
}
},
"AddAccessNumberListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success"
}
}
},
"ListCustomTaxOptionsResponse" : {
"required" : [
"custom_tax_options"
],
"type" : "object",
"properties" : {
"custom_tax_options" : {
"$ref" : "#/components/schemas/ArrayOfCustomTaxOptionInfo"
}
}
},
"SubscriptionPeriodicFeeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/OnePeriodSubscriptionPeriodicFeeInfo"
}
},
"UploadDIDNumbersRequest" : {
"type" : "object",
"properties" : {
"format" : {
"type" : "string",
"description" : "The format of the uploading file. The field is not mandatory if the file has a correct and supported extension. Possible values: 'csv', 'xls' or 'xlsx'"
},
"default_action" : {
"type" : "string",
"description" : "The field shows which action will be performed by default for every row in the attached spreadsheet file. Possible values: 'add', 'update' or 'add_update'"
}
}
},
"GetRepresentativeTransactionsTotalInfoRequest" : {
"required" : [
"i_rep",
"from_date",
"to_date"
],
"type" : "object",
"properties" : {
"i_rep" : {
"type" : "integer",
"description" : "The unique ID of the representative record"
},
"from_date" : {
"type" : "string",
"description" : "Get information recorded starting from this date"
},
"transaction_type" : {
"type" : "string",
"description" : "One of the following: commission, ot_commission, payout, bonus"
},
"to_date" : {
"type" : "string",
"description" : "Get information recorded before this date"
}
}
},
"GetIvrOptionListRequest" : {
"type" : "object",
"properties" : {
"i_voice_application" : {
"type" : "integer",
"description" : "The ID of the voice application"
}
}
},
"GetDiscountPlanInfoResponse" : {
"type" : "object",
"properties" : {
"discount_plan_info" : {
"$ref" : "#/components/schemas/DiscountPlanInfo"
}
}
},
"UpdateResaleMapRecordRequest" : {
"required" : [
"i_resale_tariff_mapping"
],
"type" : "object",
"properties" : {
"i_resale_tariff_mapping" : {
"type" : "integer",
"description" : "The unique ID of the tariff mapping record"
},
"i_tariff_sell" : {
"type" : "integer",
"description" : "The unique ID of the resale tariff record (the one that the reseller charges their subresellers)"
}
}
},
"GetCustomerVdCounterInfoResponse" : {
"type" : "object",
"properties" : {
"vd_counter_info" : {
"$ref" : "#/components/schemas/CounterInfo"
}
}
},
"ConvertMoneyRequest" : {
"required" : [
"to_iso_4217",
"amount",
"from_iso_4217"
],
"type" : "object",
"properties" : {
"to_iso_4217" : {
"type" : "string",
"description" : "The target currency"
},
"amount" : {
"type" : "number",
"description" : "The amount of money to convert"
},
"from_iso_4217" : {
"type" : "string",
"description" : "The initial currency"
}
}
},
"UpdateCustomerClassTaxationRequest" : {
"required" : [
"taxation_info",
"i_customer_class"
],
"type" : "object",
"properties" : {
"taxation_info" : {
"$ref" : "#/components/schemas/TaxationInfo"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique identifier for a tax transaction code; refers to the Tax_Transaction_Codes table"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class record"
},
"estimate_taxes" : {
"type" : "string",
"description" : "Shows whether the estimate taxes on receiving payments for the prepaid customers is enabled or disabled"
}
}
},
"GetDIDProviderInfoRequest" : {
"required" : [
"i_did_provider"
],
"type" : "object",
"properties" : {
"i_did_provider" : {
"type" : "integer",
"description" : "The unique ID of the DID provider"
}
}
},
"TerminateAssignedCommitmentRecordRequest" : {
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
},
"apply_prev_penalty" : {
"type" : "string",
"description" : "The flag specifies whether the penalties should be applied from previous commitments (default: they should)."
},
"apply_penalties" : {
"type" : "string",
"description" : "The flag specifies whether the penalties should be applied for early termination (default: they should). It may be overwritten for the specific commitment terms"
},
"penalty_period_to" : {
"type" : "string",
"description" : "Specifies the date until which the penalties are calculated"
},
"finish_date" : {
"type" : "string",
"description" : "Specifies the date on which the commitment should be terminated"
},
"penalty_period_from" : {
"type" : "string",
"description" : "Specifies the date staring from which the penalties are calculated"
},
"commitment_recurring_term_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountCommitmentRecurringTermInfo"
},
"commitment_one_time_term_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountCommitmentOneTimeTermInfo"
}
}
},
"GetAccountXDRQualityInfoResponse" : {
"type" : "object",
"properties" : {
"quality_info" : {
"$ref" : "#/components/schemas/XDRQualityMetricInfo"
}
}
},
"GetCustomerFullVDCounterListInfoRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"separate_units" : {
"type" : "integer",
"description" : "Specifies whether to provide threshold values and discount amount units (e.g., minutes) in a separate field"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"with_service_pool_info" : {
"type" : "integer",
"description" : "Specifies whether to provide service pool information of counter."
},
"with_discount_info" : {
"type" : "integer",
"description" : "Specifies whether to provide discount information of a counter"
}
}
},
"ArrayOfPaymentSystems" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PaymentSystemInfo"
}
},
"WarningInfo" : {
"required" : [
"message"
],
"type" : "object",
"properties" : {
"message" : {
"type" : "string",
"description" : "The warning message"
}
}
},
"AddRateResponse" : {
"required" : [
"i_rate"
],
"type" : "object",
"properties" : {
"i_rate" : {
"type" : "integer",
"description" : "The unique ID of the rate record created"
}
}
},
"ArrayOfAccountCommitmentRecurringEstimateTermInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountCommitmentRecurringEstimateTermInfo"
}
},
"UpdateAccountsBatchResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 if accounts batch update has been successful"
},
"warnings" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"ArrayOfAccountAuxFieldInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountAuxFieldInfo"
}
},
"ArrayOfDiscountPlanInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DiscountPlanInfo"
}
},
"AuthzMethodTypeInfo" : {
"required" : [
"i_authz_type",
"name"
],
"type" : "object",
"properties" : {
"i_authz_type" : {
"type" : "integer",
"description" : "The unique ID of the authentication method type"
},
"name" : {
"type" : "string",
"description" : "The name of the authentication method type"
}
}
},
"AddCPConditionResponse" : {
"required" : [
"i_cp_condition"
],
"type" : "object",
"properties" : {
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the call screening condition record"
}
}
},
"CustomerNumberSequenceInfo" : {
"type" : "object",
"properties" : {
"i_number_scope" : {
"type" : "integer",
"description" : "The ID of the number scope. 1 - env, 2 - reseller, 3 - customer"
},
"last_invoice_number" : {
"type" : "integer",
"description" : "The last invoice number"
},
"effective_i_number_scope" : {
"type" : "integer",
"description" : "The effective ID of the number scope"
}
}
},
"AddDisconnectQueueRecordResponse" : {
"required" : [
"i_pod"
],
"type" : "object",
"properties" : {
"i_pod" : {
"type" : "integer",
"description" : "The unique ID of the disconnect request. Refers to the DisconnectQuery table"
}
}
},
"GetNodeListRequest" : {
"type" : "object",
"properties" : {
"h323_id" : {
"type" : "string",
"description" : "For a VoIP node, this is equivalent to a hostname for an internet server (e.g. mail1.cyberdyne.com), i.e. a descriptive, human-readable name used for identification purposes"
},
"voip_dynamic_routing" : {
"type" : "string",
"description" : "Specifies whether the node type supports VoIP dynamic routing. Possible values: Y, N"
},
"ip" : {
"type" : "string",
"description" : "The IP address of the node"
},
"i_node_type" : {
"type" : "integer",
"description" : "The unique ID of the node type"
},
"name" : {
"type" : "string",
"description" : "The logical name of the node"
},
"aaa_protocol" : {
"type" : "string",
"description" : "Describes the AAA protocol used to communicate with the node. Possible values: 'disabled', 'RADIUS', 'DIAMETER'"
},
"complex_ordering" : {
"$ref" : "#/components/schemas/ComplexOrderingList"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the nodes in the response are in use"
},
"manufacturer" : {
"type" : "string",
"description" : "The manufacturer of the node"
},
"get_total" : {
"type" : "string",
"description" : "Get the total number of the retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of records to retrieve"
},
"type" : {
"type" : "string",
"description" : "The node type"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"UpdateCustomerHuntgroupRequest" : {
"required" : [
"i_c_group"
],
"type" : "object",
"properties" : {
"del_extensions" : {
"$ref" : "#/components/schemas/ArrayOfInt"
},
"prompt_action" : {
"type" : "string",
"description" : "Name of action to perform with prompt. Supported values: 'set', 'unset'"
},
"hunt_keep_original_cli" : {
"type" : "string",
"description" : "\n 'Y' - The call is redirected with the phone number and name of the original caller.\n 'N' - The call is redirected with the phone number and name of the huntgroup.\n 'I' - Id Only, The call is redirected with the phone number of the original caller and name of the huntgroup.\n Supported values: 'Y', 'N', 'I'\n "
},
"hunt_sequence" : {
"type" : "string",
"description" : "The ringing strategy; one of the following: Order, Random, Simultaneous, LeastUsed"
},
"i_ringback_tone" : {
"type" : "integer",
"description" : "The unique ID of the assigned ringback tone file"
},
"chg_callqueue" : {
"$ref" : "#/components/schemas/CQInfo"
},
"id" : {
"type" : "string",
"description" : "Huntgroup number"
},
"pickup_allowed" : {
"type" : "string",
"description" : "Flag that marks the Huntgroup as a Pickup Group. Supported values: 'Y', 'N'"
},
"i_c_ext" : {
"type" : "integer",
"description" : "Obsolete. Present in schema only for backward compatibility"
},
"name" : {
"type" : "string",
"description" : "Extension name"
},
"add_callqueue" : {
"$ref" : "#/components/schemas/CQInfo"
},
"prompt" : {
"type" : "string",
"description" : "A SOAP attachment name to be used in prompt operations"
},
"chg_extensions" : {
"$ref" : "#/components/schemas/ArrayOfAssignedExtensionsInfo"
},
"del_callqueue" : {
"type" : "integer",
"description" : "The unique ID of the call queue name to be deleted"
},
"add_extensions" : {
"$ref" : "#/components/schemas/ArrayOfAssignedExtensionsInfo"
},
"i_c_group" : {
"type" : "integer",
"description" : "The unique ID of the huntgroup"
},
"i_customer" : {
"type" : "integer",
"description" : "Obsolete. Present in schema only for backward compatibility"
}
}
},
"AddServicePolicyResponse" : {
"required" : [
"i_service_policy"
],
"type" : "object",
"properties" : {
"i_service_policy" : {
"type" : "integer",
"description" : "The unique identifier of the service policy"
}
}
},
"GetDIDNumberListStatisticsRequest" : {
"type" : "object"
},
"ArrayOfMetricDataInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MetricDataInfo"
}
},
"GetServiceTypeListRequest" : {
"type" : "object",
"properties" : {
"get_charge_unit_info" : {
"type" : "integer",
"description" : "Get information about the service type charge units"
},
"with_internal" : {
"type" : "integer",
"description" : "If set to '1', the internal service types will be provided in the response"
},
"name" : {
"type" : "string",
"description" : "Enables retrieving the service types list by name"
}
}
},
"GetCustomerQFInfoRequest" : {
"required" : [
"i_quick_form"
],
"type" : "object",
"properties" : {
"i_quick_form" : {
"type" : "integer",
"description" : "The unique ID of the quick form"
}
}
},
"DestinationDeleteCSetGroupResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"GetConnectionTypeInfoResponse" : {
"type" : "object",
"properties" : {
"connection_type_info" : {
"$ref" : "#/components/schemas/ConnectionTypeInfo"
}
}
},
"AddTariffDownloadTemplateRequest" : {
"required" : [
"name",
"i_time_zone"
],
"type" : "object",
"properties" : {
"i_media_type" : {
"type" : "integer",
"description" : "The unique ID of the media type record"
},
"name" : {
"type" : "string",
"description" : "Template name"
},
"custom_description" : {
"type" : "string",
"description" : "Template description"
},
"type" : {
"type" : "string",
"description" : "The name of the template type"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the time zone"
}
}
},
"ArrayOfAccountCommitmentOneTimeEstimateTermInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountCommitmentOneTimeEstimateTermInfo"
}
},
"AddCallQueueRequest" : {
"type" : "object",
"properties" : {
"callqueue_info" : {
"$ref" : "#/components/schemas/CQInfo"
}
}
},
"UpdateQFRequest" : {
"required" : [
"qf_info"
],
"type" : "object",
"properties" : {
"qf_info" : {
"$ref" : "#/components/schemas/QFInfo"
}
}
},
"ArrayOfAccountTransactionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountTransactionInfo"
}
},
"GetTimeZoneListResponse" : {
"required" : [
"time_zone_list"
],
"type" : "object",
"properties" : {
"time_zone_list" : {
"$ref" : "#/components/schemas/TimeZoneInfoList"
}
}
},
"GetResaleMapListResponse" : {
"type" : "object",
"properties" : {
"resale_map_list" : {
"$ref" : "#/components/schemas/ArrayOfResaleMapInfo"
}
}
},
"AddProductSubscriptionResponse" : {
"required" : [
"i_product_subscription"
],
"type" : "object",
"properties" : {
"i_product_subscription" : {
"type" : "integer",
"description" : "The ID of created product subscription record"
},
"subscription_info" : {
"$ref" : "#/components/schemas/ProductSubscriptionInfo"
}
}
},
"RoutingPlanCategoryInfo" : {
"type" : "object",
"properties" : {
"order_number" : {
"type" : "integer",
"description" : "The route category order number"
},
"i_routing_plan_cat" : {
"type" : "integer",
"description" : "The unique ID of the routing plan route category record"
},
"i_route_category" : {
"type" : "integer",
"description" : "The unique ID of the route category record"
},
"name" : {
"type" : "string",
"description" : "The name of the route category"
},
"i_routing_plan" : {
"type" : "integer",
"description" : "The unique ID of the routing plan record"
},
"description" : {
"type" : "string",
"description" : "The route category record description"
}
}
},
"ArrayOfVDTopupOptionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VDTopupOptionInfo"
}
},
"SessionLogMessageMetaInfo" : {
"type" : "object",
"properties" : {
"session_id" : {
"type" : "string",
"description" : "The h323-conf-id or call-id of the session"
},
"cli" : {
"type" : "string",
"description" : "The calling line identification"
},
"datetime" : {
"type" : "string",
"description" : "The precise date and time when the message was generated"
},
"diagramtext" : {
"type" : "string",
"description" : "The text which is shown on the diagram"
},
"source_ip" : {
"type" : "string",
"description" : "The source IP address"
},
"participant_from_id" : {
"type" : "string",
"description" : "The unique identifier of the participant that generated the SIP message"
},
"message_class" : {
"type" : "string",
"description" : "The class of the log message"
},
"participant_to" : {
"type" : "string",
"description" : "The participant that received the SIP message"
},
"operation" : {
"type" : "string",
"description" : "The type of the operation"
},
"dialog_id" : {
"type" : "string",
"description" : "The ID of the dialog the current log message belongs to"
},
"sip_node" : {
"type" : "string",
"description" : "The IP address of the SIP node"
},
"participant_from" : {
"type" : "string",
"description" : "The participant that generated the SIP message"
},
"user_name" : {
"type" : "string",
"description" : "The user name"
},
"level" : {
"type" : "integer",
"description" : "The level of the log message"
},
"participant_to_id" : {
"type" : "string",
"description" : "The unique identifier of the participant that received the SIP message"
},
"cld" : {
"type" : "string",
"description" : "The called line identification"
}
}
},
"GetCustomerCallBarringOptionsResponse" : {
"type" : "object",
"properties" : {
"options" : {
"$ref" : "#/components/schemas/ArrayOfCallBarringRuleInfo"
}
}
},
"AddAllowedLocationResponse" : {
"required" : [
"i_a_verified_locations"
],
"type" : "object",
"properties" : {
"i_a_verified_locations" : {
"type" : "integer",
"description" : "The ID of the account's allowed location record"
}
}
},
"LoginToRealmRequest" : {
"required" : [
"realm",
"login"
],
"type" : "object",
"properties" : {
"enable_csrf_protection" : {
"type" : "integer",
"description" : "The flag shows whether to permanently enable CSRF protection for the session"
},
"realm" : {
"type" : "string",
"description" : "The realm name the user wants to log into for the specified login; possible values: reseller, customer, accounts, representative, vendor"
},
"login" : {
"type" : "string",
"description" : "The user name as specified on the web interface"
}
}
},
"BatchDeleteCRStatusInfo" : {
"required" : [
"id"
],
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The ID of XDR of deleted call record file"
}
}
},
"DeleteTimePeriodResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case os success, exception in case of failure"
}
}
},
"GenerateAccountsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 if an accounts generation procedure was queued"
},
"i_batch" : {
"type" : "integer",
"description" : "The ID of the batch to which the accounts belong"
}
}
},
"AddAccountAliasRequest" : {
"required" : [
"alias_info"
],
"type" : "object",
"properties" : {
"alias_info" : {
"$ref" : "#/components/schemas/AliasInfo"
}
}
},
"ArrayOfPaymentProcessors" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PaymentProcessor"
}
},
"UnsuspendCustomerRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"GetCommitmentListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The commitment name"
},
"managed_by" : {
"type" : "integer",
"description" : "Return only commitments managed by the specified reseller"
},
"iso_4217" : {
"type" : "string",
"description" : "Filter commitments by the currency"
},
"check_usage" : {
"type" : "integer",
"description" : "The flag that specifies whether it is needed to check if the commitment is assigned to at least one account"
},
"min_period" : {
"type" : "integer",
"description" : "Filter the commitments by their minimum period"
},
"min_period_filter" : {
"type" : "string",
"description" : "Specifies the condition to be used for filtering the commitments by min_period. Possible values: less, equal, greater"
},
"i_subscription" : {
"type" : "integer",
"description" : "Filter only commitments that include recurring charges set via a specified subscription"
},
"i_addon_product" : {
"type" : "integer",
"description" : "Filter only commitments that include the specified addon product"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"AccountGetSimpleAccountInfoResponse" : {
"type" : "object",
"properties" : {
"customer_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
},
"account_info" : {
"$ref" : "#/components/schemas/AccountInfo"
},
"reseller_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
}
}
},
"GetInvoiceListRequest" : {
"required" : [
"limit",
"offset"
],
"type" : "object",
"properties" : {
"stage" : {
"type" : "string",
"description" : "Shows invoices in a specific phase. Possible values: generated, under_review "
},
"invoice_number_list" : {
"$ref" : "#/components/schemas/ArrayOfInvoiceNumber"
},
"i_parent" : {
"type" : "integer",
"description" : "The unique ID of the reseller (to get invoices for all subcustomers of this reseller)"
},
"pdf_generated" : {
"type" : "integer",
"description" : "Fetch only the invoices for which a pdf file has been created"
},
"covers_date" : {
"type" : "string",
"description" : "Return invoices that cover this billing date"
},
"invoice_status_list" : {
"$ref" : "#/components/schemas/ArrayOfInvoiceStatusInfo"
},
"issued_before" : {
"type" : "string",
"description" : "Fetch invoices with the 'issue_date' earlier than this date"
},
"limit" : {
"type" : "integer",
"description" : "Limit of invoices (maximum quantity of invoices)"
},
"offset" : {
"type" : "integer",
"description" : "Starting position for the invoice list"
},
"to_date" : {
"type" : "string",
"description" : "Fetch invoices with start date of the billing period(period_from) earlier than this date"
},
"get_arhived_pdfs" : {
"type" : "integer",
"description" : "Specifies whether to return the archived PDF invoices"
},
"from_date" : {
"type" : "string",
"description" : "Fetch invoices with start date of the billing period(period_from) later than this date"
},
"invoice_number" : {
"type" : "integer",
"description" : "Refers to Invoice Number – unique identifier of the invoice"
},
"only_pay_required" : {
"type" : "integer",
"description" : "Fetch only invoices which should be paid"
},
"complex_ordering" : {
"$ref" : "#/components/schemas/ComplexOrderingList"
},
"issued_after" : {
"type" : "string",
"description" : "Fetch invoices with the 'issue_date' later than this date"
},
"hide_void" : {
"type" : "integer",
"description" : "Exclude void invoices"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer the invoice belongs to"
}
}
},
"GetSipStatusResponse" : {
"type" : "object",
"properties" : {
"sip_status" : {
"type" : "integer",
"description" : "1 - online (account is used by SIP UA to register with the SIP server), 0 - offline"
},
"sip_info" : {
"$ref" : "#/components/schemas/SipStatusInfo"
},
"additional_sip_info_list" : {
"$ref" : "#/components/schemas/ArrayOfSipStatusInfo"
}
}
},
"RerateXDRsResponse" : {
"required" : [
"xdrs_rerated"
],
"type" : "object",
"properties" : {
"xdrs_rerated" : {
"type" : "integer",
"description" : "The total number of XDRs that were re-rated"
}
}
},
"TaxTransactionCode" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Shows whether the tax transaction code is in use"
},
"plugin_code_list" : {
"$ref" : "#/components/schemas/ArrayOfTaxPluginTransactionCodeInfo"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique ID of the taxation code database record"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller who manages this tax transaction code"
},
"description" : {
"type" : "string",
"description" : "The description of the transaction code"
},
"code" : {
"type" : "string",
"description" : "The value of the transaction code"
}
}
},
"ArrayOfCustomerTransactionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerTransactionInfo"
}
},
"GetRouteCategoryInfoResponse" : {
"type" : "object",
"properties" : {
"route_category_info" : {
"$ref" : "#/components/schemas/RouteCategoryInfo"
}
}
},
"GetProductGroupListResponse" : {
"required" : [
"groups"
],
"type" : "object",
"properties" : {
"groups" : {
"$ref" : "#/components/schemas/ArrayOfProductGroupInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of groups found"
}
}
},
"UpdateNotificationTemplateInfoRequest" : {
"required" : [
"notification_template_info"
],
"type" : "object",
"properties" : {
"notification_template_info" : {
"$ref" : "#/components/schemas/NotificationTemplateInfo"
}
}
},
"TerminateAccountResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
},
"warnings" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"GetAPISchemaRequest" : {
"type" : "object",
"properties" : {
"with_output_schema" : {
"type" : "integer",
"description" : "If set to '1', information about API methods' output structures will be shown in the response"
},
"service_name" : {
"type" : "string",
"description" : "The name of the API service"
},
"method_name" : {
"type" : "string",
"description" : "The name of the API method"
}
}
},
"UpdateFraudConstraintRequest" : {
"required" : [
"fraud_constraint_info"
],
"type" : "object",
"properties" : {
"fraud_constraint_info" : {
"$ref" : "#/components/schemas/FraudConstraintInfo"
}
}
},
"AddVendorDIDProviderAccountResponse" : {
"required" : [
"i_did_provider_acc"
],
"type" : "object",
"properties" : {
"i_did_provider_acc" : {
"type" : "integer",
"description" : "The unique ID of the DID provider account"
}
}
},
"ArrayOfDIDNumberInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DIDNumberInfo"
}
},
"DeleteCommissionPlanResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"ArrayOfTotalTransInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TotalTransInfo"
}
},
"TotalTransInfo" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "number",
"description" : "The total amount for transactions of this type"
},
"name" : {
"type" : "string",
"description" : "Transaction type"
}
}
},
"GetCallBarringClassInfoRequest" : {
"required" : [
"i_cp_condition"
],
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the call barring class is in use"
},
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the call barring class"
}
}
},
"AccountGetTracedXdrListResponse" : {
"type" : "object",
"properties" : {
"traced_xdrs" : {
"$ref" : "#/components/schemas/ArrayOfTraceXdrInfo"
}
}
},
"GetSpendingCounterListResponse" : {
"type" : "object",
"properties" : {
"spending_counter_list" : {
"$ref" : "#/components/schemas/ArrayOfSpendingCounterInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"GetMemberOfHuntgroupsList" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
}
}
},
"GetEnvListResponse" : {
"required" : [
"env_list"
],
"type" : "object",
"properties" : {
"env_list" : {
"$ref" : "#/components/schemas/ArrayOfEnvInfo"
}
}
},
"DeleteTariffResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"GetCommissionPlanListRequest" : {
"type" : "object",
"properties" : {
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of entity, which manage the commission plan"
},
"iso_4217" : {
"type" : "string",
"description" : "The commission plan currency"
},
"name" : {
"type" : "string",
"description" : "The commission plan name"
},
"get_total" : {
"type" : "integer",
"description" : "Flag which indicates whether the total number of the commission plans should be retrurned"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"i_cp_base" : {
"type" : "integer",
"description" : "The unique ID of the commission plan base"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"StatusHistoryInfo" : {
"type" : "object",
"properties" : {
"time_stamp" : {
"type" : "string",
"description" : "Date and time when this change was made"
},
"status_name" : {
"type" : "string",
"description" : "Customer status name"
},
"i_status" : {
"type" : "integer",
"description" : "The unique ID of the status record"
},
"i_cust_stat" : {
"type" : "integer",
"description" : "The unique ID of the customer status change record"
}
}
},
"AddIvrApplicationRequest" : {
"required" : [
"ivr_application_info"
],
"type" : "object",
"properties" : {
"ivr_application_info" : {
"$ref" : "#/components/schemas/IvrApplicationInfo"
}
}
},
"AddNumberRequest" : {
"required" : [
"number_info"
],
"type" : "object",
"properties" : {
"number_info" : {
"$ref" : "#/components/schemas/DIDNumberInfo"
}
}
},
"GetAccessPolicyInfoRequest" : {
"required" : [
"i_access_policy"
],
"type" : "object",
"properties" : {
"with_attributes" : {
"type" : "integer",
"description" : "If set to '1', the list of related service policy attribute values will be provided in the response"
},
"check_usage" : {
"type" : "integer",
"description" : "If set to '1', the 'is_used' field will be provided in the response"
},
"with_access_phases" : {
"type" : "integer",
"description" : "If set to '1', the list of access_phases will be provided in the response"
},
"i_access_policy" : {
"type" : "integer",
"description" : "The unique ID of the Access Policy"
}
}
},
"UpdateVendorAccountRequest" : {
"required" : [
"vendor_account_info"
],
"type" : "object",
"properties" : {
"vendor_account_info" : {
"$ref" : "#/components/schemas/VendorAccountInfo"
}
}
},
"PaymentSystemInfo" : {
"required" : [
"i_payment_method",
"payment_method"
],
"type" : "object",
"properties" : {
"icon_url" : {
"type" : "string",
"description" : "URL for the payment method icon"
},
"web_link" : {
"type" : "string",
"description" : "An URL for Payment Processor API and documentation"
},
"remote_cc_storage" : {
"type" : "string",
"description" : "Indicates whether Payment Processor supports remote storing card info and can use a token for payments. Possible values: Y, N"
},
"refnum" : {
"type" : "string",
"description" : "Reference number (custom field)"
},
"i_online_payment_processor" : {
"type" : "integer",
"description" : "The unique ID of the Payment Processor"
},
"ext_auth" : {
"type" : "string",
"description" : "Does method need External authentication"
},
"i_payment_method" : {
"type" : "integer",
"description" : "The unique ID of Payment Method"
},
"processor" : {
"type" : "string",
"description" : "The name of the Payment Processor"
},
"recurring" : {
"type" : "string",
"description" : "Indicates whether Recurring Payments are enabled. Possible values: Y, N"
},
"csc_policy" : {
"type" : "string",
"description" : "Shows whether transactions via merchant require credit card security code or not"
},
"test_mode" : {
"type" : "string",
"description" : "Indicates that Payment Processor is in test mode"
},
"url_suffix" : {
"type" : "string",
"description" : "Suffix URL for Merchant Account"
},
"login" : {
"type" : "string",
"description" : "Login for the Payment Processor"
},
"payment_method" : {
"type" : "string",
"description" : "Name of the payment method, one of the following: Cash, Cheque, American Express, Discover, MasterCard, VISA, Switch, Check, DirectDebitNL. Pass undefined value in order to dismiss payment method"
},
"handler" : {
"type" : "string",
"description" : "Name of Mason component for creating a specific request template for particular Payment Processor with external authentication"
},
"min_allowed_payment" : {
"type" : "number",
"description" : "The minimal allowed payment amount"
},
"callback" : {
"type" : "string",
"description" : "Name of the callback page for Payment Processor with external authentication"
},
"merchant_account_name" : {
"type" : "string",
"description" : "The Name of the Merchant Account for the Payment Processor"
}
}
},
"ArrayOfTemplateMediaAttributeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TemplateMediaAttributeInfo"
}
},
"ArrayOfUAPortConfiguration" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UAPortConfiguration"
}
},
"GetIvrApplicationInfoRequest" : {
"required" : [
"i_voice_app_access_number"
],
"type" : "object",
"properties" : {
"i_voice_app_access_number" : {
"type" : "integer",
"description" : "The unique ID of the IVR application"
}
}
},
"GetProductRolesListRequest" : {
"type" : "object"
},
"AuthorizedEmailInfo" : {
"type" : "object",
"properties" : {
"i_tariff_template" : {
"type" : "integer",
"description" : "The unique ID of the tariff template DB record"
},
"disabled" : {
"type" : "string",
"description" : "Disable tariff upload from this source"
},
"email_from" : {
"type" : "string",
"description" : "Sender’s email; to prevent unauthorized access, only a trusted email will be allowed"
},
"email_key" : {
"type" : "string",
"description" : "Security key; the tariff will be accepted only if the correct key is specified in the message’s subject line or body"
}
}
},
"GetAccountXDRListRequest" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "ID of the Service Type that can be used instead of i_service"
},
"cli" : {
"type" : "string",
"description" : "The calling party phone number"
},
"i_service" : {
"type" : "integer",
"description" : "ID of Service, refer to Services table"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"connect_time_before" : {
"type" : "string",
"description" : "Get xDRs with connect_time before this date"
},
"call_recording" : {
"type" : "integer",
"description" : "Set this flag to filter xDRs by their call recording status. When it's not provided, all xDRs are obtained"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved xDRs"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"quality" : {
"type" : "string",
"description" : "The call quality. Possible values: good, fair, poor, unknown"
},
"connect_time_after" : {
"type" : "string",
"description" : "Get xDRs with connect_time after this date"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"to_date" : {
"type" : "string",
"description" : "Get xDRs with bill_time before this date"
},
"get_split_xdrs" : {
"type" : "integer",
"description" : "If set, split XDRs will be present in the response"
},
"roaming" : {
"type" : "integer",
"description" : "Set this flag to filter xDRs by their roaming status. When it's not provided, all xDRs are obtained"
},
"show_unsuccessful" : {
"type" : "integer",
"description" : "Show xDRs of unsuccessful attempts"
},
"history_pattern" : {
"type" : "string",
"description" : "Specifies whether to show xDRs with history that matches the pattern"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"call_id" : {
"type" : "string",
"description" : "The unique identifier of the call"
},
"from_date" : {
"type" : "string",
"description" : "Get xDRs with bill_time starting from this date"
},
"with_netaccess_usage" : {
"type" : "integer",
"description" : "If set, then each netaccess xDR will contain 'bytes_downloaded' and 'bytes_uploaded' fields in the response"
},
"enable_safe_mode" : {
"type" : "integer",
"description" : "The flag shows whether to check the amount of data before processing"
},
"format" : {
"type" : "string",
"description" : "This parameter allows to get xDRs in other formats via SOAP attachment. Currently only the \"csv\" format is supported"
},
"with_cr_download_ids" : {
"type" : "integer",
"description" : "If set, then each xDR will contain download ids to the recorded files if any"
},
"cld" : {
"type" : "string",
"description" : "Calling line destination"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The unique identifier of the session"
}
}
},
"DeleteScheduledCommitmentRecordReplacementResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "The result of the operation, or an exception in case of failure"
}
}
},
"GetCommitmentListResponse" : {
"type" : "object",
"properties" : {
"commitment_list" : {
"$ref" : "#/components/schemas/ArrayOfCommitmentInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of found records"
}
}
},
"GetXDRCollectionInfoRequest" : {
"required" : [
"collection_name"
],
"type" : "object",
"properties" : {
"collection_name" : {
"type" : "string",
"description" : "The name of the xDR collection"
}
}
},
"ServiceAndRatingRoutingInfo" : {
"type" : "object",
"properties" : {
"i_acc_routing_tariff" : {
"type" : "integer",
"description" : "Routing plan and tariff pair identifier"
},
"reseller_tariff_name" : {
"type" : "string",
"description" : "Tariff name(used for resellers product)"
},
"i_routing_plan" : {
"type" : "integer",
"description" : "Routing identifier"
},
"i_tariff" : {
"type" : "integer",
"description" : "Tariff identifier"
},
"i_accessibility" : {
"type" : "integer",
"description" : "Service&Rating identifier"
},
"tariff_name" : {
"type" : "string",
"description" : "Tariff name"
},
"i_tariff_reseller" : {
"type" : "integer",
"description" : "Tariff identifier(used for resellers product)"
},
"routing_plan_name" : {
"type" : "string",
"description" : "Routing Plan name"
}
}
},
"AddUpdateCustomerHuntgroupResponse" : {
"required" : [
"i_c_group"
],
"type" : "object",
"properties" : {
"i_c_group" : {
"type" : "integer",
"description" : "The unique ID of the created huntgroup"
}
}
},
"GetInvoiceStatusInfoRequest" : {
"required" : [
"i_invoice_status"
],
"type" : "object",
"properties" : {
"i_invoice_status" : {
"type" : "integer",
"description" : "The unique ID of the invoice status record"
}
}
},
"UpdateSpendingConstraintResponse" : {
"required" : [
"i_sp_constraint"
],
"type" : "object",
"properties" : {
"i_sp_constraint" : {
"type" : "integer",
"description" : "The identifier of the spending constraint"
}
}
},
"GetMediatorXDRInfoDetailedRequest" : {
"required" : [
"collection_name",
"xdr_id"
],
"type" : "object",
"properties" : {
"collection_name" : {
"type" : "string",
"description" : "The name of the xDR collection"
},
"xdr_id" : {
"type" : "string",
"description" : "The ID of the xDR record"
}
}
},
"DialingRuleInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Shows whether the dialing rule is in use. Possible values: 1 - in use, 0 - not in use"
},
"i_owner" : {
"type" : "integer",
"description" : "The unique ID of the dialing rule owner record"
},
"is_default" : {
"type" : "integer",
"description" : "Shows whether the dialing rule is default in the system"
},
"owner_type" : {
"type" : "string",
"description" : "The type of dialing rule owner. One of the following: Customer, CustomerSite, Account"
},
"name" : {
"type" : "string",
"description" : "The dialing rule name"
},
"rule" : {
"$ref" : "#/components/schemas/DialingRuleOptionsInfo"
},
"description" : {
"type" : "string",
"description" : "The dialing rule description"
},
"rule_type" : {
"type" : "string",
"description" : "Type of the dialing rule wizard. Possible values: 'pbx – The wizard for creating pbx dialing rules. Both translation parameters and service codes are available.', 'planOnly - translation parameters will be available in the wizard.', 'advanced - The wizard for creating custom dialing rules. Dialing rules can be created by using Perl regular expressions.'"
},
"i_dialing_rule" : {
"type" : "integer",
"description" : "The unique ID of the dialing rule record"
},
"restricted" : {
"type" : "string",
"description" : "Only administrator is allowed to assign restricted rules"
},
"usage_type" : {
"type" : "string",
"description" : "Where this rule can be applied/assigned"
},
"dial_codes" : {
"$ref" : "#/components/schemas/DialingCodes"
},
"tr_rule_to_local" : {
"type" : "string",
"description" : "Translation rule 'to local format'"
},
"tr_rule_from_local" : {
"type" : "string",
"description" : "Translation rule \"from local format\""
}
}
},
"GetUserRTTicketListResponse" : {
"required" : [
"ticket_list"
],
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The number of retrieved tickets"
},
"ticket_list" : {
"$ref" : "#/components/schemas/ArrayOfTicketInfo"
}
}
},
"ServiceAndRatingRoutingList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServiceAndRatingRoutingInfo"
}
},
"GetCustomerQFInfoResponse" : {
"required" : [
"qf_info"
],
"type" : "object",
"properties" : {
"qf_info" : {
"$ref" : "#/components/schemas/QFInfo"
}
}
},
"DeleteVoiceQualityProfileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 if the voice quality profile was deleted"
}
}
},
"ArrayOfAccessRoleInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccessRoleInfo"
}
},
"GetMOHListInfoResponse" : {
"type" : "object",
"properties" : {
"moh_list_info" : {
"$ref" : "#/components/schemas/MOHListInfo"
}
}
},
"GetCCStaffInfoRequest" : {
"required" : [
"i_cc_staff"
],
"type" : "object",
"properties" : {
"i_cc_staff" : {
"type" : "integer",
"description" : "The unique ID of the CC staff record to be fetched"
}
}
},
"ArrayOfUAInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UAInfo"
}
},
"ReleaseDIDNumberRequest" : {
"type" : "object",
"properties" : {
"number" : {
"type" : "string",
"description" : "DID number to release"
},
"timestamp" : {
"type" : "string",
"description" : "Time stamp of previous reservation to check"
}
}
},
"GetSubdivisionsListRequest" : {
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "A two-letter country code defined in ISO 3166-1 alpha-2"
}
}
},
"ActiveSessionInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"cli" : {
"type" : "string",
"description" : "The calling line phone number"
},
"on_net" : {
"type" : "integer",
"description" : "The flag that shows whether the session is on-net"
},
"subdivision" : {
"type" : "string",
"description" : "The called destination country subdivision name"
},
"vendor_name" : {
"type" : "string",
"description" : "The name of the vendor on the PortaBilling interface"
},
"original_cld" : {
"type" : "string",
"description" : "The original called line phone number"
},
"resale_hierarchy" : {
"$ref" : "#/components/schemas/ArrayOfCustomerInfo"
},
"source_ip" : {
"type" : "string",
"description" : "The IP address of the entity"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"connect_time" : {
"type" : "string",
"description" : "The time when the connection was initiated"
},
"service_type_name" : {
"type" : "string",
"description" : "The logical name of the Service Type"
},
"country" : {
"type" : "string",
"description" : "The called destination country name"
},
"i_connection_type" : {
"type" : "integer",
"description" : "The unique ID of the connection type"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor"
},
"original_cli" : {
"type" : "string",
"description" : "The original calling line phone number"
},
"duration" : {
"type" : "integer",
"description" : "The session length (number of seconds) from the moment when the session was started"
},
"call_id" : {
"type" : "string",
"description" : "The call-id of the session"
},
"nodes_passed" : {
"$ref" : "#/components/schemas/ArrayOfSessionNodeInfo"
},
"is_disconnectable" : {
"type" : "integer",
"description" : "The flag that shows whether the session can be disconnected"
},
"account_id" : {
"type" : "string",
"description" : "The ID (PIN) of the account on the PortaBilling interface, unique in the environment"
},
"setup_time" : {
"type" : "string",
"description" : "The setup time of the session"
},
"connection_name" : {
"type" : "string",
"description" : "The name of the connection used"
},
"cld" : {
"type" : "string",
"description" : "The called line phone number"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The h323-conf-id of the session"
},
"hotlined" : {
"type" : "integer",
"description" : "The flag that shows whether hotlining is configured (Internet sessions only)"
},
"i_connection" : {
"type" : "integer",
"description" : "The unique ID of the connection"
},
"customer_name" : {
"type" : "string",
"description" : "The name of the customer"
},
"connection_type_name" : {
"type" : "string",
"description" : "The name of the connection type"
}
}
},
"GetCustomerClassInfoResponse" : {
"type" : "object",
"properties" : {
"customer_class_info" : {
"$ref" : "#/components/schemas/CustomerClassInfo"
}
}
},
"ArrayOfTemplateGroupFieldList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TemplateGroupFieldList"
}
},
"GetEnvNotificationTemplateInfoRequest" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the either email or sms notification template as it appears in the Notifications table in the database"
}
}
},
"ArrayOfTaxPluginParameterInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TaxPluginParameterInfo"
}
},
"GetCurrencyInfoResponse" : {
"required" : [
"currency_info"
],
"type" : "object",
"properties" : {
"currency_info" : {
"$ref" : "#/components/schemas/CurrencyInfo"
}
}
},
"SendMeCustomerClassNotificationSampleResponse" : {
"required" : [
"is_sent"
],
"type" : "object",
"properties" : {
"is_sent" : {
"type" : "integer",
"description" : "Specifies whether the notification was sent. Possible values: 1 – The notification was sent, 0 – The notification was not sent"
}
}
},
"GetLastBillingDateConstraintListResponse" : {
"required" : [
"constraint_list"
],
"type" : "object",
"properties" : {
"constraint_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerLastBillingDateConstraintInfo"
}
}
},
"UpdateCustomerClassNotificationListRequest" : {
"required" : [
"notification_list",
"i_customer_class"
],
"type" : "object",
"properties" : {
"notification_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerClassNotificationInfo"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
}
}
},
"GetASRFileListRequest" : {
"required" : [
"period_from",
"i_vendor",
"period_to"
],
"type" : "object",
"properties" : {
"period_from" : {
"type" : "string",
"description" : "Get vendor ASR files dated starting from this date"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"period_to" : {
"type" : "string",
"description" : "Get vendor ASR files dated before this date"
}
}
},
"ServiceFeatureDetails" : {
"type" : "object",
"properties" : {
"flag_pos" : {
"type" : "integer",
"description" : "Service_flag item position in the service features array"
},
"feature_name" : {
"type" : "string",
"description" : "Service feature name"
},
"attributes_list" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureAttributes"
},
"default_flag" : {
"type" : "string",
"description" : "Default value of the corresponding service feature item. One of the following: Y – enabled, N – disabled, ^ – customer's default, ~ – product default"
},
"i_service_feature" : {
"type" : "integer",
"description" : "The unique ID of the service feature"
}
}
},
"ArrayOfUAProfileParameterInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UAProfileParameterInfo"
}
},
"GetCriteriaListResponse" : {
"required" : [
"criteria_list"
],
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of Criteria found"
},
"criteria_list" : {
"$ref" : "#/components/schemas/ArrayOfCriterionInfo"
}
}
},
"GetNetworkConnectivityListRequest" : {
"type" : "object"
},
"AccountRegisterTransactionResponse" : {
"type" : "object",
"properties" : {
"transaction" : {
"$ref" : "#/components/schemas/TransactionInfo"
}
}
},
"RoutingCriteriaDestGroupMetricFlags" : {
"type" : "object",
"properties" : {
"aloc_penalty" : {
"type" : "integer",
"description" : "Exclude the penalty threshold of the average length of call from the routing criteria"
},
"aloc_warning" : {
"type" : "integer",
"description" : "Exclude the warning threshold of the average length of call from the routing criteria"
},
"ppm_penalty" : {
"type" : "integer",
"description" : "Exclude the penalty threshold of the profit per minute from the routing criteria"
},
"ppm_warning" : {
"type" : "integer",
"description" : "Exclude the warning threshold of the profit per minute from the routing criteria"
},
"high_pdd_warning" : {
"type" : "integer",
"description" : "Exclude the warning threshold of the maximum acceptable PDD from the routing criteria"
},
"high_pdd_penalty" : {
"type" : "integer",
"description" : "Exclude the penalty threshold for the maximum acceptable PDD from the routing criteria"
},
"low_pdd_warning" : {
"type" : "integer",
"description" : "Exclude the warning threshold of the minimum acceptable PDD from the routing criteria"
},
"asr_warning" : {
"type" : "integer",
"description" : "Exclude the warning threshold of the average success rate from the routing criteria"
},
"low_pdd_penalty" : {
"type" : "integer",
"description" : "Exclude the penalty threshold of the minimum acceptable PDD from the routing criteria"
},
"asr_penalty" : {
"type" : "integer",
"description" : "Exclude the penalty threshold of the average success rate from the routing criteria"
}
}
},
"GetDefaultDestinationPrefixListResponse" : {
"type" : "object"
},
"CustomerGetCustomerNumberSequenceInfoResponse" : {
"required" : [
"number_sequence_info"
],
"type" : "object",
"properties" : {
"number_sequence_info" : {
"$ref" : "#/components/schemas/CustomerNumberSequenceInfo"
}
}
},
"DeleteDialingRuleRequest" : {
"required" : [
"i_dialing_rule"
],
"type" : "object",
"properties" : {
"i_dialing_rule" : {
"type" : "integer",
"description" : "The unique ID of the dialing rule record"
}
}
},
"RegenerateInvoiceRequest" : {
"required" : [
"i_invoice"
],
"type" : "object",
"properties" : {
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"ArrayOfBillingPeriodsHistoryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BillingPeriodHistoryInfo"
}
},
"AddUpdateRoutingPlanResponse" : {
"type" : "object",
"properties" : {
"i_routing_plan" : {
"type" : "integer",
"description" : "The unique ID of the created routing plan record"
}
}
},
"ArrayOfEmergencyUnitRoutingNumberRuleInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EmergencyUnitRoutingNumberRuleInfo"
}
},
"TerminateAssignedCommitmentRecordResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "The result of the operation, or an exception in case of failure"
}
}
},
"GetHGListInfoResponse" : {
"type" : "object",
"properties" : {
"huntgroup_list" : {
"$ref" : "#/components/schemas/ArrayOfHGInfo"
},
"total" : {
"type" : "integer",
"description" : "Number of huntgroups"
}
}
},
"GetPresetCategoryListRequest" : {
"required" : [
"i_notification_preset"
],
"type" : "object",
"properties" : {
"i_notification_preset" : {
"type" : "integer",
"description" : "The unique identifier of the notification preset"
}
}
},
"ServiceAndRatingInfo" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "Product identifier to which Service&Rating entity belongs"
},
"i_service_type" : {
"type" : "integer",
"description" : "Unique service type ID"
},
"alert_overuse_reject" : {
"type" : "string",
"description" : "Flag which indicates whether the system should notify in case of a fraud suspicion"
},
"i_service" : {
"type" : "integer",
"description" : "Unique service ID"
},
"i_node" : {
"type" : "integer",
"description" : "Node identifier"
},
"i_rate_match_mode" : {
"type" : "integer",
"description" : "Rate Mode identifier"
},
"reseller_tariff_name" : {
"type" : "string",
"description" : "Tariff name(used for resellers product)"
},
"routing_list" : {
"$ref" : "#/components/schemas/ServiceAndRatingRoutingList"
},
"allow_suspended_consumption" : {
"type" : "string",
"description" : "This parameter allows/disallows end users to use certain services when their accounts are suspended. Possible values: 'None','FreeOnly'"
},
"i_accessibility" : {
"type" : "integer",
"description" : "Service&Rating identifier"
},
"i_oli" : {
"type" : "integer",
"description" : "OLI identifier"
},
"max_auth_funds" : {
"type" : "number",
"description" : "This determines the maximum amount of account funds to be used for the session"
},
"min_session_funds" : {
"type" : "number",
"description" : "The deposit amount for each individual session to be locked to a specified value"
},
"i_tariff_reseller" : {
"type" : "integer",
"description" : "Tariff identifier (used for a reseller's product or a shared product managed by the admin)"
},
"max_session_funds" : {
"type" : "number",
"description" : "Reduces deposit amount to be locked for each individual session but does not restrict the session"
},
"check_funds" : {
"type" : "string",
"description" : "Type of the policy for checking funds in the call beginning(enum: Y, N, B,D)"
},
"i_tariff" : {
"type" : "integer",
"description" : "Tariff identifier"
},
"tariff_name" : {
"type" : "string",
"description" : "Tariff name"
},
"cld" : {
"type" : "string",
"description" : "CLD tech prefix helps to identify connection from several with same IP address"
}
}
},
"TariffSellInfo" : {
"type" : "object",
"properties" : {
"markup_percent" : {
"type" : "number",
"description" : "Specifies a percentage markup for the resale tariff as compared with the wholesale tariff rates. Only used if the i_tariff_sell property is not provided"
},
"exchange_rate" : {
"type" : "number",
"description" : "A custom exchange rate. If empty or not defined, the current exchange rate will be used. Only used if the i_tariff_sell property is not defined"
},
"name" : {
"type" : "string",
"description" : "The name of the resale tariff record (the one that the reseller charges their subresellers). Only used if the i_tariff_sell property is not defined"
},
"description" : {
"type" : "string",
"description" : "The resale tariff description. Only used if the i_tariff_sell property is not defined"
},
"markup_fixed_amount" : {
"type" : "number",
"description" : "Specifies the fixed amount to be added to the resale tariff if (only if) the calculated percentage markup is lower than this one. Only used if the i_tariff_sell property is not provided"
}
}
},
"ArrayOfAuxXDRInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AuxXDRInfo"
}
},
"GetBrandpaneArchiveRequest" : {
"type" : "object",
"properties" : {
"realm" : {
"type" : "string",
"description" : "The realm name as in the configuration (accounts, customer, cc_staff, representative, admin, vendor)"
}
}
},
"ArrayOfCommissionPlanBaseInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CommissionPlanBaseInfo"
}
},
"ValidateAccountInfoRequest" : {
"type" : "object",
"properties" : {
"account_info" : {
"$ref" : "#/components/schemas/AccountInfo"
}
}
},
"ReviewInvoiceResponse" : {
"required" : [
"i_invoice"
],
"type" : "object",
"properties" : {
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"GetUserInfoListRequest" : {
"type" : "object",
"properties" : {
"search" : {
"type" : "string",
"description" : "A pattern that allows searching by user's personal information (login, company name, first name, last name, baddr1, address_line_2, city, zip, cont1, cont2, phone1, phone2, email, description). Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character"
},
"status" : {
"type" : "string",
"description" : "Search by user's status. Possible values: active, inactive, expired or exceeded"
},
"login" : {
"type" : "string",
"description" : "The username for login and user identification"
},
"i_role" : {
"type" : "integer",
"description" : "The identifier of the access role"
},
"email" : {
"type" : "string",
"description" : "An email contact for the user"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved users"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"i_acl" : {
"type" : "integer",
"description" : "The privilege level or role assigned to the user "
},
"hide_personal_info" : {
"type" : "integer",
"description" : "Filter users by their ability to access personal information."
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"ArrayOfUsedLocationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UsedLocationInfo"
}
},
"GetBundlePromotionListRequest" : {
"type" : "object",
"properties" : {
"filter" : {
"type" : "string",
"description" : "Allows retrieving bundle promotions by the name or part of the name"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who manages the required bundle promotions"
},
"iso_4217" : {
"type" : "string",
"description" : "The bundle promotion plan currency in the three-letter format (ISO 4217)"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set associated with this bundle promotion plan"
},
"get_total" : {
"type" : "integer",
"description" : "Specifies whether to show the total number of found bundle promotions. Then, even if, e.g. the limit property is specified, the total number of bundle promotions that satisfy other conditions will be shown."
},
"managed_by_admin" : {
"type" : "string",
"description" : "Specifies that only those bundle promotions that are managed by administrator must be retrieved. Possible values: Y – Retrieve only bundle promotions managed by admin; N – Retrieve all bundle promotions"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property specified in the API request"
}
}
},
"GetDIDAreasListRequest" : {
"type" : "object",
"properties" : {
"req_params" : {
"$ref" : "#/components/schemas/DIDRequestParameters"
},
"req_params_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDRequestParametersInfo"
},
"did_provider_info" : {
"$ref" : "#/components/schemas/CustomerDIDProviderIdent"
},
"for_idle_numbers_only" : {
"type" : "string",
"description" : "Get the list of areas by numbers in the DID Pool (Y/N), default - N"
}
}
},
"UploadExternalInvoiceFileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"ArrayOfVoiceApplicationOptionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VoiceApplicationOptionInfo"
}
},
"GetCustomTaxOptionResponse" : {
"type" : "object",
"properties" : {
"custom_tax_option" : {
"$ref" : "#/components/schemas/CustomTaxOptionInfo"
}
}
},
"CustomerGetSelfcareConfigDataRequest" : {
"type" : "object"
},
"ScheduledCommitmentReplacementInfo" : {
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record that should be replaced. On the 'upgrade_on' date this commitment will be terminated (without penalties) and replaced with the new one"
},
"i_new_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the commitment that will be assigned to the account after the upgrade"
},
"i_addon_product" : {
"type" : "integer",
"description" : "The identifier of the addon product that will be assigned to the account until the upgrade is done"
},
"upgrade_on" : {
"type" : "string",
"description" : "The date on which the new commitment should be applied permanently. Until this date the customer may use the services provided by the new i_addon_product according to the old commitment price"
}
}
},
"ArrayOfVdDestGroup" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VdDestGroupInfo"
}
},
"GetSubscriptionInfoRequest" : {
"required" : [
"i_subscription"
],
"type" : "object",
"properties" : {
"check_usage_by_resellers" : {
"type" : "integer",
"description" : "If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response"
},
"with_discounts" : {
"type" : "integer",
"description" : "Indicates whether a list of periodic fees will be returned for the retrieved subscription"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Plan record"
},
"with_fees" : {
"type" : "integer",
"description" : "Flag which indicates whether the periodic fees for the Subscription should be returned"
}
}
},
"GetVendorBatchListResponse" : {
"type" : "object",
"properties" : {
"vendor_batch_list" : {
"$ref" : "#/components/schemas/ArrayOfVendorBatchInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of retrieved records"
}
}
},
"AssignedExtensionsInfo" : {
"type" : "object",
"properties" : {
"hunt_order" : {
"type" : "integer",
"description" : "Indicates the position of this extension in the huntgroup ringing order. For the add_customer_huntgroup and update_customer_huntgroup methods, if hunt_order of the extension is not specified, then the extension will be automatically assigned the next highest hunt order number. That is, if you already have extensions with hunt order numbers 0, 1, 2, the new extension will be assigned hunt order number 3"
},
"primary_group" : {
"type" : "string",
"description" : "Indicates whether this huntgroup is assigned as the primary group for the extension"
},
"hunt_delay" : {
"type" : "integer",
"description" : "Indicates the delay (in seconds) before the extension starts ringing"
},
"i_customer_of_account" : {
"type" : "integer",
"description" : "The unique ID of the customer who owns the account"
},
"hunt_active" : {
"type" : "string",
"description" : "Specifies whether ringing is enabled or not. Possible values: Y – Ringing is enabled; N – Ringing is disabled"
},
"i_c_ext" : {
"type" : "integer",
"description" : "Extension ID; Refers to the Centrex_Group_Extensions table. Used in the 'add_extensions' structure"
},
"hunt_expire" : {
"type" : "integer",
"description" : "Indicates the duration of ringing (in seconds)"
},
"huntstop" : {
"type" : "string",
"description" : "Indicates whether to disable any forwarding for calls made to this huntgroup"
},
"name" : {
"type" : "string",
"description" : "The name of the owner"
},
"i_cg_ext" : {
"type" : "integer",
"description" : "Primary key in the Centrex_Group_Extensions table – the list of numbers to forward the call to. Used in the 'chg_extensions' and 'del_extensions' structures"
},
"account_id" : {
"type" : "string",
"description" : "The ID of the account this extension is assigned to"
},
"i_c_group" : {
"type" : "integer",
"description" : "The unique ID of the huntgroup record. Used in the 'add_extensions' structure"
},
"id" : {
"type" : "string",
"description" : "The extension identifier used in dialing"
},
"type" : {
"type" : "string",
"description" : "One of the following: Account, Group, Unassigned"
}
}
},
"UpdateRoamingProfileRequest" : {
"required" : [
"roaming_profile_info"
],
"type" : "object",
"properties" : {
"roaming_profile_info" : {
"$ref" : "#/components/schemas/RoamingProfileInfo"
}
}
},
"CancelDIDProvisionResponse" : {
"required" : [
"is_canceled"
],
"type" : "object",
"properties" : {
"is_canceled" : {
"type" : "integer",
"description" : "Indicates whether the number has been released"
}
}
},
"AddAccountRequest" : {
"type" : "object",
"properties" : {
"generate_web_password" : {
"type" : "integer",
"description" : "Specifies whether to autogenerate a password to the account self-care interface. Possible values: 1 – Generate a password; 0 – Do not generate a password"
},
"account_info" : {
"$ref" : "#/components/schemas/AccountInfo"
}
}
},
"GetSpendingConstraintInfoRequest" : {
"required" : [
"i_sp_constraint"
],
"type" : "object",
"properties" : {
"i_sp_constraint" : {
"type" : "integer",
"description" : "The identifier of the spending constraint"
}
}
},
"UpdateVendorBatchRequest" : {
"required" : [
"vendor_batch_info"
],
"type" : "object",
"properties" : {
"vendor_batch_info" : {
"$ref" : "#/components/schemas/VendorBatchInfo"
}
}
},
"UpdateDiscountPlanResponse" : {
"required" : [
"i_vd_plan"
],
"type" : "object",
"properties" : {
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan"
}
}
},
"GetTemplateComponentListResponse" : {
"type" : "object",
"properties" : {
"template_component_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateComponentInfo"
}
}
},
"UpdateCommitmentOneTimeTermRequest" : {
"required" : [
"one_time_term_info"
],
"type" : "object",
"properties" : {
"one_time_term_info" : {
"$ref" : "#/components/schemas/CommitmentOneTimeTermInfo"
}
}
},
"GetAccessPolicyListRequest" : {
"type" : "object",
"properties" : {
"with_attributes" : {
"type" : "integer",
"description" : "If set to '1', the list of related service policy attribute values will be provided for every record in the response"
},
"name" : {
"type" : "string",
"description" : "The name of the access policy"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who owns the access policy"
},
"check_usage" : {
"type" : "integer",
"description" : "If set to '1', the 'is_used' field will be provided for every record in the response"
},
"with_access_phases" : {
"type" : "integer",
"description" : "If set to '1', the list of 'access_phases' will be provided for every record in the response"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetCustomXdrReportListResponse" : {
"required" : [
"total",
"report_list"
],
"type" : "object",
"properties" : {
"report_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomXdrReportInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved reports"
}
}
},
"SetTaxPluginParametersRequest" : {
"required" : [
"tax_plugin_parameters",
"i_plugin"
],
"type" : "object",
"properties" : {
"tax_plugin_parameters" : {
"$ref" : "#/components/schemas/ArrayOfTaxPluginParameterInfo"
},
"i_plugin" : {
"type" : "integer",
"description" : "The unique ID of the taxation plugin database record"
}
}
},
"GetPhoneBookRecordResponse" : {
"type" : "object",
"properties" : {
"phonebook_rec_info" : {
"$ref" : "#/components/schemas/PhoneBookRecInfo"
}
}
},
"ArrayOfRequestDIDNumberInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RequestDIDNumberInfo"
}
},
"SubscriptionPeriodicFeeList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SubscriptionPeriodicFeeInfo"
}
},
"GetZendeskOrganizationInfoResponse" : {
"type" : "object",
"properties" : {
"zendesk_organization_info" : {
"$ref" : "#/components/schemas/ZendeskOrganizationInfo"
}
}
},
"AddConnectionResponse" : {
"required" : [
"i_connection"
],
"type" : "object",
"properties" : {
"i_connection" : {
"type" : "integer",
"description" : "The unique ID of the vendor connection record"
}
}
},
"AssignDIDToCustomerResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 – DID was assigned, 0 – DID was not assigned"
}
}
},
"CustomerDIDNumberInfo" : {
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique ID of the DID number record"
},
"area_name" : {
"type" : "string",
"description" : "Area name"
},
"country_name" : {
"type" : "string",
"description" : "Country name"
},
"did_number" : {
"type" : "string",
"description" : "DID number"
},
"extension_id" : {
"type" : "string",
"description" : "ID of the extension"
},
"group_name" : {
"type" : "string",
"description" : "Name of the DID group the number belongs to"
},
"master_account_id" : {
"type" : "string",
"description" : "ID (PIN) of the account this DID number is assigned to"
},
"description" : {
"type" : "string",
"description" : "DID number description"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account created for this DID number"
},
"extension_name" : {
"type" : "string",
"description" : "Name of the extension"
},
"i_master_account" : {
"type" : "integer",
"description" : "The unique ID of the account this DID number is assigned to"
},
"is_provisioned" : {
"type" : "integer",
"description" : "Indicates whether this number is provisioned from an online DID provider"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record to which the DID number belongs"
},
"pricing" : {
"$ref" : "#/components/schemas/DIDPricing"
}
}
},
"GetAccountCustomFieldsSchemaRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record. If not provided, the ID of the entity that is logged in will be used"
}
}
},
"ArrayOfPhoneBookRecInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/PhoneBookRecInfo"
}
},
"ScheduleTariffCloningResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 in case of success, exception error message in case of failure"
}
}
},
"UATypeUsageInfo" : {
"required" : [
"total_free",
"total_used",
"i_ua_type"
],
"type" : "object",
"properties" : {
"total_free" : {
"type" : "integer",
"description" : "The total number of the UA devices of this type that are available"
},
"total_used" : {
"type" : "integer",
"description" : "The total number of the UA devices of this type that are in use"
},
"manufacturer" : {
"type" : "string",
"description" : "The UA type device manufacturer's company name"
},
"version" : {
"type" : "string",
"description" : "The version of the UA device of this type"
},
"i_ua_type" : {
"type" : "integer",
"description" : "The unique ID of the UA type"
},
"product" : {
"type" : "string",
"description" : "The model of the UA device of this type"
}
}
},
"GetCommissionPlanInfoResponse" : {
"type" : "object",
"properties" : {
"commission_plan_info" : {
"$ref" : "#/components/schemas/CommissionPlanInfo"
}
}
},
"CloneTemplateRequest" : {
"required" : [
"i_template",
"name"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"name" : {
"type" : "string",
"description" : "Template name"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller"
}
}
},
"SessionLogInfoForRT" : {
"type" : "object",
"properties" : {
"node_list" : {
"$ref" : "#/components/schemas/ArrayOfSessionLogNodeInfo"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The ID of the billing session"
},
"call_id" : {
"type" : "string",
"description" : "The ID of the service session"
}
}
},
"ArrayOfAccessLevels" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccessLevelInfo"
}
},
"SetInvoiceStateRequest" : {
"required" : [
"state",
"i_invoice"
],
"type" : "object",
"properties" : {
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
},
"state" : {
"type" : "string",
"description" : "Change the invoice state to either of these: opened, closed"
}
}
},
"GlobalCurrencyInfo" : {
"type" : "object",
"properties" : {
"name_major" : {
"type" : "string",
"description" : "Major name of the currency, e.g. dollar (returned only in the response to the \"get\" method)"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 alphabetic code, the unqiue currency identifier"
},
"iso_4217_num" : {
"type" : "string",
"description" : "ISO4217 numeric code, the unqiue currency identifier"
},
"name" : {
"type" : "string",
"description" : "The currency name"
},
"decimal_digits" : {
"type" : "integer",
"description" : "Maximum number of decimal places allowed for a currency, e.g. for US dollars or euros it will be 2, since the smallest unit is one cent (0.01), while for yens it will be 0"
},
"name_minor" : {
"type" : "string",
"description" : "Minor name of the currency, e.g. cent, (returned only in the response to the \"get\" method) "
},
"obsolete" : {
"type" : "string",
"description" : "Specifies whether this currency is obsolete"
}
}
},
"ArrayOfTemplateInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TemplateInfo"
}
},
"MetricGroupingTimeInfo" : {
"required" : [
"value",
"group_count"
],
"type" : "object",
"properties" : {
"unit" : {
"type" : "string",
"description" : "A sampling time unit. Possible values: year, month, week, day, hour, min, sec, msec"
},
"value" : {
"type" : "integer",
"description" : "The value of the sampling time unit. Min value: 1"
},
"group_count" : {
"type" : "integer",
"description" : "Shows how many data groups should be created. Min value: 1"
}
}
},
"GetCustomerMigrationResponse" : {
"type" : "object",
"properties" : {
"migration_info" : {
"$ref" : "#/components/schemas/CustomerMigrationInfo"
}
}
},
"GetRoamingProfileInfoRequest" : {
"required" : [
"i_roaming_profile"
],
"type" : "object",
"properties" : {
"with_policy" : {
"type" : "integer",
"description" : "Specifies whether the fraud policy for each restriction level will be returned for the retrieved roaming profile"
},
"i_roaming_profile" : {
"type" : "integer",
"description" : "The unique ID of the roaming profile"
},
"with_countries" : {
"type" : "integer",
"description" : "Specifies whether the lists of roaming countries for each restriction level will be returned for the retrieved roaming profile"
}
}
},
"AddUAProfileRequest" : {
"required" : [
"ua_profile_info"
],
"type" : "object",
"properties" : {
"ua_profile_info" : {
"$ref" : "#/components/schemas/UAProfileInfo"
}
}
},
"AddUpdateDialingRuleRequest" : {
"required" : [
"dialing_rule_info"
],
"type" : "object",
"properties" : {
"dialing_rule_info" : {
"$ref" : "#/components/schemas/DialingRuleInfo"
}
}
},
"AclInfo" : {
"type" : "object",
"properties" : {
"group" : {
"type" : "string",
"description" : "Name of ACL group"
},
"name" : {
"type" : "string",
"description" : "ACL by name"
},
"i_acl" : {
"type" : "integer",
"description" : "Unique ID of the ACL"
},
"type" : {
"type" : "string",
"description" : "Type of ACL"
},
"subsystem" : {
"type" : "string",
"description" : "Name of subsystem ACL belongs to"
}
}
},
"TaxationInfo" : {
"required" : [
"processor"
],
"type" : "object",
"properties" : {
"options_billsoft" : {
"$ref" : "#/components/schemas/TaxationOptionsBillsoft"
},
"options_custom" : {
"$ref" : "#/components/schemas/ArrayOfCustomTaxationOptions"
},
"options_suretax" : {
"$ref" : "#/components/schemas/TaxationOptionsSureTax"
},
"processor" : {
"type" : "string",
"description" : "Taxation plug-in name"
},
"options_avalara" : {
"$ref" : "#/components/schemas/TaxationOptionsAvalara"
},
"options_gst" : {
"$ref" : "#/components/schemas/TaxationOptionsGST"
},
"options_vat" : {
"$ref" : "#/components/schemas/TaxationOptionsVat"
}
}
},
"OffPeakInfo" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the off-peak period"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller record (managed by)"
},
"i_offpeak" : {
"type" : "integer",
"description" : "The unique ID of the off-peak period"
}
}
},
"ArrayOfRepresentativeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RepresentativeInfo"
}
},
"GetBundlePromotionInfoResponse" : {
"type" : "object",
"properties" : {
"bundle_promotion_info" : {
"$ref" : "#/components/schemas/BundlePromotionInfo"
}
}
},
"BundleDiscountThresholdList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BundleDiscountThresholdInfo"
}
},
"AddUserResponse" : {
"type" : "object",
"properties" : {
"i_user" : {
"type" : "integer",
"description" : "The unique ID of the user record"
}
}
},
"EnableApiNotificationsCustomerRequest" : {
"required" : [
"event"
],
"type" : "object",
"properties" : {
"i_main_office" : {
"type" : "integer",
"description" : "The unique ID of a сustomer's record with headquarters office type"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"event" : {
"type" : "string",
"description" : "The event name"
}
}
},
"TemplateMediaAttributeInfo" : {
"type" : "object",
"properties" : {
"attribute_name" : {
"type" : "string",
"description" : "The name of the attribute"
},
"attribute_type" : {
"type" : "string",
"description" : "The type of the attribute"
},
"editor_order" : {
"type" : "integer",
"description" : "Defines the position of the attribute in the editor"
},
"value" : {
"type" : "string",
"description" : "The value of the attribute of the template"
},
"i_ma_definition" : {
"type" : "integer",
"description" : "The unique ID of the media attribute"
},
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"list_values" : {
"$ref" : "#/components/schemas/ArrayOfMediaAttributeValueInfo"
},
"editable" : {
"type" : "string",
"description" : "Defines whether the value of the attribute can be changed for the template"
},
"mandatory" : {
"type" : "string",
"description" : "Defines whether the value of the attribute is mandatory"
},
"hidden" : {
"type" : "string",
"description" : "Defines whether the value of the attribute is hidden on the Web Interface"
},
"i_tma" : {
"type" : "integer",
"description" : "The unique ID of the template media attribute"
}
}
},
"UpdateCPRuleRequest" : {
"required" : [
"cp_rule_info"
],
"type" : "object",
"properties" : {
"cp_rule_info" : {
"$ref" : "#/components/schemas/CPRuleInfo"
}
}
},
"DialingRuleOptionsInfo" : {
"type" : "object",
"properties" : {
"css" : {
"type" : "integer",
"description" : "1 - Strip selection code after selection Routing Plan"
},
"nex" : {
"type" : "string",
"description" : "National Exceptions; comma-separated list "
},
"dp" : {
"type" : "string",
"description" : "Prefix for domestic calls outside area code"
},
"location" : {
"type" : "string",
"description" : "Indicates where the relevant dialing rule belongs: 'I' for an international dialing rule, or 'A' for North America"
},
"ip" : {
"type" : "string",
"description" : "International dialing prefix"
},
"ex" : {
"type" : "string",
"description" : "Exceptions; comma-separated list "
},
"ac" : {
"type" : "string",
"description" : "Area code(s)"
},
"csdr" : {
"type" : "integer",
"description" : "1 - Apply the customer dialling rules to a number follows after the selection code"
},
"ia" : {
"type" : "integer",
"description" : "1 - Always Dial the Area Code as a part of the number"
},
"nl" : {
"type" : "integer",
"description" : "Local dialing number length"
},
"em" : {
"type" : "string",
"description" : "Emergency Numbers; comma-separated list "
},
"cc" : {
"type" : "string",
"description" : "Country code"
},
"cs" : {
"type" : "integer",
"description" : "0 - Routing plan selection disabled, 1 - Routing plan selection enabled"
},
"op" : {
"type" : "string",
"description" : "Prefix for accessing the outside phone network"
}
}
},
"DeleteCodecConverterFileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success"
}
}
},
"ANY" : {
"type" : "object"
},
"AccessRoleInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Shows if the access role is used or not"
},
"i_role_type" : {
"type" : "integer",
"description" : "The type of the access role"
},
"permissions" : {
"$ref" : "#/components/schemas/AccessComponentPermission"
},
"is_system" : {
"type" : "integer",
"description" : "Shows if the access role is system or not"
},
"name" : {
"type" : "string",
"description" : "The name of the access role"
},
"i_role" : {
"type" : "integer",
"description" : "The identifier of the access role"
}
}
},
"WebLogFieldInfo" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the field"
},
"new_value" : {
"type" : "string",
"description" : "The current value of the field"
},
"old_value" : {
"type" : "string",
"description" : "The previous value of the field"
}
}
},
"GetMOHFileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 in case of success, 0 in case of failure"
}
}
},
"DeleteCustomerMigrationResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 in case of failure"
}
}
},
"ArrayOfNotificationPresetCategoryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NotificationPresetCategoryInfo"
}
},
"ArrayOfReportFileInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ReportFileInfo"
}
},
"GetAccountServiceFeaturesRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
}
}
},
"AddDestinationPrefixRequest" : {
"required" : [
"destination_info"
],
"type" : "object",
"properties" : {
"destination_info" : {
"$ref" : "#/components/schemas/DestinationPrefixInfo"
}
}
},
"AddTrafficProfileResponse" : {
"required" : [
"i_traffic_profile"
],
"type" : "object",
"properties" : {
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
}
}
},
"GetRetailCustomerXDRListRequest" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the related service type"
},
"cli" : {
"type" : "string",
"description" : "The calling party phone number"
},
"billing_model" : {
"type" : "integer",
"description" : "Indicates whether the data should be retrieved for the credit entries or for the debit ones: 1 - Credit accounts; -1 - Debit accounts; Empty - Return both"
},
"i_service" : {
"type" : "integer",
"description" : "ID of the Service, refers to the Services table"
},
"i_customer_type" : {
"type" : "integer",
"description" : "The unique ID of the XDR owner customer type"
},
"connect_time_before" : {
"type" : "string",
"description" : "Get xDRs with connect_time before this date"
},
"call_recording" : {
"type" : "integer",
"description" : "Set this flag to filter xDRs by their call recording status. When it's not provided, all xDRs are obtained"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved xDRs"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"quality" : {
"type" : "string",
"description" : "The call quality. Possible values: good, fair, poor, unknown"
},
"connect_time_after" : {
"type" : "string",
"description" : "Get xDRs with connect_time after this date"
},
"i_invoice" : {
"type" : "integer",
"description" : "Indicates what xDRs will be shown: nill - Midterm xDRs and out-ofturn xDRs; 0 - Out Of Turn xDRs; Not set – xDRs of all types"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"to_date" : {
"type" : "string",
"description" : "Get XDRs with bill_time before this date"
},
"get_split_xdrs" : {
"type" : "integer",
"description" : "If set, split XDRs will be present in the response"
},
"roaming" : {
"type" : "integer",
"description" : "Set this flag to filter xDRs by their roaming status. When it's not provided, all xDRs are obtained"
},
"show_unsuccessful" : {
"type" : "integer",
"description" : "Show xDRs of unsuccessful attempts"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"history_pattern" : {
"type" : "string",
"description" : "Specifies whether to show xDRs with history that matches the pattern"
},
"for_current_period" : {
"type" : "integer",
"description" : "Specifies whether to show xDRs for the current billing period"
},
"from_date" : {
"type" : "string",
"description" : "Get xDRs with bill_time starting from this date"
},
"call_id" : {
"type" : "string",
"description" : "The unique identifier of the call"
},
"with_netaccess_usage" : {
"type" : "integer",
"description" : "If set, then each netaccess xDR will contain the 'bytes_downloaded' and 'bytes_uploaded' fields in the response"
},
"enable_safe_mode" : {
"type" : "integer",
"description" : "The flag shows whether to check the amount of data before processing"
},
"format" : {
"type" : "string",
"description" : "This parameter allows API user to get xDRs in other formats via SOAP attachment. Currently only the \".csv\" format is supported"
},
"show_hidden" : {
"type" : "integer",
"description" : "If the method is called by the administrator and is set to 1, the list of hidden xDRs will be provided in the response"
},
"with_cr_download_ids" : {
"type" : "integer",
"description" : "If set, then each xDR will contain download ids to the recorded files if any"
},
"cld" : {
"type" : "string",
"description" : "The called party phone number"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer real"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The unique identifier of the session"
},
"cdr_entity" : {
"type" : "string",
"description" : "Flag indicates from where CDRs should be returned: A - account xDRs; C - customer xDRs; Do not send - Return account and customer xDRs"
}
}
},
"GetPaymentTransactionResponse" : {
"type" : "object",
"properties" : {
"transaction" : {
"$ref" : "#/components/schemas/TransactionInfo"
}
}
},
"ArrayOfFraudTrafficAlertInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FraudTrafficAlertInfo"
}
},
"GetDestinationPrefixListRequest" : {
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "Search by country prefix"
},
"network" : {
"type" : "string",
"description" : "Mobile network name"
},
"destination" : {
"type" : "string",
"description" : "Refers to the pattern of the destination prefix"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"with_system" : {
"type" : "integer",
"description" : "The flag shows whether the system's destinations should be included in the response"
},
"description" : {
"type" : "string",
"description" : "Search by description"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set"
},
"format" : {
"type" : "string",
"description" : "Search by number format"
},
"i_country_subdivision" : {
"type" : "integer",
"description" : "The unique ID of the state or province related to the destination"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved destination prefixes"
},
"destination_list" : {
"$ref" : "#/components/schemas/ArrayOfRequestDestinationPrefixInfo"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"order_by_destination" : {
"type" : "string",
"description" : "Specifies whether to sort destinations: 1 - descending order; 0 - ascending If this field is empty then destinations will be sorted by the i_dest field"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"file_format" : {
"type" : "string",
"description" : "This parameter enables the user to get destinations in other formats via an attachment. Possible values: 'csv', 'xls', 'xlsx'"
}
}
},
"BillingPeriodInfo" : {
"required" : [
"i_billing_period",
"description"
],
"type" : "object",
"properties" : {
"i_billing_period" : {
"type" : "integer",
"description" : "The unique ID of the Billing Period"
},
"description" : {
"type" : "string",
"description" : "The Billing Period description"
}
}
},
"AddCustomFieldResponse" : {
"required" : [
"i_custom_field"
],
"type" : "object",
"properties" : {
"i_custom_field" : {
"type" : "integer",
"description" : "The unique ID of the custom field record"
}
}
},
"GetTemplateMediaAttributeListResponse" : {
"type" : "object",
"properties" : {
"template_media_attribute_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateMediaAttributeInfo"
}
}
},
"ArrayOfServiceWalletXDRInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServiceWalletXDRInfo"
}
},
"CurrencyInfo" : {
"required" : [
"iso_4217"
],
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Shows whether the currency is in use"
},
"i_ma_currency" : {
"type" : "integer",
"description" : "The unique merchant account currency identifier. This property is mandatory if min_payment or i_merchant_account is supplied"
},
"name_major" : {
"type" : "string",
"description" : "The main currency unit, e.g. dollar"
},
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique payment system ID for the transaction"
},
"iso_4217" : {
"type" : "string",
"description" : "Currency ISO4217 code"
},
"name" : {
"type" : "string",
"description" : "Currency name"
},
"i_x_rate_source" : {
"type" : "integer",
"description" : "Defines the method of entering the exchange rate for the currency. Refers to X_Rate_Source table"
},
"name_minor" : {
"type" : "string",
"description" : "The lesser currency unit (if applicable), e.g. cent"
},
"base_units" : {
"type" : "number",
"description" : "An exchange rate between the currency and base unit. This property is used for manual exchange only (i_x_rate_source=1 )"
},
"min_allowed_payment" : {
"type" : "number",
"description" : "The smallest allowed amount for an online payment (in the corresponding currency), in order to prevent service abuse"
},
"decimal_digits" : {
"type" : "integer",
"description" : "Maximum number of decimal places for a currency, e.g. for US dollars or euros it will be 2, since the smallest unit is one cent (0.01), while for yens it will be 0"
}
}
},
"DeleteRoutingPlanRequest" : {
"required" : [
"i_routing_plan"
],
"type" : "object",
"properties" : {
"i_routing_plan" : {
"type" : "integer",
"description" : "The unique ID of the created routing plan record"
}
}
},
"GetAsyncRequestInfoRequest" : {
"required" : [
"i_async_request"
],
"type" : "object",
"properties" : {
"i_async_request" : {
"type" : "integer",
"description" : "The unique ID of the request"
}
}
},
"GetDiscountInfoResponse" : {
"type" : "object",
"properties" : {
"discount_info" : {
"$ref" : "#/components/schemas/DiscountInfo"
}
}
},
"UpdateCustomerParams" : {
"type" : "object",
"properties" : {
"apply_spending_counter_charge_now" : {
"type" : "integer",
"description" : "Indicates when charge for the traffic profile spending counter should be applied. Possible values: '1' - immediately, '0' - at the beginning of the next day"
}
}
},
"AddUpdateCustomerAbbreviatedDialingNumberResponse" : {
"required" : [
"i_ab_dialing"
],
"type" : "object",
"properties" : {
"i_ab_dialing" : {
"type" : "integer",
"description" : "ID of abbreviated dialing number record"
}
}
},
"ArrayOfInvoiceInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/InvoiceInfo"
}
},
"AccountCustomFieldsInfo" : {
"type" : "object",
"properties" : {
"i_custom_field" : {
"type" : "integer",
"description" : "Unique ID of the Custom Field record"
},
"value" : {
"type" : "string",
"description" : "Value of the Custom Field"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who manages the Custom Field record"
},
"name" : {
"type" : "string",
"description" : "Name of the Custom Field"
},
"properties" : {
"type" : "string",
"description" : "JSON-encoded Validation Schema for the Custom Field"
},
"default_value" : {
"type" : "string",
"description" : "Default value for the Custom Field"
},
"personal_data" : {
"type" : "string",
"description" : "Shows that the custom field contains private data and should not be shown to unauthorized users"
},
"type" : {
"type" : "string",
"description" : "Canonical name of the Custom Field's type. Currently supported: 'text', 'list', 'date', 'number', 'datetime'"
},
"mandatory" : {
"type" : "string",
"description" : "Shows that the Custom Field is mandatory. Possible values: 'Y', 'N'"
},
"visible_to_end_user" : {
"type" : "string",
"description" : "Shows that the Custom Field is visible to the End User. Possible values: 'Y', 'N'"
}
}
},
"GetCustomerClassListResponse" : {
"type" : "object",
"properties" : {
"customer_class_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerClassInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved customer class records"
}
}
},
"AddUpdateServiceResponse" : {
"type" : "object",
"properties" : {
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
}
}
},
"GetGlobalCurrencyInfoRequest" : {
"required" : [
"iso_4217"
],
"type" : "object",
"properties" : {
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 alphabetic code, the unique currency identifier"
}
}
},
"SpendingCounterInfo" : {
"type" : "object",
"properties" : {
"notified_estimation_ratio" : {
"type" : "string",
"description" : "The date and time when the notification about the reaching of the warning thresholds was sent"
},
"spent_amount_limit" : {
"type" : "number",
"description" : "The total amount of money per period that a customer can spend on services. It is calculated as sum of the constraint_amount and the extra_amount"
},
"last_modified" : {
"type" : "string",
"description" : "The date and time when the counter was last updated"
},
"period_to" : {
"type" : "string",
"description" : "The date and time when the spending counter expires"
},
"i_c_spend_counter" : {
"type" : "integer",
"description" : "The unique ID of the customer's spending counter"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
},
"spent_amount" : {
"type" : "number",
"description" : "The amount actually spent"
},
"constraint_amount" : {
"type" : "number",
"description" : "The initial amount of money that the customer can spend on services in the period"
},
"period_from" : {
"type" : "string",
"description" : "The date and time when the spending counter is activated"
},
"extra_amount" : {
"type" : "number",
"description" : "The additional credit for the period – temporarily amount that increases the customer's spending limit"
},
"notified_depletion" : {
"type" : "string",
"description" : "The date and time when the notification about the funds depletion was sent"
},
"notified_ratio" : {
"type" : "string",
"description" : "The date and time when the notification about the reaching of the spending limit was sent"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"i_spend_constraint_limit" : {
"type" : "integer",
"description" : "The unique ID of the spend constraint limit record"
}
}
},
"DeleteCustomerBatchResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 – In case of success; 0 - for failure"
}
}
},
"GetCustomerVdNotificationListRequest" : {
"type" : "object",
"properties" : {
"peak_level" : {
"type" : "integer",
"description" : "Possible values: 0 – The peak period; 1 – The off-peak period; 2 – The 2nd off-peak period"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group to apply the top-up to"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"get_total" : {
"type" : "integer",
"description" : "Include the total number of records"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"limit" : {
"type" : "integer",
"description" : "The number of records to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of records to skip at the beginning"
}
}
},
"ObtainAccessNumberRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
}
}
},
"GetDiscountPlanListRequest" : {
"type" : "object",
"properties" : {
"iso_4217" : {
"type" : "string",
"description" : "Volume discount plan currency"
},
"name" : {
"type" : "string",
"description" : "Name pattern of a volume discount plan"
},
"check_complete_status" : {
"type" : "integer",
"description" : "If set to '1', the 'is_complete' field will be returned for every discount plan in the response"
},
"with_shared" : {
"type" : "integer",
"description" : "If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set associated with this discount plan"
},
"check_usage" : {
"type" : "integer",
"description" : "Check discount plans usage by entities"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved volume discount plans"
},
"only_completed" : {
"type" : "integer",
"description" : "Include completed discount plans only"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer the volume discount plan is assigned to. Specify 0 or null to retrieve volume discount plans managed by the administrator"
},
"offset" : {
"type" : "string",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetCustomerQFListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The quick form name pattern"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property value to be specified in the API request"
}
}
},
"GetTrafficProfileListResponse" : {
"required" : [
"traffic_profile_list"
],
"type" : "object",
"properties" : {
"traffic_profile_list" : {
"$ref" : "#/components/schemas/ArrayOfTrafficProfileInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of retrieved records"
}
}
},
"AccountPerServiceInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"ratio" : {
"type" : "integer",
"description" : "Billing:Base Ratio. If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration"
},
"rating_base_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units in which service use is measured; this also is the smallest possible unit you use in the rating configuration (e.g. second)"
},
"credits" : {
"type" : "number",
"description" : "The sum of credit transaction amounts related to the service"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service; refers to Services table"
},
"rate_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units used to calculate service charges (e.g. message, minute)"
},
"name" : {
"type" : "string",
"description" : "The service name"
},
"charges" : {
"type" : "number",
"description" : "The sum of charge transaction amounts related to the service"
},
"total" : {
"type" : "integer",
"description" : "Subtotal for this type of transactions/service"
},
"unit" : {
"type" : "string",
"description" : "The unit in which the charged quantity is shown (e.g. second)"
},
"charged_amount" : {
"type" : "number",
"description" : "The sum of the amounts in the 'credits' and 'charges' fields"
},
"charged_quantity" : {
"type" : "integer",
"description" : "Units charged"
},
"rating_base" : {
"type" : "string",
"description" : "Specifies which particular parameter is used to calculate charges, e.g. \"session time\", \"amount of data transferred\" and the like"
},
"total_sessions" : {
"type" : "integer",
"description" : "The total number of sessions of this transactions/service type"
}
}
},
"GetBusinessModelsListRequest" : {
"type" : "object"
},
"ArrayOfMetricAggregatorInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MetricAggregatorInfo"
}
},
"ArrayOfAccessNumberInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccessNumberInfo"
}
},
"GetDialingRuleInfoResponse" : {
"type" : "object",
"properties" : {
"dialing_rule_info" : {
"$ref" : "#/components/schemas/DialingRuleInfo"
}
}
},
"GetAsyncRequestListResponse" : {
"type" : "object",
"properties" : {
"request_list" : {
"$ref" : "#/components/schemas/ArrayOfAsyncRequestInfo"
}
}
},
"AccountsAdvancedSearchInfo" : {
"type" : "object",
"properties" : {
"firstname" : {
"type" : "string",
"description" : "Account owner's first name"
},
"midinit" : {
"type" : "string",
"description" : "Account owner's middle initial(s)"
},
"cont1" : {
"type" : "string",
"description" : "Main contact person"
},
"salutation" : {
"type" : "string",
"description" : "Account owner's salutation"
},
"lastname" : {
"type" : "string",
"description" : "Account owner's last name"
},
"state" : {
"type" : "string",
"description" : "Province or state"
},
"city" : {
"type" : "string",
"description" : "City of account owner's address"
},
"cont2" : {
"type" : "string",
"description" : "Alternative contact person"
},
"id" : {
"type" : "string",
"description" : "Search pattern for account IDs"
},
"country" : {
"type" : "string",
"description" : "Country code"
},
"bill_status" : {
"type" : "string",
"description" : "The billing status of the account. Possible values: O – open; I – inactive; C – terminated"
},
"note" : {
"type" : "string",
"description" : "Short note (description)"
},
"login" : {
"type" : "string",
"description" : "User login for self-care web interface"
},
"zip" : {
"type" : "string",
"description" : "Postal (zip) code"
},
"faxnum" : {
"type" : "string",
"description" : "Fax number"
},
"phone1" : {
"type" : "string",
"description" : "Main phone number"
},
"phone2" : {
"type" : "string",
"description" : "Alternative phone number"
},
"companyname" : {
"type" : "string",
"description" : "Account owner's company name"
}
}
},
"MarkXdrOutOfTurnResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"MoveAccountResponse" : {
"required" : [
"old_i_account",
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The new unique ID of the account that was moved"
},
"old_i_account" : {
"type" : "integer",
"description" : "The old ID of the account that was moved"
},
"warnings" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"GetDIDNumberListStatisticsResponse" : {
"type" : "object",
"properties" : {
"total_free" : {
"type" : "integer",
"description" : "The total number of DID numbers that are not used (including frozen ones)"
},
"total_used" : {
"type" : "integer",
"description" : "The total number of DID numbers that are already in use"
},
"total_frozen" : {
"type" : "integer",
"description" : "The total number of frozen DID numbers"
},
"total" : {
"type" : "integer",
"description" : "The total number of DID numbers"
},
"min_periodic_fee" : {
"type" : "integer",
"description" : "The minimum value of the 'periodic_fee' field of DID numbers in the system"
},
"max_activation_fee" : {
"type" : "integer",
"description" : "The maximum value of the 'activation_fee' field of DID numbers in the system"
},
"min_activation_fee" : {
"type" : "integer",
"description" : "The minimum value of the 'activation_fee' field of DID numbers in the system"
},
"max_periodic_fee" : {
"type" : "integer",
"description" : "The maximum value of the 'periodic_fee' field of DID numbers in the system"
}
}
},
"UploadSIMCardsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, exception on failure"
}
}
},
"AddVendorDIDProviderAccountRequest" : {
"required" : [
"did_provider_account_info"
],
"type" : "object",
"properties" : {
"did_provider_account_info" : {
"$ref" : "#/components/schemas/DIDProviderAccountInfo"
}
}
},
"GetZendeskOrganizationListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of retrieved Zendesk organizations"
},
"zendesk_organization_list" : {
"$ref" : "#/components/schemas/ArrayOfZendeskOrganizationInfo"
}
}
},
"PaymentMethod" : {
"type" : "object",
"properties" : {
"icon_url" : {
"type" : "string",
"description" : "URL for payment method icon"
},
"payment_method" : {
"type" : "string",
"description" : "The internal name of a payment method"
},
"ecommerce" : {
"type" : "string",
"description" : "Specifies whether the payment method can be used for ecommerce transactions"
},
"i_payment_method" : {
"type" : "integer",
"description" : "The unique ID of the chosen payment method"
},
"name" : {
"type" : "string",
"description" : "The public name of a payment method"
},
"online" : {
"type" : "string",
"description" : "Specifies whether the payment method can be used online"
},
"simple_usage" : {
"type" : "string",
"description" : "Specifies whether the payment method can be used without any redirections"
}
}
},
"AddDisconnectQueueRecordRequest" : {
"required" : [
"account_id"
],
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the related service type. Default: 6 (NETACCESS)"
},
"session_id" : {
"type" : "string",
"description" : "ID of the session to work with"
},
"at_time" : {
"type" : "string",
"description" : "Time when status should be applied. Default: current time"
},
"tx_expire" : {
"type" : "string",
"description" : "Expiration time"
},
"i_node" : {
"type" : "integer",
"description" : "Unique ID of Nodes record (should be POD server)"
},
"param1" : {
"type" : "string",
"description" : "Formatted disconnector parameters string"
},
"account_id" : {
"type" : "string",
"description" : "Account number"
}
}
},
"AddUpdateOverrideTariffResponse" : {
"type" : "object",
"properties" : {
"i_customer_override_tariff" : {
"type" : "integer",
"description" : "The unique override tariff rule ID"
}
}
},
"VoidInvoiceResponse" : {
"required" : [
"i_invoice"
],
"type" : "object",
"properties" : {
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"GetSuretaxExemptionListRequest" : {
"type" : "object"
},
"UpdateRepresentativeRequest" : {
"type" : "object",
"properties" : {
"representative_info" : {
"$ref" : "#/components/schemas/RepresentativeInfo"
}
}
},
"ArrayOfAPIMethodInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/APIMethodInfo"
}
},
"SubscriptionDiscountList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SubscriptionDiscountInfo"
}
},
"DeleteRateRequest" : {
"required" : [
"i_rate"
],
"type" : "object",
"properties" : {
"i_rate" : {
"type" : "integer",
"description" : "The unique ID of the rate record to be deleted"
}
}
},
"XDRQualityMetricInfo" : {
"type" : "object",
"properties" : {
"profile_info" : {
"$ref" : "#/components/schemas/VoiceQualityProfileInfo"
},
"metric_data_list" : {
"$ref" : "#/components/schemas/ArrayOfVoiceQualityMetricDataInfo"
}
}
},
"ArrayOfQFInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/QFInfo"
}
},
"AccessLevelInfo" : {
"type" : "object",
"properties" : {
"objects" : {
"$ref" : "#/components/schemas/ArrayOfObjectPermissions"
},
"subsystem" : {
"type" : "string",
"description" : "The name of the subsystem the current web interface objects belong to"
},
"parents" : {
"$ref" : "#/components/schemas/ArrayOfAccessLevels"
}
}
},
"DestinationResultBatchAddDestinationInfo" : {
"type" : "object",
"properties" : {
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination record"
}
}
},
"GetCustomXdrReportTypesRequest" : {
"type" : "object"
},
"ArrayOfDIDInventoryOptionsInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DIDInventoryOptionsInfo"
}
},
"SessionNodeInfo" : {
"type" : "object",
"properties" : {
"node_name" : {
"type" : "string",
"description" : "The logical name of the node"
},
"node_type" : {
"type" : "string",
"description" : "The node type"
},
"ip" : {
"type" : "string",
"description" : "The IP address of the node"
},
"manufacturer" : {
"type" : "string",
"description" : "The manufacturer of the node"
},
"order" : {
"type" : "integer",
"description" : "The order number of the node in the session nodes chain"
},
"i_node" : {
"type" : "integer",
"description" : "The unique ID of the node"
},
"i_node_type" : {
"type" : "integer",
"description" : "The unique ID of the node type"
}
}
},
"AddAccessPolicyResponse" : {
"required" : [
"i_access_policy"
],
"type" : "object",
"properties" : {
"i_access_policy" : {
"type" : "integer",
"description" : "The unique ID of the access policy"
}
}
},
"MakeRepresentativeTransactionResponse" : {
"required" : [
"balance",
"i_xdr"
],
"type" : "object",
"properties" : {
"balance" : {
"type" : "number",
"description" : "The modified balance of the representative"
},
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the xDR record"
}
}
},
"QFInfo" : {
"required" : [
"i_env",
"state",
"i_quick_form"
],
"type" : "object",
"properties" : {
"granted_acls" : {
"$ref" : "#/components/schemas/ArrayOfQFGrantedACL"
},
"i_env" : {
"type" : "integer",
"description" : "The unique environment ID"
},
"iso_4217" : {
"type" : "string",
"description" : "A currency code for the quick form"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who uses the quick form"
},
"name" : {
"type" : "string",
"description" : "The name of the quick form"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
},
"state" : {
"type" : "string",
"description" : "The current state of the quick form"
},
"display_summary" : {
"type" : "string",
"description" : "Specifies whether the summary table is shown after saving the entities"
},
"i_quick_form" : {
"type" : "integer",
"description" : "The unique ID of the quick form"
}
}
},
"DeleteSpendingConstraintResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"IPTVChannelPackage" : {
"required" : [
"i_channel_package"
],
"type" : "object",
"properties" : {
"provider" : {
"type" : "string",
"description" : "The name of the provider of the channel"
},
"external_id" : {
"type" : "integer",
"description" : "The unique ID of the IPTV channel package in the external system"
},
"name" : {
"type" : "string",
"description" : "The name of the IPTV channel package"
},
"type" : {
"type" : "string",
"description" : "The type of the IPTV channel package ( enum 'iptv', 'vod' )"
},
"description" : {
"type" : "string",
"description" : "The description of the IPTV channel package"
},
"i_channel_package" : {
"type" : "integer",
"description" : "The unique ID of the IPTV channel package in PortaBilling"
}
}
},
"RoutingPlanList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RoutingPlanInfo"
}
},
"ArrayOfUAPortApplicableServiceInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UAPortApplicableServiceInfo"
}
},
"AddCommitmentOneTimeTermResponse" : {
"type" : "object",
"properties" : {
"i_one_time_term" : {
"type" : "integer",
"description" : "The unique identifier of the one-time term"
}
}
},
"DeleteVendorAccountResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"RateInfo" : {
"type" : "object",
"properties" : {
"network" : {
"type" : "string",
"description" : "The name of the mobile network"
},
"destination" : {
"type" : "string",
"description" : "Destination number"
},
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination record"
},
"destination_group" : {
"type" : "string",
"description" : "Destination group name"
},
"interval_1" : {
"type" : "integer",
"description" : "First billing interval"
},
"route_category" : {
"type" : "integer",
"description" : "ID of route category"
},
"formula" : {
"type" : "string",
"description" : "Indicates if this rate uses a call rating formula"
},
"price_1" : {
"type" : "number",
"description" : "Price for first interval"
},
"op_preference" : {
"type" : "integer",
"description" : "Routing priority for off-peak period"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff record"
},
"description" : {
"type" : "string",
"description" : "Text description for this entry"
},
"i_offpeak" : {
"type" : "integer",
"description" : "The unique ID of the off-peak record"
},
"forbidden" : {
"type" : "string",
"description" : "Indicates that no calls are authorized for the particular destination"
},
"interval_n" : {
"type" : "integer",
"description" : "Next billing interval"
},
"discontinued" : {
"type" : "string",
"description" : "Indicates that rate is discontinued"
},
"iso_3166_1_a2" : {
"type" : "string",
"description" : "The ISO 3166 two-letter country code"
},
"special_price_1" : {
"type" : "number",
"description" : "Special price for first interval"
},
"rate_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units used to calculate service charges. Related to ServiceInfo type"
},
"price_n" : {
"type" : "number",
"description" : "Price for next interval"
},
"effective_from" : {
"type" : "string",
"description" : "Defines when the rate starts to be applied"
},
"op_interval_1" : {
"type" : "integer",
"description" : "First billing interval for off-peak time"
},
"reverse_rating" : {
"type" : "string",
"description" : "Indicates whether rate is marked reverse or not"
},
"preference" : {
"type" : "integer",
"description" : "Routing priority"
},
"effective_immediately" : {
"type" : "string",
"description" : "Specifies whether the rate must be applied immediately. Possible values: Y – The effective_from date is ignored. The rate becomes effective immediately upon its adding / updating; N – The effective_from date is applied; P – Only the rate with the effective_from date in the past becomes effective immediately upon its adding / updating. The default value is N"
},
"i_rate" : {
"type" : "integer",
"description" : "The unique ID of the rate record (mandatory for update operations)"
},
"country" : {
"type" : "string",
"description" : "Country name"
},
"i_rate_formula" : {
"type" : "integer",
"description" : "The unique ID of the rating formula record"
},
"i_dest_group" : {
"type" : "integer",
"description" : "ID of the destination group"
},
"inter_intra_state_enabled" : {
"type" : "integer",
"description" : "Specifies whether the price per minute depends not only on the destination, but also on the caller and the called party residing in the same state"
},
"op_interval_n" : {
"type" : "integer",
"description" : "Next billing interval for off-peak time"
},
"op_price_1" : {
"type" : "number",
"description" : "Price for first interval for off- peak time"
},
"huntstop" : {
"type" : "string",
"description" : "Indicates whether huntstop is set or not"
},
"effective_now" : {
"type" : "integer",
"description" : "Shows whether the rate is currently effective. Possible values: 1 - the rate is effective now; 0 - the rate is not effective now"
},
"unit" : {
"type" : "string",
"description" : "A customer-visible name for the units in which service use is measured. Related to ServiceInfo type"
},
"op_price_n" : {
"type" : "number",
"description" : "Price for next interval for off- peak time"
},
"op_huntstop" : {
"type" : "string",
"description" : "Indicates whether huntstop for off-peak period is set or not"
},
"editable" : {
"type" : "integer",
"description" : "Shows whether the rate is editable. Possible values: 1 - editable; 0 - not editable"
},
"special_price_n" : {
"type" : "number",
"description" : "Special price for next interval"
},
"inactive_from" : {
"type" : "string",
"description" : "Defines when the rate stops to be applied"
},
"hidden" : {
"type" : "string",
"description" : "Indicates that the rate is excessive and may be omitted when making the list of rates"
},
"op_route_category" : {
"type" : "integer",
"description" : "ID of route category for off-peak period"
}
}
},
"ManageActiveCallRecordingRequest" : {
"required" : [
"call_id",
"command"
],
"type" : "object",
"properties" : {
"call_id" : {
"type" : "string",
"description" : "The unique ID of the call"
},
"command" : {
"type" : "string",
"description" : "Allows you to start or stop call recording. One of the following: stop; start"
}
}
},
"ArrayOfExtendedDataEntryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ExtendedDataEntryInfo"
}
},
"GetCustomerMetricListResponse" : {
"required" : [
"metrics"
],
"type" : "object",
"properties" : {
"metrics" : {
"$ref" : "#/components/schemas/ArrayOfCustomerMetricInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of retrieved measured services"
}
}
},
"AuxXDRInfo" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The value of the XDR"
},
"xdr_time" : {
"type" : "string",
"description" : "The date and time that shows when the XDR was processed"
},
"xdr_column_id" : {
"type" : "string",
"description" : "The name of the XDR column"
}
}
},
"GetTariffListRequest" : {
"required" : [
"limit",
"offset"
],
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the related service type"
},
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product"
},
"search" : {
"type" : "string",
"description" : "Search pattern in the name and description of the tariff"
},
"with_obsolete" : {
"type" : "integer",
"description" : "The flag that indicates whether to include outdated tariffs"
},
"with_buying_tariffs" : {
"type" : "integer",
"description" : "The flag that indicates whether to include buying tariffs"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"iso_4217" : {
"type" : "string",
"description" : "Currency for the Tariff"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the tariff is in use"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved tariffs"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"routing_ext" : {
"type" : "string",
"description" : "Flag that inform if the tariff contains information about the carrier's routing preferences"
},
"applied_to" : {
"type" : "string",
"description" : "One of the following: customer, vendor, reseller, subcustomer, subreseller"
},
"with_shared" : {
"type" : "integer",
"description" : "If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record (managed by)"
},
"with_authorized_emails" : {
"type" : "integer",
"description" : "Specifies whether to include information about authorized email addresses into the list. Possible values: 1 - Include information about authorized email addresses into the list; 0 - Do not include information about authorized email addresses into the list"
}
}
},
"ReleaseSIMCardResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 if the SIM card was successfully released"
}
}
},
"CloneRoamingProfileResponse" : {
"required" : [
"i_roaming_profile"
],
"type" : "object",
"properties" : {
"i_roaming_profile" : {
"type" : "integer",
"description" : "The unique ID of the roaming profile clone"
}
}
},
"GetInvoiceTemplateListRequest" : {
"type" : "object",
"properties" : {
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API reques"
}
}
},
"AttributePermission" : {
"required" : [
"attribute",
"permissions"
],
"type" : "object",
"properties" : {
"attribute" : {
"type" : "string",
"description" : "An attribute name"
},
"permissions" : {
"type" : "string",
"description" : "String representation of attribute permissions in the \"CRUD\" format (1-granted, 0- revoked): create, read, update, delete. For example, 1100 means that only the create and read permissions are granted to a specific user"
}
}
},
"AddMerchantAccountResponse" : {
"required" : [
"i_merchant_account"
],
"type" : "object",
"properties" : {
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique ID of the Merchant_Account record"
},
"merchant_account" : {
"$ref" : "#/components/schemas/MerchantAccount"
}
}
},
"GetAccountVdCounterInfoRequest" : {
"required" : [
"i_avd_counter"
],
"type" : "object",
"properties" : {
"i_avd_counter" : {
"type" : "integer",
"description" : "The unique ID of the record"
}
}
},
"GetServicePolicyAttributeListRequest" : {
"required" : [
"i_service_type"
],
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
}
}
},
"TerminateCustomerRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"supress_notification" : {
"type" : "integer",
"description" : "Suppress the notification about customer termination"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record to be terminated"
}
}
},
"GetQFFieldsListResponse" : {
"required" : [
"qf_fields_list"
],
"type" : "object",
"properties" : {
"qf_fields_list" : {
"$ref" : "#/components/schemas/ArrayOfQFFieldInfo"
}
}
},
"DeleteTemplateRequest" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The ID of the template"
}
}
},
"RouteList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RouteInfo"
}
},
"ArrayOfSampleDialingRulesInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SampleDialingRulesInfo"
}
},
"DeleteMarketingGroupRequest" : {
"required" : [
"i_marketing_group"
],
"type" : "object",
"properties" : {
"i_marketing_group" : {
"type" : "integer",
"description" : "The ID of the marketing group"
}
}
},
"ArrayOfCounterInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CounterInfo"
}
},
"AddUpdateAuthzRuleRequest" : {
"required" : [
"authz_rule_info"
],
"type" : "object",
"properties" : {
"authz_rule_info" : {
"$ref" : "#/components/schemas/AuthzRuleInfo"
},
"override_autogenerated" : {
"type" : "integer",
"description" : "Specifies whether to override existing autogenerated rules: 1 – if an autogenerated rule for this IP address already exists, override it by the new manual rule, 0 – if an autogenerated rule for this IP address already exists, throw SOAP fault 'duplicate ip pattern'"
}
}
},
"GetCustomerClassNotificationTemplateInfoResponse" : {
"type" : "object",
"properties" : {
"bcc" : {
"type" : "string",
"description" : "An email address of the person who wants to receive a copy of this notification. You can specify more than one valid email address; make sure you separate them with commas."
},
"body" : {
"type" : "string",
"description" : "The content of the message"
},
"subject" : {
"type" : "string",
"description" : "The subject as it appears in an email to a recepient"
},
"variables" : {
"$ref" : "#/components/schemas/ArrayOfNotificationTemplateVariables"
}
}
},
"CloneCustomerClassRequest" : {
"required" : [
"i_customer_class"
],
"type" : "object",
"properties" : {
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who is going to manage the customer class"
},
"name" : {
"type" : "string",
"description" : "The name of the new cloned customer class"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class to use the info from for the cloning procedure"
}
}
},
"AccountAddAccountWithTopupRequest" : {
"required" : [
"voucher_info",
"account_info"
],
"type" : "object",
"properties" : {
"voucher_info" : {
"$ref" : "#/components/schemas/VoucherInfo"
},
"account_info" : {
"$ref" : "#/components/schemas/AccountInfo"
}
}
},
"ArrayOfNotificationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NotificationInfo"
}
},
"DeleteMerchantAccountRequest" : {
"required" : [
"i_merchant_account"
],
"type" : "object",
"properties" : {
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique ID of the Merchant_Account record to be deleted"
}
}
},
"QFAddInfo" : {
"required" : [
"name",
"iso_4217",
"i_customer_class"
],
"type" : "object",
"properties" : {
"granted_acls" : {
"$ref" : "#/components/schemas/ArrayOfQFGrantedACL"
},
"iso_4217" : {
"type" : "string",
"description" : "Currency code for the quick form"
},
"managed_by" : {
"type" : "integer",
"description" : "The ID of the customer"
},
"name" : {
"type" : "string",
"description" : "Name of the quick form"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The ID of the customer class"
},
"display_summary" : {
"type" : "string",
"description" : "Specifies whether the summary table is shown after saving the entities"
}
}
},
"UpdatePreferableAccountRequest" : {
"required" : [
"preferable_account_info"
],
"type" : "object",
"properties" : {
"preferable_account_info" : {
"$ref" : "#/components/schemas/PreferableAccountInfo"
}
}
},
"GetRoutingPlanListRequest" : {
"type" : "object",
"properties" : {
"no_usage_check" : {
"type" : "integer",
"description" : "Do not perform Routing Plan usage check"
},
"with_route_categories" : {
"type" : "integer",
"description" : "If set to '1', route categories assigned to the routing plan will be added to the response"
},
"name" : {
"type" : "string",
"description" : "Name pattern for Routing Plans search"
},
"description" : {
"type" : "string",
"description" : "The description of a routing plan"
},
"with_rp_connections" : {
"type" : "integer",
"description" : "If set to '1', the routing plan connections assigned to the routing plan will be added to the response"
},
"get_total" : {
"type" : "integer",
"description" : "1 to return 'total' field in the method response"
},
"limit" : {
"type" : "integer",
"description" : "Number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "Number of rows to skip at the beginning of the response list"
}
}
},
"GetOliInfoResponse" : {
"required" : [
"oli_info"
],
"type" : "object",
"properties" : {
"oli_info" : {
"$ref" : "#/components/schemas/OliInfo"
}
}
},
"ServiceInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the related service type"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"rate_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units used to calculate service charges. You will use these units to specify your rating prices, and the usage details in xDRs will be shown in these units"
},
"service_pool_combination_list" : {
"$ref" : "#/components/schemas/ArrayOfServicePoolCombinationInfo"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "Unique ID of Destination_Group_Sets record"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The identifier of the tax transaction code"
},
"internal" : {
"type" : "string",
"description" : "Indicates whether the service is considered for internal usage"
},
"i_st_charge_unit" : {
"type" : "integer",
"description" : "The unique ID of the related service type charge unit"
},
"rating_base" : {
"type" : "string",
"description" : "Specification of which particular parameter is used to calculate charges, e.g. \"session time\", \"amount of data transferred\" and the like. Where applicable, the rating base selection also defines what is to be used as the base unit; e.g. for the Internet Access service you could use bytes, kilobytes or megabytes as the base unit"
},
"ratio" : {
"type" : "integer",
"description" : "If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the service has been used"
},
"dest_group_set_name" : {
"type" : "string",
"description" : "The destination group set name"
},
"name" : {
"type" : "string",
"description" : "Service name"
},
"default" : {
"type" : "string",
"description" : "Shows whether the service belongs to the system's default set"
},
"unit" : {
"type" : "string",
"description" : "A customer-visible name for the units in which service use is measured; this also would be the smallest possible unit you can use in the rating configuration"
},
"usage_rating" : {
"type" : "string",
"description" : "Shows whether usage charging is mandatory or not for the Service. Possible values: 'Y', 'N'"
},
"invoice_group" : {
"type" : "string",
"description" : "Shows the group in the invoice to which the usage records must be placed"
}
}
},
"BusinessModelInfo" : {
"type" : "object",
"properties" : {
"i_business_model" : {
"type" : "integer",
"description" : "The unique ID of a business model"
},
"name" : {
"type" : "string",
"description" : "The name of a business model"
}
}
},
"DestinationGetCSetGroupTreeRequest" : {
"required" : [
"i_dest_group_set"
],
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set"
},
"destination" : {
"type" : "string",
"description" : "The destination number pattern to filter groups in the result tree"
},
"dest_group_name" : {
"type" : "string",
"description" : "The name of the destination group to filter groups in the result tree"
},
"dest_group_description" : {
"type" : "string",
"description" : "The description of the destination group to filter groups in the result tree"
}
}
},
"ProductAddProductDetailedResponse" : {
"type" : "object",
"properties" : {
"product_info" : {
"$ref" : "#/components/schemas/RawProductInfo"
}
}
},
"AccountEstimateCallPriceResponse" : {
"required" : [
"call_price_info"
],
"type" : "object",
"properties" : {
"call_price_info" : {
"$ref" : "#/components/schemas/EstimatedCallPriceInfo"
}
}
},
"UpdateDIDNumberInfoStatus" : {
"required" : [
"i_did_number",
"status"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique ID of the DID number record"
},
"status" : {
"type" : "string",
"description" : "The status that shows whether the operation was successful. Possible values: 'failure', 'success'"
}
}
},
"DeleteTemplateResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success"
}
}
},
"ArrayOfProductGroupInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ProductGroupInfo"
}
},
"GetPortingRequestResponse" : {
"type" : "object",
"properties" : {
"porting_request_info" : {
"$ref" : "#/components/schemas/PortingRequestInfo"
}
}
},
"Rollovers" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "The amount of the service volume that has rolled over"
},
"expiration_date" : {
"type" : "string",
"description" : "The reset date of the rolled-over discount"
}
}
},
"UpdateIvrApplicationResponse" : {
"required" : [
"i_voice_app_access_number"
],
"type" : "object",
"properties" : {
"i_voice_app_access_number" : {
"type" : "integer",
"description" : "The unique ID of the IVR application"
}
}
},
"AddUpdateServicePoolRequest" : {
"required" : [
"service_pool_info"
],
"type" : "object",
"properties" : {
"service_pool_info" : {
"$ref" : "#/components/schemas/ServiceInfo"
}
}
},
"AddDIDGroupResponse" : {
"required" : [
"i_group"
],
"type" : "object",
"properties" : {
"i_group" : {
"type" : "integer",
"description" : "The unique ID of the DID group"
}
}
},
"MakeTransferResponse" : {
"required" : [
"error_description",
"error_code"
],
"type" : "object",
"properties" : {
"transaction_id" : {
"type" : "integer",
"description" : "The unique ID of the remittance transaction"
},
"error_description" : {
"type" : "string",
"description" : "A brief error description"
},
"error_code" : {
"type" : "integer",
"description" : "Error codes: 1001 – Empty price list for the destination requested from the remittance processor API. 1002 – Empty price list was formed on the PortaBilling side. Check your configuration and account or customer balance. 1003 – Account or customer status is blocked or inactive. 1004 – Error in the remittance processor back-end. 1005 – A remittance processor was not configured for the Account's or Customer's currency. 9999 – Another Internal error. 1..100 – Errors from the remittance processor back-end (internal processing error). 101..999 – Errors from external remittance processor API"
}
}
},
"ArrayOfCPServiceInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CPServiceInfo"
}
},
"ArrayOfConflictingVDPs" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ConflictingVDPs"
}
},
"GenerateMidtermInvoiceResponse" : {
"required" : [
"i_invoice"
],
"type" : "object",
"properties" : {
"warning" : {
"type" : "string",
"description" : "If the operation ended with a warning, the field contains the text of the warning"
},
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"GenericGetPropertyHistoryCatalogInfoResponse" : {
"type" : "object",
"properties" : {
"property_history_catalog_info" : {
"$ref" : "#/components/schemas/PropertyHistoryCatalogInfo"
}
}
},
"GetTemplateListRequest" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the template is in use"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of templates"
},
"name" : {
"type" : "string",
"description" : "The name of the template"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller"
},
"i_template_type" : {
"type" : "integer",
"description" : "The unique ID of the template type"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"TopupAccountRequest" : {
"required" : [
"voucher_info",
"account_info"
],
"type" : "object",
"properties" : {
"voucher_info" : {
"$ref" : "#/components/schemas/VoucherInfo"
},
"use_debit_voucher" : {
"type" : "integer",
"description" : "Specifies whether to use another prepaid card to recharge an account (both accounts must have the same main product assigned). Possible values: 1 – Use prepaid card, 0 – Use voucher"
},
"account_info" : {
"$ref" : "#/components/schemas/AccountInfo"
}
}
},
"CloneUAProfileResponse" : {
"required" : [
"i_ua_profile"
],
"type" : "object",
"properties" : {
"i_ua_profile" : {
"type" : "integer",
"description" : "The unique ID of the UA Profile record"
}
}
},
"ManageActiveCallRecordingResponse" : {
"required" : [
"cld_status",
"cli_status"
],
"type" : "object",
"properties" : {
"cld_status" : {
"type" : "string",
"description" : "Callee part call recording start/stop status; enum [\nFAILED - some errors happened during attempt to enabled/disable recording;\nDENIED - action isn't allowed according to BE data;\nOK - action processed successfully ]"
},
"cli_status" : {
"type" : "string",
"description" : "Caller part call recording start/stop status; enum [\nFAILED - some errors happened during attempt to enabled/disable recording;\nDENIED - action isn't allowed according to BE data;\nOK - action processed successfully ]"
}
}
},
"DeleteDestGroupResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"UpdateServicePolicyRequest" : {
"required" : [
"service_policy_info"
],
"type" : "object",
"properties" : {
"service_policy_info" : {
"$ref" : "#/components/schemas/ServicePolicyInfo"
}
}
},
"GetUIConfigListRequest" : {
"type" : "object",
"properties" : {
"section_name" : {
"type" : "string",
"description" : "The name of the config section to filter the response by"
}
}
},
"UpdateTariffRequest" : {
"required" : [
"tariff_info"
],
"type" : "object",
"properties" : {
"tariff_info" : {
"$ref" : "#/components/schemas/TariffInfo"
}
}
},
"UpdateAllowedLocationResponse" : {
"required" : [
"i_a_verified_locations"
],
"type" : "object",
"properties" : {
"i_a_verified_locations" : {
"type" : "integer",
"description" : "The ID of the account's allowed location record"
}
}
},
"ChargeUnitInfo" : {
"type" : "object",
"properties" : {
"default_rate_unit" : {
"type" : "string",
"description" : "The default customer-visible name for the units used to calculate service charges"
},
"name" : {
"type" : "string",
"description" : "The name of the service type charge unit"
},
"default_rate_ratio" : {
"type" : "integer",
"description" : "If billing units are different from base units, this parameter defines how many base units make up one billing unit"
},
"i_st_charge_unit" : {
"type" : "integer",
"description" : "The unique ID of the service type charge unit"
},
"rating_base" : {
"type" : "string",
"description" : "Specification of the particular parameter that is used to calculate charges, e.g. “session time”, “amount of data transferred” and the like"
}
}
},
"ReturnDIDNumberRequest" : {
"required" : [
"number"
],
"type" : "object",
"properties" : {
"number" : {
"type" : "string",
"description" : "DID Number"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"ReleaseAccessNumberResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation was completed"
}
}
},
"LocaleLanguageInfo" : {
"type" : "object",
"properties" : {
"direction" : {
"type" : "string",
"description" : "Text direction"
},
"name" : {
"type" : "string",
"description" : "The name of the language"
},
"iso_639_1" : {
"type" : "string",
"description" : "The ISO 639-1 code of the language"
}
}
},
"ProductCheckContentBasedChargingResponse" : {
"type" : "object",
"properties" : {
"active_groups" : {
"$ref" : "#/components/schemas/ANY"
}
}
},
"CloneTemplateResponse" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
}
}
},
"AddRoutingCriteriaResponse" : {
"required" : [
"i_criteria"
],
"type" : "object",
"properties" : {
"i_criteria" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria DB record"
}
}
},
"GetEnvInfoResponse" : {
"required" : [
"env_info"
],
"type" : "object",
"properties" : {
"env_info" : {
"$ref" : "#/components/schemas/EnvInfo"
}
}
},
"CustomerXDRInfo" : {
"type" : "object",
"properties" : {
"destination" : {
"type" : "string",
"description" : "The destination name"
},
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination record"
},
"CLD" : {
"type" : "string",
"description" : "Called Line Identification"
},
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the xdr record"
},
"beneficiary_account_id" : {
"type" : "string",
"description" : "The unique ID of the beneficiary account if the service was consumed by a beneficiary. Otherwise, this value is the same as 'account_id' (used only for accounts)"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account the XDR belongs to"
},
"connect_time" : {
"type" : "string",
"description" : "Call connect time"
},
"charged_amount" : {
"type" : "number",
"description" : "Amount charged"
},
"bit_flags" : {
"type" : "integer",
"description" : "Extended information how the service was used; the integer field that should be treated as a bit-map. Each currently used bit is listed in the Transaction_Flag_Types table (bit_offset indicates position). To learn more about bit flags values, please see the How to Use Bit Flags chapter in this guide"
},
"bytes_uploaded" : {
"type" : "integer",
"description" : "The quantity of uploaded bytes for the xDR. Available only for xDRs with netaccess service. The field is returned by 'with_netaccess_usage' in the request"
},
"unix_connect_time" : {
"type" : "integer",
"description" : "Call connect time (expressed in Unix time format - seconds since epoch)"
},
"history" : {
"type" : "string",
"description" : "Additional information about XDR"
},
"xdr_type" : {
"type" : "string",
"description" : "The type of xDR. Possible values: 'customer' or 'account'"
},
"bill_status" : {
"type" : "string",
"description" : "Call bill status"
},
"cr_download_ids" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"description" : {
"type" : "string",
"description" : "Destination description"
},
"service" : {
"type" : "string",
"description" : "The service name"
},
"call_id" : {
"type" : "string",
"description" : "The identifier of the call"
},
"account_id" : {
"type" : "string",
"description" : "The unique ID of the account database record (used only for accounts)"
},
"h323_incoming_conf_id" : {
"type" : "string",
"description" : "The unique ID of the incoming session (if exists) used for interrelating xDRs, when the charged session is established as a result of a previous session (possibly having its own xDR)"
},
"aux_xdrs" : {
"$ref" : "#/components/schemas/ArrayOfAuxXDRInfo"
},
"setup_time" : {
"type" : "integer",
"description" : "The time (in ms) between first provisional response and connect_time"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The unique session ID"
},
"disconnect_time" : {
"type" : "string",
"description" : "Call disconnect time"
},
"disconnect_reason" : {
"type" : "string",
"description" : "Call disconnect reason"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"subdivision" : {
"type" : "string",
"description" : "Country subdivision"
},
"iso_3166_1_a3" : {
"type" : "string",
"description" : "ISO 3166-1 alpha-3 - three-letter country code"
},
"CLI" : {
"type" : "string",
"description" : "Calling Line Identification"
},
"split_order" : {
"type" : "integer",
"description" : "The sequential number in case the XDR is part of a group of XDRs resulting from the same session"
},
"bill_time" : {
"type" : "string",
"description" : "Call bill time"
},
"i_rate" : {
"type" : "integer",
"description" : "The unique ID of the rate record"
},
"is_split" : {
"type" : "string",
"description" : "Shows whether the xDR is split"
},
"country" : {
"type" : "string",
"description" : "Country"
},
"bytes_downloaded" : {
"type" : "integer",
"description" : "The quantity of downloaded bytes for the xDR. Available only for xDRs with netaccess service. The field is returned by 'with_netaccess_usage' in the request"
},
"unix_disconnect_time" : {
"type" : "integer",
"description" : "Call disconnect time (expressed in Unix time format - seconds since epoch)"
},
"disconnect_cause" : {
"type" : "string",
"description" : "The code of disconnect cause"
},
"charged_quantity" : {
"type" : "integer",
"description" : "Units charged"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer/reseller the XDR belongs to"
}
}
},
"ArrayOfNodes" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NodeInfo"
}
},
"ArrayOfNotificationTemplateVariableFormats" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NotificationTemplateVariableFormat"
}
},
"ReleaseDIDFromOwnerBatchResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 – DID was released, 0 – DID was not released"
}
}
},
"GetFraudConstraintListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of retrieved records"
},
"fraud_constraint_list" : {
"$ref" : "#/components/schemas/ArrayOfFraudConstraintInfo"
}
}
},
"GetServicePolicyListRequest" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"name" : {
"type" : "string",
"description" : "The name of the service policy"
},
"description" : {
"type" : "string",
"description" : "The description of the service policy"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the service policy is in use"
},
"match_priority" : {
"type" : "integer",
"description" : "This is only used for policies that match dynamically. If more than one service policy corresponds to the caller’s user agent name, the one with the highest priority will be used"
},
"match_pattern" : {
"type" : "string",
"description" : "If this field is not empty the service policy is considered dynamically matched and will be attempted for every new call initiated by internal accounts"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of service policies"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"UploadEmergencyUnitsRequest" : {
"type" : "object"
},
"ChangePasswordResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
},
"errors" : {
"$ref" : "#/components/schemas/ChangePasswordResponseErrMessages"
}
}
},
"GetMerchantAccountRequest" : {
"required" : [
"i_merchant_account"
],
"type" : "object",
"properties" : {
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique ID of the Merchant_Account record (a payment or payment remittance system to be shown)"
}
}
},
"ArrayOfDisconnectReasonInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DisconnectReasonInfo"
}
},
"GetAllAccAliasesListInfoRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"i_customer" : {
"type" : "integer",
"description" : "Refers to customer record to which the alias belongs. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"DestinationGetCSetGroupTreeResponse" : {
"type" : "object",
"properties" : {
"destination_groups" : {
"$ref" : "#/components/schemas/ArrayOfCSetGroupTreeNode"
}
}
},
"UpdateBundlePromotionRequest" : {
"type" : "object",
"properties" : {
"bundle_promotion_info" : {
"$ref" : "#/components/schemas/BundlePromotionInfo"
}
}
},
"GetSiteInfoResponse" : {
"type" : "object",
"properties" : {
"site" : {
"$ref" : "#/components/schemas/CustomerSiteInfo"
}
}
},
"GenerateOutOfTurnInvoiceResponse" : {
"required" : [
"success",
"i_invoice"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
},
"i_invoice" : {
"type" : "integer",
"description" : "Unique ID of the invoice record"
}
}
},
"GetVersionRequest" : {
"type" : "object"
},
"ArrayOfSupportedLanguageInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SupportedLanguageInfo"
}
},
"RegenerateInvoicePDFListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"ArrayOfRoutingOptionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RoutingOptionInfo"
}
},
"GetCostRevenueFileRequest" : {
"required" : [
"file_name",
"type"
],
"type" : "object",
"properties" : {
"file_name" : {
"type" : "string",
"description" : "The file name"
},
"compress" : {
"type" : "string",
"description" : "If specified, describes the compression used for the returned attachment. Possible values: none, zip. Default: zip"
},
"type" : {
"type" : "integer",
"description" : "The type of the Cost/Revenue report"
}
}
},
"TemplateUpdateTemplateDataGroupListRequest" : {
"required" : [
"i_template",
"template_data_group_list"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"template_data_group_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateDataGroupInfo"
}
}
},
"DeleteAccessPolicyResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, exception error message in case of failure"
}
}
},
"DeleteEmergencyUnitRequest" : {
"required" : [
"i_emergency_unit"
],
"type" : "object",
"properties" : {
"i_emergency_unit" : {
"type" : "integer",
"description" : "The identifier of the emergency routing unit"
}
}
},
"AddDiscountPlanResponse" : {
"required" : [
"i_vd_plan"
],
"type" : "object",
"properties" : {
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan"
}
}
},
"GetPreferableAccountRequest" : {
"required" : [
"i_preferable_account"
],
"type" : "object",
"properties" : {
"i_preferable_account" : {
"type" : "integer",
"description" : "The unique ID of the frequently used account"
}
}
},
"UpdateUAProfileRequest" : {
"required" : [
"ua_profile_info"
],
"type" : "object",
"properties" : {
"ua_profile_info" : {
"$ref" : "#/components/schemas/UAProfileInfo"
}
}
},
"CustomTaxOptionInfo" : {
"type" : "object",
"properties" : {
"i_option" : {
"type" : "integer",
"description" : "The unique ID of the custom tax"
},
"tax_percent" : {
"type" : "number",
"description" : "A percentage rate value for this tax"
},
"name" : {
"type" : "string",
"description" : "The name of the custom tax option"
},
"used" : {
"type" : "integer",
"description" : "Shows whether this tax is used. Possible values: 1 - The tax is used, 0 - The tax is not used"
},
"applied_to" : {
"type" : "string",
"description" : "Shows which services this tax is applied to. Possible values: only_usage_charges – All charges except for subscriptions and credits / adjustments; all_charges – Applied to all charges including subscriptions and credits / adjustments; all_recurring_charges – Applied only to subscriptions"
},
"alias" : {
"type" : "string",
"description" : "The alias of the custom tax. By default is construsted as a combination of the prefix ct_ and the value of the i_option property. For example: \"ct_81\""
}
}
},
"UpdateSubscriptionResponse" : {
"required" : [
"i_subscription"
],
"type" : "object",
"properties" : {
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Plan"
}
}
},
"UpdateAssignedCommitmentRecordRequest" : {
"type" : "object",
"properties" : {
"account_commitment_info" : {
"$ref" : "#/components/schemas/AccountCommitmentInfo"
}
}
},
"GetTemplateComponentListRequest" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
}
}
},
"VendorXDRInfo" : {
"type" : "object",
"properties" : {
"i_service" : {
"type" : "integer",
"description" : "The unique identifier of the service related to the XDR"
},
"i_dest" : {
"type" : "integer",
"description" : "The unique identifier of the destination"
},
"i_xdr" : {
"type" : "integer",
"description" : "The unique ID of the XDR record"
},
"CLD" : {
"type" : "string",
"description" : "The called line identification"
},
"failed" : {
"type" : "string",
"description" : "The failed status of the XDR"
},
"i_account" : {
"type" : "integer",
"description" : "The unique identifier of the account related to the XDR"
},
"charged_time" : {
"type" : "integer",
"description" : "The amount of time that was charged"
},
"CLI" : {
"type" : "string",
"description" : "The calling line identification"
},
"connect_time" : {
"type" : "string",
"description" : "The session connect time"
},
"charged_amount" : {
"type" : "number",
"description" : "The amount charged"
},
"bill_time" : {
"type" : "string",
"description" : "The time when the session was billed"
},
"bit_flags" : {
"type" : "integer",
"description" : "Extended information on how the service was used; the integer field that should be treated as a bit-map. Each currently used bit is listed in the Transaction_Flag_Types table (bit_offset indicates position)"
},
"country" : {
"type" : "string",
"description" : "The country name of the destination related to the XDR"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique identifier of the vendor"
},
"history" : {
"type" : "string",
"description" : "The additional information about the XDR"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique identifier of the destination group"
},
"used_quantity" : {
"type" : "integer",
"description" : "The number of service units used"
},
"call_id" : {
"type" : "string",
"description" : "The unique identifier of the call"
},
"description" : {
"type" : "string",
"description" : "The description of the destination related to the XDR"
},
"account_id" : {
"type" : "string",
"description" : "The identifier of the account (unique in environment)"
},
"h323_incoming_conf_id" : {
"type" : "string",
"description" : "The unique ID of the incoming session (if exists) used for interrelating xDRs, when the charged session is established as a result of a previous session (possibly having its own xDR)"
},
"setup_time" : {
"type" : "integer",
"description" : "The time (in ms) between first provisional response and connect_time"
},
"aux_xdrs" : {
"$ref" : "#/components/schemas/ArrayOfAuxXDRInfo"
},
"disconnect_cause" : {
"type" : "integer",
"description" : "The code of the session disconnect cause"
},
"charged_quantity" : {
"type" : "integer",
"description" : "The number of service units charged for"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique identifier of the customer"
},
"h323_conf_id" : {
"type" : "string",
"description" : "The unique identifier of the session"
},
"i_connection" : {
"type" : "integer",
"description" : "The unique identifier of the connection"
},
"disconnect_time" : {
"type" : "string",
"description" : "The session disconnect time"
}
}
},
"CustomFieldsValuesInfo" : {
"required" : [
"name",
"db_value"
],
"type" : "object",
"properties" : {
"i_custom_field" : {
"type" : "integer",
"description" : "The unique ID of the custom field. Either the 'i_custom_field' or the 'name' is required for the 'update_custom_fields_values' method"
},
"text_value" : {
"type" : "string",
"description" : "Custom field value"
},
"i_custom_field_value" : {
"type" : "integer",
"description" : "The unique ID of the custom field value. The field is ignored in the 'update_custom_fields_values' method request"
},
"name" : {
"type" : "string",
"description" : "Custom field name"
},
"db_value" : {
"type" : "string",
"description" : "Database value of the custom field"
}
}
},
"UpdateCallBarringOptionsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"UpdateSIMCardListRequest" : {
"required" : [
"card_list"
],
"type" : "object",
"properties" : {
"card_list" : {
"$ref" : "#/components/schemas/ArrayOfSIMCardInfo"
}
}
},
"AccountInfo" : {
"type" : "object",
"properties" : {
"product_visible_name" : {
"type" : "string",
"description" : "Product name visible to end user"
},
"i_parent" : {
"type" : "integer",
"description" : "The unique ID of the reseller (for accounts under subcustomers). Possible values: 0 – if account is under direct customer, Otherwise – equal to reseller's ID. This field is only present in \"get\" responses. In \"add\"/\"update\" responses it is ignored"
},
"i_credit_card" : {
"type" : "integer",
"description" : "The unique ID of the account's credit card"
},
"out_date_format" : {
"type" : "string",
"description" : "Output format for date indication"
},
"email" : {
"type" : "string",
"description" : "Email address associated with the account. This allows the owner of the account to reset the password for self-care access, and the new password will be sent to this email address"
},
"password" : {
"type" : "string",
"description" : "User password for the self-care web interface"
},
"aux_fields" : {
"$ref" : "#/components/schemas/ArrayOfAccountAuxFieldInfo"
},
"um_url_valid" : {
"type" : "integer",
"description" : "Indicates whether the URL to access the Voicemail web interface is valid"
},
"blocked" : {
"type" : "string",
"description" : "Block account's calls"
},
"mac" : {
"type" : "string",
"description" : "MAC address of the CPE associated with this account"
},
"login_to_um_is_available" : {
"type" : "integer",
"description" : "Specifies whether the user is allowed to access the unified messaging system"
},
"bill_status" : {
"type" : "string",
"description" : "The status of the user's account: O – The account is open; I – The account is inactive; C – The account is terminated. Note that this value cannot be set via the add_account or update_account methods. If you need to terminate the account, use the terminate_account method instead"
},
"life_time" : {
"type" : "integer",
"description" : "Defines the number of days the account remains active after the date of its first use. The account will expire on the first usage date + life time days"
},
"ua_profile_id" : {
"type" : "integer",
"description" : "The unique ID for UA profile; Indicates the IP phone assigned to the account"
},
"login" : {
"type" : "string",
"description" : "User login for self-care web interface. Can only include digits, letters and the following symbols: \"@\", \"-\", \"_\", \".\". Minimum value length is 4; maximum is 64 symbols"
},
"i_role" : {
"type" : "integer",
"description" : "The unique ID of the account's access role; refers to the Roles table"
},
"in_date_format" : {
"type" : "string",
"description" : "Input format for date indication"
},
"is_active" : {
"type" : "integer",
"description" : "Shows whether the account is currently usable or not: 1 – the account is now usable; 0 – the account is not usable, e.g. blocked, terminated, expired, hasn’t been activated yet, etc."
},
"phone1" : {
"type" : "string",
"description" : "Main phone number"
},
"cust_bill_suspension_delayed" : {
"type" : "integer",
"description" : "Specifies whether suspension of the customer that owns this account has been delayed"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The unique ID for the account's time zone; refers to Time_Zones table"
},
"phone2" : {
"type" : "string",
"description" : "Alternative phone number"
},
"credit_exceed" : {
"type" : "string",
"description" : "Shows whether the account has exceeded its credit limit"
},
"salutation" : {
"type" : "string",
"description" : "Account owner's salutation"
},
"assigned_addons" : {
"$ref" : "#/components/schemas/ArrayOfProductInfo"
},
"um_url" : {
"type" : "string",
"description" : "The URL to access the voicemail web interface. PortaSIP Media Server is compatible with the following formats: https://1.1.1.1:8943/src/redirect.php, https://mydomain.com:8943/src/redirect.php"
},
"billing_model" : {
"type" : "integer",
"description" : "The account type; one of the following: -1 – Debit account; 0 – Recharge voucher; 1 – Credit account; 2 – Alias; 4 – Beneficiary. Debit is usually associated with prepaid cards. Credit is an account that will be invoiced for incurred costs. Voucher accounts are \"refill coupons\" for other types of accounts. Alias provides an alternative ID for an account. Beneficiary is dependent on a sponsor and uses their funds. This property is mandatory for the add_account, add_account_with_topup and validate_account_info methods"
},
"customer_bill_status" : {
"type" : "string",
"description" : "O - the customer is open, S - the customer is suspended due to an overdue invoice, C - the customer is closed due to an unpaid invoice, E - the customer is exported"
},
"sip_agent" : {
"type" : "string",
"description" : "If this account is currently used by a SIP phone to register with the PortaSIP server, the SIP phone identification info is displayed"
},
"account_expired" : {
"type" : "integer",
"description" : "Shows whether the account has expired or not"
},
"um_h323_id" : {
"type" : "string",
"description" : "The node ID (a descriptive, human-readable name used for identification purposes) of PortaUM node serving the account"
},
"extension_name" : {
"type" : "string",
"description" : "The name of the account's extension"
},
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of the customer site the account belongs to"
},
"um_domain" : {
"type" : "string",
"description" : "The domain name of the PortaUM node serving the account"
},
"realm" : {
"type" : "string",
"description" : "A custom string. An account realm allows administrators to impose a scope of uniqueness for an account ID"
},
"site_name" : {
"type" : "string",
"description" : "The name of the customer site the account belongs to"
},
"country" : {
"type" : "string",
"description" : "The code of the country in the ISO 3166-1 alpha-2 format"
},
"i_account_role" : {
"type" : "integer",
"description" : "The unique ID of the account role; refers to the Account_Roles table. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID"
},
"i_batch" : {
"type" : "integer",
"description" : "The unique ID of the batch to which the account belongs"
},
"i_distributor" : {
"type" : "integer",
"description" : "The unique ID of the distributer associated with the account"
},
"customer_credit_exceed" : {
"type" : "string",
"description" : "Shows whether the customer that owns this account has exceeded his credit limit"
},
"included_services" : {
"$ref" : "#/components/schemas/ArrayOfServices"
},
"voucher_info" : {
"$ref" : "#/components/schemas/VoucherInfo"
},
"i_master_account" : {
"type" : "integer",
"description" : "Applicable only to the alias and beneficiary account types; the main account this alias is associated with or the sponsor account for a beneficiary"
},
"notepad" : {
"type" : "string",
"description" : "When making changes in the account record, the administrator can use the Notepad tab to provide a comment detailing the reason for these changes (for example, \"product changed, credited $50\")"
},
"inactivity_expire_time" : {
"type" : "integer",
"description" : "Specifies the number of days the account remains active after its last use or recharge"
},
"product_name" : {
"type" : "string",
"description" : "The name of the account's product"
},
"activation_date" : {
"type" : "string",
"description" : "Date from which the account is usable"
},
"firstname" : {
"type" : "string",
"description" : "Account owner's first name"
},
"i_product" : {
"type" : "integer",
"description" : "The unique ID for the account's product; refers to Products table"
},
"extension_id" : {
"type" : "string",
"description" : "The account's extension number"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for currency in which the account is billed"
},
"iso_639_1" : {
"type" : "string",
"description" : "The language the user prefers when interacting with an IVR application"
},
"master_billing_model" : {
"type" : "integer",
"description" : "The type of the master account"
},
"timer" : {
"type" : "string",
"description" : "Booth timer (for accounts of a callshop reseller)"
},
"batch_name" : {
"type" : "string",
"description" : "The name of the batch to which the account belongs; this may be passed as a parameter to the add_account method instead of i_batch value; if there is no batch record in the database with the same name, a new record will be created"
},
"zero_balance" : {
"type" : "integer",
"description" : "Applicable only to debit accounts; specifies whether the account has used up all of its available funds"
},
"state" : {
"type" : "string",
"description" : "Province or state"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"opening_balance" : {
"type" : "number",
"description" : "The initial balance of the account"
},
"customer_bill_suspended" : {
"type" : "integer",
"description" : "Specifies whether the customer that owns this account has been suspended"
},
"has_custom_fields" : {
"type" : "integer",
"description" : "Specifies that account has additional information stored in custom fields"
},
"id" : {
"type" : "string",
"description" : "ID (PIN) of the account on the PortaBilling interface, unique in the environment"
},
"out_date_time_format" : {
"type" : "string",
"description" : "Output format for full date/time indication"
},
"last_usage" : {
"type" : "string",
"description" : "Date on which the account was last used"
},
"subscriber_email" : {
"type" : "string",
"description" : "Subscriber's email address"
},
"i_did_number" : {
"type" : "integer",
"description" : "The unique identifier of the assigned DID number"
},
"account_inactive" : {
"type" : "integer",
"description" : "Shows whether the account has been already activated (i.e. its activation date came)"
},
"h323_password" : {
"type" : "string",
"description" : "The VoIP password used to authenticate calls made using the account"
},
"redirect_number" : {
"type" : "string",
"description" : "Associated number specifies the number to be sent back to the IVR in an authorization confirmation. For example, this might be a redirect to a technical support number in an IVR application"
},
"master_account_id" : {
"type" : "string",
"description" : "The ID of the master account"
},
"time_zone_name" : {
"type" : "string",
"description" : "The name of the account's time zone"
},
"management_number" : {
"type" : "string",
"description" : "A custom identifier of the account (optional)"
},
"i_lang" : {
"type" : "string",
"description" : "The code for the account's web language; refers to Languages table"
},
"sip_contact" : {
"type" : "string",
"description" : "The URI of the IP phone used by the SIP Proxy to contact the IP phone"
},
"idle_days" : {
"type" : "integer",
"description" : "The number of days account has been idle for"
},
"address_line_2" : {
"type" : "string",
"description" : "The 2nd line of the account owner's address"
},
"zip" : {
"type" : "string",
"description" : "Postal (zip) code. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash)"
},
"first_usage" : {
"type" : "string",
"description" : "Date on which the account was used for the first time"
},
"balance" : {
"type" : "number",
"description" : "The account's current balance"
},
"i_subscriber" : {
"type" : "integer",
"description" : "The unique ID of the account's subscriber record. Refers to the Subscribers table"
},
"customer_name" : {
"type" : "string",
"description" : "The name of the customer that the account belongs to"
},
"cont1" : {
"type" : "string",
"description" : "Main contact person"
},
"midinit" : {
"type" : "string",
"description" : "Account owner's middle initial(s)"
},
"status" : {
"type" : "string",
"description" : "The status of the account"
},
"zero_balance_date" : {
"type" : "string",
"description" : "Applicable only to debit accounts; specifies when the account has used up all of its available funds"
},
"customer_blocked" : {
"type" : "string",
"description" : "Shows whether the customer that owns this account has been blocked"
},
"lastname" : {
"type" : "string",
"description" : "Account owner's last name"
},
"city" : {
"type" : "string",
"description" : "City of account owner's address"
},
"um_ip" : {
"type" : "string",
"description" : "The IP address of the PortaUM node handling the account"
},
"cont2" : {
"type" : "string",
"description" : "Alternative contact person"
},
"out_time_format" : {
"type" : "string",
"description" : "Output format for time indication"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID for the account's discount plan; refers to the Volume_Discount_Plans table "
},
"password_lifetime" : {
"type" : "integer",
"description" : "Accounts's self-care WI password life time (in seconds)"
},
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
},
"customer_status" : {
"type" : "string",
"description" : "Shows the status of the customer that owns this account"
},
"ecommerce_enabled" : {
"type" : "string",
"description" : "Allow the account's owner to make online payments or set up periodical payments on the account's self-care page"
},
"in_time_format" : {
"type" : "string",
"description" : "Input format for time indication"
},
"first_usage_time" : {
"type" : "string",
"description" : "Date and time when the account was used for the first time"
},
"password_timestamp" : {
"type" : "string",
"description" : "Date when the password was last changed"
},
"expiration_date" : {
"type" : "string",
"description" : "Date from which the account will become unusable"
},
"service_flags" : {
"type" : "string",
"description" : "Account's service features settings; allow to see what features of the services provided are available to end users. Service flags at the product level show the default values of service attributes for all accounts which this product is assigned to. Service flags at the customer level show the default values of service attributes for all accounts of this customer. Service flags at the account level show service attributes that override the ones defined at the product and customer levels. Note that the add_account method ignores this property and the update_account method uses it only if the service_features property is absent"
},
"note" : {
"type" : "string",
"description" : "Short note (description)"
},
"bcc" : {
"type" : "string",
"description" : "BCC email address"
},
"sip_status" : {
"type" : "integer",
"description" : "Indicates whether the account is used by a SIP phone to register with a PortaSIP server: 1 – online (the account is used by a SIP phone to register with a PortaSIP server) 0 – offline"
},
"i_account_balance_control_type" : {
"type" : "integer",
"description" : "Account balance control type"
},
"issue_date" : {
"type" : "string",
"description" : "Date of issue of the account"
},
"faxnum" : {
"type" : "string",
"description" : "Fax number"
},
"control_number" : {
"type" : "integer",
"description" : "The sequential number of the account in the batch"
},
"last_recharge" : {
"type" : "string",
"description" : "Date on which the account was last recharged using IVR, web self-care, SMS, etc."
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record to which the account belongs"
},
"i_acl" : {
"type" : "integer",
"description" : "The unique ID for the account's access level; refers to the Access_Levels table"
},
"companyname" : {
"type" : "string",
"description" : "Account owner's company name"
},
"baddr1" : {
"type" : "string",
"description" : "1st line of account owner's address"
},
"credit_limit" : {
"type" : "number",
"description" : "Only available when the account type is set to \"Credit\". Defines the credit allowance in the account’s currency"
}
}
},
"ReviewInvoiceListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception error message in case of failure"
}
}
},
"GetAccountRoleListRequest" : {
"type" : "object",
"properties" : {
"i_account_role" : {
"type" : "integer",
"description" : "The unique ID of the account role type"
},
"name" : {
"type" : "string",
"description" : "The name of the account role type"
},
"inventory_usage" : {
"type" : "string",
"description" : "Specifies whether to retrieve the inventory for the account role type"
},
"validation_format" : {
"type" : "string",
"description" : "The validation for the ID of the account role type"
},
"realm" : {
"type" : "string",
"description" : "The top realm of the account role type"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of records to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"SubscriptionInfo" : {
"type" : "object",
"properties" : {
"i_usage_ttc" : {
"type" : "integer",
"description" : "The usual tax transaction code ID"
},
"charge_suspended_customers" : {
"type" : "string",
"description" : "Specifies whether subscription charges are applied to suspended customers. Possible values: N - not applied, Y - applied in full"
},
"generate_daily_charge" : {
"type" : "string",
"description" : "Specifies whether to keep the total charge only or to generate daily charges. Possible values: Y – Generate daily charges; N – Keep the total charge only"
},
"prorate_last_period" : {
"type" : "string",
"description" : "Specifies whether subscription charges for the last billing period are prorated. Possible values: Y – prorated; N – in full, no prorating (available for postpaid and in advance charge models)"
},
"iso_4217" : {
"type" : "string",
"description" : "The currency for the Subscription Plan"
},
"cancel_penalty_prorated" : {
"type" : "integer",
"description" : "Specifies whether the remaining subscription charges should be applied when the subscription is cancelled earlier than the minimum subscription period"
},
"minimum_period" : {
"type" : "integer",
"description" : "Time interval (in months) during which the subscription must remain uninterrupted so as to avoid penalties"
},
"activation_mode" : {
"type" : "integer",
"description" : "If the subscription is assigned to an account, this parameter specifies the date upon which the subscription charges will apply. Possible values: 1 - at the given start date, 2 - upon the account's first usage"
},
"shared" : {
"type" : "string",
"description" : "Shows whether the subscription managed by the administrator is available to resellers"
},
"discount_list" : {
"$ref" : "#/components/schemas/SubscriptionDiscountList"
},
"prorate_first_period" : {
"type" : "string",
"description" : "Specifies whether subscription charges for the first billing period are prorated. Possible values: Y – prorated; N – in full, no prorating (available for postpaid and in advance charge models)"
},
"is_used_by_resellers" : {
"type" : "integer",
"description" : "Shows whether the shared subscription is used by resellers"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Plan"
},
"discount_type" : {
"type" : "string",
"description" : "Only available for subscription plans charged in advance; specifies type of multi-month discounts for the subscription. Possible values: fixed - discounts are represented as fixed amounts, percentage - discounts are represented as percentage of the standard fee"
},
"i_cancellation_ttc" : {
"type" : "integer",
"description" : "The cancellation tax transaction code ID"
},
"charge_model" : {
"type" : "integer",
"description" : "Defines the way subscription charges are applied to a customer's account. Possible values: 0 - progressively, 1 - at the end of the billing period, 2 - in advance"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the subscription plan is in use"
},
"invoice_description" : {
"type" : "string",
"description" : "The subscription plan name that is visible to the end user"
},
"advance_periods" : {
"type" : "integer",
"description" : "Only available for subscription plans charged in advance; specifies for how many periods advance charges should be made"
},
"name" : {
"type" : "string",
"description" : "The name of the Subscription Plan"
},
"periodic_fees" : {
"$ref" : "#/components/schemas/SubscriptionPeriodicFeeList"
},
"description" : {
"type" : "string",
"description" : "The Subscription Plan description"
},
"i_activation_ttc" : {
"type" : "integer",
"description" : "The activation tax transaction code ID"
},
"tax_info" : {
"type" : "string",
"description" : "The configured taxation menthod options"
},
"rounding" : {
"type" : "integer",
"description" : "A pattern that defines the rounding of the amount charged for a billing period"
},
"i_customer" : {
"type" : "integer",
"description" : "The ID of the reseller who manages the Subscription"
},
"cancel_penalty" : {
"type" : "number",
"description" : "A one-time fee applied when the subscription is cancelled earlier than the minimum subscription period"
},
"multiple" : {
"type" : "string",
"description" : "Specifies whether the same subscription can be applied multiple times to one account. Possible values: N - subscription can be applied only once, Y - subscription can be applied multiple times"
},
"penalty_mode" : {
"type" : "string",
"description" : "Specifies the type of penalty for a subscription cancelled earlier than the minimum subscription period. Possible values: none - no fee is applied, fixed - apply a fixed one-time fee, remaining - apply the remaining subscription charges, discount - the fee is equal to the applied amount of the discount provided by the subscription"
},
"activation_fee" : {
"type" : "number",
"description" : "A one-time fee applied when the subscription is activated"
}
}
},
"GetRPConnectionInfoResponse" : {
"type" : "object",
"properties" : {
"rp_connection_info" : {
"$ref" : "#/components/schemas/RPConnectionInfo"
}
}
},
"GetResaleMapRecordResponse" : {
"type" : "object",
"properties" : {
"resale_map_record_info" : {
"$ref" : "#/components/schemas/ResaleMapRecordInfo"
}
}
},
"ArrayOfEstimateTaxesXDRInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EstimateTaxesXDRInfo"
}
},
"DestinationGetMCCMNCListRequest" : {
"type" : "object"
},
"DeleteServiceAndRatingRequest" : {
"required" : [
"i_accessibility"
],
"type" : "object",
"properties" : {
"i_accessibility" : {
"type" : "integer",
"description" : "The unique ID of the rating entry record to be deleted"
}
}
},
"DeleteServiceAndRatingResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"ArrayOfExtendedDataFilterInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ExtendedDataFilterInfo"
}
},
"GetUserUIConfigListResponse" : {
"required" : [
"ui_config_list"
],
"type" : "object",
"properties" : {
"ui_config_list" : {
"$ref" : "#/components/schemas/ArrayOfUIConfigInfo"
}
}
},
"AddMeasuredMetricResponse" : {
"required" : [
"i_measured_metric"
],
"type" : "object",
"properties" : {
"i_measured_metric" : {
"type" : "integer",
"description" : "The unique ID of the measured metric"
}
}
},
"ArrayOfAccessAttributePermission" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccessAttributePermission"
}
},
"MakeVDTransactionResponse" : {
"type" : "object",
"properties" : {
"i_xdr" : {
"type" : "integer",
"description" : "The ID of XDR record"
}
}
},
"ReleaseDIDFromCustomerResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 – success, 0 – failed"
}
}
},
"AddCustomerRequest" : {
"type" : "object",
"properties" : {
"generate_web_password" : {
"type" : "integer",
"description" : "Specifies whether to autogenerate a password for the customer self-care interface. Possible values: 1 - Generate a password; 0 - Do not generate a password"
},
"customer_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
}
}
},
"UpdateCustomerTaxationRequest" : {
"required" : [
"taxation_info",
"i_customer"
],
"type" : "object",
"properties" : {
"taxation_info" : {
"$ref" : "#/components/schemas/TaxationInfo"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique identifier for a tax transaction code; refers to the Tax_Transaction_Codes table"
},
"estimate_taxes" : {
"type" : "string",
"description" : "Shows whether the estimate taxes on receiving payments for the prepaid customers is enabled or disabled"
}
}
},
"ArrayOfRatingGroupInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RatingGroupInfo"
}
},
"GetIPTVServicePackageListResponse" : {
"required" : [
"package_list"
],
"type" : "object",
"properties" : {
"package_list" : {
"$ref" : "#/components/schemas/ArrayOfIPTVServicePackage"
}
}
},
"UpdateMeasuredMetricRequest" : {
"required" : [
"measured_metric_info"
],
"type" : "object",
"properties" : {
"measured_metric_info" : {
"$ref" : "#/components/schemas/MeasuredMetricInfo"
}
}
},
"AddTariffRequest" : {
"required" : [
"tariff_info"
],
"type" : "object",
"properties" : {
"tariff_info" : {
"$ref" : "#/components/schemas/TariffInfo"
}
}
},
"ArrayOfBoothInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BoothInfo"
}
},
"GetNotificationPresetInfoRequest" : {
"required" : [
"i_notification_preset"
],
"type" : "object",
"properties" : {
"i_notification_preset" : {
"type" : "integer",
"description" : "The unique identifier of the notification preset"
}
}
},
"AddCCStaffRequest" : {
"required" : [
"cc_staff_info"
],
"type" : "object",
"properties" : {
"cc_staff_info" : {
"$ref" : "#/components/schemas/CCStaffInfo"
}
}
},
"UpdateUserNotificationCategoryListRequest" : {
"required" : [
"i_user",
"notification_category_list"
],
"type" : "object",
"properties" : {
"i_user" : {
"type" : "integer",
"description" : "The unique ID of the user record"
},
"notification_category_list" : {
"$ref" : "#/components/schemas/ArrayOfUserNotificationCategoryInfo"
}
}
},
"UpdateUARequest" : {
"required" : [
"ua_info"
],
"type" : "object",
"properties" : {
"ua_info" : {
"$ref" : "#/components/schemas/UAInfo"
}
}
},
"GetVendorInfoRequest" : {
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"name" : {
"type" : "string",
"description" : "The name of the vendor"
}
}
},
"ArrayOfAccessComponentPermission" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccessComponentPermission"
}
},
"GetCustomerPaymentMethodInfoResponse" : {
"type" : "object",
"properties" : {
"payment_method_info" : {
"$ref" : "#/components/schemas/PaymentMethodInfo"
}
}
},
"AddUpdateAccountSubscriptionResponse" : {
"required" : [
"i_account_subscription"
],
"type" : "object",
"properties" : {
"i_account_subscription" : {
"type" : "integer",
"description" : "The unique ID of the created/modified account subscription record"
}
}
},
"PingResponse" : {
"type" : "object",
"properties" : {
"user_id" : {
"type" : "integer",
"description" : "The ID of the user currently logged into the specified session"
}
}
},
"GetCriterionRequest" : {
"required" : [
"i_bd_criteria"
],
"type" : "object",
"properties" : {
"with_thresholds" : {
"type" : "integer",
"description" : "Specifies whether to show the list of thresholds associated with the criteria. Possible values: 1 – Show the list of thresholds. 0 – Do not show the list of thresholds."
},
"i_bd_criteria" : {
"type" : "integer",
"description" : "The unique ID of the bundle promotion criteria"
}
}
},
"AccountGetServiceFeaturesMetaInfoRequest" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product"
},
"with_localization" : {
"type" : "integer",
"description" : "The flag shows whether to localize options using the language selected on the web interface"
},
"billing_model" : {
"type" : "integer",
"description" : "The account type; one of the following: -1 – Debit account; 0 – Recharge voucher; 1 – Credit account; 2 – Alias. Debit is usually associated with prepaid cards. Credit is an account that will be invoiced for incurred costs. Voucher accounts are \"refill coupons\" for other types of accounts. Alias provides alternative ID for an account. This property is mandatory for the add_account, add_account_with_topup and validate_account_info methods"
},
"array_mode" : {
"type" : "integer",
"description" : "The flag shows whether to pack response into service_features or return raw subtypes"
},
"iso_639_1" : {
"type" : "string",
"description" : "The language the user prefers when interacting with an IVR application"
},
"addon_products" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of the customer site"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"GetAccountPermittedProxyInfoResponse" : {
"type" : "object",
"properties" : {
"permitted_sip_proxies" : {
"$ref" : "#/components/schemas/ArrayOfPermittedSipProxiesInfo"
},
"is_add_new_sip_proxy_allowed" : {
"type" : "integer",
"description" : "Indicates whether the adding of a new proxy is allowed"
}
}
},
"DeleteCustomerClassRequest" : {
"required" : [
"i_customer_class"
],
"type" : "object",
"properties" : {
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class record"
}
}
},
"ArrayOfSubrealmsInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SubrealmsInfo"
}
},
"GetPreferableAccountResponse" : {
"type" : "object",
"properties" : {
"preferable_account_info" : {
"$ref" : "#/components/schemas/PreferableAccountInfo"
}
}
},
"ObtainDIDNumberResponse" : {
"type" : "object",
"properties" : {
"number_info" : {
"$ref" : "#/components/schemas/DIDNumberInfo"
}
}
},
"VDPConflicts" : {
"type" : "object",
"properties" : {
"service_name" : {
"type" : "string",
"description" : "The name of the service"
},
"addon_precedence" : {
"type" : "string",
"description" : "In order to differentiate the add-on products there is also a 'precedence level' parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level"
},
"conflicting_vdps" : {
"$ref" : "#/components/schemas/ArrayOfConflictingVDPs"
}
}
},
"GetDiscountListRequest" : {
"required" : [
"i_vd_plan"
],
"type" : "object",
"properties" : {
"is_usage_period_set" : {
"type" : "integer",
"description" : "Specifies whether to return discounts with filled or empty 'usage_period' field"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service to search the discount by"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group to search the discount by"
},
"i_vd_type" : {
"type" : "integer",
"description" : "The unique ID of the discount type"
},
"service_name" : {
"type" : "string",
"description" : "Service name pattern"
},
"threshold_type" : {
"type" : "string",
"description" : "The type of the discount threshold type to search by. Possible values: 'Charged Amount','Charged Time'"
},
"peak_level" : {
"type" : "integer",
"description" : "ID of the Peak Level (0 - Peak Period, 1 - Off-Peak Period, 2 - 2nd Off-Peak Period)"
},
"with_thresholds" : {
"type" : "integer",
"description" : "Specifies whether to retrieve thresholds for the discount"
},
"dg_name" : {
"type" : "string",
"description" : "Destination group name pattern"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan"
}
}
},
"ArrayOfUIConfigInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UIConfigInfo"
}
},
"BundleDiscountThresholdInfo" : {
"required" : [
"threshold",
"discount"
],
"type" : "object",
"properties" : {
"threshold" : {
"type" : "number",
"description" : "The threshold of the bundle promotion criterion. 0 means that te threshold is unlimited"
},
"discount" : {
"type" : "number",
"description" : "The amount of the discount that applies to the threshold set"
}
}
},
"DeleteDiscountPlanRequest" : {
"required" : [
"i_vd_plan"
],
"type" : "object",
"properties" : {
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan to be deleted"
}
}
},
"ArrayOfSessionLogIdInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SessionLogIdInfo"
}
},
"GetRepresentativeInfoResponse" : {
"type" : "object",
"properties" : {
"representative_info" : {
"$ref" : "#/components/schemas/RepresentativeInfo"
}
}
},
"GetCustomerStatusHistoryRequest" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"UpdateCustomerServiceFeaturesRequest" : {
"type" : "object",
"properties" : {
"detailed_response" : {
"type" : "integer",
"description" : "Flag which shows whether an array of Service Features should be returned in response or not"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID a of customer record"
},
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
}
}
},
"GetMyAclForObjectsResponse" : {
"type" : "object",
"properties" : {
"access_level" : {
"$ref" : "#/components/schemas/AccessLevelInfo"
}
}
},
"GetTaxPluginResponse" : {
"type" : "object",
"properties" : {
"plugin" : {
"type" : "string",
"description" : "The name of the module responsible for handling tax calculations"
},
"requires_configuration" : {
"type" : "integer",
"description" : "Shows whether the taxation plugin requires configuration. This field is only applicable if the \"catalog_based\" option is set to 1"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the taxation plugin has been assigned"
},
"catalog_based" : {
"type" : "integer",
"description" : "Defines if the taxation plugin requires special codes for any transaction (0 - no, 1 - yes)"
},
"name" : {
"type" : "string",
"description" : "The name of the taxation plugin that is displayed on the WI"
},
"i_billing_processor" : {
"type" : "integer",
"description" : "The unique ID of the taxation plugin database record"
},
"can_process_prepaid_taxes" : {
"type" : "integer",
"description" : "Defines if the taxation plugin can make estimates and handle taxes for prepaid customers and debit accounts"
},
"tax_plugin_parameters" : {
"$ref" : "#/components/schemas/ArrayOfTaxPluginParameterInfo"
},
"is_configured" : {
"type" : "integer",
"description" : "Shows whether the taxation plugin is configured. This field is only applicable if the \"catalog_based\" option is set to 1"
}
}
},
"DeleteAccessNumberResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success"
}
}
},
"VoiceApplicationOptionInfo" : {
"type" : "object",
"properties" : {
"i_block" : {
"type" : "integer",
"description" : "The unique identifier of the option container block"
},
"required_value" : {
"type" : "string",
"description" : "The required value of the option"
},
"i_an_parameter" : {
"type" : "integer",
"description" : "The unique identifier of the option"
},
"value" : {
"type" : "string",
"description" : "The value of the option"
},
"name" : {
"type" : "string",
"description" : "The name of the option"
},
"validation" : {
"type" : "string",
"description" : "Validation settings for the option value"
},
"i_parent" : {
"type" : "integer",
"description" : "The ID of IVR option that is depended on"
},
"default_value" : {
"type" : "string",
"description" : "The default value of the option"
},
"block_name" : {
"type" : "string",
"description" : "The name of the option container block"
},
"type" : {
"type" : "string",
"description" : "The type of the option value"
},
"i_block_attr" : {
"type" : "integer",
"description" : "The unique ID of the dependent IVR option"
}
}
},
"UpdateRouteCategoryResponse" : {
"required" : [
"i_route_category"
],
"type" : "object",
"properties" : {
"i_route_category" : {
"type" : "integer",
"description" : "The unique ID of the route category DB record"
}
}
},
"SetTaxPluginParametersResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation was completed"
}
}
},
"AddUpdateRoutingPlanRequest" : {
"required" : [
"routing_plan_info"
],
"type" : "object",
"properties" : {
"routing_plan_info" : {
"$ref" : "#/components/schemas/RoutingPlanInfo"
}
}
},
"VoucherInfo" : {
"required" : [
"id"
],
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "The unique ID of the voucher"
}
}
},
"GetCurrencyInfoRequest" : {
"required" : [
"iso_4217"
],
"type" : "object",
"properties" : {
"i_ma_currency" : {
"type" : "integer",
"description" : "The unique merchant account currency identifier"
},
"iso_4217" : {
"type" : "string",
"description" : "Currency ISO4217 code"
}
}
},
"GetHGListInfoRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"get_main_office_huntgroups" : {
"type" : "integer",
"description" : "If provided, the list of the main office huntgroups will be returned together with a branch office huntgroups"
},
"i_c_ext" : {
"type" : "integer",
"description" : "\n The unique extension ID. If provided, will return the list of huntgroups this extension is assigned to.\n Otherwise returns the list of all huntgroups\n "
},
"self_ref" : {
"type" : "integer",
"description" : "Reference to a huntgroup which will be excluded from the list"
},
"name" : {
"type" : "string",
"description" : "Enables retrieving the huntgroups list by name"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory if sent from the retail customer realm"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"ArrayOfServicePolicyAttributeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServicePolicyAttributeInfo"
}
},
"UpdateAccountSubscriptionRequest" : {
"required" : [
"i_account",
"i_account_subscription",
"subscription_info"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"i_account_subscription" : {
"type" : "integer",
"description" : "The unique ID of the account subscription record to be updated"
},
"subscription_info" : {
"$ref" : "#/components/schemas/AccountSubscriptionInfo"
}
}
},
"DeleteCommitmentRecurringTermResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "The result of the operation, or an exception in case of failure"
}
}
},
"CustomerGetSelfcareConfigDataResponse" : {
"required" : [
"config_data"
],
"type" : "object",
"properties" : {
"config_data" : {
"$ref" : "#/components/schemas/ANY"
}
}
},
"ArrayOfResaleMapInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ResaleMapRecordInfo"
}
},
"GetCQInfoRequest" : {
"required" : [
"i_c_queue"
],
"type" : "object",
"properties" : {
"i_c_queue" : {
"type" : "integer",
"description" : "The unique ID of a call queue record"
}
}
},
"DeleteDestGroupSetResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"CustomerMetricInfo" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"definition_level" : {
"type" : "string",
"description" : "Level of the metric definition (enum 'customer_class', 'customer')"
},
"destination" : {
"type" : "string",
"description" : "The destination name. Only certain special destinations are applicable. In-built special destinations (rate codes) that are applicable for available measured services: ACTIVECALLS – Covers charges for the actual number of concurrent calls made by a particular customer's accounts; ALLOWEDCALLS – Covers charges for the number of concurrent calls allowed for a particular customer. Other special destinations can be created and used as well, but they must not associate with any country. Note that specified destination doesn't impact measurement base. The destination is used only for information purpose in xDRs and statistics"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service type. Note that specified service type doesn’t impact measurement base. The service type value is used only for information purpose in xDRs and statistics. E.g. if API user specifies ID of the Voice Calls service here, an xDR with charges for active calls will have the Voice Calls service type"
},
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination. Only certain special destinations are applicable"
},
"apply_charge" : {
"type" : "string",
"description" : "Defines whether this service is free of charge or not. Possible values: 'Y', 'N'"
},
"i_metric_charge_method" : {
"type" : "integer",
"description" : "The ID of the charge method"
},
"free_items" : {
"type" : "integer",
"description" : "The amount of free items"
},
"i_measured_metric" : {
"type" : "integer",
"description" : "The ID of the measured metric"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"price" : {
"type" : "number",
"description" : "The price for each consumed service item"
}
}
},
"GetServiceFeaturesListRequest" : {
"type" : "object",
"properties" : {
"level" : {
"type" : "string",
"description" : "One of the following: Customers – show customers' service features, Accounts – show account's service features, Customer Sites – show service features defined in customer sites, Products – show service features defined in products, All – show all service features in the system"
},
"show_attributes" : {
"type" : "integer",
"description" : "Flag that indicates whether the service feature attributes will be shown: 1 (show), 0 (do not show)"
},
"get_raw_info" : {
"type" : "integer",
"description" : "The flag that indicates whether the internal fixups will be applied to the output: 1 (not applied, default), 0 (applied). This operation includes removal of deprecated features and transformation of service feature attributes"
}
}
},
"ArrayOfCommitmentOneTimeTermInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CommitmentOneTimeTermInfo"
}
},
"DestinationListCSetGroupDestsResponse" : {
"type" : "object",
"properties" : {
"destinations" : {
"$ref" : "#/components/schemas/ArrayOfDestinationPrefixInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"ArrayOfChargeMethodsInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ChargeMethodsInfo"
}
},
"ArrayOfFollowMeNumberInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/FollowMeNumberInfo"
}
},
"GetCodecConverterFileListResponse" : {
"type" : "object",
"properties" : {
"file_list" : {
"$ref" : "#/components/schemas/ArrayOfCodecConverterFileInfo"
}
}
},
"ArrayOfHGInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/HGInfo"
}
},
"CounterAmountsInfo" : {
"type" : "object",
"properties" : {
"allocated" : {
"type" : "number",
"description" : "The amount is allocated during this period and is used as a base for prorating rollovers"
},
"continued" : {
"type" : "integer",
"description" : "The amount of the used units is carried over on to the next period when counter is reset within a regular period"
},
"money_continued" : {
"type" : "number",
"description" : "The amount of the used monetary is carried over on to the next period when counter is reset within a regular period"
}
}
},
"ArrayOfCustomerPerServiceInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerPerServiceInfo"
}
},
"AddUpdateRPConnectionResponse" : {
"type" : "object",
"properties" : {
"i_rp_connection" : {
"type" : "integer",
"description" : "The unique ID of the added/updated custom routing"
}
}
},
"SystemMetricDataInfo" : {
"required" : [
"name",
"metric_data"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The coded name of the metric"
},
"metric_data" : {
"$ref" : "#/components/schemas/ArrayOfMetricDataInfo"
}
}
},
"GetRetailCustomerXDRListResponse" : {
"required" : [
"xdr_list"
],
"type" : "object",
"properties" : {
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerXDRInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved xDRs"
}
}
},
"DestinationAddCSetGroupResponse" : {
"required" : [
"dest_group_info"
],
"type" : "object",
"properties" : {
"dest_group_info" : {
"$ref" : "#/components/schemas/CSetGroupInfo"
}
}
},
"DestinationMoveCSetGroupDestsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"ChangePasswordResponseErrMessages" : {
"type" : "object",
"properties" : {
"old_password" : {
"type" : "string",
"description" : "Old password error"
},
"new_password" : {
"type" : "string",
"description" : "New password error"
}
}
},
"DeleteTrafficProfileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"AccountDeleteAccountResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if success, 0 otherwise"
}
}
},
"UpdateCustomerClassNotificationTemplateResponse" : {
"required" : [
"is_updated"
],
"type" : "object",
"properties" : {
"is_updated" : {
"type" : "integer",
"description" : "Specifies whether the notification template was updated. Possible values: 1 – The notification template was updated, 0 – The notification template was not updated."
},
"authorship" : {
"type" : "string",
"description" : "Specifies whether the template has been modified. Possible values: System – The template has not been modified; Custom – The template has been modified"
}
}
},
"AddMarketingGroupRequest" : {
"required" : [
"marketing_group_info"
],
"type" : "object",
"properties" : {
"marketing_group_info" : {
"$ref" : "#/components/schemas/MarketingGroupInfo"
}
}
},
"UAProfileInfo" : {
"type" : "object",
"properties" : {
"discontinued" : {
"type" : "string",
"description" : "The flag shows whether the UA profile is discontinued. Possible values: 'Y', 'N'"
},
"mode" : {
"type" : "integer",
"description" : "Shows whether the Cisco ATA profile is configured in H323 or SIP mode. Possible values: 0 - H323, 1 - SIP. This field is present in the response of the 'get_ua_profile_info' method if the 'get_parameters' flag is true"
},
"effective_from" : {
"type" : "string",
"description" : "UA Profile effective from date"
},
"shared" : {
"type" : "string",
"description" : "Shows whether the CPE profile managed by the administrator is available to resellers"
},
"ua_profile_parameters" : {
"$ref" : "#/components/schemas/ArrayOfUAProfileParameterInfo"
},
"is_used_by_resellers" : {
"type" : "integer",
"description" : "Shows whether the shared CPE profile is used by resellers"
},
"i_ua_profile" : {
"type" : "integer",
"description" : "The unique ID of the UA Profile record"
},
"version" : {
"type" : "string",
"description" : "The UA version"
},
"name" : {
"type" : "string",
"description" : "Name of the UA Profile"
},
"description" : {
"type" : "string",
"description" : "UA Profile description"
},
"ua_profile_id" : {
"type" : "integer",
"description" : "ID of UA Profile"
},
"is_active" : {
"type" : "integer",
"description" : "Shows whether the current version of the profile is active"
},
"notepad" : {
"type" : "string",
"description" : "UA Profile notepad"
},
"manufacturer" : {
"type" : "string",
"description" : "The UA manufacturer name"
},
"used" : {
"type" : "string",
"description" : "Indicates whether UA Profile is used or not. Possible values - 'Y', 'N'"
},
"product" : {
"type" : "string",
"description" : "The UA product name"
},
"i_ua_type" : {
"type" : "integer",
"description" : "UA Type ID"
},
"i_customer" : {
"type" : "integer",
"description" : "Managed by"
}
}
},
"GetUAProfileInfoResponse" : {
"type" : "object",
"properties" : {
"ua_profile_info" : {
"$ref" : "#/components/schemas/UAProfileInfo"
}
}
},
"GetAccountRoleInfoRequest" : {
"required" : [
"i_account_role"
],
"type" : "object",
"properties" : {
"i_account_role" : {
"type" : "integer",
"description" : "The identifier of the account role"
}
}
},
"GetAuthzRuleListResponse" : {
"required" : [
"authz_rule_list"
],
"type" : "object",
"properties" : {
"authz_rule_list" : {
"$ref" : "#/components/schemas/ArrayOfAuthzRuleInfo"
}
}
},
"AddVDTopupOptionRequest" : {
"type" : "object",
"properties" : {
"topup_option_info" : {
"$ref" : "#/components/schemas/VDTopupOptionInfo"
}
}
},
"GetDIDInventoryOptionInfoRequest" : {
"type" : "object",
"properties" : {
"i_did_inventory_option" : {
"type" : "integer",
"description" : "The unique ID of the inventory option record"
}
}
},
"CloneTariffInfo" : {
"type" : "object",
"properties" : {
"i_tariff_buy" : {
"type" : "integer",
"description" : "The unique ID of the wholesale tariff record (according to which the reseller is billed by a higher level reseller or service provider)"
},
"tariff_sell" : {
"$ref" : "#/components/schemas/TariffSellInfo"
},
"i_tariff_sell" : {
"type" : "integer",
"description" : "The unique ID of the resale tariff record (the one that the reseller charges their subresellers). If this property is not defined, a new resale tariff will be created as a copy of the reseller's wholesale tariff with the markup"
}
}
},
"ResetPasswordRequest" : {
"type" : "object",
"properties" : {
"email" : {
"type" : "string",
"description" : "The user email address"
},
"custom_url" : {
"type" : "string",
"description" : "Optional link to the reset password page (e.g. http://yourdomain.com/reset_password). If not supplied then the default PortaBilling \"forgot password\" page url will be sent"
},
"password" : {
"type" : "string",
"description" : "A new password"
},
"id" : {
"type" : "string",
"description" : "The reset password ID – A 32- symbol (128-bit) hexadecimal nonce previously sent to an email address as a part of the password reset link (it can be found at the end of the link)"
},
"login" : {
"type" : "string",
"description" : "The user login for the PortaBilling web interface"
}
}
},
"ProductGetServiceFeaturesMetaInfoResponse" : {
"type" : "object",
"properties" : {
"subtypes" : {
"$ref" : "#/components/schemas/ANY"
},
"service_features" : {
"$ref" : "#/components/schemas/ANY"
}
}
},
"SessionChangePasswordRequest" : {
"required" : [
"password",
"new_password",
"login"
],
"type" : "object",
"properties" : {
"password" : {
"type" : "string",
"description" : "The user password for the PortaBilling web interface"
},
"new_password" : {
"type" : "string",
"description" : "The new user password for the PortaBilling web interface"
},
"login" : {
"type" : "string",
"description" : "The username for the PortaBilling web interface"
}
}
},
"AssignMultiserviceUAPortInfo" : {
"required" : [
"i_service_type",
"port"
],
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "Specifies the type of service this port is used for. Only for multiservice devices"
},
"port" : {
"type" : "integer",
"description" : "The port number"
}
}
},
"GetEmergencyUnitInfoRequest" : {
"type" : "object",
"properties" : {
"i_emergency_unit" : {
"type" : "integer",
"description" : "The identifier of the emergency routing unit"
},
"emergency_unit_id" : {
"type" : "string",
"description" : "The canonical path of the administrative unit. Delimiter \".\" (dot)"
},
"with_universal" : {
"type" : "integer",
"description" : "If set to \"1\" or more, the list will include universal administrative units"
}
}
},
"CustomerPrepareCustomerForExportRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The ID of the customer"
}
}
},
"ArrayOfRollovers" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/Rollovers"
}
},
"GetOliListRequest" : {
"type" : "object",
"properties" : {
"oli" : {
"type" : "integer",
"description" : "Enables retrieving the OLI list by oli"
}
}
},
"GetCostRevenueFileResponse" : {
"type" : "object"
},
"GetUAInventoryUsageStatisticsRequest" : {
"type" : "object"
},
"AddCustomerMigrationResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 in case of failure"
}
}
},
"ServiceFeatureInfo" : {
"required" : [
"flag_value",
"name"
],
"type" : "object",
"properties" : {
"locked" : {
"type" : "integer",
"description" : "Specifies whether the feature is locked for editing for current user or not. If absent in response, then the feature can’t be locked"
},
"flag_value" : {
"type" : "string",
"description" : "Value of the corresponding service_flag item. Note that for the cli_trust and permitted_sip_proxies service features the flag_value property is not mandatory"
},
"defined" : {
"type" : "integer",
"description" : "Shows whether the service feature is defined on the object's service features level or not. If absent in the response, it means that the feature is always defined on the object's service features level"
},
"effective_flag_value" : {
"type" : "string",
"description" : "A value of the service feature. It can be received in one of the two ways: inherited by the account from the customer, customer site or the product; inherited by the customer site from the customer"
},
"name" : {
"type" : "string",
"description" : "Service feature name"
},
"attributes" : {
"$ref" : "#/components/schemas/ArrayOfServiceAttributeInfo"
},
"locks" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"CreatePortInRequestResponse" : {
"type" : "object",
"properties" : {
"porting_request_info" : {
"$ref" : "#/components/schemas/PortingRequestInfo"
}
}
},
"DeleteCustomTaxOptionRequest" : {
"required" : [
"i_option"
],
"type" : "object",
"properties" : {
"i_option" : {
"type" : "integer",
"description" : "The unique ID of the custom tax"
}
}
},
"GetDisconnectReasonListRequest" : {
"type" : "object"
},
"DeleteCustomerMigrationRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"DeleteSIMCardRequest" : {
"required" : [
"i_sim_card"
],
"type" : "object",
"properties" : {
"i_sim_card" : {
"type" : "integer",
"description" : "The unique ID of a sim card record"
}
}
},
"ArrayOfRouteCategoryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RouteCategoryInfo"
}
},
"EmergencyUnitInfo" : {
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "A two-letter country code defined in ISO 3166-1 alpha-2"
},
"routing_number_rule" : {
"$ref" : "#/components/schemas/ArrayOfEmergencyUnitRoutingNumberRuleInfo"
},
"i_emergency_unit" : {
"type" : "integer",
"description" : "The identifier of the administrative unit"
},
"emergency_unit_id" : {
"type" : "string",
"description" : "The canonical path of the administrative unit. Delimiter \".\" (dot)"
},
"routing_number" : {
"type" : "string",
"description" : "The (default) routing number, when the cld rule is not specified"
},
"name" : {
"type" : "string",
"description" : "The name of the emergency administrative unit. The field is unique for \"i_env\" and \"country\""
}
}
},
"CRInfo" : {
"required" : [
"id"
],
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "The ID of XDR record"
}
}
},
"SuspendCustomerRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"GetGlobalCurrencyInfoResponse" : {
"required" : [
"global_currency_info"
],
"type" : "object",
"properties" : {
"global_currency_info" : {
"$ref" : "#/components/schemas/GlobalCurrencyInfo"
}
}
},
"ArrayOfAssignedExtensionsInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AssignedExtensionsInfo"
}
},
"CustomerGetCustomerAccountsSubscriptionsResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
},
"subscriptions" : {
"$ref" : "#/components/schemas/ArrayOfAccountSubscriptionInfo"
}
}
},
"ArrayOfOffPeakInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/OffPeakInfo"
}
},
"ValidateCustomerInfoRequest" : {
"type" : "object",
"properties" : {
"customer_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
}
}
},
"DeleteCodecConverterFileRequest" : {
"required" : [
"id"
],
"type" : "object",
"properties" : {
"handler" : {
"type" : "string",
"description" : "The handler name"
},
"id" : {
"type" : "integer",
"description" : "The unique identifier of the file"
}
}
},
"GetAccountFullVDCounterListInfoRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record. Not mandatory when the method that requires this structure is executed from the account realm"
},
"separate_units" : {
"type" : "integer",
"description" : "Specifies whether to provide threshold values and discount amount units (e.g., minutes) in a separate field"
},
"with_service_pool_info" : {
"type" : "integer",
"description" : "Specifies whether to provide service pool information of counter."
},
"with_discount_info" : {
"type" : "integer",
"description" : "Specifies whether to provide the discount information of a counter."
}
}
},
"GetMarketingGroupListResponse" : {
"type" : "object",
"properties" : {
"marketing_group_list" : {
"$ref" : "#/components/schemas/ArrayOfMarketingGroupInfo"
}
}
},
"DeleteCustomerClassMetricRequest" : {
"required" : [
"i_measured_metric",
"i_customer_class"
],
"type" : "object",
"properties" : {
"i_measured_metric" : {
"type" : "integer",
"description" : "The unique ID of the measured service"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
}
}
},
"ServicePoolCombinationInfo" : {
"type" : "object",
"properties" : {
"pooled_ratio" : {
"type" : "integer",
"description" : "The ratio for pooled units"
},
"pooled_unit" : {
"type" : "string",
"description" : "The pooled unit"
},
"i_service" : {
"type" : "integer",
"description" : "The ID of the service"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"unit_ratio" : {
"type" : "integer",
"description" : "The ratio for service pool units"
},
"pooled_unit_ratio" : {
"type" : "string",
"description" : "The ratio for pooled units"
},
"service_name" : {
"type" : "string",
"description" : "The name of the service"
},
"dg_name" : {
"type" : "string",
"description" : "The destination group name"
}
}
},
"DIDPricing" : {
"type" : "object",
"properties" : {
"customer_costs" : {
"$ref" : "#/components/schemas/DIDCostsInfo"
},
"admin_costs" : {
"$ref" : "#/components/schemas/DIDCostsInfo"
},
"reseller_costs" : {
"$ref" : "#/components/schemas/DIDCostsInfo"
}
}
},
"AddVendorBatchRequest" : {
"required" : [
"vendor_batch_info"
],
"type" : "object",
"properties" : {
"vendor_batch_info" : {
"$ref" : "#/components/schemas/VendorBatchInfo"
}
}
},
"GetAccessPolicyInfoResponse" : {
"type" : "object",
"properties" : {
"access_policy_info" : {
"$ref" : "#/components/schemas/AccessPolicyInfo"
}
}
},
"GetEnvInfoRequest" : {
"type" : "object"
},
"GetCPConditionListRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved call processing rule data records"
},
"name" : {
"type" : "string",
"description" : "Name pattern of the condition"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"type" : {
"type" : "string",
"description" : "One of the following: FromNumber, ToNumber, TimeWindow"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"CloneUAProfileRequest" : {
"required" : [
"i_ua_profile",
"name"
],
"type" : "object",
"properties" : {
"i_ua_profile" : {
"type" : "integer",
"description" : "The unique ID of the original UA Profile record"
},
"name" : {
"type" : "string",
"description" : "New UA Profile name"
},
"effective_from" : {
"type" : "string",
"description" : "UA Profile effective from date"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller"
}
}
},
"ArrayOfRoutingPlanCategoryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RoutingPlanCategoryInfo"
}
},
"UpdateAccountAliasRequest" : {
"required" : [
"alias_info"
],
"type" : "object",
"properties" : {
"alias_info" : {
"$ref" : "#/components/schemas/AliasInfo"
},
"release_assigned_did" : {
"type" : "integer",
"description" : "The flag specifies whether the previously assigned DID number should be released to the pool (true by default)"
}
}
},
"GenerateAliasesRequest" : {
"required" : [
"i_master_account"
],
"type" : "object",
"properties" : {
"i_account_role" : {
"type" : "integer",
"description" : "The ID of the account role. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a top-up voucher) and is used for account ID validation"
},
"gen_i_do_batch" : {
"type" : "integer",
"description" : "The ID of DID owner batch to use DID numbers from"
},
"gen_amount" : {
"type" : "integer",
"description" : "The number of aliases to generate"
},
"i_master_account" : {
"type" : "integer",
"description" : "The ID of the parent account record"
},
"gen_start_did" : {
"type" : "string",
"description" : "Starting DID number"
},
"blocked" : {
"type" : "string",
"description" : "Shows whether the alias will be blocked after creation and using it for the authentication is not possible; default: N"
},
"realm" : {
"type" : "string",
"description" : "An account realm enables administrators to impose a scope of uniqueness for an account ID"
},
"check_available_dids" : {
"type" : "integer",
"description" : "If set the method will check all available numbers and terminate with an error if there are less numbers available than the value in the 'gen_amount' field"
}
}
},
"GetServiceAndRatingListRequest" : {
"required" : [
"i_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "Product identifier"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record; refers to the Services table"
},
"show_routing_list" : {
"type" : "integer",
"description" : "Flag which indicates whether routing_list per Service&Rating should be included in response"
},
"i_node" : {
"type" : "integer",
"description" : "The unique ID of the node"
},
"limit" : {
"type" : "integer",
"description" : "Limit for the returned Service&Ratings"
},
"cld" : {
"type" : "string",
"description" : "Calling line destination"
},
"offset" : {
"type" : "integer",
"description" : "Starting position for the Service&Ratings"
}
}
},
"DisconnectSessionRequest" : {
"type" : "object",
"properties" : {
"service_session_id" : {
"type" : "string",
"description" : "The call-id of the session"
},
"billing_session_id" : {
"type" : "string",
"description" : "The h323-conf-id of the session"
}
}
},
"ArrayOfCustomXdrReportType" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomXdrReportType"
}
},
"GetMeasuredMetricsListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Enables retrieving the measured metrics list by name"
}
}
},
"GetAccountConsumedServiceRequest" : {
"type" : "object",
"properties" : {
"show_unsuccessful" : {
"type" : "integer",
"description" : "Show records of unsuccessful attempts"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"from_date" : {
"type" : "string",
"description" : "Get information recorded starting from this date"
},
"group_by_roaming" : {
"type" : "integer",
"description" : "Group xDRs by their roaming status"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved services"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"i_invoice" : {
"type" : "integer",
"description" : "Indicates what xDRs will be shown: nill – Midterm xDRs and out-of-turn xDRs; 0 – Out Of Turn xDRs; Not set – xDRs of all types"
},
"to_date" : {
"type" : "string",
"description" : "Get information recorded before this date"
}
}
},
"AddCustomerSiteResponse" : {
"type" : "object",
"properties" : {
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of a customer site"
}
}
},
"SubdivisionInfo" : {
"required" : [
"iso_3166_1_a2",
"i_country_subdivision",
"iso_3166_2",
"name"
],
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "A two-letter country code defined in ISO 3166-1 alpha-2"
},
"i_country_subdivision" : {
"type" : "integer",
"description" : "A unique ID of country subdivision"
},
"iso_3166_2" : {
"type" : "string",
"description" : "A code of a principal subdivision (e.g. province or state)"
},
"name" : {
"type" : "string",
"description" : "Subdivision name"
}
}
},
"ScopedTemplateInfo" : {
"type" : "object",
"properties" : {
"type_name" : {
"type" : "string",
"description" : "The name of the template type"
},
"name" : {
"type" : "string",
"description" : "Template name"
},
"managed_by" : {
"type" : "string",
"description" : "Name of the owner entity name"
},
"raw_flags" : {
"type" : "string",
"description" : "Template flags"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
},
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the invoice template"
},
"i_notification_preset" : {
"type" : "integer",
"description" : "The unique ID of the notification preset"
},
"used" : {
"type" : "integer",
"description" : "Shows whether the invoice template is used"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"DestinationPrefixInfo" : {
"type" : "object",
"properties" : {
"country" : {
"type" : "string",
"description" : "Country name"
},
"iso_3166_1_a2" : {
"type" : "string",
"description" : "A two-letter country code defined in ISO 3166-1 alpha-2"
},
"network" : {
"type" : "string",
"description" : "Mobile network name"
},
"group_name" : {
"type" : "string",
"description" : "The name of the related destination group. The field is present only if the i_dest_group of a group that belongs to a complete DG set is present in the request"
},
"destination" : {
"type" : "string",
"description" : "Destination number"
},
"subdivision" : {
"type" : "string",
"description" : "Country subdivision"
},
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of the destination record"
},
"iso_3166_1_a3" : {
"type" : "string",
"description" : "A three-letter country code defined in ISO 3166-1 alpha-3"
},
"description" : {
"type" : "string",
"description" : "Text description for this entry"
},
"i_country_subdivision" : {
"type" : "integer",
"description" : "The unique ID of the state or province related to the destination"
},
"dest_type" : {
"type" : "string",
"description" : "Destination Type"
},
"used" : {
"type" : "integer",
"description" : "Is destination prefix used"
}
}
},
"DeleteNotificationPresetResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"GetVendorTransactionsTotalInfoRequest" : {
"required" : [
"i_vendor",
"from_date",
"to_date"
],
"type" : "object",
"properties" : {
"show_unsuccessful" : {
"type" : "integer",
"description" : "Show the records of unsuccessful attempts"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"cli" : {
"type" : "string",
"description" : "The calling party phone number"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of a service for which to show transactions; refers to the Services table"
},
"cld" : {
"type" : "string",
"description" : "The called party phone number"
},
"from_date" : {
"type" : "string",
"description" : "Get information recorded starting from this date"
},
"to_date" : {
"type" : "string",
"description" : "Get information recorded before this date"
}
}
},
"CreditLimitChangeInfo" : {
"type" : "object",
"properties" : {
"prev_cl" : {
"type" : "number",
"description" : "The previous credit limit"
},
"comment" : {
"type" : "string",
"description" : "A comment on the credit limit change"
},
"timestamp" : {
"type" : "string",
"description" : "The timestamp of the credit limit change"
},
"user" : {
"type" : "string",
"description" : "The name of the user who made the change"
},
"valid_until" : {
"type" : "string",
"description" : "The date and time when the temporary credit limit will become invalid"
},
"curr_cl" : {
"type" : "number",
"description" : "The current credit limit"
},
"comment_list" : {
"$ref" : "#/components/schemas/ArrayOfCreditLimitChangeCommentInfo"
}
}
},
"GetConnectionListRequest" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The type of service transported via this connection (voice calls, Internet connectivity, etc.)"
},
"search" : {
"type" : "string",
"description" : "A pattern that allows to search by vendor’s personal information (name, companyname, firstname, lastname, baddr1, address_line_2, city, zip, cont1, cont2, phone1, phone2, email, note). Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character"
},
"i_node" : {
"type" : "integer",
"description" : "The ID of the node used for this connection"
},
"CLD" : {
"type" : "string",
"description" : "The access number the customer dialed to reach your network"
},
"conn_type_technology" : {
"type" : "string",
"description" : "The technology used by the connection type to perform the transport"
},
"get_total" : {
"type" : "string",
"description" : "Get the total number of the retrieved connections"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Works if the API request has the limit property specified"
},
"i_connection_type" : {
"type" : "integer",
"description" : "The unique ID of the connection type record"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"remote_ip" : {
"type" : "string",
"description" : "The IP of the remote gateway, e.g. 23.45.67.89"
},
"conn_type_leg_origin" : {
"type" : "integer",
"description" : "The numeric identification of the connection type origin (the meaning depends on the service type: for VOICE CALLS, 0 - originate, 1 - answer; for messaging, 0 - outgoing message, 1 - incoming message)"
},
"i_vendor_acc" : {
"type" : "integer",
"description" : "Defines the username/password used for authorization of calls via this connection"
},
"active" : {
"type" : "string",
"description" : "The flag shows whether the connection is active. Possible values: 'Y' - active, 'N' - not active, 'I' - internal"
},
"i_tariff" : {
"type" : "integer",
"description" : "The ID of the tariff used to calculate the cost of terminating calls via this connection"
},
"description" : {
"type" : "string",
"description" : "Description of the connection"
}
}
},
"AddUpdateDestGroupSetResponse" : {
"required" : [
"i_dest_group_set"
],
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set"
}
}
},
"AddSpendingConstraintRequest" : {
"required" : [
"spending_constraint_info"
],
"type" : "object",
"properties" : {
"spending_constraint_info" : {
"$ref" : "#/components/schemas/SpendingConstraintInfo"
}
}
},
"GetProductPrioritiesListResponse" : {
"required" : [
"priorities_list"
],
"type" : "object",
"properties" : {
"priorities_list" : {
"$ref" : "#/components/schemas/ArrayOfProductPrioritiesInfo"
}
}
},
"RawDiscountPlanInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Shows whether the discount plan is used or not"
},
"reset_period" : {
"type" : "string",
"description" : "The discount plan lifetime period"
},
"dest_group_set_name" : {
"type" : "string",
"description" : "The destination group set name"
},
"iso_4217" : {
"type" : "string",
"description" : "The volume discount plan currency"
},
"managed_by" : {
"type" : "string",
"description" : "The name of the customer who manages the volume discount plan"
},
"name" : {
"type" : "string",
"description" : "The volume discount plan name"
},
"description" : {
"type" : "string",
"description" : "A description of this volume discount plan"
},
"destination_lookup" : {
"type" : "string",
"description" : "Destination lookup strategy"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set associated with this discount plan"
},
"shared" : {
"type" : "string",
"description" : "Shows whether the discount plan managed by the administrator is available to resellers"
},
"is_used_by_resellers" : {
"type" : "integer",
"description" : "Shows whether the shared discount plan is used by resellers"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer to whom the volume discount plan record is assigned"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan"
}
}
},
"GetPreferableAccountListRequest" : {
"required" : [
"i_owner_account"
],
"type" : "object",
"properties" : {
"group_name" : {
"type" : "string",
"description" : "The name used to group frequently used accounts"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved frequently used accounts"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_owner_account" : {
"type" : "integer",
"description" : "The unique ID of the owner account for a frequently used account"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"AddDestinationPrefixResponse" : {
"required" : [
"i_dest"
],
"type" : "object",
"properties" : {
"i_dest" : {
"type" : "integer",
"description" : "The unique ID of a destination record"
}
}
},
"AccountGetSimpleAccountInfoRequest" : {
"type" : "object",
"properties" : {
"expand_alias" : {
"type" : "integer",
"description" : "For account aliases: indicates whether the information should be retrieved from the alias or from the related master account"
},
"with_reseller_info" : {
"type" : "integer",
"description" : "If with_reseller_info == 1 then return information about reseller"
},
"login" : {
"type" : "string",
"description" : "Account login for the account web self-care interface. The unique in the environment"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"password" : {
"type" : "string",
"description" : "The password for the account web self-care interface"
},
"with_customer_info" : {
"type" : "integer",
"description" : "If with_customer_info == 1 then return information about customer"
},
"id" : {
"type" : "string",
"description" : "ID (PIN) of the account on the PortaBilling interface, unique in the environment"
},
"get_service_features" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"ArrayOfAccountSubscriptionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountSubscriptionInfo"
}
},
"ArrayOfCustomerXDRInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerXDRInfo"
}
},
"UpdateCustomerPaymentMethodRequest" : {
"required" : [
"payment_method_info",
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"payment_method_info" : {
"$ref" : "#/components/schemas/PaymentMethodInfo"
}
}
},
"ArrayOfMNCInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MNCInfo"
}
},
"GetConnectionListResponse" : {
"required" : [
"connection_list"
],
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved connections"
},
"connection_list" : {
"$ref" : "#/components/schemas/ConnectionInfoList"
}
}
},
"DeleteConnectionRequest" : {
"required" : [
"i_connection"
],
"type" : "object",
"properties" : {
"i_connection" : {
"type" : "integer",
"description" : "The unique ID of the vendor connection record"
}
}
},
"AccountUpdateBoothResponse" : {
"required" : [
"action"
],
"type" : "object",
"properties" : {
"booth_info" : {
"$ref" : "#/components/schemas/BoothInfo"
},
"action" : {
"type" : "string",
"description" : "The action to be applied to the account. Possible values: 'unlock', 'lock', 'disconnect'"
}
}
},
"GetCommitmentTermsRequest" : {
"required" : [
"i_commitment"
],
"type" : "object",
"properties" : {
"i_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the commitment record"
}
}
},
"GetAccountRoleListResponse" : {
"type" : "object",
"properties" : {
"role_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountRoleInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved account rules"
}
}
},
"ComplexOrderingInfo" : {
"type" : "object",
"properties" : {
"direction" : {
"type" : "string",
"description" : "Specifies order direction Possible vaues: ASC, DESC"
},
"field" : {
"type" : "string",
"description" : "Specifies the name of a field to order by"
}
}
},
"ArrayOfServicePoolCombinationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServicePoolCombinationInfo"
}
},
"AddAccessNumberRequest" : {
"required" : [
"access_number_info"
],
"type" : "object",
"properties" : {
"access_number_info" : {
"$ref" : "#/components/schemas/AccessNumberInfo"
}
}
},
"DeleteProductSubscriptionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 if subscription deleted and 0 if subscription cannot be deleted"
}
}
},
"AddProductRequest" : {
"required" : [
"product_info"
],
"type" : "object",
"properties" : {
"detailed_response" : {
"type" : "integer",
"description" : "Flag which shows whether added record should be returned in response or not"
},
"product_info" : {
"$ref" : "#/components/schemas/ProductInfo"
}
}
},
"GetCustomerBatchListResponse" : {
"required" : [
"batch_list"
],
"type" : "object",
"properties" : {
"batch_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerBatchInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"UpdateCurrencyRequest" : {
"required" : [
"currency_info"
],
"type" : "object",
"properties" : {
"currency_info" : {
"$ref" : "#/components/schemas/CurrencyInfo"
}
}
},
"PingRequest" : {
"required" : [
"session_id"
],
"type" : "object",
"properties" : {
"session_id" : {
"type" : "string",
"description" : "The ID of a previously opened session"
},
"nonce" : {
"type" : "string",
"description" : "A 32-symbol (128-bit) hexadecimal nonce previously sent to an email address as a part of the allowance link (it can be found at the end of the link)"
}
}
},
"AddonLifeCycleInfo" : {
"required" : [
"i_product",
"effective_from"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the add-on product"
},
"effective_from" : {
"type" : "string",
"description" : "The date and time when the add-on product will be activated"
},
"effective_to" : {
"type" : "string",
"description" : "Date and time when add-on product will be expired"
}
}
},
"AddTariffResponse" : {
"required" : [
"i_tariff"
],
"type" : "object",
"properties" : {
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff record"
}
}
},
"AddPreferableAccountRequest" : {
"required" : [
"preferable_account_info"
],
"type" : "object",
"properties" : {
"preferable_account_info" : {
"$ref" : "#/components/schemas/PreferableAccountInfo"
}
}
},
"AddDestGroupResponse" : {
"required" : [
"i_dest_group"
],
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
}
}
},
"ArrayOfSubscriptionConflicts" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SubscriptionConflicts"
}
},
"GetVendorBatchInfoRequest" : {
"required" : [
"i_dv_batch"
],
"type" : "object",
"properties" : {
"get_did_total_usage" : {
"type" : "integer",
"description" : "Get the usage of DID numbers"
},
"i_dv_batch" : {
"type" : "integer",
"description" : "The unique ID of the vendor batch record"
}
}
},
"GetConferenceSettingsResponse" : {
"type" : "object",
"properties" : {
"conf_max_participants_num" : {
"type" : "integer",
"description" : "Specifies the maximum number of participants allowed for the conference"
}
}
},
"DownloadDGSetResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 in case of success, 0 in case of failure"
}
}
},
"GetTimeZoneListRequest" : {
"type" : "object",
"properties" : {
"search" : {
"type" : "string",
"description" : "Pattern that allows to search by a time zone name. Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character"
}
}
},
"GetTemplateDataFieldListRequest" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"i_component_type" : {
"type" : "integer",
"description" : "The unique ID of the template component type"
}
}
},
"AddUpdateCustomerMetricRequest" : {
"required" : [
"customer_metric_info"
],
"type" : "object",
"properties" : {
"customer_metric_info" : {
"$ref" : "#/components/schemas/CustomerMetricInfo"
}
}
},
"ArrayOfSubdivisionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SubdivisionInfo"
}
},
"ReviewInvoiceRequest" : {
"required" : [
"action",
"i_invoice"
],
"type" : "object",
"properties" : {
"postponed" : {
"type" : "integer",
"description" : "Specifies whether to schedule delivery of approved invoices to customers / regeneration of selected invoices for off-peak"
},
"action" : {
"type" : "string",
"description" : "The action to be applied to this invoice. Possible values: approve, regenerate"
},
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"GetCustomerPaymentTransactionListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
},
"payment_transactions" : {
"$ref" : "#/components/schemas/ArrayOfCustomerTransactionInfo"
}
}
},
"BundlePromotionInfo" : {
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set associated with this bundle promotion plan. This property is mandatory when the structure is used as a parameter of the AddBundlePromotionRequest."
},
"is_used" : {
"type" : "integer",
"description" : "Indicates whether the bundle promotion plan is used or not. Possible values: 1 – The bundle promotion plan is used. 0 – The bundle promotion plan is not used."
},
"i_bd_plan" : {
"type" : "integer",
"description" : "The unique ID of the bundle promotion plan"
},
"name" : {
"type" : "string",
"description" : "The name of the bundle promotion plan. This property is mandatory when the structure is used as a parameter of the AddBundlePromotionRequest."
},
"iso_4217" : {
"type" : "string",
"description" : "The bundle promotion plan currency in the three-letter format (ISO 4217). This property is mandatory when the structure is used as a parameter of the AddBundlePromotionRequest"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller that manages this bundle promotion plan"
},
"description" : {
"type" : "string",
"description" : "The description of the bundle promotion plan"
}
}
},
"UpdateNodeResponse" : {
"required" : [
"i_node"
],
"type" : "object",
"properties" : {
"i_node" : {
"type" : "integer",
"description" : "The unique ID of the node"
}
}
},
"GetAccountMOHListInfoRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
}
}
},
"GetNotificationPresetListRequest" : {
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "The flag shows whether to include the usage flag"
},
"name" : {
"type" : "string",
"description" : "The notification preset name"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved records"
},
"type" : {
"type" : "string",
"description" : "The type of the preset"
},
"i_customer" : {
"type" : "integer",
"description" : "The identifier of the reseller who manages the preset"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"GetAccountVDCounterListResponse" : {
"type" : "object",
"properties" : {
"counter_list" : {
"$ref" : "#/components/schemas/ArrayOfCounterInfo"
}
}
},
"UpdateCustomerRequest" : {
"type" : "object",
"properties" : {
"customer_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
},
"update_params" : {
"$ref" : "#/components/schemas/UpdateCustomerParams"
}
}
},
"AddCurrencyResponse" : {
"required" : [
"iso_4217"
],
"type" : "object",
"properties" : {
"i_ma_currency" : {
"type" : "integer",
"description" : "The unique merchant account currency identifier"
},
"iso_4217" : {
"type" : "string",
"description" : "The unique ID of the Currency record"
}
}
},
"GetCQPromptFileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
},
"prompt_error" : {
"type" : "string",
"description" : "Error message, if any"
},
"prompt_status" : {
"type" : "string",
"description" : "Status of prompt conversion"
}
}
},
"TemplateAddBuildInTemplateResponse" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The ID of the template"
}
}
},
"DeleteOverrideTariffRequest" : {
"type" : "object",
"properties" : {
"i_customer_override_tariff" : {
"type" : "integer",
"description" : "The unique ID of an override tariff rule to be deleted"
}
}
},
"AccountGetServiceFeaturesMetaInfoResponse" : {
"type" : "object",
"properties" : {
"subtypes" : {
"$ref" : "#/components/schemas/ANY"
},
"service_features" : {
"$ref" : "#/components/schemas/ANY"
}
}
},
"GetTraceSessionListRequest" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"session_type" : {
"type" : "integer",
"description" : "The unique ID of the session type"
},
"source" : {
"type" : "string",
"description" : "Fetch sessions from a specific source. Possible values: sip, db, es (optional)"
},
"cli" : {
"type" : "string",
"description" : "The calling line phone number"
},
"status" : {
"type" : "string",
"description" : "Request only sessions with a certain status. Possible values: complete, failed"
},
"from_date" : {
"type" : "string",
"description" : "Beginning of the search interval"
},
"account_id" : {
"type" : "string",
"description" : "The ID of the account the extension is assigned to"
},
"source_ip" : {
"type" : "string",
"description" : "The IP address of the entity"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"cld" : {
"type" : "string",
"description" : "The called line phone number"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_connection" : {
"type" : "integer",
"description" : "The unique ID of the connection"
},
"to_date" : {
"type" : "string",
"description" : "Ending of the search interval"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetBrandPaneResponse" : {
"type" : "object",
"properties" : {
"html_file_name" : {
"type" : "string",
"description" : "A path (relative to /home/porta-admin directory) to the brandpane’s template – HTML file named 'brandpane.tmpl' (e.g. /brandpane/env_3/accounts/brandpane.tmpl)"
},
"css_file_name" : {
"type" : "string",
"description" : "A path (relative to /home/porta-admin directory) to the brandpane's style – CSS file (e.g. /brandpane/env_3/accounts/brandpane.css)"
}
}
},
"GetTransferInfoResponse" : {
"required" : [
"status_code",
"description"
],
"type" : "object",
"properties" : {
"output_currency" : {
"type" : "string",
"description" : "The currency in the destination country"
},
"status_code" : {
"type" : "integer",
"description" : "The status code of the transaction. Can take one of the following values: 0, 1, 2, 3"
},
"destination" : {
"type" : "string",
"description" : "The destination number"
},
"denomination" : {
"type" : "number",
"description" : "Transfer amount"
},
"description" : {
"type" : "string",
"description" : "The description of the status code. Can take one of the following values: CANNOT_FIND, COMPLETED, STARTED, FAILED (corresponds to 0, 1, 2, 3 in status_code)"
}
}
},
"UpdateDiscountPlanRequest" : {
"required" : [
"discount_plan_info"
],
"type" : "object",
"properties" : {
"discount_plan_info" : {
"$ref" : "#/components/schemas/DiscountPlanInfo"
}
}
},
"UploadDatesBatchRequest" : {
"type" : "object"
},
"CleanUpInactiveRatesRequest" : {
"required" : [
"effective_from",
"i_tariff"
],
"type" : "object",
"properties" : {
"effective_from" : {
"type" : "string",
"description" : "Defines when the rate starts to be used. Only unused rates can be cleaned up"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff record"
}
}
},
"GetRoutingCriteriaDestGroupInfoRequest" : {
"required" : [
"i_criteria_dest_group"
],
"type" : "object",
"properties" : {
"i_criteria_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the routing criteria destination group DB record"
}
}
},
"SendMeNotificationSampleRequest" : {
"required" : [
"message_type",
"i_notification_preset",
"name"
],
"type" : "object",
"properties" : {
"message_type" : {
"type" : "string",
"description" : "The type of the notification. Possible values: sms, mail"
},
"i_notification_preset" : {
"type" : "integer",
"description" : "The unique identifier of the notification preset"
},
"name" : {
"type" : "string",
"description" : "The notification name"
}
}
},
"UpdateAccountServiceFeaturesRequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"detailed_response" : {
"type" : "integer",
"description" : "Specifies whether a list of Service Features will be returned in the response or not"
},
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
}
}
},
"GetAuxXDRTypeListRequest" : {
"type" : "object"
},
"RequestDIDNumberInfo" : {
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique ID of the DID number record"
}
}
},
"GetCustomerClassMetricListRequest" : {
"required" : [
"i_customer_class"
],
"type" : "object",
"properties" : {
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetAccountVdNotificationListRequest" : {
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group to apply the top-up to"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"addon_priority" : {
"type" : "integer",
"description" : "The add-on product's precedence level. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Possible values: 0 – Main product, 10 – Low, 15 – Medium low, 20 – Medium, 25 – Medium high, 30 – High"
},
"peak_level" : {
"type" : "integer",
"description" : "Possible values: 0 – The peak period; 1 – The off-peak period; 2 – The 2nd off-peak period"
},
"get_total" : {
"type" : "integer",
"description" : "Include the total number of records"
},
"limit" : {
"type" : "integer",
"description" : "The number of records to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of records to skip at the beginning"
}
}
},
"UpdateCommitmentRecurringTermRequest" : {
"required" : [
"recurring_term_info"
],
"type" : "object",
"properties" : {
"recurring_term_info" : {
"$ref" : "#/components/schemas/CommitmentRecurringTermInfo"
}
}
},
"SessionLogIdInfo" : {
"required" : [
"session_id"
],
"type" : "object",
"properties" : {
"session_id" : {
"type" : "string",
"description" : "The h323-conf-id or call-id of the session"
}
}
},
"GetBrandPaneRequest" : {
"required" : [
"env",
"realm"
],
"type" : "object",
"properties" : {
"env" : {
"type" : "integer",
"description" : "This property represents environments. It must be 'default' (for an unspecified environment) or the i_env number"
},
"realm" : {
"type" : "string",
"description" : "Realm name as in the configuration (admin, accounts, cc_staff, customer, vendor, representative, etc.)"
}
}
},
"ArrayOfServiceFeaturesConflicts" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ServiceFeaturesConflicts"
}
},
"ArrayOfString" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"ArrayOfVoiceQualityMetricDataInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VoiceQualityMetricDataInfo"
}
},
"UATypeInfo" : {
"type" : "object",
"properties" : {
"ports" : {
"type" : "integer",
"description" : "The total number of available ports for the UA device of this type"
},
"manufacturer" : {
"type" : "string",
"description" : "The UA type device manufacturer's company name"
},
"version" : {
"type" : "string",
"description" : "The version of the UA device of this type"
},
"name" : {
"type" : "string",
"description" : "The name of the UA device of this type (Combination of the manufacturer and product fields)"
},
"i_ua_type" : {
"type" : "integer",
"description" : "The unique ID of the UA type"
},
"product" : {
"type" : "string",
"description" : "The model of the UA device of this type"
},
"hidden" : {
"type" : "integer",
"description" : "Shows whether the UA type is hidden or not: 1 – the UA type is hidden; nil or 0 – the UA type is not hidden"
}
}
},
"ReleaseAccessNumberRequest" : {
"required" : [
"i_ivr_an"
],
"type" : "object",
"properties" : {
"i_ivr_an" : {
"type" : "integer",
"description" : "The unique ID of the IVR access number record"
}
}
},
"GetIPTVChannelPackageListRequest" : {
"type" : "object",
"properties" : {
"channel_package_list" : {
"$ref" : "#/components/schemas/ArrayOfIptvChannelPackageFilters"
},
"provider_name" : {
"type" : "string",
"description" : "Provider name pattern. Used for retrieving a set of IPTV channel packages by the provider name"
}
}
},
"AddCommitmentOneTimeTermRequest" : {
"required" : [
"one_time_term_info"
],
"type" : "object",
"properties" : {
"one_time_term_info" : {
"$ref" : "#/components/schemas/CommitmentOneTimeTermInfo"
}
}
},
"ArrayOfDialingRuleInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DialingRuleInfo"
}
},
"DeleteVoiceQualityProfileRequest" : {
"required" : [
"i_vq_profile"
],
"type" : "object",
"properties" : {
"i_vq_profile" : {
"type" : "integer",
"description" : "The ID of the voice quality profile"
}
}
},
"GetUsedLocationListResponse" : {
"type" : "object",
"properties" : {
"used_location_list" : {
"$ref" : "#/components/schemas/ArrayOfUsedLocationInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved records"
}
}
},
"UpdateCustomerExtensionRequest" : {
"required" : [
"i_c_ext"
],
"type" : "object",
"properties" : {
"i_c_ext" : {
"type" : "integer",
"description" : "ID of the modified extension"
},
"name" : {
"type" : "string",
"description" : "Extension name"
},
"primary_i_c_group" : {
"type" : "integer",
"description" : "The unique ID of a huntgroup to be assigned as the primary group for an extension (0 to unset)"
},
"prompt_action" : {
"type" : "string",
"description" : "When creating an extension you can upload a voice prompt with the person's name. Possible values: set – Add (or replace) a prompt for an extension. The sound file is sent in a MIME attachment to the API request; unset – Remove existing prompt. Note that The Apache Cassandra database must be enabled for this method property to work"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"published" : {
"type" : "string",
"description" : "When creating an extension you can mark it as \"published\" so that it is included in the dial-by-name directory. One of the following: Y – Makes an extensions accessible via dial-by-name; N – Excludes a certain extension from being accessible via dial-by- name (e.g. you do not want telemarketers to directly reach your CEO or CFO because their names are publicly accessible)"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"id" : {
"type" : "string",
"description" : "Extension number"
}
}
},
"HGInfo" : {
"type" : "object",
"properties" : {
"i_c_ext" : {
"type" : "integer",
"description" : "Extension ID; Refers to the Centrex_Group_Extensions table"
},
"i_prompt" : {
"type" : "integer",
"description" : "The unique ID of the assigned prompt file"
},
"name" : {
"type" : "string",
"description" : "The name of the owner"
},
"prompt_error" : {
"type" : "string",
"description" : "A description of the last processing error"
},
"published" : {
"type" : "string",
"description" : "When creating an extension you can mark it as \"published\" so that it is included in the dial-by-name directory. One of the following: Y – Makes an extensions accessible via dial-by-name; N – Excludes a certain extension from being accessible via dial-by-name (e.g. you do not want telemarketers to directly reach your CEO or CFO because their names are publicly accessible)"
},
"assigned_extensions" : {
"$ref" : "#/components/schemas/ArrayOfAssignedExtensionsInfo"
},
"hunt_keep_original_cli" : {
"type" : "string",
"description" : "Specifies whether to keep the original CLI; one of the following:\n 'Y' - The call is redirected with the phone number and name of the original caller.\n 'N' - The call is redirected with the phone number and name of the huntgroup.\n 'I' - Id Only, The call is redirected with the phone number of the original caller and name of the huntgroup.\n "
},
"hunt_sequence" : {
"type" : "string",
"description" : "The ringing strategy; one of the following: Order, Random, Simultaneous, LeastUsed"
},
"i_c_group" : {
"type" : "integer",
"description" : "The unique ID of the group record (for type = Group)"
},
"i_ringback_tone" : {
"type" : "integer",
"description" : "The unique ID of the assigned ringback tone file"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"assigned_callqueue" : {
"$ref" : "#/components/schemas/CQInfo"
},
"id" : {
"type" : "string",
"description" : "Identifier"
},
"pickup_allowed" : {
"type" : "string",
"description" : "Specifies whether to allow extensions to pick up calls made to the members of this huntgroup. Possible values: Y – Allow; N – Disallow"
},
"prompt_status" : {
"type" : "string",
"description" : "The prompt file processing status. Possible values: IN_PROGRESS, ERROR, FINISHED"
}
}
},
"EstimateSubscriptionPriceForFirstBillingPeriodResponse" : {
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "The full price the user has to pay for the first billing period of the commitment usage"
},
"iso_4217" : {
"type" : "string",
"description" : "The currency"
}
}
},
"AddNodeResponse" : {
"required" : [
"i_node"
],
"type" : "object",
"properties" : {
"i_node" : {
"type" : "integer",
"description" : "The unique ID of the node"
}
}
},
"ArrayOfMediaAttributeValueInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MediaAttributeValueInfo"
}
},
"EstimatedDIDNumberPricingParameterInfo" : {
"type" : "object",
"properties" : {
"cost" : {
"$ref" : "#/components/schemas/EstimatedDIDNumberPriceInfo"
},
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the DID pricing batch that is used to calculate the revenue"
},
"name" : {
"type" : "string",
"description" : "The name of the customer/reseller the estimated prices are related to"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer/reseller the estimated prices are related to"
},
"revenue" : {
"$ref" : "#/components/schemas/EstimatedDIDNumberPriceInfo"
}
}
},
"GetCustomXdrReportListRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"period_from" : {
"type" : "string",
"description" : "Get custom xDR reports dated starting from this date"
},
"period_to" : {
"type" : "string",
"description" : "Get custom xDR reports dated before this date"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"type" : {
"type" : "string",
"description" : "The name of a custom xDR report type"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"UpdateCustomerClassNotificationTemplateRequest" : {
"required" : [
"name",
"i_customer_class"
],
"type" : "object",
"properties" : {
"bcc" : {
"type" : "string",
"description" : "An email address of the person who wants to receive a copy of this notification. You can specify more than one valid email address; make sure you separate them with commas."
},
"body" : {
"type" : "string",
"description" : "The content of the message"
},
"reset_to_default" : {
"type" : "integer",
"description" : "Specifies whether to reset the notification template to its default value. Possible values: 1 – Reset the notification template to its default value, 0 – Do not reset the notification template."
},
"subject" : {
"type" : "string",
"description" : "The subject as it appears in an email to a recepient"
},
"name" : {
"type" : "string",
"description" : "The name of the either email or sms notification template as it appears in the Notifications table in the database"
},
"variables" : {
"$ref" : "#/components/schemas/ArrayOfNotificationTemplateVariables"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
}
}
},
"DIDNumberListInfo" : {
"required" : [
"number",
"id"
],
"type" : "object",
"properties" : {
"req_params" : {
"$ref" : "#/components/schemas/DIDRequestParameters"
},
"number" : {
"type" : "string",
"description" : "DID number"
},
"id" : {
"type" : "integer",
"description" : "The consecutive number in the list"
},
"pricing" : {
"$ref" : "#/components/schemas/DIDPricing"
}
}
},
"AddUpdateServicePoolResponse" : {
"type" : "object",
"properties" : {
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service pool record"
}
}
},
"GetXDRListRequest" : {
"required" : [
"collection_name"
],
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The ID of the service type"
},
"connect_time_to" : {
"type" : "string",
"description" : "Ending of the search interval"
},
"i_vendor" : {
"type" : "integer",
"description" : "The ID of the vendor"
},
"status" : {
"type" : "string",
"description" : "The status of the xDR record (enum: todo, incomplete, skipped, rejected, imported)"
},
"i_service" : {
"type" : "integer",
"description" : "The ID of the service"
},
"connect_time_from" : {
"type" : "string",
"description" : "Beginning of the search interval"
},
"collection_name" : {
"type" : "string",
"description" : "The name of the xDR collection"
},
"user_name" : {
"type" : "string",
"description" : "The name of the user"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"i_customer" : {
"type" : "integer",
"description" : "The ID of the customer"
},
"cld" : {
"type" : "string",
"description" : "The CLD match pattern"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"error_type" : {
"type" : "string",
"description" : "The xDR processing error type (enum: customer*, vednor*, timeout, *radius*, *confirmation, other)"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GenerateCaptchaResponse" : {
"required" : [
"ca_token",
"ca_content"
],
"type" : "object",
"properties" : {
"ca_token" : {
"type" : "string",
"description" : "The captcha token"
},
"ca_content" : {
"type" : "string",
"description" : "The encoded captcha image"
}
}
},
"DestinationGroupInfo" : {
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set to which the current destination group belongs"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"name" : {
"type" : "string",
"description" : "The destination group name"
},
"used" : {
"type" : "integer",
"description" : "Shows whether the destination group set is used"
},
"prefixes" : {
"type" : "string",
"description" : "Comma separated list of destinations included in the current destination group"
},
"description" : {
"type" : "string",
"description" : "The destination group description"
}
}
},
"ServicePolicyAttributePossibleValue" : {
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The possible value of service policy attribute"
},
"text" : {
"type" : "string",
"description" : "The way the value should be displayed"
}
}
},
"RawAccessAttributePermission" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the access attribute"
},
"permission" : {
"type" : "integer",
"description" : "The permission for the access attribute"
}
}
},
"GetAPIErrorFileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"GetRPConnectionListRequest" : {
"required" : [
"i_routing_plan"
],
"type" : "object",
"properties" : {
"i_routing_plan" : {
"type" : "integer",
"description" : "The unique ID of the Routing Plan record"
}
}
},
"GetUserNotificationCategoryListRequest" : {
"type" : "object",
"properties" : {
"i_user" : {
"type" : "integer",
"description" : "The unique ID of the user record"
}
}
},
"GetCustomerCustomFieldsValuesResponse" : {
"type" : "object",
"properties" : {
"custom_fields_values" : {
"$ref" : "#/components/schemas/ArrayOfCustomFieldsValuesInfo"
}
}
},
"AccountAddAccountWithTopupResponse" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the created account record"
},
"topup_result" : {
"type" : "string",
"description" : "The topup result message"
},
"account_created" : {
"type" : "integer",
"description" : "The flag shows the account creation status"
},
"topup_amount" : {
"type" : "number",
"description" : "The topup amount"
}
}
},
"ArrayOfXDRCollectionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/XDRCollectionInfo"
}
},
"TemplateBodyInfo" : {
"type" : "object",
"properties" : {
"mime_type_id" : {
"type" : "string",
"description" : "The MIME type of the file"
},
"language" : {
"type" : "string",
"description" : "The language of the body"
},
"version" : {
"type" : "integer",
"description" : "The version of the template"
},
"content" : {
"type" : "string",
"description" : "The content of the file. For binary data (such as images) it returns a base64 encoded string"
},
"body_name" : {
"type" : "string",
"description" : "The name of the file"
},
"rel_file_path" : {
"type" : "string",
"description" : "The relative path to the directory where the file is located"
}
}
},
"GetDIDNumbersListResponse" : {
"type" : "object",
"properties" : {
"numbers_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDNumberListInfo"
}
}
},
"ArrayOfAccountCustomFieldsInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountCustomFieldsInfo"
}
},
"ArrayOfMetricFilterInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MetricFilterInfo"
}
},
"AccountFindRecipientRequest" : {
"type" : "object",
"properties" : {
"sender_i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"phone1" : {
"type" : "string",
"description" : "Main phone number"
},
"id" : {
"type" : "string",
"description" : "ID (PIN) of the account on the PortaBilling interface, unique in the environment"
}
}
},
"SetAccountStateResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Indicates whether the account's state setting was: 1 – successful, 0 – unsuccessful"
}
}
},
"GetCustomerSubscriptionsResponse" : {
"type" : "object",
"properties" : {
"subscriptions" : {
"$ref" : "#/components/schemas/ArrayOfCustomerSubscriptionInfo"
}
}
},
"AddVendorResponse" : {
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique identifier of the created vendor"
}
}
},
"DeleteAccountPaymentMethodResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"ArrayOfCreditLimitChangeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CreditLimitChangeInfo"
}
},
"GetProductGroupInfoResponse" : {
"required" : [
"group_info"
],
"type" : "object",
"properties" : {
"group_info" : {
"$ref" : "#/components/schemas/ProductGroupInfo"
}
}
},
"DeleteVDThresholdResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"TaxationCode" : {
"required" : [
"value",
"name"
],
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The value of the taxation code"
},
"name" : {
"type" : "string",
"description" : "The name of the taxation code"
}
}
},
"GetCustomerPaymentMethodInfoRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"empty_if_not_configured" : {
"type" : "integer",
"description" : "Set this flag to receive undef value if payment method not configured. When it's not provided error returns"
}
}
},
"TemplateInfo" : {
"type" : "object",
"properties" : {
"i_media_type" : {
"type" : "integer",
"description" : "The unique ID of media type record"
},
"body_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateBodyInfo"
},
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the invoice template"
},
"custom_description" : {
"type" : "string",
"description" : "User-defined template description"
},
"type_name" : {
"type" : "string",
"description" : "The name of the template type"
},
"is_default" : {
"type" : "string",
"description" : "Shows whether the invoice template is default or not"
},
"is_system" : {
"type" : "integer",
"description" : "Shows whether the invoice template is system or not"
},
"managed_by" : {
"type" : "string",
"description" : "Name of the owner entity name"
},
"name" : {
"type" : "string",
"description" : "Template name"
},
"raw_flags" : {
"type" : "string",
"description" : "Template flags"
},
"description" : {
"type" : "string",
"description" : "Template description"
},
"media_name" : {
"type" : "string",
"description" : "Name of the template media type"
},
"used" : {
"type" : "integer",
"description" : "Shows whether invoice template is used or not"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"i_time_zone" : {
"type" : "integer",
"description" : "Defines a time zone in which the datetime will be set in tariff download/upload templates"
},
"tz" : {
"type" : "string",
"description" : "The name of the time zone"
},
"i_template_type" : {
"type" : "integer",
"description" : "The unique ID of the template type"
}
}
},
"TaxationPluginGetTaxPluginParametersMetaInfoRequest" : {
"required" : [
"i_plugin"
],
"type" : "object",
"properties" : {
"i_plugin" : {
"type" : "integer",
"description" : "The ID of the taxation plugin"
}
}
},
"DeleteDiscountRequest" : {
"required" : [
"i_vd_dg"
],
"type" : "object",
"properties" : {
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the discount for a specific destination group to be deleted"
}
}
},
"ArrayOfOutOfTurnXDRInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/OutOfTurnXDRInfo"
}
},
"GetInvoiceTypeInfoResponse" : {
"type" : "object",
"properties" : {
"type_info" : {
"$ref" : "#/components/schemas/InvoiceTypeInfo"
}
}
},
"GetAsyncRequestInfoResponse" : {
"type" : "object",
"properties" : {
"request_info" : {
"$ref" : "#/components/schemas/AsyncRequestInfo"
}
}
},
"UpdateRoutingCriteriaDestGroupRequest" : {
"required" : [
"routing_criteria_dest_group_info"
],
"type" : "object",
"properties" : {
"routing_criteria_dest_group_info" : {
"$ref" : "#/components/schemas/RoutingCriteriaDestGroupInfo"
}
}
},
"GetRoamingCountryListRequest" : {
"type" : "object",
"properties" : {
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property specified in the API request"
}
}
},
"DeleteNodeResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"ArrayOfProductPrioritiesInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ProductPriorityInfo"
}
},
"ArrayOfRawAccessAttributePermission" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RawAccessAttributePermission"
}
},
"GenericGetPropertyHistoryCatalogInfoRequest" : {
"type" : "object",
"properties" : {
"property_name" : {
"type" : "string",
"description" : "The property history catalog record name"
},
"i_property" : {
"type" : "integer",
"description" : "The unique identifier of the property history catalog record"
}
}
},
"ChangeAccountPasswordRequest" : {
"required" : [
"new_password"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"old_password" : {
"type" : "string",
"description" : "The old password"
},
"new_password" : {
"type" : "string",
"description" : "The new password"
}
}
},
"ArrayOfAbbreviatedDialingNumberInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AbbreviatedDialingNumberInfo"
}
},
"UpdateUserNotificationCategoryListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation was completed"
}
}
},
"ListMerchantAccountsResponse" : {
"required" : [
"merchant_accounts"
],
"type" : "object",
"properties" : {
"merchant_accounts" : {
"$ref" : "#/components/schemas/ArrayOfMerchantAccounts"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved payment and payment remittance systems records"
}
}
},
"RoamingProfileInfo" : {
"type" : "object",
"properties" : {
"managed_by" : {
"type" : "integer",
"description" : "The ID of the roaming profile owner record"
},
"name" : {
"type" : "string",
"description" : "The roaming profile name"
},
"description" : {
"type" : "string",
"description" : "The roaming profile description"
},
"policy" : {
"$ref" : "#/components/schemas/RoamingPolicyInfo"
},
"used" : {
"type" : "integer",
"description" : "Shows whether the roaming profile is in use"
},
"i_roaming_profile" : {
"type" : "integer",
"description" : "The ID of the roaming profile record"
},
"default_restriction_level" : {
"type" : "string",
"description" : "Specifies default restriction level of the roaming profile"
},
"countries" : {
"$ref" : "#/components/schemas/RoamingCountries"
}
}
},
"ArrayOfWarningInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/WarningInfo"
}
},
"ServiceTypeInfo" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the Service Type"
},
"usage_rating" : {
"type" : "string",
"description" : "Shows whether usage charging is mandatory or not for the Service Type. Possible values: 'Y', 'N'"
},
"name" : {
"type" : "string",
"description" : "The logical name of the Service Type"
},
"charge_unit_list" : {
"$ref" : "#/components/schemas/ArrayOfChargeUnitInfo"
}
}
},
"AccountRoleInfo" : {
"type" : "object",
"properties" : {
"i_account_role" : {
"type" : "integer",
"description" : "The unique ID of the account role type"
},
"validation_format" : {
"type" : "string",
"description" : "The validation for the ID of the account role type"
},
"name" : {
"type" : "string",
"description" : "The name of the account role type"
},
"realm" : {
"type" : "string",
"description" : "The top realm of the account role type"
},
"inventory_usage" : {
"type" : "string",
"description" : "Specifies whether to retrieve the inventory for the account role type"
}
}
},
"VendorBatchInfo" : {
"type" : "object",
"properties" : {
"country" : {
"type" : "string",
"description" : "ISO 3166 two-letter country code"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the DID vendor batch is in use"
},
"area_code" : {
"type" : "string",
"description" : "Area Code"
},
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"total_dids_used" : {
"type" : "integer",
"description" : "The total number of DID numbers in the vendor batch that are in use"
},
"name" : {
"type" : "string",
"description" : "The name of the vendor batch"
},
"vendor_name" : {
"type" : "string",
"description" : "The name of the vendor related to this vendor batch"
},
"description" : {
"type" : "string",
"description" : "The description of the vendor batch"
},
"total_dids" : {
"type" : "integer",
"description" : "The total number of DID numbers in the vendor batch"
},
"i_dv_batch" : {
"type" : "integer",
"description" : "The unique ID of the vendor batch record"
},
"area_code_description" : {
"type" : "string",
"description" : "Area Code Description"
},
"total_dids_free" : {
"type" : "integer",
"description" : "The total number of DID numbers in the vendor batch that are not in use"
}
}
},
"GetSubrealmsListRequest" : {
"type" : "object"
},
"GetSuretaxExemptionListResponse" : {
"type" : "object",
"properties" : {
"exemption_code_list" : {
"$ref" : "#/components/schemas/ArrayOfExemptionCodes"
}
}
},
"GenericGetSessionDataResponse" : {
"type" : "object",
"properties" : {
"session_id" : {
"type" : "string",
"description" : "The encrypted session identifier"
},
"i_env" : {
"type" : "integer",
"description" : "The environment ID"
},
"language_direction" : {
"type" : "string",
"description" : "Text direction"
},
"out_date_format" : {
"type" : "string",
"description" : "The output date format"
},
"realm" : {
"type" : "string",
"description" : "The realm name"
},
"env_name" : {
"type" : "string",
"description" : "The environment name"
},
"user" : {
"type" : "string",
"description" : "The user identifier"
},
"out_time_format" : {
"type" : "string",
"description" : "The output time format"
},
"out_date_time_format" : {
"type" : "string",
"description" : "The output datetime format"
},
"i_callshop" : {
"type" : "integer",
"description" : "The callshop ID"
},
"auto_redirect_to_foreign" : {
"type" : "integer",
"description" : "The flag shows whether to redirect the user to your other system in case the data is located there"
},
"callshop" : {
"type" : "integer",
"description" : "The flag shows whether the user has the callshop functionality enabled"
},
"i_user" : {
"type" : "integer",
"description" : "The user ID"
},
"language" : {
"type" : "string",
"description" : "The language"
},
"in_time_format" : {
"type" : "string",
"description" : "The input time format"
},
"tz_offset" : {
"type" : "integer",
"description" : "The time zone offset (in seconds)"
},
"max_credit_limit_increase" : {
"type" : "string",
"description" : "The maximum possible increase of the permanent credit limit"
},
"in_date_format" : {
"type" : "string",
"description" : "The input date format"
},
"i_customer" : {
"type" : "integer",
"description" : "The customer ID"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The time zone ID"
},
"tz" : {
"type" : "string",
"description" : "The time zone name"
},
"is_super_user" : {
"type" : "integer",
"description" : "The flag shows whether the current user is a superuser"
},
"hide_personal_info" : {
"type" : "integer",
"description" : "The flag shows whether the personal information is hidden for the user"
},
"max_credit_limit_days" : {
"type" : "integer",
"description" : "The maximum period of validity of the temporary credit limit"
}
}
},
"BillingPeriodClosureDelayedInfo" : {
"required" : [
"auto_close_on",
"is_closing_scheduled"
],
"type" : "object",
"properties" : {
"auto_close_on" : {
"type" : "string",
"description" : "The timestamp when the customer's billing period will be automatically closed"
},
"is_closing_scheduled" : {
"type" : "string",
"description" : "Shows whether the customer's billing period is scheduled to be closed"
}
}
},
"GetOliListResponse" : {
"required" : [
"oli_list"
],
"type" : "object",
"properties" : {
"oli_list" : {
"$ref" : "#/components/schemas/ArrayOfOliInfo"
}
}
},
"GetCQListInfoResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of retrieved call queues"
},
"callqueue_list" : {
"$ref" : "#/components/schemas/ArrayOfCQInfo"
}
}
},
"ProductInfo" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"default_i_acl" : {
"type" : "integer",
"description" : "Which ACL should be assigned to new accounts created with this product"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code for product currency"
},
"subscription_host" : {
"type" : "string",
"description" : "Left for backward compatibility"
},
"topup_addon" : {
"type" : "string",
"description" : "Specifies whether this is an add-on product or the main one. Possible values: Y – an add-on product, N – the main product"
},
"shared" : {
"type" : "string",
"description" : "Shows whether the product managed by the administrator is available to resellers"
},
"addon_effective_to" : {
"type" : "string",
"description" : "Account product addon effective to date"
},
"addon_priority" : {
"type" : "integer",
"description" : "In order to differentiate the add-on products there is also a \"precedence level\" parameter for each add-on product. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Allowed values: 0 – Main Product, 10 – Low, 15 – Medium Low, 20 – Medium, 25 – Medium High, 30 – High"
},
"info_url" : {
"type" : "string",
"description" : "URL to an external website describing product features"
},
"product_subscription" : {
"$ref" : "#/components/schemas/ProductSubscriptionInfo"
},
"is_used" : {
"type" : "integer",
"description" : "Shows if product is used or not"
},
"name" : {
"type" : "string",
"description" : "Product name"
},
"description" : {
"type" : "string",
"description" : "Product description"
},
"volume_discount_plan_name" : {
"type" : "string",
"description" : "The name of the associated volume discount plan"
},
"i_product_group" : {
"type" : "integer",
"description" : "Product Group ID"
},
"end_user_name" : {
"type" : "string",
"description" : "Product Name visible to End User"
},
"breakage" : {
"type" : "number",
"description" : "Used in Account Management to obtain a summary of depleted (practically unusable) accounts"
},
"is_used_by_resellers" : {
"type" : "integer",
"description" : "Shows whether the shared product is used by resellers"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the Subscription Plan"
},
"realm" : {
"type" : "string",
"description" : "A custom string. An account realm enables administrators to impose a scope of uniqueness for an account ID"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "ID of an assigned volume discount plan"
},
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
},
"product_group_name" : {
"type" : "string",
"description" : "Product Group name"
},
"allowed_products" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
},
"subscription_discount_list" : {
"$ref" : "#/components/schemas/SubscriptionDiscountList"
},
"i_account_role" : {
"type" : "integer",
"description" : "The unique ID of the account role; refers to the Account_Roles table. An account role defines what a specific account is designated for (e.g. whether the account represents a phone line or a topup voucher) and executes account ID validation. Thus, for a phone line, one can only pick a valid phone number as an account ID"
},
"service_flag_locks" : {
"type" : "string",
"description" : "Specifies whether values for each service feature are allowed to be changed by administrator and end user"
},
"addon_effective_from" : {
"type" : "string",
"description" : "Account product addon effective from date"
},
"included_services" : {
"$ref" : "#/components/schemas/ArrayOfProductIncludedServices"
},
"end_user_description" : {
"type" : "string",
"description" : "Description visible to End User"
},
"notepad" : {
"type" : "string",
"description" : "Product notepad"
},
"managed_by_user" : {
"type" : "string",
"description" : "Can be managed by end user"
},
"hidden" : {
"type" : "string",
"description" : "Indicates whether the product is hidden"
},
"i_customer" : {
"type" : "integer",
"description" : "Managed by"
},
"fraud_protection" : {
"type" : "string",
"description" : "Overdraft Protection mode for the Product. Possible values: 'None', 'All', 'Debit'"
}
}
},
"GetXDRCollectionInfoResponse" : {
"type" : "object",
"properties" : {
"xdr_collection_info" : {
"$ref" : "#/components/schemas/XDRCollectionInfo"
}
}
},
"AddAllowedLocationRequest" : {
"type" : "object",
"properties" : {
"allowed_location_info" : {
"$ref" : "#/components/schemas/AllowedLocationInfo"
}
}
},
"RTRequestorInfo" : {
"type" : "object",
"properties" : {
"i_entity" : {
"type" : "integer",
"description" : "The unique identifier of the requestor"
},
"name" : {
"type" : "string",
"description" : "The name of the requestor"
},
"entity_type" : {
"type" : "string",
"description" : "The type of the requestor. Possible values: 'customer', 'reseller', 'env'"
}
}
},
"UpdateQFFieldsRequest" : {
"required" : [
"qf_fields_list",
"entity_number",
"i_quick_form"
],
"type" : "object",
"properties" : {
"qf_fields_list" : {
"$ref" : "#/components/schemas/ArrayOfQFFieldInfo"
},
"i_quick_form" : {
"type" : "integer",
"description" : "The unique ID of the quick form"
},
"entity_number" : {
"type" : "integer",
"description" : "The number of the entity the fields belong to"
}
}
},
"EnableApiNotificationsCustomerResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation has been successfully completed"
}
}
},
"ArrayOfCustomFieldsInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomFieldsInfo"
}
},
"CancelDIDProvisionRequest" : {
"required" : [
"i_did_number"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "Provisioned number ID in the DID inventory"
},
"did_provider_info" : {
"$ref" : "#/components/schemas/CustomerDIDProviderIdent"
}
}
},
"CommitmentInfo" : {
"type" : "object",
"properties" : {
"i_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the commitment record"
},
"managed_by" : {
"type" : "integer",
"description" : "The identifier of the reseller who manages the commitment"
},
"name" : {
"type" : "string",
"description" : "The name of the commitment"
},
"iso_4217" : {
"type" : "string",
"description" : "The commitment currency"
},
"description" : {
"type" : "string",
"description" : "The commitment description"
},
"allowed_pause_times_per_year" : {
"type" : "integer",
"description" : "The maximum number of times the commitment can be paused per year"
},
"pausing_min_days" : {
"type" : "integer",
"description" : "The minimum number of days for a single commitment pause"
},
"upgrade_fee" : {
"type" : "number",
"description" : "The fee the customer has to pay for upgrading to this commitment from another one. The minimum value is zero. If set to zero, no xDR will be created. The UI equivalent of this field is the \"Upgrade fee\" input on the Edit commitment main panel"
},
"min_period" : {
"type" : "integer",
"description" : "The minimum number of billing periods the commitment shall be active before it can be terminated without penalties"
},
"pausing_max_days" : {
"type" : "integer",
"description" : "The maximum number of days for a single commitment pause"
},
"pausing_fee" : {
"type" : "number",
"description" : "The fee for commitment pausing"
},
"used" : {
"type" : "integer",
"description" : "The flag that specifies whether the commitment is assigned to at least one account"
},
"transfer_fee" : {
"type" : "number",
"description" : "The fee for commitment transferring"
}
}
},
"UpdateRouteCategoryRequest" : {
"required" : [
"route_category_info"
],
"type" : "object",
"properties" : {
"route_category_info" : {
"$ref" : "#/components/schemas/RouteCategoryInfo"
}
}
},
"GetServiceInfoRequest" : {
"type" : "object",
"properties" : {
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
}
}
},
"GetCustomerVdCounterHistoryListRequest" : {
"required" : [
"i_cvd_counter"
],
"type" : "object",
"properties" : {
"get_total" : {
"type" : "integer",
"description" : "Include the total number of records"
},
"i_xdr" : {
"type" : "integer",
"description" : "The ID of the XDR record from CDR_Accounts table (CDR_Customers if applied to Reseller)"
},
"limit" : {
"type" : "integer",
"description" : "The number of records to retrieve"
},
"i_cvd_counter" : {
"type" : "integer",
"description" : "The ID of the Counter record from Customer_VD_Counters table"
},
"offset" : {
"type" : "integer",
"description" : "The number of records to skip at the beginning"
}
}
},
"AssignDIDToOwnerBatchResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation has been successfully completed"
}
}
},
"UpdateAccountCustomFieldsValuesResponse" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"custom_fields_values" : {
"$ref" : "#/components/schemas/ArrayOfCustomFieldsValuesInfo"
}
}
},
"GetInvoiceInfoResponse" : {
"type" : "object",
"properties" : {
"invoice_info" : {
"$ref" : "#/components/schemas/InvoiceInfo"
}
}
},
"GetCustomerClassTaxationInfoRequest" : {
"required" : [
"i_customer_class"
],
"type" : "object",
"properties" : {
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class record"
}
}
},
"ExtendedDataFilterInfo" : {
"type" : "object",
"properties" : {
"entries" : {
"$ref" : "#/components/schemas/ArrayOfExtendedDataEntryInfo"
},
"condition" : {
"type" : "string",
"description" : "The condition used to group the entries"
}
}
},
"AddRoutingCriteriaRequest" : {
"required" : [
"routing_criteria_info"
],
"type" : "object",
"properties" : {
"routing_criteria_info" : {
"$ref" : "#/components/schemas/RoutingCriteriaInfo"
}
}
},
"UnsuspendCustomerResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"GetAccessRoleInfoResponse" : {
"type" : "object",
"properties" : {
"access_role_info" : {
"$ref" : "#/components/schemas/AccessRoleInfo"
}
}
},
"ArrayOfTraceXdrInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TraceXdrInfo"
}
},
"UpdateUserRequest" : {
"required" : [
"user_info"
],
"type" : "object",
"properties" : {
"user_info" : {
"$ref" : "#/components/schemas/UserInfo"
}
}
},
"GetServiceTypeListResponse" : {
"required" : [
"service_type_list"
],
"type" : "object",
"properties" : {
"service_type_list" : {
"$ref" : "#/components/schemas/ArrayOfServiceTypeInfo"
}
}
},
"GetInvoiceTemplateListResponse" : {
"required" : [
"template_list",
"total"
],
"type" : "object",
"properties" : {
"template_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved invoice templates"
}
}
},
"ReleaseDIDFromResellerResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 if failed"
}
}
},
"StatusHistoryInfoList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/StatusHistoryInfo"
}
},
"DeleteOverrideTariffResponse" : {
"type" : "object",
"properties" : {
"override_tariff_deleted" : {
"type" : "integer",
"description" : "Specifies whether the override tariff was deleted: 1 - one tariff was deleted, 0 - nothing was deleted"
}
}
},
"DisableApiNotificationsCustomerResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation has been successfully completed"
}
}
},
"AuthInfoStructure" : {
"type" : "object",
"properties" : {
"password" : {
"type" : "string",
"description" : "The user password for the PortaBilling web interface"
},
"session_id" : {
"type" : "string",
"description" : "The unique ID of a previously opened SOAP session (used without a login)"
},
"token" : {
"type" : "string",
"description" : "The API access token of a user. Сan be used instead of a password to set up the session"
},
"login" : {
"type" : "string",
"description" : "The user login for the PortaBilling web interface. Should be used together with one of the following: password, token"
},
"csrf_token" : {
"type" : "string",
"description" : "The CSRF token"
}
}
},
"UnbindAddonProductResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Shows whether using of addon with current Product has been disallowed successfully"
}
}
},
"AssignDIDToCustomerRequest" : {
"required" : [
"i_did_number",
"i_customer"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique DID Number identifier"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record to which the account belongs"
}
}
},
"ModifySpendingLimitRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"new_spending_limit" : {
"type" : "number",
"description" : "The total amount of money that a customer can spend in the period on services"
},
"reset_spent_amount" : {
"type" : "integer",
"description" : "Specifies whether to reset the current spending limit. Possible values: 1 - Reset the current spending limit; 0 - Do not reset the current spending limit"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"ModifyRequestResponse" : {
"type" : "object",
"properties" : {
"porting_request_info" : {
"$ref" : "#/components/schemas/PortingRequestInfo"
}
}
},
"UpdateAccountsBatchRequest" : {
"type" : "object",
"properties" : {
"activation_date" : {
"type" : "string",
"description" : "The date from which accounts are usable"
},
"i_product" : {
"type" : "integer",
"description" : "The unique ID of Product record "
},
"unified_messaging" : {
"type" : "string",
"description" : "Enable/disable or set as defined by the product UM service feature"
},
"terminate" : {
"type" : "integer",
"description" : "Indicates that accounts should be terminated"
},
"activate" : {
"type" : "integer",
"description" : "Indicates that accounts should be activated. Only for debit accounts and vouchers"
},
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of Customer Site record"
},
"opening_balance" : {
"type" : "number",
"description" : "The initial balance of the account"
},
"reapply_subscriptions" : {
"type" : "integer",
"description" : "Product subscriptions will be reapplied for accounts"
},
"force_terminate" : {
"type" : "integer",
"description" : "Indicates that accounts should be terminated (ignoring associated non-disconnectable active sessions)"
},
"blocked" : {
"type" : "string",
"description" : "Indicates whether accounts should be blocked or unblocked"
},
"advanced_search" : {
"$ref" : "#/components/schemas/AccountsAdvancedSearchInfo"
},
"redirect_number" : {
"type" : "string",
"description" : "Associated number"
},
"i_batch" : {
"type" : "integer",
"description" : "The unique ID of batch record"
},
"credit" : {
"type" : "number",
"description" : "The amount to credit accounts"
},
"i_distributor" : {
"type" : "integer",
"description" : "The unique ID of Distributor"
},
"life_time" : {
"type" : "integer",
"description" : "Accounts will expire on the first usage time + lifetime days"
},
"expiration_date" : {
"type" : "string",
"description" : "The date from which accounts will become unusable"
},
"addon_products" : {
"$ref" : "#/components/schemas/ArrayOfInt"
},
"i_role" : {
"type" : "integer",
"description" : "The unique ID of the account's access role"
},
"ivr_language" : {
"type" : "string",
"description" : "Preferred IVR language"
},
"batch" : {
"type" : "string",
"description" : "The batch name"
},
"charge" : {
"type" : "number",
"description" : "The amount to charge accounts"
},
"control_number" : {
"type" : "string",
"description" : "Comma-separated integer control numbers and/or ranges of integer control numbers. For example: 3,5-9,12"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The unique ID of Time Zone record"
}
}
},
"GetDisconnectReasonListResponse" : {
"required" : [
"disconnect_reason_list"
],
"type" : "object",
"properties" : {
"disconnect_reason_list" : {
"$ref" : "#/components/schemas/ArrayOfDisconnectReasonInfo"
}
}
},
"DeleteTrafficProfileRequest" : {
"required" : [
"i_traffic_profile"
],
"type" : "object",
"properties" : {
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
}
}
},
"UpdateProductResponse" : {
"required" : [
"i_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"product_info" : {
"$ref" : "#/components/schemas/ProductInfo"
}
}
},
"AddServiceRequest" : {
"type" : "object",
"properties" : {
"service_info" : {
"$ref" : "#/components/schemas/ServiceInfo"
}
}
},
"AccountGetRoutingOptionsResponse" : {
"type" : "object",
"properties" : {
"routing_options" : {
"$ref" : "#/components/schemas/ArrayOfRoutingOptionInfo"
}
}
},
"AddConnectionRequest" : {
"required" : [
"connection_info"
],
"type" : "object",
"properties" : {
"connection_info" : {
"$ref" : "#/components/schemas/ConnectionInfo"
}
}
},
"AccountRecipientInfo" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"firstname" : {
"type" : "string",
"description" : "Account owner's first name"
},
"id" : {
"type" : "string",
"description" : "ID (PIN) of the account on the PortaBilling interface, unique in the environment"
},
"lastname" : {
"type" : "string",
"description" : "Account owner's last name"
}
}
},
"SessionLogMessage" : {
"type" : "object",
"properties" : {
"meta_info" : {
"$ref" : "#/components/schemas/SessionLogMessageMetaInfo"
},
"text" : {
"type" : "string",
"description" : "The text of the session log message"
},
"type" : {
"type" : "string",
"description" : "The type of the session log message"
}
}
},
"BatchDeleteCallRecordingRequest" : {
"required" : [
"xdr_list"
],
"type" : "object",
"properties" : {
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfCRInfo"
}
}
},
"AddTariffDownloadTemplateResponse" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
}
}
},
"GetCustomerClassListRequest" : {
"type" : "object",
"properties" : {
"invoicing_status" : {
"type" : "string",
"description" : "Possible values: 1 - both regular and out-of-turn invoicing enabled , 2 - regular invoicing enabled, 3 - out-of-turn invoicing enabled, 4 - invoicing disabled"
},
"search" : {
"type" : "string",
"description" : "Search in the name and description of a customer class"
},
"name" : {
"type" : "string",
"description" : "The name of the customer class"
},
"with_shared" : {
"type" : "integer",
"description" : "If set to '1' and the reseller's data is requested then shared entities managed by the administrator will be added to the response"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the customer class is in use"
},
"i_business_model" : {
"type" : "integer",
"description" : "The unique ID of the business model"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of the reseller who manages the customer class"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"ArrayOfConflictingAddOns" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ConflictingAddOns"
}
},
"DeleteDIDNumberListRequest" : {
"type" : "object",
"properties" : {
"number_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDNumberInfo"
}
}
},
"ArrayOfAccountVdCounterHistoryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountVdCounterHistoryInfo"
}
},
"EstimatedDIDNumberPriceInfo" : {
"required" : [
"periodic_fee",
"activation_fee"
],
"type" : "object",
"properties" : {
"periodic_fee" : {
"type" : "number",
"description" : "A monthly amount paid for using this DID number"
},
"activation_fee" : {
"type" : "number",
"description" : "A one-time amount paid for the DID number activation"
}
}
},
"AssignUAResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"ArrayOfAccountVdNotificationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountVdNotificationInfo"
}
},
"ConflictingVDPs" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group record"
},
"effective_from" : {
"type" : "string",
"description" : "The date and time when the add-on product will be activated"
},
"effective_to" : {
"type" : "string",
"description" : "The date and time when the add-on product will expire"
},
"service_name" : {
"type" : "string",
"description" : "The name of the service"
},
"dg_name" : {
"type" : "string",
"description" : "The name of the destination group"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan record"
},
"vdp_name" : {
"type" : "string",
"description" : "The name of the volume discount plan"
},
"product_name" : {
"type" : "string",
"description" : "The name of the product"
}
}
},
"GetCustomXdrReportTypesResponse" : {
"required" : [
"report_types"
],
"type" : "object",
"properties" : {
"report_types" : {
"$ref" : "#/components/schemas/ArrayOfCustomXdrReportType"
}
}
},
"GetRoutingPlanInfoResponse" : {
"type" : "object",
"properties" : {
"routing_plan_info" : {
"$ref" : "#/components/schemas/RoutingPlanInfo"
}
}
},
"GetCommissionPlanListResponse" : {
"required" : [
"commission_plan_list"
],
"type" : "object",
"properties" : {
"commission_plan_list" : {
"$ref" : "#/components/schemas/ArrayOfCommissionPlanInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of found commission plans"
}
}
},
"ArrayOfCustomFieldsValuesInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomFieldsValuesInfo"
}
},
"GetTimePeriodInfoResponse" : {
"type" : "object",
"properties" : {
"time_period_info" : {
"$ref" : "#/components/schemas/TimePeriodInfo"
}
}
},
"DeleteVendorResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"ArrayOfDIDProviderInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DIDProviderInfo"
}
},
"GetUserInfoRequest" : {
"required" : [
"i_user"
],
"type" : "object",
"properties" : {
"i_user" : {
"type" : "integer",
"description" : "The unique ID of the user record"
},
"get_rt_auth_info" : {
"type" : "integer",
"description" : "If set to '1', the user's RT information will be provided in the response"
}
}
},
"AddRateGroupResponse" : {
"required" : [
"i_rate_list"
],
"type" : "object",
"properties" : {
"i_rate_list" : {
"$ref" : "#/components/schemas/ArrayOfInt"
}
}
},
"DeleteVendorBatchResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"SendLogToRTRequest" : {
"required" : [
"ticket_number",
"session_log_info"
],
"type" : "object",
"properties" : {
"ticket_number" : {
"type" : "string",
"description" : "The issue ticket number on the Request Tracker"
},
"comment" : {
"type" : "string",
"description" : "Comment text"
},
"session_log_info" : {
"$ref" : "#/components/schemas/SessionLogInfoForRT"
}
}
},
"AccountCommitmentInfo" : {
"type" : "object",
"properties" : {
"activation_date" : {
"type" : "string",
"description" : "The date when the charges for a commitment are activated. Activation date is shifted from the start date for the period specified by 'Commitments.ActivationDelay' in config"
},
"pause_to_date" : {
"type" : "string",
"description" : "The end of the pause"
},
"penalties_to_date" : {
"type" : "string",
"description" : "The date until which the penalties are calculated on the commitment termination. May be set in the request to 'terminate_assigned_commitment_record' method"
},
"apply_prev_penalty" : {
"type" : "string",
"description" : "The flag specifies whether the penalties should be applied from previous commitments (default: they should)."
},
"commitment_name" : {
"type" : "string",
"description" : "The name of the commitment"
},
"min_terminate_date" : {
"type" : "string",
"description" : "The date specifies the end of the minimum period, after which the commitment may be terminated without penalties"
},
"is_paused" : {
"type" : "string",
"description" : "The flag specifies whether the commitment is paused"
},
"i_account" : {
"type" : "integer",
"description" : "The unique identifier of the account record"
},
"start_date" : {
"type" : "string",
"description" : "The date when the commitment services are enabled. The charges may be postponed by the config option 'Commitments.ActivationDelay'"
},
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
},
"i_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the commitment record"
},
"prev_penalty_amount" : {
"type" : "number",
"description" : "The penalties from previous commitments"
},
"is_finished" : {
"type" : "string",
"description" : "The flag shows if service is no longer provided per this commitment"
},
"pause_from_date" : {
"type" : "string",
"description" : "The start of the pause"
},
"apply_penalties" : {
"type" : "string",
"description" : "The flag that specifies whether the penalties for early termination should be applied. The flag can be overwritten on the level of a specific account commitment term during commitment termination"
},
"penalties_from_date" : {
"type" : "string",
"description" : "The date staring from which the penalties are calculated on the commitment termination. May be set in the request to 'terminate_assigned_commitment_record' method"
},
"finish_date" : {
"type" : "string",
"description" : "The date when the commitment finishes"
},
"auto_prolong" : {
"type" : "string",
"description" : "The flag specifies whether the commitment is auto-prolonged after its initial period finished"
}
}
},
"GetSubscriptionInfoResponse" : {
"type" : "object",
"properties" : {
"subscription_info" : {
"$ref" : "#/components/schemas/SubscriptionInfo"
}
}
},
"GetPhoneBookListResponse" : {
"type" : "object",
"properties" : {
"phonebook_rec_list" : {
"$ref" : "#/components/schemas/ArrayOfPhoneBookRecInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of Phone book records"
}
}
},
"ComplexOrderingList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ComplexOrderingInfo"
}
},
"ArrayOfBusinessModelInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BusinessModelInfo"
}
},
"AddRatingGroupRequest" : {
"required" : [
"rating_group_info"
],
"type" : "object",
"properties" : {
"rating_group_info" : {
"$ref" : "#/components/schemas/RatingGroupInfo"
}
}
},
"SaleDiscountConfigurationInfo" : {
"type" : "object",
"properties" : {
"sale_discount_list" : {
"$ref" : "#/components/schemas/ArrayOfCommitmentSaleDiscountInfo"
},
"i_recurring_term" : {
"type" : "integer",
"description" : "The identifier of the commitment recurring term to which the sale discount is being configured. Can be obtained from the Commitment.get_recurring_term_list method response"
}
}
},
"UpdateEnvInfoResponse" : {
"required" : [
"i_env"
],
"type" : "object",
"properties" : {
"i_env" : {
"type" : "integer",
"description" : "The unique ID of the environment"
}
}
},
"RealmInfo" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the realm"
}
}
},
"AddNoteRequest" : {
"required" : [
"i_entity",
"entity_type",
"description"
],
"type" : "object",
"properties" : {
"detailed_response" : {
"type" : "integer",
"description" : "Specifies whether the added record will be returned in the response"
},
"i_entity" : {
"type" : "string",
"description" : "The unique ID of the entity for which the note will be created"
},
"entity_type" : {
"type" : "string",
"description" : "The type of the entity (e.g. Accounts, Customers, etc.)"
},
"description" : {
"type" : "string",
"description" : "The contents of the note"
}
}
},
"EnableApiNotificationsAccountRequest" : {
"required" : [
"event"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"i_ivr_an" : {
"type" : "integer",
"description" : "The unique ID of the IVR access number"
},
"event" : {
"type" : "string",
"description" : "The event name"
}
}
},
"AuxXDRTypeInfo" : {
"type" : "object",
"properties" : {
"i_aux_type" : {
"type" : "integer",
"description" : "The unique ID of the XDR column"
},
"name" : {
"type" : "string",
"description" : "The name of the XDR column"
},
"xdr_column_id" : {
"type" : "string",
"description" : "The XDR column identifier"
}
}
},
"AssignSIMCardRequest" : {
"required" : [
"i_account",
"i_sim_card"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The ID of the account record"
},
"i_sim_card" : {
"type" : "integer",
"description" : "The ID of the SIM card record"
}
}
},
"GetLocaleLanguagesListResponse" : {
"type" : "object",
"properties" : {
"locale_languages" : {
"$ref" : "#/components/schemas/ArrayOfLocaleLanguageInfo"
}
}
},
"ArrayOfMeasuredMetricsInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/MeasuredMetricsInfo"
}
},
"AccountControlNumberInfo" : {
"required" : [
"control_number"
],
"type" : "object",
"properties" : {
"control_number" : {
"type" : "integer",
"description" : "The sequential number of the account in the batch"
}
}
},
"GetCustomerVdCounterInfoRequest" : {
"required" : [
"i_cvd_counter"
],
"type" : "object",
"properties" : {
"i_cvd_counter" : {
"type" : "integer",
"description" : "The unique ID of the record"
}
}
},
"CommissionPlanInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Shows whether the commission plan is used or not"
},
"default_commission" : {
"type" : "number",
"description" : "The commission which will be used if there are no other commissions"
},
"name" : {
"type" : "string",
"description" : "The name of the commission plan "
},
"iso_4217" : {
"type" : "string",
"description" : "The currency of the commission plan "
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the entity managing the commission plan"
},
"subscription_commissions" : {
"$ref" : "#/components/schemas/ArrayOfCPSubscriptionInfo"
},
"global_commissions" : {
"$ref" : "#/components/schemas/ArrayOfCPPeriodInfo"
},
"i_commission_plan" : {
"type" : "integer",
"description" : "The unique ID of the commission plan"
},
"service_commissions" : {
"$ref" : "#/components/schemas/ArrayOfCPServiceInfo"
},
"i_cp_base" : {
"type" : "integer",
"description" : "The unique ID of the commission plan base"
}
}
},
"BalanceWarningThreshold" : {
"required" : [
"warning_threshold",
"type"
],
"type" : "object",
"properties" : {
"warning_threshold" : {
"type" : "number",
"description" : "Warning threshold value. NOTE: For postpaid customers, balance warning thresholds can be defined either as amounts or as percentages of a positive Permanent Credit Limit value. For prepaid customers, balance warning thresholds can be defined only as an amount of an Available Funds value"
},
"type" : {
"type" : "string",
"description" : "Type of the warning threshold. Possible values: A - absolute amount, P - percent"
}
}
},
"UserInfo" : {
"type" : "object",
"properties" : {
"activation_date" : {
"type" : "string",
"description" : "The date when the user's account is activated (UTC)"
},
"firstname" : {
"type" : "string",
"description" : "The user's first name"
},
"iso_4217" : {
"type" : "string",
"description" : "The ISO4217 currency code"
},
"out_date_format" : {
"type" : "string",
"description" : "Output date format"
},
"state" : {
"type" : "string",
"description" : "The name of the state"
},
"email" : {
"type" : "string",
"description" : "An email contact for the user"
},
"password" : {
"type" : "string",
"description" : "The password for this user"
},
"out_date_time_format" : {
"type" : "string",
"description" : "Output date and time format"
},
"i_user" : {
"type" : "integer",
"description" : "The unique ID of the user record"
},
"rt_auth_info" : {
"$ref" : "#/components/schemas/RTAuthInfo"
},
"ip_filter" : {
"type" : "string",
"description" : "The list of IP addresses that are enabled for the user to login into PortaBilling"
},
"i_lang" : {
"type" : "string",
"description" : "The language used on the admin web interface for this user"
},
"transaction_allowance" : {
"type" : "number",
"description" : "The maximum amount of credit/refund per one transaction for the user"
},
"description" : {
"type" : "string",
"description" : "A short description associated with the user"
},
"i_role" : {
"type" : "integer",
"description" : "The identifier of the access role"
},
"login" : {
"type" : "string",
"description" : "The username for login and user identification"
},
"address_line_2" : {
"type" : "string",
"description" : "The 2nd line of the user's address"
},
"zip" : {
"type" : "string",
"description" : "The user's ZIP code. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash)"
},
"in_date_format" : {
"type" : "string",
"description" : "Input date format"
},
"phone1" : {
"type" : "string",
"description" : "The main phone number"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The time zone in which this user is operating"
},
"class" : {
"type" : "string",
"description" : "The class of the user"
},
"max_credit_limit_days" : {
"type" : "integer",
"description" : "The maximum period of validity of the temporary credit limit"
},
"phone2" : {
"type" : "string",
"description" : "An alternative phone number"
},
"hide_personal_info" : {
"type" : "integer",
"description" : "Shows whether personal information is hidden from the user. Can be 0 - is visible or 1 - is hidden."
},
"salutation" : {
"type" : "string",
"description" : "The user's salutation"
},
"cont1" : {
"type" : "string",
"description" : "The main contact person"
},
"daily_allowance" : {
"type" : "number",
"description" : "The maximum amount of credit/refund per day for the user"
},
"midinit" : {
"type" : "string",
"description" : "The user's middle name"
},
"status" : {
"type" : "string",
"description" : "Indicates user's status. Can be the following: empty (if the user is active), inactive, expired or exceeded"
},
"lastname" : {
"type" : "string",
"description" : "The user's last name"
},
"login_allowed_ip_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"city" : {
"type" : "string",
"description" : "The name of the city"
},
"role_name" : {
"type" : "string",
"description" : "The name of the access role"
},
"cont2" : {
"type" : "string",
"description" : "The alternative contact person"
},
"out_time_format" : {
"type" : "string",
"description" : "Output time format"
},
"auto_redirect_to_foreign" : {
"type" : "integer",
"description" : "The flag shows whether to redirect the user to your other system in case the data is located there"
},
"country" : {
"type" : "string",
"description" : "The code of the country in the ISO 3166-1 alpha-2 format"
},
"in_time_format" : {
"type" : "string",
"description" : "Input time format"
},
"expiration_date" : {
"type" : "string",
"description" : "The date when the user's account expires"
},
"max_credit_limit_increase" : {
"type" : "string",
"description" : "The maximum possible increase of the permanent credit limit"
},
"faxnum" : {
"type" : "string",
"description" : "A fax number"
},
"api_token" : {
"type" : "string",
"description" : "The API token of the user. You could use tokens instead of standard login-password pairs for authenticating your applications integrated with PortaBilling via API."
},
"i_notification_preset" : {
"type" : "integer",
"description" : "The notification preset assigned to the user"
},
"i_acl" : {
"type" : "integer",
"description" : "The privilege level or role assigned to the user"
},
"companyname" : {
"type" : "string",
"description" : "The conventional form of user company's name"
},
"baddr1" : {
"type" : "string",
"description" : "1st line of user's address"
},
"is_super_user" : {
"type" : "string",
"description" : "Shows whether the user is super user"
}
}
},
"AccountTransactionInfo" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "Status of the transaction"
},
"iso_4217" : {
"type" : "string",
"description" : "Currency for the transaction"
},
"purpose" : {
"type" : "string",
"description" : "The purpose of the transaction"
},
"cdrid" : {
"type" : "string",
"description" : "XDR ID created for the transaction"
},
"unique_transaction_id" : {
"type" : "string",
"description" : "UUID based unique transaction ID. Should be used as i_payment_transaction for transactions via PayNearMe processor"
},
"x_transaction_id" : {
"type" : "string",
"description" : "The external transaction unique ID"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"i_online_payment_processor" : {
"type" : "integer",
"description" : "The unique payment processor ID for the transaction"
},
"result_code" : {
"type" : "string",
"description" : "Transaction's result code"
},
"timestamp" : {
"type" : "string",
"description" : "Timestamp of the transaction"
},
"i_payment_method" : {
"type" : "integer",
"description" : "Unique payment method ID for the transaction"
},
"i_payment_transaction_type" : {
"type" : "integer",
"description" : "The unique ID of the Transaction Type"
},
"cc_number_hash" : {
"type" : "string",
"description" : "A crypted hexadecimal code of the credit card number that was used to perform the transaction"
},
"result_message" : {
"type" : "string",
"description" : "Transaction's result message"
},
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique payment system ID for the transaction"
},
"secret" : {
"type" : "string",
"description" : "A secret code for the transaction"
},
"payment_method_info" : {
"type" : "string",
"description" : "Comment on the transaction's payment method"
},
"details" : {
"type" : "string",
"description" : "Description of the transaction"
},
"test_mode" : {
"type" : "string",
"description" : "Indicates whether the Payment Processor was in the test mode at the moment when the transaction was processed - Y/N"
},
"purpose_details" : {
"type" : "string",
"description" : "The details of the purpose"
},
"account_id" : {
"type" : "string",
"description" : "The identifier of the account (unique in the environment)"
},
"amount" : {
"type" : "number",
"description" : "Money amount for the transaction"
},
"i_payment_transaction" : {
"type" : "integer",
"description" : "The unique ID of a payment transaction"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"customer_name" : {
"type" : "string",
"description" : "The name of the customer"
}
}
},
"GetCustomerVDCounterListRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"service_name" : {
"type" : "string",
"description" : "Service name pattern"
},
"peak_level" : {
"type" : "integer",
"description" : "ID of the Peak Level: 0 (Peak Period), 1 (Off-Peak Period), 2 (2nd Off-Peak Period)"
},
"detailed_info" : {
"type" : "integer",
"description" : "Detailed information"
},
"dg_name" : {
"type" : "string",
"description" : "Destination group name pattern"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"ArrayOfDIDNumberListInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DIDNumberListInfo"
}
},
"GetAccountInfoRequest" : {
"type" : "object",
"properties" : {
"i_batch" : {
"type" : "integer",
"description" : "Refers to batch record to which the account belongs"
},
"detailed_info" : {
"type" : "integer",
"description" : "Detailed information"
},
"expand_alias" : {
"type" : "integer",
"description" : "For account aliases: indicates whether the information should be retrieved from the alias or from the related master account"
},
"batch_name" : {
"type" : "string",
"description" : "Name of batch to which the account belongs"
},
"with_reseller_info" : {
"type" : "integer",
"description" : "If with_reseller_info == 1 then return information about reseller"
},
"login" : {
"type" : "string",
"description" : "Account login for the account web self-care interface. The unique in the environment"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"with_customer_info" : {
"type" : "integer",
"description" : "If with_customer_info == 1 then return information about customer"
},
"control_number" : {
"type" : "integer",
"description" : "Sequential number of the account in the batch. This attribute serves to determine what account from the batch you wish to retrieve the information about. Mandatory for the API request with the batch_name property specified"
},
"i_subscriber" : {
"type" : "integer",
"description" : "The unique ID of the account's subscriber record. Refers to the Subscribers table"
},
"id" : {
"type" : "string",
"description" : "ID (PIN) of the account on the PortaBilling interface, unique in the environment"
},
"without_service_features" : {
"type" : "integer",
"description" : "Specifies whether the information about service features should be included in the response. Note that SOAP requests without information requests about service features are 30% faster, so specify \"1\" here if you don't need information about service features"
},
"get_service_features" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"get_included_services" : {
"type" : "integer",
"description" : "Specifies whether to retrieve the list of services configured for the account. Possible values: 1 – Retreive the list of services; 0 – Do not retrieve the list of services"
},
"aux_field_names" : {
"$ref" : "#/components/schemas/ArrayOfAuxFieldNames"
}
}
},
"GetCostRevenueFileListRequest" : {
"required" : [
"period_from",
"period_to",
"type"
],
"type" : "object",
"properties" : {
"period_from" : {
"type" : "string",
"description" : "Get the Cost/Revenue report files dated starting from this date"
},
"period_to" : {
"type" : "string",
"description" : "Get the Cost/Revenue report files dated before this date"
},
"type" : {
"type" : "integer",
"description" : "The type of the Cost/Revenue report"
}
}
},
"ArrayOfProductInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ProductInfo"
}
},
"GetAuxXDRTypeListResponse" : {
"type" : "object",
"properties" : {
"aux_xdr_type_list" : {
"$ref" : "#/components/schemas/ArrayOfAuxXDRTypeInfo"
}
}
},
"ArrayOfNetnumberInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NetnumberInfo"
}
},
"GetRatingGroupListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Rating group name pattern"
},
"id" : {
"type" : "integer",
"description" : "Rating group code pattern on the CoSS server"
}
}
},
"UpdateProductRequest" : {
"required" : [
"product_info"
],
"type" : "object",
"properties" : {
"detailed_response" : {
"type" : "integer",
"description" : "Flag which shows whether updated record should be returned in response or not"
},
"product_info" : {
"$ref" : "#/components/schemas/ProductInfo"
}
}
},
"ActivateAccountSubscriptionsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"ValidateAddonsCombinationRequest" : {
"required" : [
"i_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the main product record"
},
"assigned_addons" : {
"$ref" : "#/components/schemas/ArrayOfInt"
},
"selected_products" : {
"$ref" : "#/components/schemas/ArrayOfAddonLifeCycleInfo"
}
}
},
"DeleteAccessRoleResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"RTAuthInfo" : {
"type" : "object",
"properties" : {
"rt_login" : {
"type" : "string",
"description" : "Customer RT login"
},
"rt_pass" : {
"type" : "string",
"description" : "Customer RT password"
},
"rt_server_url" : {
"type" : "string",
"description" : "RT Server URL"
},
"queue" : {
"type" : "string",
"description" : "RT queue name"
},
"requestor" : {
"type" : "string",
"description" : "RT requestor name"
}
}
},
"DeleteCustomerRequest" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record to be deleted"
}
}
},
"ArrayOfVDPConflicts" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VDPConflicts"
}
},
"DeleteAccountAliasResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if success, SOAP fault otherwise"
},
"warnings" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"DeleteRouteCategoryRequest" : {
"required" : [
"i_route_category"
],
"type" : "object",
"properties" : {
"i_route_category" : {
"type" : "integer",
"description" : "The unique ID of the route category DB record"
}
}
},
"ArrayOfCustomerSubscriptionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerSubscriptionInfo"
}
},
"GetASRFileRequest" : {
"required" : [
"i_vendor",
"file_name"
],
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the vendor record"
},
"file_name" : {
"type" : "string",
"description" : "The file name"
},
"compress" : {
"type" : "string",
"description" : "If specified, describes the compression used for the returned attachment. Possible values: none, zip. Default: zip"
}
}
},
"GetVendorAccountInfoRequest" : {
"required" : [
"i_vendor_acc"
],
"type" : "object",
"properties" : {
"i_vendor_acc" : {
"type" : "integer",
"description" : "The unique ID of the vendor account record"
}
}
},
"CleanupPersonalDataResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"GetCustomerSitesResponse" : {
"required" : [
"sites"
],
"type" : "object",
"properties" : {
"sites" : {
"$ref" : "#/components/schemas/ArrayOfCustomerSiteInfo"
}
}
},
"GetSupportedLanguageRequest" : {
"type" : "object",
"properties" : {
"i_voice_application" : {
"type" : "integer",
"description" : "The ID of the voice application"
}
}
},
"TaxPluginTransactionCodeInfo" : {
"required" : [
"i_plugin"
],
"type" : "object",
"properties" : {
"i_plugin" : {
"type" : "integer",
"description" : "The unique identifier of the taxation plugin"
},
"code" : {
"type" : "string",
"description" : "The value of the taxation code"
}
}
},
"GetASRFileListResponse" : {
"type" : "object",
"properties" : {
"file_list" : {
"$ref" : "#/components/schemas/ArrayOfReportFileInfo"
}
}
},
"UserLoginToEnvResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if success"
}
}
},
"DeleteDestinationPrefixResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"UpdateSIMCardRequest" : {
"required" : [
"card_info"
],
"type" : "object",
"properties" : {
"card_info" : {
"$ref" : "#/components/schemas/SIMCardInfo"
}
}
},
"GetAllAccAliasesListInfoResponse" : {
"type" : "object",
"properties" : {
"account_aliases_list" : {
"$ref" : "#/components/schemas/ArrayOfAccAliasesListInfo"
},
"total" : {
"type" : "integer",
"description" : "Number of aliases"
}
}
},
"GetPhoneBookRecordRequest" : {
"required" : [
"i_account_phonebook"
],
"type" : "object",
"properties" : {
"i_account_phonebook" : {
"type" : "integer",
"description" : "The unique ID of the Phonebook’s record"
}
}
},
"FraudConstraintInfo" : {
"type" : "object",
"properties" : {
"is_used" : {
"type" : "integer",
"description" : "Determines whether the fraud constraint is used by the customer"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The identifier of the destination group"
},
"destination_group" : {
"type" : "string",
"description" : "The name of the destination group"
},
"duration" : {
"type" : "integer",
"description" : "The duration of the fraud constraint"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
},
"fraud_traffic_info" : {
"$ref" : "#/components/schemas/FraudTrafficInfo"
},
"i_ft_constraint" : {
"type" : "integer",
"description" : "The identifier of the fraud constraint"
},
"i_customer" : {
"type" : "integer",
"description" : "The identifier of the customer"
},
"accumulation_period" : {
"type" : "string",
"description" : "The name of the accumulation period. Possible periods: [hour, day]"
}
}
},
"ReleaseUARequest" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
}
}
},
"DeleteCallQueueResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if success, otherwise SOAP fault"
}
}
},
"DialingCodes" : {
"type" : "object",
"properties" : {
"call_release" : {
"type" : "string",
"description" : "An end user can dial this code to retrieve a call from the parked status. The default value is *71"
},
"dial_out" : {
"type" : "string",
"description" : "An end user can dial this code while on a call to transfer the call to another end user. This feature is available only for forwarded calls. The default value is *66"
},
"clir_show" : {
"type" : "string",
"description" : "An end user can dial this code before dialing the phone number to allow displaying the calling number to the called party. The default value is *68"
},
"call_park" : {
"type" : "string",
"description" : "An end user can dial this code to park a call. The default value is *70"
},
"bypass_dial_plan" : {
"type" : "string",
"description" : "A feature access code (e.g. *3164*)"
},
"paging_prefix" : {
"type" : "string",
"description" : "A dial code that allows establishing intercom calls between two extensions. The default value is *33"
},
"clir_hide" : {
"type" : "string",
"description" : "An end user can dial this code before dialing the phone number to hide the calling number from the called party. The default value is *67"
},
"group_pickup" : {
"type" : "string",
"description" : "An end user can dial this code to answer a call arriving to the other accounts of this customer. The default value is *40"
},
"voicemail" : {
"type" : "string",
"description" : "A dial code that allows an end user to access a voicemail. The default value is *98"
}
}
},
"DeleteRatingGroupRequest" : {
"required" : [
"i_rating_group"
],
"type" : "object",
"properties" : {
"i_rating_group" : {
"type" : "integer",
"description" : "The ID of the rating group"
}
}
},
"GetRPConnectionListResponse" : {
"type" : "object",
"properties" : {
"rp_connection_list" : {
"$ref" : "#/components/schemas/RPConnectionList"
}
}
},
"UpdateVoiceQualityProfileRequest" : {
"required" : [
"profile_info"
],
"type" : "object",
"properties" : {
"profile_info" : {
"$ref" : "#/components/schemas/VoiceQualityProfileInfo"
}
}
},
"UpdateVDTopupOptionRequest" : {
"type" : "object",
"properties" : {
"topup_option_info" : {
"$ref" : "#/components/schemas/VDTopupOptionInfo"
}
}
},
"GetRoamingProfileInfoResponse" : {
"type" : "object",
"properties" : {
"roaming_profile_info" : {
"$ref" : "#/components/schemas/RoamingProfileInfo"
}
}
},
"AccountGetServiceFeatureMetaInfoRequest" : {
"required" : [
"i_account",
"service_feature"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"with_localization" : {
"type" : "integer",
"description" : "The flag shows whether to localize options using the language selected on the web interface"
},
"service_feature" : {
"type" : "string",
"description" : "The service feature name"
}
}
},
"ArrayOfCodecConverterFileInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CodecConverterFileInfo"
}
},
"GetNodeTypeListRequest" : {
"type" : "object"
},
"AddRatingGroupResponse" : {
"type" : "object",
"properties" : {
"i_rating_group" : {
"type" : "integer",
"description" : "The ID of the rating group"
}
}
},
"EstimateCommitmentPriceForFirstBillingPeriodRequest" : {
"required" : [
"i_commitment"
],
"type" : "object",
"properties" : {
"i_billing_period" : {
"type" : "integer",
"description" : "The ID of the customer's billing period; refers to the Billing_Period table"
},
"i_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the commitment record"
},
"no_activation_charge" : {
"type" : "integer",
"description" : "The flag specifies if the activation fee should be excluded from the estimated price"
}
}
},
"AddSubscriptionRequest" : {
"type" : "object",
"properties" : {
"subscription_info" : {
"$ref" : "#/components/schemas/SubscriptionInfo"
}
}
},
"AssignUARequest" : {
"required" : [
"i_ua",
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"i_ua" : {
"type" : "integer",
"description" : "ID of UA record"
},
"port" : {
"type" : "integer",
"description" : "UA port used by this account. Note: if the type of UA is PortaPhone, the port field is not mandatory"
},
"ports_config_list" : {
"$ref" : "#/components/schemas/ArrayOfAssignMultiserviceUAPortInfo"
}
}
},
"RoutingPlanInfo" : {
"type" : "object",
"properties" : {
"profit_guarantee" : {
"type" : "string",
"description" : "Enable/Disable of choosing only routes which guarantee profit"
},
"profit_combination" : {
"type" : "string",
"description" : "Function for profit operations applying"
},
"profit_monitor" : {
"type" : "string",
"description" : "Enable/Disable sending of real-time alerts about calls with losses"
},
"route_category_list" : {
"$ref" : "#/components/schemas/ArrayOfRoutingPlanCategoryInfo"
},
"rp_connection_list" : {
"$ref" : "#/components/schemas/RPConnectionList"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "Unique ID of Destination_Group_Sets record"
},
"utilization_cost_diff_limit" : {
"type" : "number",
"description" : "Overload handicap (currency/min)"
},
"no_delete" : {
"type" : "integer",
"description" : "Shows that Routing Plan is used and can't be deleted (used in the RoutingPlanList method only)"
},
"selection_code" : {
"type" : "string",
"description" : "Routing Plan's selection code"
},
"i_tariff_profit" : {
"type" : "integer",
"description" : "The unique ID of the routing margin tariff to compare the vendor tariff with"
},
"profit_min_rel" : {
"type" : "number",
"description" : "Min required relative profit/Max allowed relative loss"
},
"name" : {
"type" : "string",
"description" : "Routing Plan's name"
},
"profit_min_abs" : {
"type" : "number",
"description" : "Min/Max allowed per-minute loss"
},
"codecs_presentation_mode" : {
"type" : "integer",
"description" : "The user-selected general policy for supporting incoming call codecs received from the vendor: 0 - forbidden, 1 - supported"
},
"description" : {
"type" : "string",
"description" : "Routing Plan's description"
},
"i_routing_plan" : {
"type" : "integer",
"description" : "The unique ID of the Routing Plan record"
},
"categories_enabled" : {
"type" : "string",
"description" : "Enable routing categories"
},
"profit_dispersion" : {
"type" : "number",
"description" : "Round-robin between routes with this cost difference (currency/min)"
},
"override_routes_enabled" : {
"type" : "string",
"description" : "Enable routing override"
}
}
},
"DeleteDIDGroupRequest" : {
"required" : [
"i_group"
],
"type" : "object",
"properties" : {
"i_group" : {
"type" : "integer",
"description" : "The unique ID of the DID group"
}
}
},
"GetServicePoolInfoResponse" : {
"type" : "object",
"properties" : {
"service_pool_info" : {
"$ref" : "#/components/schemas/ServiceInfo"
}
}
},
"GetRepresentativeXDRListRequest" : {
"required" : [
"i_rep",
"from_date",
"to_date"
],
"type" : "object",
"properties" : {
"i_rep" : {
"type" : "integer",
"description" : "The unique ID of the representative record"
},
"from_date" : {
"type" : "string",
"description" : "Get information recorded starting from this date"
},
"connect_time_before" : {
"type" : "string",
"description" : "Get xDRs with connect_time before this date"
},
"format" : {
"type" : "string",
"description" : "This parameter enables the user to get xDRs in other formats via a SOAP attachment. Currently only the \"csv\" format is supported"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved xDRs"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of customer record"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"transaction_type" : {
"type" : "string",
"description" : "One of the following: commission, ot_commission, payout, bonus"
},
"connect_time_after" : {
"type" : "string",
"description" : "Get xDRs with connect_time after this date"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"to_date" : {
"type" : "string",
"description" : "Get information recorded before this date"
}
}
},
"GetAssignedCommitmentRecordInfoRequest" : {
"required" : [
"i_account_commitment"
],
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
}
}
},
"ArrayOfSessionLogNodeInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SessionLogNodeInfo"
}
},
"GetCustomerQFListResponse" : {
"required" : [
"qf_forms"
],
"type" : "object",
"properties" : {
"qf_forms" : {
"$ref" : "#/components/schemas/ArrayOfQFInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved exchange rate data records"
}
}
},
"GetEnvListRequest" : {
"type" : "object"
},
"GetCurrencyListResponse" : {
"required" : [
"currency_list"
],
"type" : "object",
"properties" : {
"currency_list" : {
"$ref" : "#/components/schemas/CurrencyInfoList"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved currencies records"
}
}
},
"ArrayOfRearrangeAuthzRuleInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RearrangeAuthzRuleInfo"
}
},
"CloseDeleteCustomerSubscriptionRequest" : {
"required" : [
"i_customer_subscription"
],
"type" : "object",
"properties" : {
"i_customer_subscription" : {
"type" : "integer",
"description" : "The unique ID of the customer subscription record to be closed/deleted"
}
}
},
"GetRepresentativeListRequest" : {
"required" : [
"limit"
],
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Refers to the name of the representative"
},
"iso_4217" : {
"type" : "string",
"description" : "ISO4217 code of the currency"
},
"get_distributors_total" : {
"type" : "integer",
"description" : "Get the total number of the distributors that are related to every representative"
},
"email" : {
"type" : "string",
"description" : "Email address"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the representatives are in use"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved representatives"
},
"hidden" : {
"type" : "string",
"description" : "Shows whether the representative is hidden. Possible values: 'Y' - hidden; 'N' - visible"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of the reseller who manage the representative"
},
"limit" : {
"type" : "integer",
"description" : "Limit of representatives(maximum quantity of representatives). Mandatory for an API request with the offset property specified"
},
"get_customers_total" : {
"type" : "integer",
"description" : "Get the total number of the customers that are related to every representative"
},
"get_resellers_total" : {
"type" : "integer",
"description" : "Get the total number of the resellers that are related to every representative"
},
"offset" : {
"type" : "integer",
"description" : "Starting position for the representative list (number of rows to skip at the beginning of the list). Requires the limit property specified in the API request"
}
}
},
"GetMarketingGroupInfoResponse" : {
"type" : "object",
"properties" : {
"marketing_group_info" : {
"$ref" : "#/components/schemas/MarketingGroupInfo"
}
}
},
"QFFieldInfo" : {
"required" : [
"entity_number",
"i_quick_form"
],
"type" : "object",
"properties" : {
"order_number" : {
"type" : "integer",
"description" : "Defines the position of the component in the form"
},
"entity_number" : {
"type" : "integer",
"description" : "The number of the entity the fields belong to"
},
"value" : {
"type" : "string",
"description" : "The value of the field"
},
"name" : {
"type" : "string",
"description" : "The name of the field"
},
"description" : {
"type" : "string",
"description" : "Description of the field"
},
"i_quick_form_field" : {
"type" : "integer",
"description" : "The unique ID of the quick form field"
},
"i_quick_form" : {
"type" : "integer",
"description" : "The unique ID of the quick form"
},
"caption" : {
"type" : "string",
"description" : "The name for the field to be shown on the form"
},
"type" : {
"type" : "string",
"description" : "Defines the control that will be used for the field on the quick form. If type = 'Hidden' is set then the value for the 'enabled' field will be set = 'N' automatically and the control will not be visible on the form"
},
"mandatory" : {
"type" : "string",
"description" : "Defines whether the value for the field is mandatory"
},
"enabled" : {
"type" : "string",
"description" : "Defines whether the field will be shown on the quick form"
}
}
},
"GetAssignedCommitmentRecordInfoResponse" : {
"type" : "object",
"properties" : {
"account_commitment_info" : {
"$ref" : "#/components/schemas/AccountCommitmentInfo"
}
}
},
"UpdateDIDNumberListRequest" : {
"type" : "object",
"properties" : {
"frozen" : {
"type" : "string",
"description" : "Possible values: Y - mark the number list frozen; N - remove the frozen mark from the number list"
},
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the DID pricing batch the number list will be assigned to"
},
"i_dv_batch" : {
"type" : "integer",
"description" : "The unique ID of the vendor batch the number list will be assigned to"
},
"i_group" : {
"type" : "integer",
"description" : "The unique ID of the DID group the number list will be assigned to"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer the number list will be assigned to"
},
"number_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDNumberInfo"
}
}
},
"ArrayOfAccountProvisioningStatusInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountProvisioningStatusInfo"
}
},
"GetUAProfileListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved UA profiles"
},
"ua_profile_list" : {
"$ref" : "#/components/schemas/ArrayOfUAProfileInfo"
}
}
},
"DeleteRateResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"GetConnectionTypeInfoRequest" : {
"required" : [
"i_connection_type"
],
"type" : "object",
"properties" : {
"i_connection_type" : {
"type" : "integer",
"description" : "The unique ID of the connection type"
}
}
},
"CustomerCustomFieldsInfo" : {
"type" : "object",
"properties" : {
"i_custom_field" : {
"type" : "integer",
"description" : "Unique ID of the Custom Field record"
},
"value" : {
"type" : "string",
"description" : "Value of the Custom Field"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who manages the Custom Field record"
},
"name" : {
"type" : "string",
"description" : "Name of the Custom Field"
},
"properties" : {
"type" : "string",
"description" : "JSON-encoded Validation Schema for the Custom Field"
},
"default_value" : {
"type" : "string",
"description" : "Default value for the Custom Field"
},
"personal_data" : {
"type" : "string",
"description" : "Shows that the custom field contains private data and should not be shown to unauthorized users"
},
"type" : {
"type" : "string",
"description" : "Canonical name of the Custom Field's type. Currently supported: 'text', 'list', 'date', 'number', 'datetime'"
},
"mandatory" : {
"type" : "string",
"description" : "Shows that the Custom Field is mandatory. Possible values: 'Y', 'N'"
},
"visible_to_end_user" : {
"type" : "string",
"description" : "Shows that the Custom Field is visible to the End User. Possible values: 'Y', 'N'"
}
}
},
"DisableAsyncApiNotificationsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation has been successful"
}
}
},
"ArrayOfUserNotificationCategoryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UserNotificationCategoryInfo"
}
},
"UpdateCPConditionRequest" : {
"required" : [
"cp_condition_info"
],
"type" : "object",
"properties" : {
"cp_condition_info" : {
"$ref" : "#/components/schemas/CPConditionInfo"
}
}
},
"AddBundlePromotionRequest" : {
"required" : [
"bundle_promotion_info"
],
"type" : "object",
"properties" : {
"bundle_promotion_info" : {
"$ref" : "#/components/schemas/BundlePromotionInfo"
}
}
},
"AddUpdateRPCategoryRequest" : {
"required" : [
"rp_category_info"
],
"type" : "object",
"properties" : {
"rp_category_info" : {
"$ref" : "#/components/schemas/RoutingPlanCategoryInfo"
}
}
},
"GetProductRolesListResponse" : {
"required" : [
"roles_list"
],
"type" : "object",
"properties" : {
"roles_list" : {
"$ref" : "#/components/schemas/ArrayOfProductRolesInfo"
}
}
},
"GetNotificationTemplateInfoResponse" : {
"type" : "object",
"properties" : {
"notification_template_info" : {
"$ref" : "#/components/schemas/NotificationTemplateInfo"
}
}
},
"ArrayOfGroupIncludedProductInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/GroupIncludedProductInfo"
}
},
"UpdateCustomerSubscriptionRequest" : {
"required" : [
"i_customer_subscription",
"subscription_info",
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer_subscription" : {
"type" : "integer",
"description" : "ID of customer subscription record to be updated"
},
"subscription_info" : {
"$ref" : "#/components/schemas/CustomerSubscriptionInfo"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record"
}
}
},
"GetVDThresholdListRequest" : {
"required" : [
"i_vd_dg"
],
"type" : "object",
"properties" : {
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the discount for a specific destination group"
}
}
},
"GetVendorAccountListResponse" : {
"type" : "object",
"properties" : {
"vendor_account_list" : {
"$ref" : "#/components/schemas/VendorAccountList"
}
}
},
"EstimateAssignedCommitmentPenaltyListResponse" : {
"type" : "object",
"properties" : {
"commitment_recurring_term_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountCommitmentRecurringEstimateTermInfo"
},
"commitment_one_time_term_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountCommitmentOneTimeEstimateTermInfo"
}
}
},
"DeleteDialingRuleResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"AddonsValidationResults" : {
"type" : "object",
"properties" : {
"vdp_conflicts" : {
"$ref" : "#/components/schemas/ArrayOfVDPConflicts"
},
"subscription_conflicts" : {
"$ref" : "#/components/schemas/ArrayOfSubscriptionConflicts"
},
"service_features_conflicts" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeaturesConflicts"
},
"disallowed_products" : {
"$ref" : "#/components/schemas/ArrayOfDisallowedProducts"
}
}
},
"SetInvoiceStateResponse" : {
"required" : [
"i_invoice"
],
"type" : "object",
"properties" : {
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
}
}
},
"GetVendorListResponse" : {
"type" : "object",
"properties" : {
"vendor_list" : {
"$ref" : "#/components/schemas/VendorInfoList"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved vendors"
}
}
},
"GetCallBarringOptionsResponse" : {
"type" : "object",
"properties" : {
"options" : {
"$ref" : "#/components/schemas/ArrayOfCallBarringRuleInfo"
}
}
},
"ChargeCustomerSubscriptionFeesResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"AccessRoleGetMyAccessRolePermissionsResponse" : {
"type" : "object",
"properties" : {
"permissions" : {
"$ref" : "#/components/schemas/RawAccessComponentPermission"
},
"last_modified" : {
"type" : "string",
"description" : "The date and time when the access role was modified"
}
}
},
"VoiceApplicationInfo" : {
"type" : "object",
"properties" : {
"app_name" : {
"type" : "string",
"description" : "The name of the IVR application"
},
"i_voice_application" : {
"type" : "integer",
"description" : "The unique ID of the voice application"
},
"description" : {
"type" : "string",
"description" : "The description of the voice application"
},
"code" : {
"type" : "string",
"description" : "The code of the voice application"
}
}
},
"PriceListInfo" : {
"required" : [
"product",
"price"
],
"type" : "object",
"properties" : {
"price" : {
"type" : "string",
"description" : "The total charge applied to the account for this remittance transaction"
},
"product" : {
"type" : "string",
"description" : "The amount to be added to the balance of the mobile recipient for this remittance transaction"
}
}
},
"LogoutRequest" : {
"type" : "object",
"properties" : {
"session_id" : {
"type" : "string",
"description" : "The ID of a previously opened session"
}
}
},
"CancelDIDAssignmentResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 – success, 0 – failed"
}
}
},
"VDThresholdInfo" : {
"type" : "object",
"properties" : {
"alter_service" : {
"type" : "string",
"description" : "Alter service value"
},
"i_vd_threshold" : {
"type" : "integer",
"description" : "The unique ID of the volume discount threshold record"
},
"notify_if_exceeded" : {
"type" : "string",
"description" : "The flag indicates if a notification is sent when the threshold is exceeded. Possible values: 'Y', 'N'. The default value is 'N'"
},
"warning_threshold" : {
"type" : "number",
"description" : "Warning notification threshold value"
},
"threshold_value" : {
"type" : "number",
"description" : "Threshold value"
},
"xdr_split" : {
"type" : "string",
"description" : "The flag shows if the threshold record is marked as splitting (Splitting XDRs). Possible values: 'Y', 'N'. The default value is 'N'"
},
"discount" : {
"type" : "number",
"description" : "Discount value in percent (%)"
},
"i_vd_dg" : {
"type" : "integer",
"description" : "ID of the volume discount record (volume discount destination group record)"
}
}
},
"ProvisionDIDRequest" : {
"type" : "object",
"properties" : {
"req_params" : {
"$ref" : "#/components/schemas/DIDRequestParameters"
},
"did_provider_info" : {
"$ref" : "#/components/schemas/CustomerDIDProviderIdent"
}
}
},
"GetRoamingCountryListResponse" : {
"required" : [
"roaming_country_list"
],
"type" : "object",
"properties" : {
"roaming_country_list" : {
"$ref" : "#/components/schemas/ArrayOfRoamingCountryInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of roaming countries found"
}
}
},
"AccountCommitmentOneTimeEstimateTermInfo" : {
"type" : "object",
"properties" : {
"fee" : {
"type" : "number",
"description" : "The estimated fee including discounts"
},
"i_one_time_term" : {
"type" : "integer",
"description" : "The unique identifier of the one-time term"
}
}
},
"CustomerMigrationInfo" : {
"required" : [
"status_name",
"migrate_on"
],
"type" : "object",
"properties" : {
"status_name" : {
"type" : "string",
"description" : "A human-readable name of the migration status"
},
"migrate_on" : {
"type" : "string",
"description" : "The date when the customer will be migrated"
}
}
},
"GetOverrideTariffResponse" : {
"type" : "object",
"properties" : {
"override_tariff" : {
"$ref" : "#/components/schemas/OverrideTariffInfo"
}
}
},
"DeleteCustomTaxOptionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Shows whether custom tax option was removed or not. Posible values: 1 - The tax was removed; 0 - The tax was not removed"
}
}
},
"CustomerGetCustomerServiceFeaturesMetaInfoRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"callshop" : {
"type" : "integer",
"description" : "The flag that shows whether to fetch meta info for callshops"
},
"with_localization" : {
"type" : "integer",
"description" : "The flag shows whether to localize options using the language selected on the web interface"
},
"array_mode" : {
"type" : "integer",
"description" : "The flag that shows whether to pack the response into service_features or return raw subtypes"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"GetDestGroupListRequest" : {
"required" : [
"i_dest_group_set"
],
"type" : "object",
"properties" : {
"complete_match" : {
"type" : "string",
"description" : "This flag specifies whether the complete DG set should be considered. The possible values are: Y, N, ALL. Default: N"
},
"name" : {
"type" : "string",
"description" : "Search pattern in the names of destination groups"
},
"description" : {
"type" : "string",
"description" : "Destination pattern to search destination groups"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set record"
},
"exclude_default" : {
"type" : "string",
"description" : "Indicates whether a default group will be returned for the complete DG set. The default value is 1"
},
"get_total" : {
"type" : "integer",
"description" : "Get total number of the retrieved destination groups"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"prefix" : {
"type" : "string",
"description" : "Prefix by which to search destination groups. Note that if you provide both name and prefix properties, then search will be done only by name"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetDestinationInfoResponse" : {
"required" : [
"error_description",
"error_code"
],
"type" : "object",
"properties" : {
"country" : {
"type" : "string",
"description" : "The country of the payment receiver"
},
"destination" : {
"type" : "string",
"description" : "The destination number"
},
"operator_id" : {
"type" : "integer",
"description" : "The unique ID of the destination mobile network"
},
"error_description" : {
"type" : "string",
"description" : "A brief error description"
},
"input_currency" : {
"type" : "string",
"description" : "The account's currency"
},
"error_code" : {
"type" : "integer",
"description" : "Error codes (see their description above)"
},
"operator" : {
"type" : "string",
"description" : "The mobile operator of the payment receiver"
},
"output_currency" : {
"type" : "string",
"description" : "The currency in the destination country"
},
"price_list" : {
"$ref" : "#/components/schemas/ArrayOfPriceListInfo"
}
}
},
"UpdateDestinationPrefixRequest" : {
"required" : [
"destination_info"
],
"type" : "object",
"properties" : {
"destination_info" : {
"$ref" : "#/components/schemas/DestinationPrefixInfo"
}
}
},
"GenerateMidtermInvoiceRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"invoice_due" : {
"type" : "string",
"description" : "Invoice due date; if specified, this due date will be used instead of the system default value"
},
"period_to" : {
"type" : "string",
"description" : "The end date of the invoice period. If specified, all transactions that occurred before this date in the current billing period will be included into the invoice"
},
"i_customer" : {
"type" : "integer",
"description" : "Refers to the record of a customer for which a midterm invoice will be generated"
}
}
},
"ServiceFeatureAttributeDetails" : {
"type" : "object",
"properties" : {
"multivalue" : {
"type" : "string",
"description" : "Indicates whether multiple value entries are allowed"
},
"i_sattribute" : {
"type" : "integer",
"description" : "The unique ID of the service feature attribute"
},
"default_value" : {
"type" : "string",
"description" : "Service feature attribute default value"
},
"name" : {
"type" : "string",
"description" : "Service feature attribute name"
}
}
},
"UploadDatesBatchResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success"
}
}
},
"GetCQInfoResponse" : {
"type" : "object",
"properties" : {
"callqueue_info" : {
"$ref" : "#/components/schemas/CQInfo"
}
}
},
"AddUpdateNotificationPresetRequest" : {
"required" : [
"notification_preset_info"
],
"type" : "object",
"properties" : {
"notification_preset_info" : {
"$ref" : "#/components/schemas/NotificationPresetInfo"
}
}
},
"UpdateRatingGroupRequest" : {
"required" : [
"rating_group_info"
],
"type" : "object",
"properties" : {
"rating_group_info" : {
"$ref" : "#/components/schemas/RatingGroupInfo"
}
}
},
"ArrayOfRawAccessComponentPermission" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RawAccessComponentPermission"
}
},
"UpdateAccountPaymentMethodRequest" : {
"required" : [
"i_account",
"payment_method_info"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"payment_method_info" : {
"$ref" : "#/components/schemas/AccountPaymentMethodInfo"
}
}
},
"GetAccountUAInfoResponse" : {
"type" : "object",
"properties" : {
"ua_info" : {
"$ref" : "#/components/schemas/UAInfo"
}
}
},
"ArrayOfAccountCommitmentRecurringTermInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountCommitmentRecurringTermInfo"
}
},
"ArrayOfAccountControlNumberInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountControlNumberInfo"
}
},
"DeleteCustomerExtensionRequest" : {
"required" : [
"i_c_ext",
"i_customer"
],
"type" : "object",
"properties" : {
"i_c_ext" : {
"type" : "integer",
"description" : "The unique ID of the created extension"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
}
}
},
"GetOwnerBatchListRequest" : {
"type" : "object",
"properties" : {
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the pricing batch"
},
"get_did_total" : {
"type" : "integer",
"description" : "Get the total number of DID numbers for each DID owner batch in the response"
},
"name" : {
"type" : "string",
"description" : "The pricing batch name"
},
"iso_4217" : {
"type" : "string",
"description" : "The currency of a pricing batch"
},
"order_by" : {
"type" : "string",
"description" : "Allows to sort the resulting list by a specific field"
},
"with_markup" : {
"type" : "integer",
"description" : "If with_markup == 1, return markup information"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the owner batches are in use"
},
"get_did_total_usage" : {
"type" : "integer",
"description" : "Get the usage of DID numbers for each DID owner batch in the response"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the records in the DB"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"type" : {
"type" : "string",
"description" : "The type of the DID pricing batch"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller who owns the owner batch"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"empty_markup_options" : {
"type" : "string",
"description" : "Filter DID owner batches by the empty markup options. Possible values: 'Y' - return batches with empty markup_options; 'N' - return batches with specified markup_options"
}
}
},
"RPConnectionList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RPConnectionInfo"
}
},
"TransferAssignedCommitmentRecordResponse" : {
"required" : [
"i_account_commitment"
],
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The transferred commitment record identifier"
}
}
},
"ZendeskTicketInfo" : {
"type" : "object",
"properties" : {
"priority" : {
"type" : "string",
"description" : "The Zendesk ticket priority. Possible values: 'urgent', 'high', 'normal', 'low'"
},
"recipient" : {
"type" : "string",
"description" : "The original recipient e-mail address of the Zendesk ticket"
},
"subject" : {
"type" : "string",
"description" : "The Zendesk ticket subject"
},
"status" : {
"type" : "string",
"description" : "The Zendesk ticket status. Possible values: 'new', 'open', 'pending', 'hold', 'solved', 'closed'"
},
"created_at" : {
"type" : "string",
"description" : "The date and time when the Zendesk ticket was created"
},
"updated_at" : {
"type" : "string",
"description" : "The date and time when the Zendesk ticket last got updated"
},
"zendesk_ticket_id" : {
"type" : "integer",
"description" : "The Zendesk ticket unique ID number"
},
"i_customer" : {
"type" : "integer",
"description" : "An existing Zendesk organization for the Customer with this ID. Note: this parameter will be used as an external_id for organization on the Zendesk side"
},
"type" : {
"type" : "string",
"description" : "The Zendesk ticket type. Possible values: 'problem', 'incident', 'question' or 'task'"
}
}
},
"AccountGetSelfcareConfigDataResponse" : {
"required" : [
"config_data"
],
"type" : "object",
"properties" : {
"config_data" : {
"$ref" : "#/components/schemas/ANY"
}
}
},
"DeleteAuthzRuleRequest" : {
"required" : [
"i_authz_rule"
],
"type" : "object",
"properties" : {
"i_authz_rule" : {
"type" : "integer",
"description" : "The unique ID of the authentication rule record to delete"
}
}
},
"CustomerVdCounterHistoryInfo" : {
"required" : [
"counter_delta",
"modification_date",
"unit_counter_delta",
"i_cvd_counter"
],
"type" : "object",
"properties" : {
"counter_delta" : {
"type" : "number",
"description" : "The amount of money that was applied to the counter"
},
"unit_counter" : {
"type" : "integer",
"description" : "The unit number of the counter after the delta was applied"
},
"i_xdr" : {
"type" : "integer",
"description" : "The ID of the XDR record from the CDR_Accounts table (in the case of a reseller, it refers to the CDR_Customer table)"
},
"discount" : {
"type" : "number",
"description" : "The calculated discount applied to XDR"
},
"modification_date" : {
"type" : "string",
"description" : "The timestamp when the counter was updated"
},
"unit_counter_delta" : {
"type" : "integer",
"description" : "The number of units that was applied to the counter"
},
"i_history" : {
"type" : "integer",
"description" : "The unique ID of the record"
},
"counter" : {
"type" : "number",
"description" : "The money amount of the counter after the delta was applied"
},
"i_cvd_counter" : {
"type" : "integer",
"description" : "The ID of the counter record from the Customer_VD_Counters table"
}
}
},
"DeleteRepresentativeResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"GetSipStatusRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
}
}
},
"DeleteRoutingCriteriaDestGroupResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success"
}
}
},
"GetAccessNumberListResponse" : {
"required" : [
"access_number_list"
],
"type" : "object",
"properties" : {
"access_number_list" : {
"$ref" : "#/components/schemas/ArrayOfAccessNumberInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of records"
}
}
},
"AddUpdateProductGroupRequest" : {
"required" : [
"group_info"
],
"type" : "object",
"properties" : {
"detailed_response" : {
"type" : "integer",
"description" : "Indicates whether to show the added record in the response"
},
"group_info" : {
"$ref" : "#/components/schemas/ProductGroupInfo"
}
}
},
"UpdateCustomerCallBarringOptionsRequest" : {
"required" : [
"options",
"i_customer"
],
"type" : "object",
"properties" : {
"options" : {
"$ref" : "#/components/schemas/ArrayOfCallBarringRuleInfo"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
}
}
},
"GetCommissionPlanInfoRequest" : {
"required" : [
"i_commission_plan"
],
"type" : "object",
"properties" : {
"i_commission_plan" : {
"type" : "integer",
"description" : "The unique ID of the commission plan"
}
}
},
"GetMOHListInfoRequest" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the Customer Record"
}
}
},
"ArrayOfUserNotificationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/UserNotificationInfo"
}
},
"GetCPConditionInfoRequest" : {
"required" : [
"i_cp_condition"
],
"type" : "object",
"properties" : {
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the call screening condition record"
}
}
},
"CallBarringRuleInfo" : {
"required" : [
"i_cp_condition",
"state"
],
"type" : "object",
"properties" : {
"rule_description" : {
"type" : "string",
"description" : "User-friendly description of this rule"
},
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of call barring rule"
},
"name" : {
"type" : "string",
"description" : "Call barring rule name"
},
"state" : {
"type" : "string",
"description" : "'Y' if enabled, 'N' if disabled"
}
}
},
"DeleteUAProfileResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"GetCustomerStatusHistoryResponse" : {
"required" : [
"status_history_changes"
],
"type" : "object",
"properties" : {
"status_history_changes" : {
"$ref" : "#/components/schemas/StatusHistoryInfoList"
}
}
},
"ReserveDIDNumberRequest" : {
"type" : "object",
"properties" : {
"reserve_term" : {
"type" : "integer",
"description" : "Number of seconds to check for reserved status and avoid reservation of still reserved numbers"
},
"number" : {
"type" : "string",
"description" : "DID Number to reserve"
}
}
},
"GetVDThresholdInfoResponse" : {
"required" : [
"vd_threshold"
],
"type" : "object",
"properties" : {
"vd_threshold" : {
"$ref" : "#/components/schemas/VDThresholdInfo"
}
}
},
"UpdateCustomerSiteRequest" : {
"required" : [
"site_info"
],
"type" : "object",
"properties" : {
"site_info" : {
"$ref" : "#/components/schemas/CustomerSiteInfo"
}
}
},
"DeleteSubscriptionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful"
}
}
},
"GetAccountVdNotificationListResponse" : {
"type" : "object",
"properties" : {
"vd_notification_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountVdNotificationInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"UpdateEnvNotificationTemplateResponse" : {
"required" : [
"is_updated"
],
"type" : "object",
"properties" : {
"is_updated" : {
"type" : "integer",
"description" : "Specifies whether the notification template was updated. Possible values: 1 – The notification template was updated, 0 – The notification template was not updated"
},
"authorship" : {
"type" : "string",
"description" : "Specifies whether the template has been modified. Possible values: System - The template has not been modified; Custom - The template has been modified"
}
}
},
"UpdateAccountServiceFeaturesResponse" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
}
}
},
"GetUserNotificationCategoryListResponse" : {
"type" : "object",
"properties" : {
"notification_category_list" : {
"$ref" : "#/components/schemas/ArrayOfUserNotificationCategoryInfo"
}
}
},
"ArrayOfNetworkConnectivityInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/NetworkConnectivityInfo"
}
},
"GetCustomerRTRequestorListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The pattern to search requestors by in the 'name' field"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"AccessComponentPermission" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"objects" : {
"$ref" : "#/components/schemas/ArrayOfAccessObjectPermission"
},
"name" : {
"type" : "string",
"description" : "The name of the access component"
},
"permission" : {
"type" : "integer",
"description" : "The permission for the access component"
},
"components" : {
"$ref" : "#/components/schemas/ArrayOfAccessComponentPermission"
}
}
},
"GetProductPrioritiesListRequest" : {
"type" : "object"
},
"GetCustomerBatchInfoResponse" : {
"type" : "object",
"properties" : {
"batch_info" : {
"$ref" : "#/components/schemas/CustomerBatchInfo"
}
}
},
"UpdateVendorDIDProviderAccountResponse" : {
"required" : [
"i_did_provider_acc"
],
"type" : "object",
"properties" : {
"i_did_provider_acc" : {
"type" : "integer",
"description" : "The unique ID of the DID provider account"
}
}
},
"UpdateSubscriptionRequest" : {
"required" : [
"subscription_info"
],
"type" : "object",
"properties" : {
"subscription_info" : {
"$ref" : "#/components/schemas/SubscriptionInfo"
}
}
},
"UpdateDestGroupResponse" : {
"required" : [
"i_dest_group"
],
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
}
}
},
"AddRoamingProfileRequest" : {
"required" : [
"roaming_profile_info"
],
"type" : "object",
"properties" : {
"roaming_profile_info" : {
"$ref" : "#/components/schemas/RoamingProfileInfo"
}
}
},
"EnableAsyncApiNotificationsRequest" : {
"type" : "object"
},
"ArrayOfBatchDeleteCRStatusInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/BatchDeleteCRStatusInfo"
}
},
"ValidateAddonsCombinationResponse" : {
"type" : "object",
"properties" : {
"addons_combination_validation_result" : {
"$ref" : "#/components/schemas/AddonsValidationResults"
}
}
},
"CustomerEstimateTaxesResponse" : {
"type" : "object",
"properties" : {
"warnings" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"taxes_list" : {
"$ref" : "#/components/schemas/ArrayOfEstimatedTaxes"
}
}
},
"GetCommissionPlanBaseListRequest" : {
"type" : "object"
},
"CloneIvrApplicationResponse" : {
"type" : "object",
"properties" : {
"ivr_application_info" : {
"$ref" : "#/components/schemas/IvrApplicationInfo"
},
"access_numbers" : {
"$ref" : "#/components/schemas/ArrayOfAccessNumberInfo"
}
}
},
"AddUpdateNotificationPresetResponse" : {
"required" : [
"i_notification_preset"
],
"type" : "object",
"properties" : {
"i_notification_preset" : {
"type" : "integer",
"description" : "The unique identifier of the notification preset"
}
}
},
"AccountGetSelfcareConfigDataRequest" : {
"type" : "object"
},
"GetCustomerTransactionsTotalInfoRequest" : {
"required" : [
"billing_model",
"from_date",
"i_customer",
"to_date"
],
"type" : "object",
"properties" : {
"show_unsuccessful" : {
"type" : "integer",
"description" : "Show the records of unsuccessful attempts. The field applies only to the admin realm"
},
"cli" : {
"type" : "string",
"description" : "The calling party phone number"
},
"billing_model" : {
"type" : "integer",
"description" : "Specifies the account type for which to show transactions; one of the following: -1 – Debit account; 1 – Credit account"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of a service for which to show transactions; refers to the Services table"
},
"from_date" : {
"type" : "string",
"description" : "Get information recorded starting from this date"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"cld" : {
"type" : "string",
"description" : "The called party phone number"
},
"to_date" : {
"type" : "string",
"description" : "Get information recorded before this date"
}
}
},
"GetCustomFieldsSchemaRequest" : {
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The entity the custom fileds belong to. Possible values: customer, account"
},
"managed_by" : {
"type" : "integer",
"description" : "Specifies the unique ID of the reseller who manages the custom field record. If undefined, only custom fields managed by administrator will be returned"
},
"visible_to_end_user" : {
"type" : "string",
"description" : "Specifies whether the custom fields are visible to an end user. Possible values: Y, N"
}
}
},
"GetVDThresholdListResponse" : {
"type" : "object",
"properties" : {
"threshold_list" : {
"$ref" : "#/components/schemas/ArrayOfVDThresholdInfo"
}
}
},
"GetRatingGroupInfoRequest" : {
"type" : "object",
"properties" : {
"i_rating_group" : {
"type" : "integer",
"description" : "The ID of the rating group"
},
"name" : {
"type" : "string",
"description" : "The name of the rating group"
},
"id" : {
"type" : "integer",
"description" : "The rating group code used for communication with the CoSS server"
}
}
},
"UpdateTimePeriodResponse" : {
"required" : [
"i_offpeak"
],
"type" : "object",
"properties" : {
"i_offpeak" : {
"type" : "integer",
"description" : "The unique ID of the time period"
}
}
},
"GetAssignedCommitmentTermsRequest" : {
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
}
}
},
"UpdateCustomerCallBarringOptionsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "One of the following: 1 – success, 0 – failed"
}
}
},
"GetNodeInfoResponse" : {
"type" : "object",
"properties" : {
"node_info" : {
"$ref" : "#/components/schemas/NodeInfo"
}
}
},
"ArrayOfActiveSessionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ActiveSessionInfo"
}
},
"UpdateMarketingGroupResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "One of the following: 1 – success, 0 – failed"
}
}
},
"UpdateEmergencyUnitRequest" : {
"required" : [
"emergency_unit_info"
],
"type" : "object",
"properties" : {
"emergency_unit_info" : {
"$ref" : "#/components/schemas/EmergencyUnitInfo"
}
}
},
"GetDialingRulesListResponse" : {
"required" : [
"dialing_rules_list"
],
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The number of the retrieved dialing rules"
},
"dialing_rules_list" : {
"$ref" : "#/components/schemas/ArrayOfDialingRuleInfo"
}
}
},
"CodecInfo" : {
"required" : [
"mime_subtype",
"mime_type"
],
"type" : "object",
"properties" : {
"mime_subtype" : {
"type" : "string",
"description" : "The subtype of the codec"
},
"mime_type" : {
"type" : "string",
"description" : "The type of the codec"
}
}
},
"GetVendorTransactionsTotalInfoResponse" : {
"type" : "object",
"properties" : {
"count" : {
"type" : "integer",
"description" : "The total number of transactions"
},
"iso_4217" : {
"type" : "string",
"description" : "Transactions currency"
},
"sessions_count" : {
"type" : "integer",
"description" : "The total number of sessions"
},
"total_amount" : {
"type" : "number",
"description" : "Total transactions amount"
},
"per_service_info" : {
"$ref" : "#/components/schemas/ArrayOfVendorPerServiceInfo"
},
"total_info" : {
"$ref" : "#/components/schemas/ArrayOfTotalTransInfo"
}
}
},
"GetTemplateMediaAttributeListRequest" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"only_visible" : {
"type" : "integer",
"description" : "If set, attributes not shown on the Web Interface will be excluded from response"
}
}
},
"PaymentMethodInfo" : {
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "ISO 3166 two-letter country code"
},
"number" : {
"type" : "string",
"description" : "Credit card number without spaces, e.g. 4444333322221111"
},
"account_number" : {
"type" : "string",
"description" : "Bank account number. Applicable to the Check and DirectDebitNL methods"
},
"processing_type" : {
"type" : "string",
"description" : "Processing type of the payment method"
},
"refnum" : {
"type" : "string",
"description" : "Reference number (custom field)"
},
"city" : {
"type" : "string",
"description" : "Name of the city of the cardholder"
},
"i_country_subdivision" : {
"type" : "integer",
"description" : "ID for cardholder's state; refers to Country_Subdivision table"
},
"i_payment_method" : {
"type" : "integer",
"description" : "Unique ID of the payment method"
},
"address" : {
"type" : "string",
"description" : "Address of the cardholder"
},
"start_date" : {
"type" : "string",
"description" : "Card activation date. Applicable to the Switch method"
},
"token" : {
"type" : "string",
"description" : "A reference to the payment information (which is stored by the Payment Processor only)"
},
"bank_number" : {
"type" : "string",
"description" : "Bank routing number. Applicable to the Check method"
},
"available_for_refund" : {
"type" : "number",
"description" : "The amount available for refund"
},
"exp_date" : {
"type" : "string",
"description" : "Card expiration date. Applicable to all credit card methods"
},
"issue_no" : {
"type" : "string",
"description" : "Card issue number. Applicable to the Switch method"
},
"name" : {
"type" : "string",
"description" : "Name of the cardholder (owner of a bank account, etc.)"
},
"phone_number" : {
"type" : "string",
"description" : "Phone number in E.164 format for validating the Credit Card"
},
"number_hash" : {
"type" : "string",
"description" : "A crypted hexadecimal code of the credit card number"
},
"payment_method" : {
"type" : "string",
"description" : "Name of the payment method, one of the following: Cash, Cheque, American Express, Discover, MasterCard, VISA, Maestro, Check, DirectDebitNL. Pass undefined value in order to dismiss payment method"
},
"zip" : {
"type" : "string",
"description" : "Postal code of the cardholder. Possible length: 2–10 symbols. You can use letters, digits and symbols ' ' (space) and '-' (dash)"
},
"csc_required" : {
"type" : "integer",
"description" : "Shows whether card security code is required or not"
},
"cvv" : {
"type" : "string",
"description" : "Card security code (CVV, CVS, etc.). Applicable to all credit card methods"
}
}
},
"ArrayOfCommitmentSaleDiscountInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CommitmentSaleDiscountInfo"
}
},
"DeleteAllowedLocationRequest" : {
"required" : [
"i_a_verified_locations"
],
"type" : "object",
"properties" : {
"i_a_verified_locations" : {
"type" : "integer",
"description" : "The ID of the account's allowed location record"
}
}
},
"AddUAResponse" : {
"required" : [
"i_ua"
],
"type" : "object",
"properties" : {
"i_ua" : {
"type" : "integer",
"description" : "ID of UA record"
}
}
},
"GetAccountTransactionsTotalInfoRequest" : {
"required" : [
"from_date",
"i_account",
"to_date"
],
"type" : "object",
"properties" : {
"show_unsuccessful" : {
"type" : "integer",
"description" : "Show the records of unsuccessful attempts. The field applies only to the admin realm"
},
"cli" : {
"type" : "string",
"description" : "The calling party phone number"
},
"billing_model" : {
"type" : "integer",
"description" : "Specifies the account type for which to show transactions; one of the following: -1 – Debit account; 1 – Credit account"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the Service record; refers to the Services table"
},
"from_date" : {
"type" : "string",
"description" : "Get transactions made after this date"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"cld" : {
"type" : "string",
"description" : "The called party phone number"
},
"to_date" : {
"type" : "string",
"description" : "Get transactions made before this date"
}
}
},
"GetAllowedLocationListRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"period_from" : {
"type" : "string",
"description" : "The start date and time for the allowed location"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved allowed locations"
},
"period_to" : {
"type" : "string",
"description" : "The end date and time for the allowed location"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"verified_by" : {
"type" : "string",
"description" : "The mark the shows whether the record was set by screening or by admin from web. Possible values: A, S"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"DestGroupSetInfo" : {
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set record"
},
"complete_match" : {
"type" : "string",
"description" : "Y/N marks the destination group set with ability to match all existent destinations"
},
"default_i_dest_group" : {
"type" : "integer",
"description" : "The id of the group within the set (with complete_match \"Y\" only) which acts as a failover when no match is found"
},
"name" : {
"type" : "string",
"description" : "The destination group set name"
},
"used" : {
"type" : "integer",
"description" : "Shows whether the destination group set is used"
},
"is_set_empty" : {
"type" : "integer",
"description" : "Shows whether the destination group set has at least one destination group assigned"
}
}
},
"CloseDeleteAccountSubscriptionRequest" : {
"required" : [
"i_account_subscription"
],
"type" : "object",
"properties" : {
"i_account_subscription" : {
"type" : "integer",
"description" : "The unique ID of the account's subscription record to be closed / deleted"
}
}
},
"RoamingCountries" : {
"type" : "object",
"properties" : {
"no_restriction" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"suspicious" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"high_risk" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"DeleteAccountSubscriptionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"GetCountriesListResponse" : {
"type" : "object",
"properties" : {
"countries_list" : {
"$ref" : "#/components/schemas/ArrayOfCountryInfo"
}
}
},
"UpdateAccountRequest" : {
"required" : [
"account_info"
],
"type" : "object",
"properties" : {
"account_info" : {
"$ref" : "#/components/schemas/AccountInfo"
},
"release_assigned_did" : {
"type" : "integer",
"description" : "The flag specifies whether the previously assigned DID number should be released to the pool (true by default)"
}
}
},
"AddCPRuleRequest" : {
"required" : [
"cp_rule_info"
],
"type" : "object",
"properties" : {
"cp_rule_info" : {
"$ref" : "#/components/schemas/CPRuleInfo"
}
}
},
"ProductUpdateProductDetailedRequest" : {
"required" : [
"product_info"
],
"type" : "object",
"properties" : {
"product_info" : {
"$ref" : "#/components/schemas/RawProductInfo"
}
}
},
"AddDiscountRequest" : {
"required" : [
"discount_info"
],
"type" : "object",
"properties" : {
"discount_info" : {
"$ref" : "#/components/schemas/DiscountInfo"
}
}
},
"AddCodecConverterFileRequest" : {
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The object type. Possible values: 'account', 'customer'"
},
"codec_list" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"audio_profile" : {
"type" : "string",
"description" : "The audio profile"
},
"file_name" : {
"type" : "string",
"description" : "The file name"
},
"handler" : {
"type" : "string",
"description" : "The handler name"
},
"callback" : {
"type" : "string",
"description" : "The callback name"
},
"storage_info" : {
"type" : "integer",
"description" : "The flag that shows whether to include storage information into the response"
},
"callback_params" : {
"type" : "string",
"description" : "The callback params"
},
"i_object" : {
"type" : "integer",
"description" : "The unique identifier of the object"
}
}
},
"DeleteDIDNumberResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 – success, 0 – failed"
}
}
},
"TaxationOptionsCustom" : {
"required" : [
"i_option",
"tax_percent",
"name",
"is_apply"
],
"type" : "object",
"properties" : {
"i_option" : {
"type" : "integer",
"description" : "The unique ID of the custom tax option"
},
"tax_percent" : {
"type" : "string",
"description" : "A percentage value for the custom tax option"
},
"name" : {
"type" : "string",
"description" : "The name of the custom tax option"
},
"applied_to" : {
"type" : "string",
"description" : "This field shows which services this tax is applied to"
},
"is_apply" : {
"type" : "string",
"description" : "Indicates whether the custom tax option has been applied(flag - Y/N)"
}
}
},
"UnbindAddonProductRequest" : {
"required" : [
"i_product",
"i_addon_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the main product"
},
"i_addon_product" : {
"type" : "integer",
"description" : "The unique ID of the add-on product"
}
}
},
"GetCPConditionListResponse" : {
"type" : "object",
"properties" : {
"cp_condition_list" : {
"$ref" : "#/components/schemas/ArrayOfCPConditionInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved call processing rule records"
}
}
},
"AuthzRuleInfo" : {
"type" : "object",
"properties" : {
"cld_pattern" : {
"type" : "string",
"description" : "CLD (DNIS) pattern to check during authorization"
},
"i_authz_rule" : {
"type" : "integer",
"description" : "The unique ID of the authentication rule record"
},
"i_service_policy" : {
"type" : "integer",
"description" : "The unique ID of the Service Policies record"
},
"order_number" : {
"type" : "integer",
"description" : "Authorization rule sequence number"
},
"node_name" : {
"type" : "string",
"description" : "The name of the node for which the rule is auto-generated. Filled in case if the 'auto_link_type' is 'Nodes' and when 'with_extended_info' in the method info is equal to 1"
},
"cli_pattern" : {
"type" : "string",
"description" : "CLI (ANI) pattern to check during authorization"
},
"connection_description" : {
"type" : "string",
"description" : "The description of the connection for which the rule is auto-generated. Filled in case if the 'auto_link_type' is 'Connections' and when 'with_extended_info' in the method info is equal to 1"
},
"auto_link_type" : {
"type" : "string",
"description" : "Entity for which the rule has been auto-generated"
},
"ip_pattern" : {
"type" : "string",
"description" : "IP or Network/Mask of the trusted source"
},
"account_id" : {
"type" : "string",
"description" : "The ID of the account for which the rule is auto-generated. Filled in case if the 'auto_link_type' is 'Accounts' and when 'with_extended_info' in the method info is equal to 1"
},
"i_authz_type" : {
"type" : "integer",
"description" : "The unique ID of the authentication method type record"
},
"translation_rule" : {
"type" : "string",
"description" : "Translation rule for the chosen user-name"
},
"auto_link_id" : {
"type" : "integer",
"description" : "The unique ID of the entity for which the rule has been auto-generated"
}
}
},
"GetCQListInfoRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"get_main_office_callqueues" : {
"type" : "integer",
"description" : "Specifies whether the main office's call queues should be shown instead of call queues of the specified customer"
},
"detailed_info" : {
"type" : "integer",
"description" : "Specifies whether detailed information will be returned in the response or not"
},
"i_c_group" : {
"type" : "integer",
"description" : "Enables retrieving the huntgroup list by huntgroup ID"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetDefaultCustomerClassRequest" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "ID of the reseller who manages the customer class (undefined in case of Managed By Administrator Only)"
}
}
},
"AccessPolicyPhaseInfo" : {
"type" : "object",
"properties" : {
"definition_list" : {
"$ref" : "#/components/schemas/ArrayOfTimePeriodDefinitionInfo"
},
"tx_rate" : {
"type" : "integer",
"description" : "The upload speed rate of the access policy phase"
},
"tx_rate_unit" : {
"type" : "string",
"description" : "The upload measure unit of the access policy phase"
},
"i_offpeak" : {
"type" : "integer",
"description" : "The unique ID of the time period DB record related to the access policy phase"
},
"i_access_policy_phase" : {
"type" : "integer",
"description" : "The unique ID of the access policy phase DB record"
},
"type" : {
"type" : "string",
"description" : "The type of the access policy phase. Possible values: offpeak, regular and limited"
},
"rx_rate_unit" : {
"type" : "string",
"description" : "The download measure unit of the access policy phase"
},
"rx_rate" : {
"type" : "integer",
"description" : "The download speed rate of the access policy phase"
}
}
},
"GetAclListRequest" : {
"type" : "object",
"properties" : {
"group" : {
"type" : "string",
"description" : "The name of ACL group to search"
},
"name" : {
"type" : "string",
"description" : "Search ACL by name"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"type" : {
"type" : "string",
"description" : "Type of ACL to search. Possible values: Component, User, Customer, CC Staff, Account, Vendor, Representative, Reseller, Distributor"
},
"subsystem" : {
"type" : "string",
"description" : "The name of subsystem ACL belongs to"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"with_i_acl" : {
"type" : "integer",
"description" : "If the entity has customized default ACL (instead of the predefined one), specify the unique ID of this customized default ACL here. Then it will be included to the list"
}
}
},
"UsedLocationInfo" : {
"type" : "object",
"properties" : {
"country_name" : {
"type" : "string",
"description" : "Country name"
},
"restriction_level" : {
"type" : "string",
"description" : "The restriction level which belongs to the location (0-no restriction, 5 - cautious, 10 - high risk)"
},
"verified_until" : {
"type" : "string",
"description" : "The timestamp for the validity of the location after it was verified by screening or administrator"
},
"subscriber_ip" : {
"type" : "string",
"description" : "Subscriber IP address"
},
"usage_counter" : {
"type" : "integer",
"description" : "Accumulated event counter"
},
"last_used" : {
"type" : "string",
"description" : "The timestamp of the last usage event"
}
}
},
"ArrayOfTemplateComponentInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TemplateComponentInfo"
}
},
"GetCustomerTaxationInfoRequest" : {
"required" : [
"i_billing_processor",
"i_customer"
],
"type" : "object",
"properties" : {
"i_billing_processor" : {
"type" : "integer",
"description" : "Taxation processor to get the info for, instead of the one assigned to the customer"
},
"effective_values" : {
"type" : "integer",
"description" : "Get taxation info, including the values that were inherited from the customer class"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record"
}
}
},
"GetNotificationListRequest" : {
"required" : [
"i_notification_preset"
],
"type" : "object",
"properties" : {
"i_notification_preset" : {
"type" : "integer",
"description" : "The unique identifier of the notification preset"
}
}
},
"GetAccountListResponse" : {
"type" : "object",
"properties" : {
"account_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved accounts"
}
}
},
"UploadExternalInvoiceFileRequest" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
}
}
},
"WebLogInfo" : {
"required" : [
"entity_type"
],
"type" : "object",
"properties" : {
"i_log" : {
"type" : "integer",
"description" : "The unique ID of the web log record"
},
"i_entity" : {
"type" : "string",
"description" : "The unique ID of the entity to which the changes were applied"
},
"ip" : {
"type" : "string",
"description" : "The IP address of the user"
},
"i_parent" : {
"type" : "string",
"description" : "The unique ID of the parent entity"
},
"action_type" : {
"type" : "string",
"description" : "The type of the action (e.g. insert, update, delete) that was applied to the entity"
},
"parent_type" : {
"type" : "string",
"description" : "The type of the parent entity (e.g. Products, Tariffs, etc.)"
},
"timestamp" : {
"type" : "string",
"description" : "The timestamp of the action"
},
"realm" : {
"type" : "string",
"description" : "The unique name of the realm (e.g. admin, accounts, customer, etc.)"
},
"entity_type" : {
"type" : "string",
"description" : "The type of the entity (e.g. Accounts, Customers, etc.)"
},
"parent_name" : {
"type" : "string",
"description" : "The name of the parent entity"
},
"i_user" : {
"type" : "integer",
"description" : "The unique ID of the user"
},
"description" : {
"type" : "string",
"description" : "The description of the web log record"
},
"username" : {
"type" : "string",
"description" : "The unique name of the user who applied the changes"
},
"entity_name" : {
"type" : "string",
"description" : "The name of the entity to which the changes were applied"
},
"fields" : {
"$ref" : "#/components/schemas/ArrayOfWebLogFieldInfo"
},
"data_access_mode" : {
"type" : "string",
"description" : "The type of data access applied to the user when the action was requested. Possible values: open, protected"
}
}
},
"ArrayOfCPSubscriptionInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CPSubscriptionInfo"
}
},
"AddUpdatePhoneBookRecordResponse" : {
"type" : "object",
"properties" : {
"i_account_phonebook" : {
"type" : "integer",
"description" : "The unique ID of the PhoneBook's record"
}
}
},
"CurrencyInfoList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CurrencyInfo"
}
},
"AddPreferableAccountResponse" : {
"required" : [
"i_preferable_account"
],
"type" : "object",
"properties" : {
"i_preferable_account" : {
"type" : "integer",
"description" : "The unique ID of the frequently used account"
}
}
},
"AddUpdateOwnerBatchResponse" : {
"type" : "object",
"properties" : {
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the DID Pricing Batch"
}
}
},
"TemplateDataFieldInfo" : {
"type" : "object",
"properties" : {
"document_order" : {
"type" : "integer",
"description" : "Defines the position of the data field in the document"
},
"editor_order" : {
"type" : "integer",
"description" : "Defines the position of the data field in the editor"
},
"symbolic_id" : {
"type" : "string",
"description" : "The name of the variable used for the field in the template"
},
"i_format" : {
"type" : "integer",
"description" : "The unique ID of the format of the field"
},
"rule" : {
"type" : "string",
"description" : "The format rule used if the format is set to 'Other'"
},
"description" : {
"type" : "string",
"description" : "The description of the field"
},
"sample_data" : {
"type" : "string",
"description" : "The value of the field shown in 'Preview' mode"
},
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"format" : {
"type" : "string",
"description" : "The format of the field"
},
"i_format_type" : {
"type" : "integer",
"description" : "The unique ID of the format type of the field"
},
"format_type_name" : {
"type" : "string",
"description" : "The name of the format type"
},
"editor_name" : {
"type" : "string",
"description" : "The name of the data field"
},
"i_component_type" : {
"type" : "integer",
"description" : "The unique ID of the component's type"
},
"i_td_field" : {
"type" : "integer",
"description" : "The unique ID of the data field"
},
"pp_rule" : {
"type" : "string",
"description" : "The post-processing rule for the field"
}
}
},
"GenerateAliasesResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 if an aliases generation procedure was queued"
}
}
},
"ArrayOfCustomerClassNotificationCategoryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerClassNotificationCategoryInfo"
}
},
"GetMarketingGroupInfoRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "Marketing group name"
},
"id" : {
"type" : "integer",
"description" : "Marketing group code on the CoSS server"
},
"i_marketing_group" : {
"type" : "integer",
"description" : "The ID of the marketing group"
},
"get_external_info" : {
"type" : "integer",
"description" : "This flag indicates whether a local group or a group from the CoSS server should be returned"
}
}
},
"IvrApplicationInfo" : {
"type" : "object",
"properties" : {
"i_voice_application" : {
"type" : "integer",
"description" : "The ID of the corressponding Voice application"
},
"options" : {
"$ref" : "#/components/schemas/ArrayOfVoiceApplicationOptionInfo"
},
"i_voice_app_access_number" : {
"type" : "integer",
"description" : "The unique ID of the IVR application"
},
"name" : {
"type" : "string",
"description" : "The name of the IVR application"
},
"description" : {
"type" : "string",
"description" : "The description of the IVR application"
},
"code" : {
"type" : "string",
"description" : "The code of the Voice application"
}
}
},
"CommissionPlanBaseInfo" : {
"type" : "object",
"properties" : {
"base" : {
"type" : "string",
"description" : "The commission plan base name"
},
"i_cp_base" : {
"type" : "integer",
"description" : "The unique ID of the commission plan base"
}
}
},
"GetOverrideTariffRequest" : {
"type" : "object",
"properties" : {
"i_customer_override_tariff" : {
"type" : "integer",
"description" : "The unique override tariff rule ID"
},
"i_original_tariff" : {
"type" : "integer",
"description" : "The unique ID of the original tariff"
}
}
},
"ArrayOfTicketInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TicketInfo"
}
},
"CounterRolloversInfo" : {
"type" : "object",
"properties" : {
"rollover1" : {
"type" : "number",
"description" : "The rolled over quota amount will be expired in the next counter usage period"
},
"rollover3" : {
"type" : "number",
"description" : "The rolled over quota amount will be expired in the +3 counter usage period"
},
"rollover2" : {
"type" : "number",
"description" : "The rolled over quota amount will be expired in the +2 counter usage period"
},
"rollover0" : {
"type" : "number",
"description" : "The rolled over quota amount will be expired in the current counter usage period"
}
}
},
"ArrayOfTaxationCodes" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TaxationCode"
}
},
"ArrayOfIPTVServicePackage" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IPTVServicePackage"
}
},
"ArrayOfAllowedLocationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AllowedLocationInfo"
}
},
"UpdateCustomerSiteResponse" : {
"type" : "object",
"properties" : {
"i_customer_site" : {
"type" : "integer",
"description" : "The unique ID of a customer site"
}
}
},
"DiscountInfo" : {
"type" : "object",
"properties" : {
"align_billing" : {
"type" : "string",
"description" : "Defines how/if the usage period should be aligned to the customer's billing period (Supported values: 'Y', 'R', 'N', where 'R' and 'Y' are identical and 'R' is kept only to preserve compatibility)"
},
"prorate" : {
"type" : "string",
"description" : "Prorate the thresholds when period can't be used from its regular beginning (Supported values: 'Y', 'N')"
},
"threshold_list" : {
"$ref" : "#/components/schemas/ArrayOfVDThresholdInfo"
},
"i_service" : {
"type" : "integer",
"description" : "Unique Service id"
},
"rate_unit" : {
"type" : "string",
"description" : "Units"
},
"wallet_transfer_allowed" : {
"type" : "string",
"description" : "Determines whether to allow transfer of the service wallet contents between entities. (Y = Yes / N = No)"
},
"rollover_periods" : {
"type" : "integer",
"description" : "Number of periods to expire the rolled over quota amount"
},
"i_vd_type" : {
"type" : "integer",
"description" : "The ID of the discount type. This option works in conjunction with usage_period. Possible values: 1 - discount; 2 - quota or service wallet (distinguished by the usage_period value)"
},
"service_name" : {
"type" : "string",
"description" : "Service name"
},
"threshold_type" : {
"type" : "string",
"description" : "Discount type value ( enum 'Charged Amount', 'Charged Time')"
},
"usage_period" : {
"type" : "integer",
"description" : "This defines how often the volume discount is reset and what type of discount to create.\nPossible values for vd_type = 1:\n Empty value - create a one-time discount;\n 1 - create a daily reset discount;\n 2 - create a weekly reset discount;\n 3 - create a semimonthly reset discount;\n 4 - create a monthly reset discount.\nPossible values for vd_type = 2:\n Empty value - create a service wallet;\n 1 - create a daily reset quota;\n 2 - create a weekly reset quota;\n 3 - create a semimonthly reset quota;\n 4 - create a monthly reset quota\n"
},
"dg_name" : {
"type" : "string",
"description" : "Destination Group name"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The ID of Tax Transaction Code for Service Wallet Top-Up"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the discount plan"
},
"wallet_expiration_warning" : {
"type" : "integer",
"description" : "The number of days in advance for the notification that the service wallet expires"
},
"exclusive" : {
"type" : "string",
"description" : "Specifies whether an account should be granted exclusive free calls. Possible values: I – Never – for all discount types; N – Always – for discounts; Y – When lower than full – for discounts; F – After the last threshold – for all discount types; The default value depends on the discount type: F – default for quotas and service wallets; N – default for discounts. "
},
"restart" : {
"type" : "string",
"description" : "Should the new Discount be applied after the previous one finished (Supported values: 'Y', 'N')"
},
"topup_option_list" : {
"$ref" : "#/components/schemas/ArrayOfVDTopupOptionInfo"
},
"max_peak_level" : {
"type" : "integer",
"description" : "\n In pair with peak_level defines period when this Discount Thresholds should be used.\n This field defines maximal level (from Peak, Off-Peak, 2nd Off-Peak) for this Discount Thresholds\n "
},
"i_dest_group" : {
"type" : "integer",
"description" : "Unique Destination Group ID"
},
"peak_level" : {
"type" : "integer",
"description" : "\n Indicates whether this Discount Thresholds should be applied during the peak or off-peak period.\n If off-peak Discount Group doesn't exist peak will be used.\n 0 - Peak, 1 - Off-Peak, 2 - 2nd Off-Peak\n "
},
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the volume discount record (volume discount destination group record)"
},
"tax_transaction_code" : {
"type" : "string",
"description" : "The Tax Transaction Code for Service Wallet Top-Up"
},
"wallet_expired_notify" : {
"type" : "string",
"description" : "Determines whether to send the notification when the service wallet expires. (Y = Yes / N = No)"
},
"transfer_allowed" : {
"type" : "string",
"description" : "Determines whether to allow transfer of unused units between entities. (Y = Yes / N = No)"
}
}
},
"GetEmergencyUnitListResponse" : {
"type" : "object",
"properties" : {
"emergency_unit_list" : {
"$ref" : "#/components/schemas/ArrayOfEmergencyUnitInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved emergency routing units"
}
}
},
"ArrayOfTemplateBodyInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TemplateBodyInfo"
}
},
"AddUpdateCustomerAbbreviatedDialingNumberRequest" : {
"required" : [
"i_customer",
"abbreviated_dialing_number_info"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
},
"abbreviated_dialing_number_info" : {
"$ref" : "#/components/schemas/AbbreviatedDialingNumberInfo"
}
}
},
"AddNetnumberInfoResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success"
}
}
},
"AddServiceAndRatingResponse" : {
"type" : "object",
"properties" : {
"service_and_rating_info" : {
"$ref" : "#/components/schemas/ServiceAndRatingInfo"
},
"i_accessibility" : {
"type" : "integer",
"description" : "The unique ID of the rating entry record that was added"
}
}
},
"GetAccountVdCounterHistoryListResponse" : {
"type" : "object",
"properties" : {
"vd_counter_history_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountVdCounterHistoryInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"UploadMeasuredMetricDataRequest" : {
"required" : [
"object",
"i_measured_metric",
"i_object"
],
"type" : "object",
"properties" : {
"object" : {
"type" : "string",
"description" : "The type of object to which the measurement data upload is applied. Possible values: 'account', 'customer'"
},
"i_measured_metric" : {
"type" : "integer",
"description" : "The unique identifier of the measured metric"
},
"i_object" : {
"type" : "integer",
"description" : "The unique identifier of the object"
}
}
},
"RatingGroupInfo" : {
"type" : "object",
"properties" : {
"assigned_marketing_groups" : {
"$ref" : "#/components/schemas/ArrayOfMarketingGroupInfo"
},
"destination" : {
"type" : "string",
"description" : "Destination prefix"
},
"i_rating_group" : {
"type" : "integer",
"description" : "The ID of the rating group"
},
"name" : {
"type" : "string",
"description" : "The name of the rating group"
},
"i_dest" : {
"type" : "integer",
"description" : "The ID of the destination assigned to the rating group"
},
"id" : {
"type" : "integer",
"description" : "The rating group code used for communication with the CoSS server"
},
"description" : {
"type" : "string",
"description" : "A short description of the specified destination"
}
}
},
"DeleteRepresentativeRequest" : {
"required" : [
"i_rep"
],
"type" : "object",
"properties" : {
"i_rep" : {
"type" : "integer",
"description" : "The unique ID of the representative record"
}
}
},
"GetSessionContextRequest" : {
"type" : "object"
},
"GetAuthzRuleListRequest" : {
"type" : "object",
"properties" : {
"with_extended_info" : {
"type" : "integer",
"description" : "If set to 1, the method returns the following additional fields in the response AuthzRuleInfo structures: 'account_id', 'connection_description' and 'node_name'"
},
"autogenerated" : {
"type" : "integer",
"description" : "The filter to search autogenerated or manually created authentication rules. Possible values: 1 - autogenerated, 0 - manually created"
},
"auto_link_type" : {
"type" : "string",
"description" : "The filter to search the authentication rules by the 'auto_link_type' DB column"
}
}
},
"UpdateTemplateMediaAttributeListResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"DeleteCustomerResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"ArrayOfCustomerVdCounterHistoryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerVdCounterHistoryInfo"
}
},
"DestinationBatchAddDestinationPrefixRequest" : {
"required" : [
"destination_list"
],
"type" : "object",
"properties" : {
"destination_list" : {
"$ref" : "#/components/schemas/ArrayOfDestinationPrefixInfo"
}
}
},
"UpdateCustomerPaymentMethodResponse" : {
"required" : [
"i_credit_card"
],
"type" : "object",
"properties" : {
"i_credit_card" : {
"type" : "integer",
"description" : "ID of modified payment method record"
}
}
},
"DestinationGetDestGroupAllowedPrefixesRequest" : {
"required" : [
"i_dest_group"
],
"type" : "object",
"properties" : {
"country" : {
"type" : "string",
"description" : "The country"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"search_str" : {
"type" : "string",
"description" : "The additional filter value"
},
"description" : {
"type" : "string",
"description" : "The description"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"search_type" : {
"type" : "string",
"description" : "The additional filter name. Possible values: 'prefix', 'country', 'description'"
},
"prefix" : {
"type" : "string",
"description" : "The prefix"
}
}
},
"ArrayOfEstimatedTaxes" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EstimatedTax"
}
},
"UnpauseAssignedCommitmentRecordRequest" : {
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
}
}
},
"GetCodecConverterFileRequest" : {
"required" : [
"id"
],
"type" : "object",
"properties" : {
"codec" : {
"type" : "string",
"description" : "The codec name"
},
"handler" : {
"type" : "string",
"description" : "The handler name"
},
"id" : {
"type" : "integer",
"description" : "The unique identifier of the file"
},
"info_only" : {
"type" : "integer",
"description" : "The flag that shows whether to fetch only the information without attachment"
}
}
},
"GetAccessRoleTypeListRequest" : {
"type" : "object",
"properties" : {
"with_metadata" : {
"type" : "integer",
"description" : "Specifies whether the retrieve components tree metadata for the access role type"
}
}
},
"UserLoginToEnvRequest" : {
"required" : [
"i_env"
],
"type" : "object",
"properties" : {
"i_env" : {
"type" : "integer",
"description" : "The unique ID of the environment"
}
}
},
"RearrangeAuthzRuleInfo" : {
"required" : [
"order_number",
"i_authz_rule"
],
"type" : "object",
"properties" : {
"i_authz_rule" : {
"type" : "integer",
"description" : "The unique ID of the authentication rule"
},
"order_number" : {
"type" : "integer",
"description" : "The sequential number of the authentication rule"
}
}
},
"GetConnectionTypeListRequest" : {
"type" : "object",
"properties" : {
"name" : {
"type" : "string",
"description" : "The name of the connection type"
}
}
},
"ArrayOfRoamingCountryInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RoamingCountryInfo"
}
},
"ArrayOfWebLogFieldInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/WebLogFieldInfo"
}
},
"UnblockConnectionDestinationGroupResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"TerminateCustomerResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure "
}
}
},
"XrateList" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/XrateInfo"
}
},
"DeleteCPConditionResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "One of the following: 1 – success, 0 – failed"
}
}
},
"GetAccountConsumedServiceResponse" : {
"type" : "object",
"properties" : {
"consumed_service_list" : {
"$ref" : "#/components/schemas/ArrayOfConsumedServices"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved services"
}
}
},
"UpdateCommitmentOneTimeTermResponse" : {
"type" : "object",
"properties" : {
"i_one_time_term" : {
"type" : "integer",
"description" : "The unique identifier of the record"
}
}
},
"GetIvrApplicationInfoResponse" : {
"type" : "object",
"properties" : {
"ivr_application_info" : {
"$ref" : "#/components/schemas/IvrApplicationInfo"
}
}
},
"DeleteAutoPaymentResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"DeleteFraudConstraintResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"RateMatchModeInfo" : {
"required" : [
"i_rate_match_mode"
],
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "integer",
"description" : "The unique ID of the service type"
},
"options" : {
"type" : "string",
"description" : "The rate match mode options"
},
"i_rate_match_mode" : {
"type" : "integer",
"description" : "The unique ID of the rate match mode record"
},
"name" : {
"type" : "string",
"description" : "The rate match mode name"
}
}
},
"UpdateVendorBatchResponse" : {
"required" : [
"i_dv_batch"
],
"type" : "object",
"properties" : {
"i_dv_batch" : {
"type" : "integer",
"description" : "The unique ID of the vendor DID batch record"
}
}
},
"RearrangeAuthzRuleListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, exception error message in case of failure"
}
}
},
"GetInvoiceInfoRequest" : {
"type" : "object",
"properties" : {
"get_pdf" : {
"type" : "integer",
"description" : "Specifies whether to return the invoice in the PDF format"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"i_invoice" : {
"type" : "integer",
"description" : "The unique ID of the invoice record"
},
"invoice_number" : {
"type" : "integer",
"description" : "Invoice Number - unique identifier of the invoice(in borders if customer)"
}
}
},
"GetCustomerBillingPeriodsHistoryResponse" : {
"type" : "object",
"properties" : {
"billing_periods" : {
"$ref" : "#/components/schemas/ArrayOfBillingPeriodsHistoryInfo"
}
}
},
"GetCPRuleListResponse" : {
"type" : "object",
"properties" : {
"cp_rule_list" : {
"$ref" : "#/components/schemas/ArrayOfCPRuleInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of records"
}
}
},
"GetCurrencyListRequest" : {
"type" : "object",
"properties" : {
"skip_merchant_account_info" : {
"type" : "integer",
"description" : "Specifies whether to remove merchant account info related to a currency record from the response"
},
"search" : {
"type" : "string",
"description" : "Pattern that allows to search by Currency name. Use the following wildcard symbols: The percentage ( % ) wildcard allows you to match any string of zero or more characters; The underscore ( _ ) wildcard allows you to match any single character"
},
"get_total" : {
"type" : "integer",
"description" : "Flag which allows to include the total number of retrieved records into the response"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"GetServiceTypeInfoResponse" : {
"type" : "object",
"properties" : {
"service_type_info" : {
"$ref" : "#/components/schemas/ServiceTypeInfo"
}
}
},
"DeleteVendorAccountRequest" : {
"required" : [
"i_vendor_acc"
],
"type" : "object",
"properties" : {
"i_vendor_acc" : {
"type" : "integer",
"description" : "The unique ID of the vendor account record"
}
}
},
"UpdateUIConfigListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 in case of failure"
}
}
},
"GetFraudTrafficAlertListRequest" : {
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The identifier of the destination group"
},
"period_to" : {
"type" : "string",
"description" : "Get traffic alerts dated before this date and time"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The identifier of the traffic profile"
},
"i_customer_class" : {
"type" : "integer",
"description" : "The identifier of the customer class"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The identifier of the destination group set"
},
"i_customer_type" : {
"type" : "integer",
"description" : "The type of the customer. Possible values: 1 - Retail customer or subcustomer, 2 - Reseller"
},
"period_from" : {
"type" : "string",
"description" : "Get traffic alerts dated starting from this date and time"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"i_customer" : {
"type" : "integer",
"description" : "The identifier of the customer"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"ArrayOfRegenerateInvoicePDFInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RegenerateInvoicePDFInfo"
}
},
"AddUARequest" : {
"required" : [
"ua_info"
],
"type" : "object",
"properties" : {
"ua_info" : {
"$ref" : "#/components/schemas/UAInfo"
}
}
},
"VoiceQualityProfileInfo" : {
"type" : "object",
"properties" : {
"round_trip_delay_l2" : {
"type" : "integer",
"description" : "The round trip delay metric level2 value, ms"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the voice quality profile is in use"
},
"i_vq_profile" : {
"type" : "integer",
"description" : "The unique ID of the voice quality profile"
},
"mos_cq_l1" : {
"type" : "number",
"description" : "The MOS-CQ metric level1 value"
},
"round_trip_delay_l1" : {
"type" : "integer",
"description" : "The round trip delay metric level1 value, ms"
},
"inter_arrival_jitter_l2" : {
"type" : "integer",
"description" : "The inter arrival jitter metric level2 value, ms"
},
"managed_by" : {
"type" : "integer",
"description" : "The ID of the voice quality profile owner record"
},
"name" : {
"type" : "string",
"description" : "The voice quality profile name"
},
"description" : {
"type" : "string",
"description" : "The voice quality profile description"
},
"inter_arrival_jitter_l1" : {
"type" : "integer",
"description" : "The inter arrival jitter metric level1 value, ms"
},
"packet_loss_l1" : {
"type" : "integer",
"description" : "The packet loss metric level1 value, percents"
},
"packet_loss_l2" : {
"type" : "integer",
"description" : "The packet loss metric level2 value, percents"
},
"mos_cq_l2" : {
"type" : "number",
"description" : "The MOS-CQ metric level2 value"
}
}
},
"DeleteProductResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"CPServiceInfo" : {
"required" : [
"periods"
],
"type" : "object",
"properties" : {
"periods" : {
"$ref" : "#/components/schemas/ArrayOfCPPeriodInfo"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service"
},
"i_cp_service" : {
"type" : "integer",
"description" : "The unique ID of the commission plan service"
}
}
},
"GetAPISchemaResponse" : {
"required" : [
"api_service_list"
],
"type" : "object",
"properties" : {
"api_service_list" : {
"$ref" : "#/components/schemas/ArrayOfAPIServiceInfo"
}
}
},
"GetNodeListResponse" : {
"type" : "object",
"properties" : {
"node_list" : {
"$ref" : "#/components/schemas/ArrayOfNodes"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"GetVendorInfoResponse" : {
"type" : "object",
"properties" : {
"vendor_info" : {
"$ref" : "#/components/schemas/VendorInfo"
}
}
},
"BatchAddRateResponse" : {
"required" : [
"success",
"result_list"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
},
"result_list" : {
"$ref" : "#/components/schemas/ArrayOfResultBatchAddRateInfo"
}
}
},
"AddUpdateCustomerClassResponse" : {
"required" : [
"i_customer_class"
],
"type" : "object",
"properties" : {
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class record"
}
}
},
"GetTimePeriodInfoRequest" : {
"required" : [
"i_offpeak"
],
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Check whether the time period is in use"
},
"i_offpeak" : {
"type" : "integer",
"description" : "The unique ID of the time period"
}
}
},
"GetTraceSessionListResponse" : {
"type" : "object",
"properties" : {
"trace_session_list" : {
"$ref" : "#/components/schemas/ArrayOfTraceSessionInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of retrieved records"
}
}
},
"GetCountriesListRequest" : {
"type" : "object"
},
"GetAccountXDRQualityInfoRequest" : {
"required" : [
"id"
],
"type" : "object",
"properties" : {
"id" : {
"type" : "integer",
"description" : "ID of the XDR record"
}
}
},
"AddUpdateCustomerClassMetricResponse" : {
"required" : [
"i_customer_class"
],
"type" : "object",
"properties" : {
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer calss"
}
}
},
"GetUAProfileInfoRequest" : {
"required" : [
"i_ua_profile"
],
"type" : "object",
"properties" : {
"check_usage_by_resellers" : {
"type" : "integer",
"description" : "If the method is called by the administrator and is set to '1' then the 'is_used_by_resellers' field will be provided for every record in the response"
},
"get_parameters" : {
"type" : "integer",
"description" : "Include UA profile parameters into the response"
},
"i_ua_profile" : {
"type" : "integer",
"description" : "The unique ID of the UA Profile record"
}
}
},
"GetRouteCategoryInfoRequest" : {
"required" : [
"i_route_category"
],
"type" : "object",
"properties" : {
"check_usage" : {
"type" : "integer",
"description" : "Checks whether the route category is in use"
},
"i_route_category" : {
"type" : "integer",
"description" : "The unique ID of the route category DB record"
}
}
},
"GetRepresentativeXDRListResponse" : {
"type" : "object",
"properties" : {
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfRepresentativeXDRInfo"
},
"total" : {
"type" : "integer",
"description" : "The number of the retrieved xDRs"
}
}
},
"AddUpdateDialingRuleResponse" : {
"type" : "object",
"properties" : {
"i_dialing_rule" : {
"type" : "integer",
"description" : "The unique ID of the dialing rule record"
}
}
},
"AddUpdateCustomerClassMetricRequest" : {
"required" : [
"customer_class_metric_info"
],
"type" : "object",
"properties" : {
"customer_class_metric_info" : {
"$ref" : "#/components/schemas/CustomerClassMetricInfo"
}
}
},
"CBCNumberPatternInfo" : {
"type" : "object",
"properties" : {
"number" : {
"type" : "string",
"description" : "The call barring class number pattern"
}
}
},
"AddRepresentativeRequest" : {
"type" : "object",
"properties" : {
"generate_web_password" : {
"type" : "integer",
"description" : "Auto Generate Representative's password"
},
"representative_info" : {
"$ref" : "#/components/schemas/RepresentativeInfo"
}
}
},
"AccountEstimateTaxesResponse" : {
"type" : "object",
"properties" : {
"warnings" : {
"$ref" : "#/components/schemas/ArrayOfString"
},
"taxes_list" : {
"$ref" : "#/components/schemas/ArrayOfEstimatedTaxes"
}
}
},
"GetProductGroupInfoRequest" : {
"type" : "object",
"properties" : {
"i_product_group" : {
"type" : "integer",
"description" : "The unique ID of the product group"
},
"name" : {
"type" : "string",
"description" : "The name of the product group"
}
}
},
"FraudTrafficAlertInfo" : {
"type" : "object",
"properties" : {
"destination_group" : {
"type" : "string",
"description" : "The name of the destination group"
},
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique identifier of the destination group set record"
},
"destination_group_set" : {
"type" : "string",
"description" : "The name of the destination group set"
},
"cost" : {
"type" : "number",
"description" : "The total cost of all calls"
},
"traffic_profile_name" : {
"type" : "string",
"description" : "The name of the traffic profile"
},
"calls" : {
"type" : "integer",
"description" : "The number of calls"
},
"notified" : {
"type" : "string",
"description" : "The date and time when the alert was triggered"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique identifier of the destination group record"
},
"constraint_duration" : {
"type" : "integer",
"description" : "The initial duration of calls that the customer can accumulate in the period before notification"
},
"period_to" : {
"type" : "string",
"description" : "The date and time when the traffic counter expires"
},
"last_modified" : {
"type" : "string",
"description" : "The date and time when the counter was last updated"
},
"duration" : {
"type" : "integer",
"description" : "The total duration of all calls"
},
"attempts" : {
"type" : "integer",
"description" : "The number of call attempts"
},
"i_traffic_profile" : {
"type" : "integer",
"description" : "The unique identifier of the traffic profile record"
},
"revenue" : {
"type" : "number",
"description" : "The total revenue for all calls"
},
"i_ft_constraint" : {
"type" : "integer",
"description" : "The identifier of the fraud traffic constraint"
},
"period_from" : {
"type" : "string",
"description" : "The date and time when the traffic counter is created"
},
"customer" : {
"type" : "string",
"description" : "The name of the customer"
},
"accumulation_period" : {
"type" : "string",
"description" : "The name of the accumulation period. Possible periods: [hour, day]"
},
"i_customer" : {
"type" : "integer",
"description" : "The identifier of the customer"
}
}
},
"GetXDRCollectionListRequest" : {
"type" : "object",
"properties" : {
"status" : {
"type" : "string",
"description" : "The status of the xDR collection (enum: any, new, processing, finished)"
},
"collection_name" : {
"type" : "string",
"description" : "The name of the xDR collection"
},
"from_date" : {
"type" : "string",
"description" : "Beginning of the search interval"
},
"with_errors_only" : {
"type" : "string",
"description" : "Get xDR collections with errors only. (enum: Y - with errors only, N - without errors only). Get any collection if the flag is not specified"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"to_date" : {
"type" : "string",
"description" : "Ending of the search interval"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"CustomerGetCustomerServiceFeaturesMetaInfoResponse" : {
"type" : "object",
"properties" : {
"subtypes" : {
"$ref" : "#/components/schemas/ANY"
},
"service_features" : {
"$ref" : "#/components/schemas/ANY"
}
}
},
"ArrangeCPRulesRequest" : {
"required" : [
"i_account",
"rules"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"rules" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
}
}
},
"ArrayOfSipStatusInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/SipStatusInfo"
}
},
"UpdateEnvNotificationTemplateRequest" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"bcc" : {
"type" : "string",
"description" : "An email address of the person who wants to receive a copy of this notification. You can specify more than one valid email address; make sure you separate them with commas"
},
"body" : {
"type" : "string",
"description" : "The content of the message"
},
"reset_to_default" : {
"type" : "integer",
"description" : "Specifies whether to reset the notification template to its default value. Possible values: 1 – Reset the notification template to its default value. 0 – Do not reset the notification template"
},
"subject" : {
"type" : "string",
"description" : "The subject as it appears in an email to a recepient"
},
"name" : {
"type" : "string",
"description" : "The name of either the email or sms notification template as it appears in the Notifications table in the database"
},
"variables" : {
"$ref" : "#/components/schemas/ArrayOfNotificationTemplateVariables"
}
}
},
"GetDialingRuleInfoRequest" : {
"type" : "object",
"properties" : {
"i_owner" : {
"type" : "integer",
"description" : "The unique ID of the dialing rule owner record"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the dialing rule is in use"
},
"owner_type" : {
"type" : "string",
"description" : "The type of dialing rule owner. One of the following: Customer, CustomerSite, Account"
},
"i_dialing_rule" : {
"type" : "integer",
"description" : "The unique ID of the dialing rule record"
},
"with_tech_prefix" : {
"type" : "integer",
"description" : "1 – The response will include the special \"tech prefix\" dialing rule (for administrators only). 0 – The \"tech prefix\" dialing rule will not be included."
}
}
},
"AddUpdateSIMCardResponse" : {
"required" : [
"i_sim_card"
],
"type" : "object",
"properties" : {
"i_sim_card" : {
"type" : "integer",
"description" : "The unique ID of a sim card record"
}
}
},
"NotificationTemplateVariable" : {
"required" : [
"i_td_field"
],
"type" : "object",
"properties" : {
"i_format" : {
"type" : "integer",
"description" : "The unique ID of the format of the variable"
},
"rule" : {
"type" : "string",
"description" : "The custom name of the rule used for post-processing"
},
"description" : {
"type" : "string",
"description" : "The description of the variable"
},
"var_group" : {
"type" : "string",
"description" : "The name of the group the variable belongs to"
},
"i_format_type" : {
"type" : "string",
"description" : "The unique ID of the format type of the variable"
},
"editor_name" : {
"type" : "string",
"description" : "The name of the variable"
},
"i_td_field" : {
"type" : "string",
"description" : "The unique ID of the variable as it appears in the Template_Data_Fields_Base (for system templates) and Template_Data_Fields (for custom templates) tables in the database"
},
"pp_rule" : {
"type" : "string",
"description" : "Post-processing rule for variables that can be specified using regular expressions in Perl"
}
}
},
"GetCustomerVDCounterListResponse" : {
"type" : "object",
"properties" : {
"counter_list" : {
"$ref" : "#/components/schemas/ArrayOfCounterInfo"
}
}
},
"AddCommitmentRecurringTermRequest" : {
"required" : [
"recurring_term_info"
],
"type" : "object",
"properties" : {
"recurring_term_info" : {
"$ref" : "#/components/schemas/CommitmentRecurringTermInfo"
}
}
},
"GetDestGroupSetInfoRequest" : {
"required" : [
"i_dest_group_set"
],
"type" : "object",
"properties" : {
"i_dest_group_set" : {
"type" : "integer",
"description" : "The unique ID of the destination group set"
},
"check_set_emptiness" : {
"type" : "integer",
"description" : "If set to '1', the 'is_set_empty' field will be present in the method response"
}
}
},
"GetCustomerMigrationRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"GetTaxTransactionCodeListRequest" : {
"type" : "object",
"properties" : {
"plugin_code" : {
"type" : "string",
"description" : "The taxation plugin code pattern"
},
"description" : {
"type" : "string",
"description" : "The description pattern"
},
"i_billing_processor" : {
"type" : "integer",
"description" : "The ID of the billing processor"
},
"with_plugin_codes" : {
"type" : "integer",
"description" : "The flag shows whether to include plugin specific codes into the response"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the tax transaction code is in use"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved taxation codes"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"code" : {
"type" : "string",
"description" : "The code pattern"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
}
}
},
"ArrayOfZendeskTicketInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ZendeskTicketInfo"
}
},
"GroupIncludedProductInfo" : {
"required" : [
"i_product"
],
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
}
}
},
"TaxationOptionsBillsoft" : {
"type" : "object",
"properties" : {
"customer_type" : {
"type" : "string",
"description" : "Type of the customer; one of the following: Default, Business, Residential"
},
"reseller_regulated" : {
"type" : "string",
"description" : "Reseller’s status in the sale; one of the following: Default, Regulated, Unregulated"
},
"incorporated_area" : {
"type" : "string",
"description" : "Incorporated City Area; one of the following: Default, Inside, Outside"
},
"transaction_codes" : {
"$ref" : "#/components/schemas/ArrayOfTransactionCodes"
},
"county_exempt" : {
"type" : "string",
"description" : "Exempt from county taxes"
},
"reseller_voipa" : {
"type" : "string",
"description" : "VoIP Taxation; one of the following: Default, Normal, Aggressive"
},
"state_exempt" : {
"type" : "string",
"description" : "Exempt from state taxes"
},
"federal_exempt" : {
"type" : "string",
"description" : "Exempt from federal taxes"
},
"taxation_mode" : {
"type" : "string",
"description" : "Specifies which additional taxes will be calculated for a customer. The objects that are taxed depend both on the Taxation Mode and on the VoIP Taxation configuration. Possible values: not_switched - Taxation is applied based on the number of lines the customer uses; switched - Taxation is applied based on the number of trunks, extensions and outbound channels that the customer uses"
},
"local_exempt" : {
"type" : "string",
"description" : "Exempt from local taxes"
}
}
},
"DestinationBatchAddDestinationPrefixResponse" : {
"required" : [
"success",
"result_list"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
},
"result_list" : {
"$ref" : "#/components/schemas/ArrayOfResultBatchAddDestinationInfo"
}
}
},
"GetHGInfoResponse" : {
"type" : "object",
"properties" : {
"huntgroup_info" : {
"$ref" : "#/components/schemas/HGInfo"
}
}
},
"GetTemplateInfoResponse" : {
"type" : "object",
"properties" : {
"template_info" : {
"$ref" : "#/components/schemas/TemplateInfo"
}
}
},
"MoveAccountRequest" : {
"required" : [
"i_account",
"i_customer",
"batch_name"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account to be moved"
},
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product"
},
"batch_name" : {
"type" : "string",
"description" : "The name of the batch to put the account into"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer to move account to"
},
"i_routing_plan" : {
"type" : "integer",
"description" : "The unique ID of the routing plan"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan"
}
}
},
"UpdateTemplateMediaAttributeListRequest" : {
"required" : [
"template_media_attribute_list",
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"template_media_attribute_list" : {
"$ref" : "#/components/schemas/ArrayOfTemplateMediaAttributeInfo"
}
}
},
"GetServiceListRequest" : {
"type" : "object",
"properties" : {
"i_service_type" : {
"type" : "string",
"description" : "The unique ID of the Service Type"
},
"get_usage" : {
"type" : "integer",
"description" : "Get information about usage of the services"
},
"rate_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units used to calculate service charges. You will use these units to specify your rating prices, and the usage details in xDRs will be shown in these units"
},
"order_by" : {
"type" : "string",
"description" : "Sorting criteria (enum 'i_service', 'name'), the default value is 'i_service'"
},
"get_total" : {
"type" : "string",
"description" : "Get the total number of the retrieved services"
},
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The identifier of the tax transaction code"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"rating_base" : {
"type" : "string",
"description" : "Specification of which particular parameter is used to calculate charges, e.g. \"session time\", \"amount of data transferred\" and the like. Where applicable, the rating base selection also defines what is to be used as the base unit; e.g. for the Internet Access service you could use bytes, kilobytes or megabytes as the base unit"
},
"i_st_charge_unit" : {
"type" : "integer",
"description" : "The unique ID of the related service type charge unit"
},
"internal" : {
"type" : "string",
"description" : "Indicates whether the service is considered for internal usage"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"ratio" : {
"type" : "integer",
"description" : "If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration"
},
"name" : {
"type" : "string",
"description" : "Name pattern of a service"
},
"unit" : {
"type" : "string",
"description" : "A customer-visible name for the units in which service use is measured; this also would be the smallest possible unit you can use in the rating configuration"
},
"usage_rating" : {
"type" : "string",
"description" : "Shows whether usage charging is mandatory or not for the Service. Possible values: 'Y', 'N'"
},
"order_direction" : {
"type" : "string",
"description" : "Sorting direction (enum 'ASC', 'DESC'), the default value is 'ASC'"
}
}
},
"CustomFieldsInfo" : {
"type" : "object",
"properties" : {
"i_custom_field" : {
"type" : "integer",
"description" : "Unique ID of the Custom Field record"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the custom field was used"
},
"object" : {
"type" : "string",
"description" : "The type of entity (account/customer) to which the сustom field is applied"
},
"value" : {
"type" : "string",
"description" : "Value of the Custom Field"
},
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who manages the Custom Field record"
},
"name" : {
"type" : "string",
"description" : "Name of the Custom Field"
},
"properties" : {
"type" : "string",
"description" : "JSON-encoded Validation Schema for the Custom Field"
},
"default_value" : {
"type" : "string",
"description" : "Default value for the Custom Field"
},
"personal_data" : {
"type" : "string",
"description" : "Shows that the custom field contains private data and should not be shown to unauthorized users"
},
"type" : {
"type" : "string",
"description" : "Canonical name of the Custom Field's type. Currently supported: 'text', 'list', 'date', 'number', 'datetime'"
},
"mandatory" : {
"type" : "string",
"description" : "Marks that the Custom Field is mandatory. Possible values: 'Y', 'N'"
},
"visible_to_end_user" : {
"type" : "string",
"description" : "Marks that the Custom Field is visible to the End User. Possible values: 'Y', 'N'"
}
}
},
"AssignDIDToOwnerBatchRequest" : {
"required" : [
"i_did_number"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique DID Number identifier"
},
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the DID Pricing Batch"
},
"periodic_fee" : {
"type" : "number",
"description" : "A monthly amount charged by the vendor for the provisioned DID number"
},
"activation_fee" : {
"type" : "number",
"description" : "A one-time amount paid to the vendor for the DID number activation"
}
}
},
"GetActiveCallsRequest" : {
"type" : "object",
"properties" : {
"actual" : {
"type" : "string",
"description" : "Return only actual records"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetCustomerClassNotificationCategoryListRequest" : {
"type" : "object",
"properties" : {
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the customer class"
}
}
},
"RegisterTransactionRequest" : {
"required" : [
"amount",
"i_payment_method"
],
"type" : "object",
"properties" : {
"amount" : {
"type" : "number",
"description" : "Paid amount (Should be equal to or greater than the Minimum Allowed Payment)"
},
"i_owner" : {
"type" : "integer",
"description" : "The unique ID of the entity (e.g. i_account, i_customer). Used to get results for another entity"
},
"i_payment_method" : {
"type" : "integer",
"description" : "The unique ID of the chosen Payment Method"
},
"owner_type" : {
"type" : "string",
"description" : "A symbolic title of system entity. Used when calling entity wants to get result for other entity. Possible values: 'Customer', 'Account'"
},
"purpose" : {
"type" : "string",
"description" : "The purpose of the transaction"
},
"purpose_details" : {
"type" : "string",
"description" : "Description of the purpose of the transaction"
}
}
},
"GetVoiceApplicationListRequest" : {
"type" : "object"
},
"ReprocessMediatorXDRListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception on failure"
}
}
},
"AddFollowMeNumberRequest" : {
"type" : "object",
"properties" : {
"number_info" : {
"$ref" : "#/components/schemas/FollowMeNumberInfo"
}
}
},
"GetGlobalCurrencyListResponse" : {
"required" : [
"global_currency_list"
],
"type" : "object",
"properties" : {
"global_currency_list" : {
"$ref" : "#/components/schemas/GlobalCurrencyInfoList"
}
}
},
"ArrayOfAttributePermissions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AttributePermission"
}
},
"GetDIDInventoryOptionsRequest" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller"
}
}
},
"ArrayOfRadiusAttributeData" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/RadiusAttributeData"
}
},
"ArrayOfCustomerSiteInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerSiteInfo"
}
},
"AccountMOHListInfo" : {
"type" : "object",
"properties" : {
"account_defined_moh_list" : {
"$ref" : "#/components/schemas/ArrayOfMOHInfo"
},
"is_moh_update_disabled" : {
"type" : "integer",
"description" : "Indicates whether the MOH update is allowed"
},
"system_default_i_moh" : {
"type" : "integer",
"description" : "Default system MOH object"
},
"aggregated_moh_list" : {
"$ref" : "#/components/schemas/ArrayOfMOHInfo"
},
"default_moh_list" : {
"$ref" : "#/components/schemas/ArrayOfMOHInfo"
}
}
},
"GetAccountProductInfoRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
}
}
},
"UAPortConfiguration" : {
"required" : [
"port"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique integer identifier of account record in the PortaBilling(TM) database"
},
"i_service_type" : {
"type" : "integer",
"description" : "Shows the type of the service this port is currently used for. Only for multiservice devices"
},
"allowed_services" : {
"$ref" : "#/components/schemas/ArrayOfUAPortApplicableServiceInfo"
},
"release_allowed" : {
"type" : "string",
"description" : "The flag shows if the port can be released. Possible values: Y, N"
},
"port" : {
"type" : "integer",
"description" : "The port number"
},
"physical_interface_number" : {
"type" : "integer",
"description" : "For devices that have different types of physical interfaces this field contains the physical interface number"
},
"account_id" : {
"type" : "string",
"description" : "The ID of the account"
}
}
},
"GetScheduledCommitmentRecordReplacementRequest" : {
"required" : [
"i_account_commitment"
],
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
}
}
},
"GetCustomerServiceFeaturesRequest" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of a customer record"
}
}
},
"ArrayOfTriggerEventDataInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TriggerEventDataInfo"
}
},
"GetSessionLogInfoResponse" : {
"type" : "object",
"properties" : {
"session_log" : {
"$ref" : "#/components/schemas/SessionLogInfo"
}
}
},
"AccountAuxFieldInfo" : {
"required" : [
"name"
],
"type" : "object",
"properties" : {
"value" : {
"type" : "string",
"description" : "The field value"
},
"name" : {
"type" : "string",
"description" : "The field name"
}
}
},
"CustomXdrReportInfo" : {
"type" : "object",
"properties" : {
"period_from" : {
"type" : "string",
"description" : "Get custom xDR reports dated starting from this date"
},
"custom_file_name" : {
"type" : "string",
"description" : "The name of the report file (in a format defined in the configuration)"
},
"file_name" : {
"type" : "string",
"description" : "The name of the report file (the unique report ID)"
},
"period_to" : {
"type" : "string",
"description" : "Get custom xDR reports dated before this date"
},
"type" : {
"type" : "string",
"description" : "The name of a custom xDR report type"
}
}
},
"ArrayOfVDThresholdInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VDThresholdInfo"
}
},
"GetCallBarringClassListResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The total number of retrieved records"
},
"call_barring_class_list" : {
"$ref" : "#/components/schemas/ArrayOfCallBarringClassInfo"
}
}
},
"AssignDIDToResellerResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 – DID was assigned, 0 – DID was not assigned"
}
}
},
"CloneCustomerClassResponse" : {
"required" : [
"i_customer_class"
],
"type" : "object",
"properties" : {
"i_customer_class" : {
"type" : "integer",
"description" : "The unique ID of the new cloned customer class"
}
}
},
"AccountSubscriptionInfo" : {
"type" : "object",
"properties" : {
"activation_date" : {
"type" : "string",
"description" : "The date when the subscription was activated"
},
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product from which the subscription is inherited"
},
"i_account_subscription" : {
"type" : "integer",
"description" : "The unique ID of the account subscription record"
},
"int_status" : {
"type" : "integer",
"description" : "A status of the subscription: 0 - pending, 1 - active, 2 - closed"
},
"generate_daily_charge" : {
"type" : "string",
"description" : "Specifies whether to keep the total charge only or to generate daily charges. Possible values: Y - Generate daily charges; N - Keep the total charge only"
},
"effective_fee" : {
"type" : "number",
"description" : "Amount of the actual periodic fee for the current billing period according to its order number"
},
"commitment_name" : {
"type" : "string",
"description" : "The name of the commitment"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account"
},
"discount_list" : {
"$ref" : "#/components/schemas/SubscriptionDiscountList"
},
"monthly_fee" : {
"type" : "number",
"description" : "Standard subscription's monthly fee value "
},
"discount_amount" : {
"type" : "number",
"description" : "The fixed discount amount for the subscription periodic fee. This is a read-only field which is used by commitments only"
},
"i_discount_current" : {
"type" : "integer",
"description" : "The unique ID of the current period multimonths discount"
},
"next_effective_fee" : {
"type" : "number",
"description" : "The amount of the periodic fee for the next billing period"
},
"billed_to" : {
"type" : "string",
"description" : "The date to which subscription charges have already been applied"
},
"i_subscription" : {
"type" : "integer",
"description" : "The unique ID of the subscription plan; refers to Subscriptions table"
},
"start_date" : {
"type" : "string",
"description" : "The desired subscription activation date (defined in the customer's time zone); if missing or undefined, the subscription will start immediately after it is created; otherwise, the value should be greater than or equal to today's date (in the customer's time zone); can be updated for pending subscriptions only"
},
"has_discount" : {
"type" : "integer",
"description" : "The flag shows whether the subscription has a discount assigned."
},
"i_commitment" : {
"type" : "integer",
"description" : "The reference to the commitment if the subscription was assigned as a part of the commitment"
},
"is_finished" : {
"type" : "string",
"description" : "Indicates whether the subscription has been already closed"
},
"i_discount_next" : {
"type" : "integer",
"description" : "The unique ID of the next period multimonths discount"
},
"invoice_description" : {
"type" : "string",
"description" : "The subscription plan name that is visible to the end user. Can be specified directly on the account level. Otherwice the value from the subscription level is used"
},
"name" : {
"type" : "string",
"description" : "Name of the subscription plan, referenced by the i_subscription attribute"
},
"obligatory" : {
"type" : "string",
"description" : "Indicates that the subscription comes from the account's product, and so cannot be closed until the account has this product assigned to it"
},
"finish_date" : {
"type" : "string",
"description" : "The date when the subscription should be automatically canceled; if provided must be greater or equal to the start_date"
},
"rounding" : {
"type" : "integer",
"description" : "A pattern that defines the rounding of the amount charged for a billing period"
},
"discount_rate" : {
"type" : "number",
"description" : "Discount rate for the subsciption in percents; if missed or provided undefined, it means that the discount rate defined in the customer information should be applied."
},
"multiple" : {
"type" : "integer",
"description" : "Can this Subscription be applied more than once"
},
"subscription_level_invoice_description" : {
"type" : "string",
"description" : "The subscription plan name visible to the end user inherited from the subscription (default configuration) or from the product settings"
}
}
},
"GetNetworkConnectivityListResponse" : {
"type" : "object",
"properties" : {
"connectivities" : {
"$ref" : "#/components/schemas/ArrayOfNetworkConnectivityInfo"
}
}
},
"VDTopupResponse" : {
"type" : "object",
"properties" : {
"counter_info" : {
"$ref" : "#/components/schemas/FullCounterInfo"
},
"status" : {
"type" : "string",
"description" : "This field specifies the status of the transaction on the payment gateway side. Possible values: STARTED - transaction pending, COMPLETED - transaction completed, FAILED - transaction failed"
}
}
},
"GetTaxPluginsListResponse" : {
"required" : [
"tax_plugins"
],
"type" : "object",
"properties" : {
"tax_plugins" : {
"$ref" : "#/components/schemas/ArrayOfTaxPluginInfo"
}
}
},
"DeleteCustomerClassMetricResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Possible values: 1 – If success, 0 – In case of failure"
}
}
},
"GetLastBillingDateConstraintListRequest" : {
"required" : [
"i_time_zone"
],
"type" : "object",
"properties" : {
"i_time_zone" : {
"type" : "integer",
"description" : "The unique ID of the time zone"
}
}
},
"TestTariffRatingRequest" : {
"required" : [
"mode",
"destination",
"i_tariff"
],
"type" : "object",
"properties" : {
"unit_quantity" : {
"type" : "integer",
"description" : "The amount of the tariff service units for which the tariff rate would be tested"
},
"destination" : {
"type" : "string",
"description" : "The phone number to initiate the test session"
},
"mode" : {
"type" : "integer",
"description" : "1 - initiate the test based on \"unit_quantity\"; 2 - initiate the test based on \"available_funds\""
},
"available_funds" : {
"type" : "number",
"description" : "Simulate authorization for a situation when the user has the entered amount of available funds"
},
"date_time" : {
"type" : "string",
"description" : "The date and the time when the test session is initiated"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff DB record"
}
}
},
"AddTaxTransactionCodeRequest" : {
"required" : [
"tax_transaction_code_info"
],
"type" : "object",
"properties" : {
"tax_transaction_code_info" : {
"$ref" : "#/components/schemas/TaxTransactionCode"
}
}
},
"ArrayOfVendorBatchInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/VendorBatchInfo"
}
},
"ArrayOfXDRRevertInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/XDRRevertInfo"
}
},
"SetSessionContextRequest" : {
"type" : "object",
"properties" : {
"euuid" : {
"type" : "string",
"description" : "The unique identifier of the environment"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
}
}
},
"UpdateTariffResponse" : {
"required" : [
"i_tariff"
],
"type" : "object",
"properties" : {
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff record"
}
}
},
"DeleteCommitmentOneTimeTermResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "The result of the operation, or an exception in case of failure"
}
}
},
"GetUserUIConfigListRequest" : {
"type" : "object",
"properties" : {
"section_name" : {
"type" : "string",
"description" : "The name of the config section to filter the response by"
}
}
},
"ArrayOfIptvChannelPackageFilters" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/IptvChannelPackageFilter"
}
},
"GenericTriggerEventRequest" : {
"required" : [
"event_name"
],
"type" : "object",
"properties" : {
"event_name" : {
"type" : "string",
"description" : "The event name"
},
"event_data" : {
"$ref" : "#/components/schemas/ArrayOfTriggerEventDataInfo"
},
"start_time" : {
"type" : "string",
"description" : "The event start time"
}
}
},
"DeletePreferableAccountRequest" : {
"required" : [
"i_preferable_account"
],
"type" : "object",
"properties" : {
"i_preferable_account" : {
"type" : "integer",
"description" : "The unique ID of the frequently used account"
}
}
},
"ArrayOfCallBarringClassInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CallBarringClassInfo"
}
},
"ArrayOfAPIMethodRealmInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/APIMethodRealmInfo"
}
},
"GenerateOutOfTurnInvoiceRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"invoice_due" : {
"type" : "string",
"description" : "The invoice due date. If specified, this due date will be used instead of the system default value"
},
"all_xdrs" : {
"type" : "integer",
"description" : "Specifies whether to use all available xDRs (those marked accordingly) for generating an out-of-turn invoice. Possile values: 1 – Use all marked xDRs; 0 – Use only some of the marked xDRs"
},
"i_customer" : {
"type" : "integer",
"description" : "Refers to the record of a customer for which an outof-turn invoice will be generated"
},
"xdr_list" : {
"$ref" : "#/components/schemas/ArrayOfOutOfTurnXDRInfo"
}
}
},
"ReviewInvoiceInfo" : {
"required" : [
"action",
"i_invoice"
],
"type" : "object",
"properties" : {
"postponed" : {
"type" : "integer",
"description" : "Specifies whether to schedule delivery of approved invoices to customers / regeneration of selected invoices for off-peak"
},
"action" : {
"type" : "string",
"description" : "The action to be applied to this invoice. Possible values: approve, regenerate"
},
"i_invoice" : {
"type" : "integer",
"description" : "The unique identifier of the invoice"
}
}
},
"XDRRevertInfo" : {
"required" : [
"owner",
"id"
],
"type" : "object",
"properties" : {
"owner" : {
"type" : "string",
"description" : "The name of the xDR list owner. Possible values: 'customer', 'account' or 'vendor'"
},
"comment" : {
"type" : "string",
"description" : "The comment related to the revert procedure"
},
"hide" : {
"type" : "string",
"description" : "If equal to 'Y', the original and correction xDRs will be marked hidden. Possible values: 'Y' - hide the original and correction xDRs during the refund procedure, 'N' - do not hide the xDRs. The field is ignored if the 'charged_amount' field in the structure is not equal to the original xDR amount"
},
"charged_amount" : {
"type" : "number",
"description" : "The charged amount that will be saved in the correction xDR"
},
"id" : {
"type" : "integer",
"description" : "The unique ID of the xDR"
}
}
},
"CPConditionNumberInfo" : {
"required" : [
"number"
],
"type" : "object",
"properties" : {
"number" : {
"type" : "string",
"description" : "Phone number"
},
"negated" : {
"type" : "string",
"description" : "Indicates that the condition is met when the number is not matched. (Y / N)"
},
"onnet" : {
"type" : "string",
"description" : "Whether the number is onnet (Y / N)"
}
}
},
"GetAssignedCommitmentTermsResponse" : {
"type" : "object",
"properties" : {
"commitment_recurring_term_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountCommitmentRecurringTermInfo"
},
"commitment_one_time_term_list" : {
"$ref" : "#/components/schemas/ArrayOfAccountCommitmentOneTimeTermInfo"
}
}
},
"AssignDIDToResellerRequest" : {
"required" : [
"i_did_number",
"i_customer"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique DID Number identifier"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the reseller record"
}
}
},
"TicketInfo" : {
"type" : "object",
"properties" : {
"created" : {
"type" : "string",
"description" : "Ticket creation time"
},
"priority" : {
"type" : "integer",
"description" : "Ticket priority"
},
"last_updated" : {
"type" : "string",
"description" : "Last date when ticket has been updated"
},
"status" : {
"type" : "string",
"description" : "Ticket status"
},
"subject" : {
"type" : "string",
"description" : "Ticket subject"
},
"id" : {
"type" : "integer",
"description" : "Ticket number"
},
"requestors" : {
"$ref" : "#/components/schemas/ArrayOfString"
}
}
},
"GetCustomerServiceFeaturesResponse" : {
"type" : "object",
"properties" : {
"service_features" : {
"$ref" : "#/components/schemas/ArrayOfServiceFeatureInfo"
}
}
},
"MetricGroupingInfo" : {
"required" : [
"grouping_type"
],
"type" : "object",
"properties" : {
"value_info" : {
"$ref" : "#/components/schemas/MetricGroupingValueInfo"
},
"time_info" : {
"$ref" : "#/components/schemas/MetricGroupingTimeInfo"
},
"grouping_type" : {
"type" : "string",
"description" : "Grouping type. Possible values: 'filter', 'time', 'value'"
},
"filter_list" : {
"$ref" : "#/components/schemas/ArrayOfMetricGroupingFilterInfo"
}
}
},
"PermittedSipProxiesInfo" : {
"type" : "object",
"properties" : {
"proxy_name" : {
"type" : "string",
"description" : "Name of the proxy"
}
}
},
"AddFraudConstraintResponse" : {
"required" : [
"i_ft_constraint"
],
"type" : "object",
"properties" : {
"i_ft_constraint" : {
"type" : "integer",
"description" : "The identifier of the fraud constraint"
}
}
},
"TemplateGetTemplateGroupFieldListRequest" : {
"required" : [
"i_template"
],
"type" : "object",
"properties" : {
"i_template" : {
"type" : "integer",
"description" : "The unique ID of the template"
},
"i_tdg" : {
"type" : "integer",
"description" : "The unique ID of the data group of the template"
}
}
},
"GetDestGroupInfoRequest" : {
"required" : [
"i_dest_group"
],
"type" : "object",
"properties" : {
"country" : {
"type" : "string",
"description" : "The country to search destinations"
},
"iso_3166_1_a2" : {
"type" : "string",
"description" : "Search by ISO 3166 two-letter country code"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group record"
},
"without_destination_list" : {
"type" : "integer",
"description" : "Show Destination Group info only"
},
"description" : {
"type" : "string",
"description" : "Destination description to search destinations"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved destinations"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"prefix" : {
"type" : "string",
"description" : "The prefix by which to search destinations. Note that the search parameters prefix, country and description are exclusive with the following priority: prefix->country->description. E.g., if you provide both prefix and country properties, then search will be done only by the prefix"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"GetCustomerVdNotificationListResponse" : {
"type" : "object",
"properties" : {
"vd_notification_list" : {
"$ref" : "#/components/schemas/ArrayOfCustomerVdNotificationInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"GetRepresentativeListResponse" : {
"type" : "object",
"properties" : {
"representative_list" : {
"$ref" : "#/components/schemas/ArrayOfRepresentativeInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of retrieved representatives"
}
}
},
"ArrayOfAccountCommitmentOneTimeTermInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccountCommitmentOneTimeTermInfo"
}
},
"ConnectionDestinationGroupInfo" : {
"type" : "object",
"properties" : {
"calls" : {
"type" : "integer",
"description" : "The total number of calls for a certain period of time"
},
"last_updated" : {
"type" : "string",
"description" : "The datetime timestamp when the values in the structure were updated"
},
"high_pdd" : {
"type" : "integer",
"description" : "The value of the maximum acceptable PDD (Post-Dial Delay) for a certain period of time"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique identifier of the destination group"
},
"ppm" : {
"type" : "number",
"description" : "The profit per minute for a certain period of time"
},
"block_from" : {
"type" : "string",
"description" : "The datetime timestamp when the connection destination group was blocked"
},
"low_pdd" : {
"type" : "integer",
"description" : "The minimum acceptable PDD (Post-Dial Delay) for a certain period of time"
},
"asr" : {
"type" : "integer",
"description" : "The average success rate (the number of successfully connected calls divided by the total number of call attempts) for a certain period of time"
},
"reduce_priority" : {
"type" : "string",
"description" : "Shows whether the destination group in the connection is penalized"
},
"is_blocked" : {
"type" : "integer",
"description" : "Shows whether the destination group in the connection is blocked"
},
"block_until" : {
"type" : "string",
"description" : "The datetime timestamp when the connection destination group will be unblocked"
},
"dest_group_name" : {
"type" : "string",
"description" : "The name of the destination group"
},
"aloc" : {
"type" : "integer",
"description" : "The average duration of call for a certain period of time"
},
"destination_group_thresholds" : {
"$ref" : "#/components/schemas/RoutingCriteriaDestGroupInfo"
}
}
},
"AddTaxTransactionCodeResponse" : {
"required" : [
"i_tax_transaction_code"
],
"type" : "object",
"properties" : {
"i_tax_transaction_code" : {
"type" : "integer",
"description" : "The unique ID of the taxation code database record"
}
}
},
"AddMeasuredMetricDataRequest" : {
"required" : [
"metric_info"
],
"type" : "object",
"properties" : {
"metric_info" : {
"$ref" : "#/components/schemas/MeasuredMetricDataInfo"
}
}
},
"DeleteOwnerBatchRequest" : {
"required" : [
"i_do_batch"
],
"type" : "object",
"properties" : {
"i_do_batch" : {
"type" : "integer",
"description" : "The unique ID of the DID Pricing Batch"
}
}
},
"AccountVDTopupRequest" : {
"required" : [
"i_service",
"i_dest_group",
"topup_amount",
"i_account",
"peak_level"
],
"type" : "object",
"properties" : {
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group to apply the top-up to"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service record"
},
"topup_expires" : {
"type" : "string",
"description" : "A date and time in the UTC format when the topped up volume discount becomes expired (YYYY-MM-DD HH24:MI:SS)"
},
"topup_amount" : {
"type" : "number",
"description" : "The top-up amount"
},
"voucher_info" : {
"$ref" : "#/components/schemas/VoucherInfo"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record. Not mandatory when the method that requires this structure is executed from the account realm"
},
"addon_priority" : {
"type" : "integer",
"description" : "The add-on product's precedence level. If there are more than one add-on products assigned to an account they will be sorted according to the specified precedence level. Possible values: 0 – Main product, 10 – Low, 15 – Medium low, 20 – Medium, 25 – Medium high, 30 – High"
},
"peak_level" : {
"type" : "integer",
"description" : "Possible values: 0 – The peak period; 1 – The off-peak period; 2 – The 2nd off-peak period"
},
"h323_conf_id" : {
"type" : "string",
"description" : "Custom data for third-party application processing"
},
"payment_info" : {
"$ref" : "#/components/schemas/AccountPaymentInfo"
}
}
},
"AddCustomerSubscriptionRequest" : {
"required" : [
"subscription_info",
"i_customer"
],
"type" : "object",
"properties" : {
"subscription_info" : {
"$ref" : "#/components/schemas/CustomerSubscriptionInfo"
},
"i_customer" : {
"type" : "integer",
"description" : "ID of customer record"
}
}
},
"NotificationInfo" : {
"required" : [
"name",
"i_notification"
],
"type" : "object",
"properties" : {
"sms_tpl_authorship" : {
"type" : "string",
"description" : "Specifies whether the SMS template used is default or has been modified. Possible values: System - default template, Custom - modified template."
},
"name" : {
"type" : "string",
"description" : "The name of the notification"
},
"i_notification_category" : {
"type" : "integer",
"description" : "The category ID"
},
"description" : {
"type" : "string",
"description" : "The description of the notidication"
},
"sms_template_name" : {
"type" : "string",
"description" : "The name of the SMS template"
},
"send_sms" : {
"type" : "integer",
"description" : "Specifies whether this notification will be sent by SMS. Possible values: 1 - The nofication will be sent by SMS, 0 - The notification will not be sent by SMS."
},
"send_mail" : {
"type" : "integer",
"description" : "Specifies whether this notification will be sent by email. Possible values: 1 - The nofication will be sent by email, 0 - The notification will not be sent by email."
},
"i_notification" : {
"type" : "integer",
"description" : "The unique ID of the notification"
},
"can_sms" : {
"type" : "integer",
"description" : "Specifies whether this template can be sent by SMS"
},
"category" : {
"type" : "string",
"description" : "The category of the notication"
},
"can_mail" : {
"type" : "integer",
"description" : "Specifies whether this template can be sent by email"
},
"mail_template_name" : {
"type" : "string",
"description" : "The name of the email template"
},
"mail_tpl_authorship" : {
"type" : "string",
"description" : "Specifies whether the email template used is default or has been modified. Possible values: System - default template, Custom - modified template."
}
}
},
"SendMeEnvNotificationSampleResponse" : {
"required" : [
"is_sent"
],
"type" : "object",
"properties" : {
"is_sent" : {
"type" : "integer",
"description" : "Specifies whether the notification was sent. Possible values: 1 – The notification was sent, 0 – The notification was not sent"
}
}
},
"UpdateTemplateDataFieldListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, exception in case of failure"
}
}
},
"AddUpdateRPConnectionRequest" : {
"required" : [
"rp_connection_info"
],
"type" : "object",
"properties" : {
"rp_connection_info" : {
"$ref" : "#/components/schemas/RPConnectionInfo"
}
}
},
"AccountGetAllowedAddonsRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "ID of account record"
}
}
},
"AddCommitmentRecurringTermResponse" : {
"type" : "object",
"properties" : {
"i_recurring_term" : {
"type" : "integer",
"description" : "The unique identifier of the record"
}
}
},
"SetSessionContextResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"AddUserRequest" : {
"required" : [
"user_info"
],
"type" : "object",
"properties" : {
"user_info" : {
"$ref" : "#/components/schemas/UserInfo"
}
}
},
"AllowedLocationInfo" : {
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"iso_3166_1_a2" : {
"type" : "string",
"description" : "A two-letter country code defined in ISO 3166-1 alpha-2"
},
"period_from" : {
"type" : "string",
"description" : "The start date and time of the allowed location"
},
"i_a_verified_locations" : {
"type" : "integer",
"description" : "The ID of the account's allowed location record"
},
"subscriber_ip" : {
"type" : "string",
"description" : "Subscriber IP address"
},
"period_to" : {
"type" : "string",
"description" : "The end date and time of the allowed location"
},
"verified_by" : {
"type" : "string",
"description" : "Mark shows whether the record was set by screening or by admin from web. Possible values: A, S"
}
}
},
"CloseCustomerSubscriptionResponse" : {
"required" : [
"i_customer_subscription"
],
"type" : "object",
"properties" : {
"i_customer_subscription" : {
"type" : "integer",
"description" : "1 in case of success, 0 in case of failure"
}
}
},
"DeleteCallBarringClassRequest" : {
"required" : [
"i_cp_condition"
],
"type" : "object",
"properties" : {
"i_cp_condition" : {
"type" : "integer",
"description" : "The unique ID of the call barring class"
}
}
},
"ReleaseSIMCardRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The ID of the account record"
}
}
},
"CustomerRestoreCustomerAfterImportRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "The ID of the customer"
}
}
},
"ArrayOfCalendarDateInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CalendarDateInfo"
}
},
"GetPaymentMethodsForOwnerResponse" : {
"type" : "object",
"properties" : {
"payment_methods" : {
"$ref" : "#/components/schemas/ArrayOfPaymentSystems"
}
}
},
"MatchDestinationGroupsRequest" : {
"required" : [
"number",
"get_prefixes_list",
"i_tariff"
],
"type" : "object",
"properties" : {
"number" : {
"type" : "string",
"description" : "A caller number for searching the appropriate destination group in the tariff"
},
"get_prefixes_list" : {
"type" : "integer",
"description" : "This indicates whether the list of destinations included in this group will be retrieved: 0 – retrieve, 1 – do not retrieve"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the special tariff containing destination groups"
}
}
},
"UpdateDIDGroupRequest" : {
"required" : [
"group_info"
],
"type" : "object",
"properties" : {
"group_info" : {
"$ref" : "#/components/schemas/DIDGroupInfo"
}
}
},
"CodecStorageKeysInfo" : {
"type" : "object",
"properties" : {
"u_law" : {
"type" : "string",
"description" : "Storage key for the codec u_law"
},
"mp3" : {
"type" : "string",
"description" : "Storage key for the codec mp3"
},
"a_law" : {
"type" : "string",
"description" : "Storage key for the codec a_law"
},
"g729" : {
"type" : "string",
"description" : "Storage key for the codec g729"
},
"g723" : {
"type" : "string",
"description" : "Storage key for the codec g723"
},
"wav" : {
"type" : "string",
"description" : "Storage key for the codec wav"
}
}
},
"ArrayOfReviewInvoiceInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ReviewInvoiceInfo"
}
},
"ArrayOfCustomerVdNotificationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/CustomerVdNotificationInfo"
}
},
"SyncXratesResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 for success, 0 for failure"
}
}
},
"UpdateUserUIConfigListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 is case of success, 0 in case of failure"
}
}
},
"GetDIDNumbersListRequest" : {
"type" : "object",
"properties" : {
"req_params" : {
"$ref" : "#/components/schemas/DIDRequestParameters"
},
"req_params_list" : {
"$ref" : "#/components/schemas/ArrayOfDIDRequestParametersInfo"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"did_provider_info" : {
"$ref" : "#/components/schemas/CustomerDIDProviderIdent"
},
"idle_only" : {
"type" : "string",
"description" : "Get the list of numbers in the DID Pool (Y/N), default - N"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"DestinationGetDestGroupAllowedPrefixesResponse" : {
"type" : "object",
"properties" : {
"prefixes" : {
"$ref" : "#/components/schemas/ANY"
},
"total" : {
"type" : "integer",
"description" : "The total number of the retrieved records"
}
}
},
"UpdateMerchantAccountResponse" : {
"required" : [
"i_merchant_account"
],
"type" : "object",
"properties" : {
"i_merchant_account" : {
"type" : "integer",
"description" : "The unique ID of the Merchant_Account record"
},
"merchant_account" : {
"$ref" : "#/components/schemas/MerchantAccount"
}
}
},
"ArrayOfExtendedDataObjectInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ExtendedDataObjectInfo"
}
},
"GetSpendingCounterListRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"period_from_start" : {
"type" : "string",
"description" : "The start date and time when the spending counter is activated"
},
"period_from_end" : {
"type" : "string",
"description" : "The end date and time when the spending counter is activated"
},
"period_to_start" : {
"type" : "string",
"description" : "The start date and time when the spending counter expires"
},
"period_to_end" : {
"type" : "string",
"description" : "The end date and time when the spending counter expires"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of retrieved records"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of the customer record"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
}
}
},
"DeleteCPRuleRequest" : {
"required" : [
"cp_rule_info"
],
"type" : "object",
"properties" : {
"cp_rule_info" : {
"$ref" : "#/components/schemas/CPRuleInfo"
}
}
},
"ProductCheckContentBasedChargingRequest" : {
"type" : "object",
"properties" : {
"i_product" : {
"type" : "integer",
"description" : "The unique ID of the product record"
},
"included_tariffs" : {
"$ref" : "#/components/schemas/ArrayOfUnsignedLong"
},
"i_access_policy" : {
"type" : "integer",
"description" : "The unique ID of the access policy"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan"
}
}
},
"AddUpdateCustomerSubscriptionResponse" : {
"required" : [
"i_customer_subscription"
],
"type" : "object",
"properties" : {
"i_customer_subscription" : {
"type" : "integer",
"description" : "ID of created/modified customer subscription record"
}
}
},
"GetVendorAccountInfoResponse" : {
"type" : "object",
"properties" : {
"vendor_account_info" : {
"$ref" : "#/components/schemas/VendorAccountInfo"
}
}
},
"ArrayOfResultBatchAddDestinationInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DestinationResultBatchAddDestinationInfo"
}
},
"DeleteVendorDIDProviderAccountRequest" : {
"required" : [
"i_did_provider_acc"
],
"type" : "object",
"properties" : {
"i_did_provider_acc" : {
"type" : "integer",
"description" : "The unique ID of the DID provider account"
}
}
},
"ArrayOfAccessPolicyInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/AccessPolicyInfo"
}
},
"AddUpdateSubresellerResponse" : {
"type" : "object",
"properties" : {
"i_customer" : {
"type" : "integer",
"description" : "ID of created / modified subreseller record"
}
}
},
"GetDIDInventoryOptionInfoResponse" : {
"type" : "object",
"properties" : {
"option_info" : {
"$ref" : "#/components/schemas/DIDInventoryOptionsInfo"
}
}
},
"GetMyInfoRequest" : {
"type" : "object"
},
"GetAccountStateRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"service_type" : {
"type" : "string",
"description" : "The name of the service type. Possible values: INTERNAL, SESSION, VOICE, DATA, NETACCESS, QUANTITY, WIFI, DIALUP, MSG, CONFERENCE. This property is mandatory if i_acc_state_type is not specified"
},
"i_acc_state_type" : {
"type" : "integer",
"description" : "The unique ID of the account state type: 1 – voice_fraud_suspicion. This property is mandatory if state_name and service_type are not specified"
},
"state_name" : {
"type" : "string",
"description" : "The name of the account state type. Possible value: voice_fraud_suspicion. This property is mandatory if i_acc_state_type is not specified"
}
}
},
"ArrayOfDIDGroupInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/DIDGroupInfo"
}
},
"GetAccessRoleTypeListResponse" : {
"required" : [
"access_role_types"
],
"type" : "object",
"properties" : {
"access_role_types" : {
"$ref" : "#/components/schemas/ArrayOfAccessRoleTypeInfo"
}
}
},
"ArrayOfEmergencyUnitInfo" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/EmergencyUnitInfo"
}
},
"GetBrandpaneArchiveResponse" : {
"type" : "object",
"properties" : {
"html_file_name" : {
"type" : "string",
"description" : "The path to the brandpane’s template - HTML file named 'brandpane.tmpl' (e.g. /brandpane/env_3/accounts/brandpane.tmpl"
},
"css_file_name" : {
"type" : "string",
"description" : "The path to the brandpane's style - CSS file (e.g. /brandpane/env_3/accounts/brandpane.css)"
}
}
},
"AddUpdateOwnerBatchRequest" : {
"required" : [
"owner_batch_info"
],
"type" : "object",
"properties" : {
"owner_batch_info" : {
"$ref" : "#/components/schemas/DIDOwnerBatchInfo"
}
}
},
"GetTaxPluginRequest" : {
"required" : [
"i_billing_processor"
],
"type" : "object",
"properties" : {
"i_billing_processor" : {
"type" : "integer",
"description" : "The unique ID of the taxation plugin database record"
},
"check_usage" : {
"type" : "integer",
"description" : "Check whether the taxation plugin was assigned to any entity"
},
"with_parameters" : {
"type" : "integer",
"description" : "If set to '1', the list of the taxation plugin parameters will be provided in the response"
}
}
},
"GetUsedLocationListRequest" : {
"required" : [
"i_account"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved used locations"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list"
},
"group_by_ip" : {
"type" : "integer",
"description" : "Group usage locations by their subscriber ip"
}
}
},
"UpdateDIDNumberResponse" : {
"required" : [
"i_did_number"
],
"type" : "object",
"properties" : {
"i_did_number" : {
"type" : "integer",
"description" : "The unique ID of the DID number"
}
}
},
"UpdateCustomerClassNotificationListResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "A non-zero value means that the operation was completed"
}
}
},
"ArrayOfCustomTaxationOptions" : {
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/TaxationOptionsCustom"
}
},
"ReapplyProductSubscriptionsResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 in case of success, 0 in case of failure"
}
}
},
"DeleteRPConnectionResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 if operation is successful, 0 if not"
}
}
},
"SipStatusInfo" : {
"type" : "object",
"properties" : {
"flags" : {
"type" : "integer",
"description" : "1 - UA is behind NAT"
},
"user_agent" : {
"type" : "string",
"description" : "User agent identification info"
},
"last_modified" : {
"type" : "string",
"description" : "Date and time the register request was received"
},
"contact" : {
"type" : "string",
"description" : "URI of the user agent which the SIP Proxy uses to contact the IP phone"
},
"username" : {
"type" : "string",
"description" : "Username of registered account; same as account's id attribute from AccountInfo"
},
"domain" : {
"type" : "string",
"description" : "Domain of the registrar: IP address and, if port is non-standard, port number (after the colon)"
},
"callid" : {
"type" : "string",
"description" : "Call-id of the register request"
},
"expires" : {
"type" : "string",
"description" : "Date and time this registration will expire"
}
}
},
"AccountEstimateCallPriceRequest" : {
"required" : [
"number"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the owner account"
},
"number" : {
"type" : "string",
"description" : "A number to estimate the call price for"
},
"rating_context" : {
"type" : "string",
"description" : "An abstract string with rating context information. For example: 'i_service_type=3,i_node=1,accessCode=ANY,selectCode=ANY,oliCode=0'"
}
}
},
"TransferAssignedCommitmentRecordRequest" : {
"required" : [
"i_account_commitment",
"i_account_to"
],
"type" : "object",
"properties" : {
"i_account_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the account commitment record"
},
"i_new_commitment" : {
"type" : "integer",
"description" : "The unique identifier of the new commitment if the old one should be replaced"
},
"apply_transfer_fee" : {
"type" : "string",
"description" : "The flag specifies whether the transfer fee should be applied"
},
"i_account_to" : {
"type" : "integer",
"description" : "The identifier of the account to move the commitment to"
}
}
},
"GetRatingGroupInfoResponse" : {
"type" : "object",
"properties" : {
"rating_group_info" : {
"$ref" : "#/components/schemas/RatingGroupInfo"
}
}
},
"CounterThresholdModifiersInfo" : {
"type" : "object",
"properties" : {
"threshold_multiplier" : {
"type" : "number",
"description" : "The multiplication modifier for thresholds on prorated counter"
},
"threshold_shift" : {
"type" : "number",
"description" : "The additive modifier for thresholds on the shifted base (rolled over) counter"
}
}
},
"GetExtensionsListInfoResponse" : {
"type" : "object",
"properties" : {
"total" : {
"type" : "integer",
"description" : "The number of entries"
},
"extensions_list" : {
"$ref" : "#/components/schemas/ArrayOfExtensionsInfo"
}
}
},
"GetAccountRoleInfoResponse" : {
"type" : "object",
"properties" : {
"role_info" : {
"$ref" : "#/components/schemas/AccountRoleInfo"
}
}
},
"DeleteSpendingConstraintRequest" : {
"required" : [
"i_sp_constraint"
],
"type" : "object",
"properties" : {
"i_sp_constraint" : {
"type" : "integer",
"description" : "The identifier of the spending constraint"
}
}
},
"UpdateRateGroupResponse" : {
"required" : [
"i_rate_list"
],
"type" : "object",
"properties" : {
"i_rate_list" : {
"$ref" : "#/components/schemas/ArrayOfInt"
}
}
},
"ValidateCustomerInfoResponse" : {
"type" : "object",
"properties" : {
"customer_info" : {
"$ref" : "#/components/schemas/CustomerInfo"
}
}
},
"AddVDThresholdResponse" : {
"type" : "object",
"properties" : {
"i_vd_threshold" : {
"type" : "integer",
"description" : "The unique ID of the threshold added for a specific discount"
}
}
},
"VdDestGroupInfo" : {
"type" : "object",
"properties" : {
"ratio" : {
"type" : "integer",
"description" : "Billing:Base Ratio. If billing units are different from base units, this parameter defines how many base units make up one billing unit (for instance, 1024 bytes makes 1 kilobyte). This parameter is extremely important, as it affects calculations in all xDRs for this service. If you decide to deploy a new service with a different ratio between units (e.g. 1 kilobyte equaling 1000 bytes), a new service type must be created before you attempt to do any further configuration"
},
"destination_group_name" : {
"type" : "string",
"description" : "Destination group name"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"i_service" : {
"type" : "integer",
"description" : "The unique ID of the service"
},
"rate_unit" : {
"type" : "string",
"description" : "A customer-visible name for the units used to calculate service charges (e.g. message, minute)"
},
"discount_plan_name" : {
"type" : "string",
"description" : "Discount plan name"
},
"i_vd_type" : {
"type" : "integer",
"description" : "The unique ID of the discount type. Possible values: 1 - Discount; 2 - Quota"
},
"service_name" : {
"type" : "string",
"description" : "The name of the service"
},
"unit" : {
"type" : "string",
"description" : "A customer-visible name for the units in which volume discount use is measured"
},
"threshold_type" : {
"type" : "string",
"description" : "The type of the volume discount plan coounter threshold"
},
"usage_period" : {
"type" : "integer",
"description" : "This defines how often the volume discount is reset"
},
"peak_level" : {
"type" : "string",
"description" : "An ID of the peak level: 0 - Peak period; 1 - Off-peak period; 2 - Second off-peak period"
},
"i_vd_dg" : {
"type" : "integer",
"description" : "The unique ID of the volume discount record"
},
"discount_type" : {
"type" : "string",
"description" : "Volume discount type"
},
"i_vd_plan" : {
"type" : "integer",
"description" : "The unique ID of the volume discount plan record"
}
}
},
"DeleteProductGroupResponse" : {
"required" : [
"success"
],
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "Returns 1 in case of success, 0 in case of failure"
}
}
},
"GetCQMohFileRequest" : {
"required" : [
"i_c_queue"
],
"type" : "object",
"properties" : {
"i_c_queue" : {
"type" : "integer",
"description" : "The unique record of a call queue"
}
}
},
"NodeInfo" : {
"type" : "object",
"properties" : {
"ip" : {
"type" : "string",
"description" : "The IP address of the node"
},
"i_node" : {
"type" : "integer",
"description" : "The unique ID of the node"
},
"i_node_type" : {
"type" : "integer",
"description" : "The unique ID of the node type"
},
"diameter_realm" : {
"type" : "string",
"description" : "This is the realm for all Diameter interactions"
},
"radius_key" : {
"type" : "string",
"description" : "This is the authentication key for all Radius interactions"
},
"rtpp_level" : {
"type" : "integer",
"description" : "Describes the NAT traversal capabilities of this node"
},
"voip_user_name" : {
"type" : "string",
"description" : "Defines which parameters should be used to identify the account the call should be billed to (applies to calls that arrived from the IP network)"
},
"pod_server" : {
"type" : "string",
"description" : "This enables the event-triggered interaction with the RFC 3576-based service controlling the network sessions on the NAS. Possible values: 'Y', 'N'"
},
"cld_translation_rule" : {
"type" : "string",
"description" : "The authentication translation rule used to transform a dialed phone number into the E.164 format used in PortaBilling"
},
"pod_port" : {
"type" : "integer",
"description" : "The internet UDP port to which requests are sent"
},
"is_used" : {
"type" : "integer",
"description" : "Shows whether the node is in use"
},
"h323_id" : {
"type" : "string",
"description" : "For a VoIP node, this is equivalent to a hostname for an internet server (e.g. mail1.cyberdyne.com), i.e. a descriptive, human-readable name used for identification purposes"
},
"telephony_user_name" : {
"type" : "string",
"description" : "Defines which parameters should be used to identify the account the call should be billed to (applies to calls that arrived from PSTN network)"
},
"pod_shared_key" : {
"type" : "string",
"description" : "A shared secret used for requests authentication"
},
"name" : {
"type" : "string",
"description" : "The logical name of the node"
},
"aaa_protocol" : {
"type" : "string",
"description" : "Describes the AAA protocol used to communicate with the node. Possible values: 'disabled', 'RADIUS', 'DIAMETER'"
},
"pod_radius_ip" : {
"type" : "string",
"description" : "The IP address for the RADIUS RFC 3576 server to which requests are sent"
},
"notepad" : {
"type" : "string",
"description" : "Node notepad"
},
"radius_source_ip" : {
"type" : "string",
"description" : "If more than one interface can be present on the node, specifies the IP address of the one that communicates with the Radius server"
},
"i_time_zone" : {
"type" : "integer",
"description" : "The unique ID for the node's time zone"
}
}
},
"UserNotificationInfo" : {
"type" : "object",
"properties" : {
"send_sms" : {
"type" : "integer",
"description" : "Specifies whether this notification will be sent by sms. Possible values: 1 – The notification will be sent by sms, 0 – The notification will not be sent by sms"
},
"send_mail" : {
"type" : "integer",
"description" : "Specifies whether this notification will be sent by email. Possible values: 1 – The notification will be sent by email, 0 – The notification will not be sent by email"
},
"i_notification" : {
"type" : "integer",
"description" : "The unique ID of the notification"
}
}
},
"GetAccountVdCounterHistoryListRequest" : {
"required" : [
"i_avd_counter"
],
"type" : "object",
"properties" : {
"get_total" : {
"type" : "integer",
"description" : "Include the total number of records"
},
"i_xdr" : {
"type" : "integer",
"description" : "The ID of the XDR record from CDR_Accounts table"
},
"limit" : {
"type" : "integer",
"description" : "The number of records to retrieve"
},
"i_avd_counter" : {
"type" : "integer",
"description" : "The ID of the Counter record from Account_VD_Counters table"
},
"offset" : {
"type" : "integer",
"description" : "The number of records to skip at the beginning"
}
}
},
"GetVoiceQualityProfileListResponse" : {
"required" : [
"profile_list"
],
"type" : "object",
"properties" : {
"profile_list" : {
"$ref" : "#/components/schemas/ArrayOfVoiceQualityProfileInfo"
},
"total" : {
"type" : "integer",
"description" : "The total number of voice quality profiles found"
}
}
},
"GetCustomXdrReportRequest" : {
"required" : [
"i_customer"
],
"type" : "object",
"properties" : {
"file_name" : {
"type" : "string",
"description" : "The name of the report file (the unique report ID)"
},
"i_customer" : {
"type" : "integer",
"description" : "The unique ID of a customer record. Not mandatory when the method that requires this structure is executed from the retail customer realm"
}
}
},
"DIDMarkupOptionsInfo" : {
"type" : "object",
"properties" : {
"i_vendor" : {
"type" : "integer",
"description" : "The unique ID of the Vendor record"
},
"rounding" : {
"type" : "integer",
"description" : "Quantity of digits after point for rounding"
},
"periodic_fee_markup" : {
"type" : "integer",
"description" : "A monthly fee markup charged from Customer or Reseller for the DID number."
},
"external_provisioning" : {
"type" : "string",
"description" : "On-Demand provisioning from External Vendor active (Y/N), default - N"
},
"activation_fee" : {
"type" : "number",
"description" : "A one-time cost paid by Customer or Reseller for the DID number activation."
},
"base_periodic_fee" : {
"type" : "number",
"description" : "A monthly amount charged from Customer or Reseller for the DID number."
}
}
},
"MCCInfo" : {
"type" : "object",
"properties" : {
"iso_3166_1_a2" : {
"type" : "string",
"description" : "Country identifier in ISO-3166-1-A2 format"
},
"name" : {
"type" : "string",
"description" : "Country name"
},
"mcc" : {
"type" : "string",
"description" : "Mobile Country Code"
}
}
},
"GetAccountSWXDRListRequest" : {
"required" : [
"from_date",
"i_account",
"to_date"
],
"type" : "object",
"properties" : {
"with_aux_xdrs" : {
"type" : "integer",
"description" : "Includes the array of auxiliary xDRs to the retrieved XDRs list"
},
"history_pattern" : {
"type" : "string",
"description" : "Specifies whether to show xDRs with history that matches the pattern"
},
"i_dest_group" : {
"type" : "integer",
"description" : "The unique ID of the destination group"
},
"with_usage" : {
"type" : "integer",
"description" : "Includes usage records to the retrieved XDRs list"
},
"from_date" : {
"type" : "string",
"description" : "Get xDRs with bill_time starting from this date"
},
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the account record. Not mandatory when the method that requires this structure is executed from the account realm"
},
"connect_time_before" : {
"type" : "string",
"description" : "Get xDRs with connect_time before this date"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of the retrieved xDRs"
},
"limit" : {
"type" : "integer",
"description" : "The number of rows to retrieve. Mandatory for an API request with the offset property specified"
},
"connect_time_after" : {
"type" : "string",
"description" : "Get xDRs with connect_time after this date"
},
"offset" : {
"type" : "integer",
"description" : "The number of rows to skip at the beginning of the list. Requires the limit property to be specified in the API request"
},
"to_date" : {
"type" : "string",
"description" : "Get XDRs with bill_time before this date"
}
}
},
"ScheduleTariffCloningRequest" : {
"required" : [
"name",
"i_tariff"
],
"type" : "object",
"properties" : {
"managed_by" : {
"type" : "integer",
"description" : "The unique ID of the reseller who will own the cloned tariff. Leave the field empty for an admin tariff"
},
"name" : {
"type" : "string",
"description" : "The name of the cloned tariff"
},
"i_tariff" : {
"type" : "integer",
"description" : "The unique ID of the tariff that will be cloned"
}
}
},
"GetPhoneBookListRequest" : {
"required" : [
"i_account",
"limit",
"offset"
],
"type" : "object",
"properties" : {
"i_account" : {
"type" : "integer",
"description" : "The unique ID of the owner account. Not mandatory when the method that requires this structure is executed from the account realm"
},
"phone_number_pattern" : {
"type" : "string",
"description" : "Phone Number Pattern (default is %)"
},
"get_total" : {
"type" : "integer",
"description" : "Get the total number of Phone book records"
},
"limit" : {
"type" : "integer",
"description" : "Limit of Phonebook records (the maximum quantity of Phonebook records, number of rows to retrieve)"
},
"offset" : {
"type" : "integer",
"description" : "Starting position for a Phonebook list (number of rows to skip at the beginning of the list)"
}
}
},
"GenericGetCommonInfoRequest" : {
"type" : "object"
},
"GetDateListResponse" : {
"required" : [
"date_list"
],
"type" : "object",
"properties" : {
"date_list" : {
"$ref" : "#/components/schemas/ArrayOfCalendarDateInfo"
}
}
},
"ReserveDIDNumberResponse" : {
"type" : "object",
"properties" : {
"success" : {
"type" : "integer",
"description" : "1 - success, 0 - failure"
},
"timestamp" : {
"type" : "string",
"description" : "Time stamp of reservation"
}
}
},
"GetRateInfoRequest" : {
"required" : [
"i_rate"
],
"type" : "object",
"properties" : {
"i_rate" : {
"type" : "integer",
"description" : "The unique ID of the rate record"
}
}
}
}
},
"openapi" : "3.0.2",
"servers" : [
{
"url" : "https://portabilling-web.yourdomain.com",
"description" : "The PortaBilling web server"
}
],
"tags" : [
{
"name" : "ACL | ACL management"
},
{
"name" : "AccessControl | Access control management"
},
{
"name" : "AccessPolicy | Access policy management"
},
{
"name" : "AccessRole | Access role management"
},
{
"name" : "AccessRole | Internal"
},
{
"name" : "Account | Account management"
},
{
"name" : "Account | Account role management"
},
{
"name" : "Account | Alias management"
},
{
"name" : "Account | Async API notification management"
},
{
"name" : "Account | Auto-payment management"
},
{
"name" : "Account | Batch management"
},
{
"name" : "Account | Call barring rules management"
},
{
"name" : "Account | Call screening management"
},
{
"name" : "Account | Commitment management"
},
{
"name" : "Account | Custom field management"
},
{
"name" : "Account | Favourites list management"
},
{
"name" : "Account | Follow-me settings management"
},
{
"name" : "Account | Fraud condition management"
},
{
"name" : "Account | IP device assignment management"
},
{
"name" : "Account | Information and statistics management"
},
{
"name" : "Account | Internal"
},
{
"name" : "Account | Location management"
},
{
"name" : "Account | Payment and topup management"
},
{
"name" : "Account | Phonebook management"
},
{
"name" : "Account | SIM card management"
},
{
"name" : "Account | Service features management"
},
{
"name" : "Account | Subscription management"
},
{
"name" : "Account | Transaction management"
},
{
"name" : "Account | Volume discount management"
},
{
"name" : "AsyncRequest | API notification management"
},
{
"name" : "AsyncRequest | Asynchronous request management"
},
{
"name" : "AuthzRule | Authorization rule management"
},
{
"name" : "BillingSession | Billing session management"
},
{
"name" : "BillingSession | Call recording management"
},
{
"name" : "BillingSession | Internet session management"
},
{
"name" : "BrandPane | Brand pane management"
},
{
"name" : "Brandpane | Brandpane management"
},
{
"name" : "BundlePromotion | Bundle promotion management"
},
{
"name" : "BundlePromotion | Criterium management"
},
{
"name" : "CCStaff | CC staff management"
},
{
"name" : "CDR | Call recording management"
},
{
"name" : "CDR | Disconnect reason management"
},
{
"name" : "CDR | XDR management"
},
{
"name" : "Calendar | Calendar management"
},
{
"name" : "CallBarring | Call barring class management"
},
{
"name" : "CallBarring | Call barring options management"
},
{
"name" : "CodecConverter | Codec converter file management"
},
{
"name" : "CommissionPlan | Commission plan management"
},
{
"name" : "Commitment | Commitment management"
},
{
"name" : "ContentBasedCharging | Marketing group management"
},
{
"name" : "ContentBasedCharging | Rating group management"
},
{
"name" : "Currency | Currencies exchange management"
},
{
"name" : "Currency | Currency management"
},
{
"name" : "CustomFields | Custom field management"
},
{
"name" : "Customer | Abbreviated dialing number management"
},
{
"name" : "Customer | Account batch management"
},
{
"name" : "Customer | Async API notification management"
},
{
"name" : "Customer | Auto-payment management"
},
{
"name" : "Customer | Call barring rule management"
},
{
"name" : "Customer | Call queue management"
},
{
"name" : "Customer | Custom field management"
},
{
"name" : "Customer | Customer management"
},
{
"name" : "Customer | Extension management"
},
{
"name" : "Customer | Huntgroup management"
},
{
"name" : "Customer | Information and statistics management"
},
{
"name" : "Customer | Internal"
},
{
"name" : "Customer | Measured service management"
},
{
"name" : "Customer | Payments, taxation and invoice management"
},
{
"name" : "Customer | Service features management"
},
{
"name" : "Customer | Site management"
},
{
"name" : "Customer | Spending counter management"
},
{
"name" : "Customer | Subscription management"
},
{
"name" : "Customer | Support request management"
},
{
"name" : "Customer | Transaction management"
},
{
"name" : "Customer | Voice prompt management"
},
{
"name" : "Customer | Volume discount management"
},
{
"name" : "CustomerClass | Business model management"
},
{
"name" : "CustomerClass | Customer class management"
},
{
"name" : "CustomerClass | Notification template management"
},
{
"name" : "CustomerClass | Payments, taxation and invoice management"
},
{
"name" : "DID | Assignment management"
},
{
"name" : "DID | DID number management"
},
{
"name" : "DID | Group management"
},
{
"name" : "DID | Inventory management"
},
{
"name" : "DID | Pricing batch management"
},
{
"name" : "DID | Vendor batch management"
},
{
"name" : "DID_Provider | DID auto-provisioning management"
},
{
"name" : "Destination | Destination group management"
},
{
"name" : "Destination | Destination group set management"
},
{
"name" : "Destination | Destination management"
},
{
"name" : "Destination | Internal"
},
{
"name" : "DialingRule | Dialing rule management"
},
{
"name" : "DiscountPlan | Discount management"
},
{
"name" : "DiscountPlan | Discount plan management"
},
{
"name" : "DiscountPlan | Threshold management"
},
{
"name" : "DiscountPlan | Topup option management"
},
{
"name" : "DiscountPlan | Transaction management"
},
{
"name" : "EmergencyUnit | Emergency routing unit management"
},
{
"name" : "Env | Custom field management"
},
{
"name" : "Env | Custom tax management"
},
{
"name" : "Env | Environment management"
},
{
"name" : "Env | Notification template management"
},
{
"name" : "Generic | Billing period management"
},
{
"name" : "Generic | Currency management"
},
{
"name" : "Generic | Extended information management"
},
{
"name" : "Generic | Generic information management"
},
{
"name" : "Generic | Internal"
},
{
"name" : "Generic | None"
},
{
"name" : "Generic | Time zone management"
},
{
"name" : "IPTV | Channel package management"
},
{
"name" : "IPTV | Service package management"
},
{
"name" : "IVRApplications | Access number management"
},
{
"name" : "IVRApplications | Application management"
},
{
"name" : "IVRApplications | IVR user application management"
},
{
"name" : "Invoice | Internal"
},
{
"name" : "Invoice | Invoice management"
},
{
"name" : "Invoice | Template management"
},
{
"name" : "MOH | Music on hold file management"
},
{
"name" : "MeasuredServices | Customer class metric management"
},
{
"name" : "MeasuredServices | Customer metric management"
},
{
"name" : "MeasuredServices | Measured metric management"
},
{
"name" : "MeasuredServices | Measured service management"
},
{
"name" : "Metric | Measured metric management"
},
{
"name" : "Metric | Measured service management"
},
{
"name" : "Metric | System metric management"
},
{
"name" : "NegotiatedFeatures | Negotiated feature management"
},
{
"name" : "Node | Node management"
},
{
"name" : "Notification | Notification management"
},
{
"name" : "NumberPorting | Number porting management"
},
{
"name" : "OLI | OLI management"
},
{
"name" : "OffPeak | Off-peak period management"
},
{
"name" : "Payment | Merchant account management"
},
{
"name" : "Payment | Payment method management"
},
{
"name" : "Payment | Processor management"
},
{
"name" : "Payment | Transaction management"
},
{
"name" : "Product | Group management"
},
{
"name" : "Product | Internal"
},
{
"name" : "Product | Product management"
},
{
"name" : "Product | Service and rating management"
},
{
"name" : "Product | Subscription management"
},
{
"name" : "QuickForms | Field management"
},
{
"name" : "QuickForms | Quick form management"
},
{
"name" : "Rate | Group management"
},
{
"name" : "Rate | Internal"
},
{
"name" : "Rate | Rate management"
},
{
"name" : "Report | ASR report management"
},
{
"name" : "Report | Cost/Revenue report management"
},
{
"name" : "Representative | Information and statistics management"
},
{
"name" : "Representative | Representative management"
},
{
"name" : "Representative | Transaction management"
},
{
"name" : "RoamingProfile | Roaming profile management"
},
{
"name" : "RouteCategories | Route category management"
},
{
"name" : "RoutingCriteria | Destination group management"
},
{
"name" : "RoutingCriteria | Routing criteria management"
},
{
"name" : "RoutingPlan | Custom routing management"
},
{
"name" : "RoutingPlan | Route category management"
},
{
"name" : "RoutingPlan | Routing plan management"
},
{
"name" : "SIMCard | SIM card management"
},
{
"name" : "Service | Service management"
},
{
"name" : "Service | Service pool management"
},
{
"name" : "Service | Type management"
},
{
"name" : "ServiceFeatures | Service feature management"
},
{
"name" : "ServicePolicy | Service policy management"
},
{
"name" : "Session | Authenticated session management"
},
{
"name" : "Subscription | Subscription management"
},
{
"name" : "Tariff | Information and statistics management"
},
{
"name" : "Tariff | Override tariff rule management"
},
{
"name" : "Tariff | Reseller tariff management"
},
{
"name" : "Tariff | Tariff management"
},
{
"name" : "TaxationPlugin | Code management"
},
{
"name" : "TaxationPlugin | Internal"
},
{
"name" : "TaxationPlugin | Taxation plugin management"
},
{
"name" : "Template | Internal"
},
{
"name" : "Template | Template management"
},
{
"name" : "TimePeriod | Time period management"
},
{
"name" : "TraceSession | Session information management"
},
{
"name" : "TrafficProfile | Alert management"
},
{
"name" : "TrafficProfile | Constraint management"
},
{
"name" : "TrafficProfile | Fraud traffic management"
},
{
"name" : "TrafficProfile | Profile management"
},
{
"name" : "TransferTo | Mobile remittance transaction management"
},
{
"name" : "UA | Internal"
},
{
"name" : "UA | Inventory management"
},
{
"name" : "UA | Profile management"
},
{
"name" : "UA | UA device management"
},
{
"name" : "UA | UA device type management"
},
{
"name" : "UAProfileGenerator | UA profile management"
},
{
"name" : "User | Generic information management"
},
{
"name" : "User | Internal"
},
{
"name" : "User | Notification template management"
},
{
"name" : "User | User management"
},
{
"name" : "Vendor | Connection management"
},
{
"name" : "Vendor | Connection type management"
},
{
"name" : "Vendor | DID provider account management"
},
{
"name" : "Vendor | Information and statistics management"
},
{
"name" : "Vendor | Transaction management"
},
{
"name" : "Vendor | Vendor account management"
},
{
"name" : "Vendor | Vendor management"
},
{
"name" : "VoiceQualityProfile | Voice quality profile management"
},
{
"name" : "WebLog | Web log management"
},
{
"name" : "XDRMediator | XDR Mediator management"
}
],
"paths" : {
"/CommissionPlan/get_commission_plan_info" : {
"post" : {
"operationId" : "CommissionPlan:get_commission_plan_info",
"summary" : "get_commission_plan_info - This method allows an API user to get a commission plan record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCommissionPlanInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommissionPlanInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommissionPlanInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CommissionPlan | Commission plan management"
]
}
},
"/IVRApplications/get_supported_language_list" : {
"post" : {
"operationId" : "IVRApplications:get_supported_language_list",
"summary" : "get_supported_language_list - This method enables an API user to get the list of available languages for voice applications",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSupportedLanguageResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSupportedLanguageRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSupportedLanguageRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Application management"
]
}
},
"/Account/get_vd_notification_list" : {
"post" : {
"operationId" : "Account:get_vd_notification_list",
"summary" : "get_vd_notification_list - The method enables an API user to retrieve the list of volume discount notifications for the account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountVdNotificationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountVdNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountVdNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/Rate/batch_add_rate" : {
"post" : {
"operationId" : "Rate:batch_add_rate",
"summary" : "batch_add_rate - This method allows an API user to add a new rates for a destination in batch mode",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchAddRateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/BatchAddRateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/BatchAddRateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Rate management"
]
}
},
"/Customer/delete_batch" : {
"post" : {
"operationId" : "Customer:delete_batch",
"summary" : "delete_batch - This method allows an API user to delete the existing batch",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Account batch management"
]
}
},
"/Customer/add_customer_huntgroup" : {
"post" : {
"operationId" : "Customer:add_customer_huntgroup",
"summary" : "add_customer_huntgroup - This method allows a retail customer to create a huntgroup",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerHuntgroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/AddCustomerHuntgroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/AddCustomerHuntgroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Huntgroup management"
]
}
},
"/Account/get_custom_fields_values" : {
"post" : {
"operationId" : "Account:get_custom_fields_values",
"summary" : "get_custom_fields_values - This method allows an API user to get the list of account's custom fields",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountCustomFieldsValuesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountCustomFieldsValuesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountCustomFieldsValuesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Custom field management"
]
}
},
"/RoamingProfile/get_roaming_profile_list" : {
"post" : {
"operationId" : "RoamingProfile:get_roaming_profile_list",
"summary" : "get_roaming_profile_list - This method enables an API user to get the list of roaming profiles",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRoamingProfileListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoamingProfileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoamingProfileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoamingProfile | Roaming profile management"
]
}
},
"/QuickForms/update_quick_form" : {
"post" : {
"operationId" : "QuickForms:update_quick_form",
"summary" : "update_quick_form - This method enables an API user to update the quick form",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateQFResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateQFRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateQFRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"QuickForms | Quick form management"
]
}
},
"/XDRMediator/download_collection_skipped_xdrs" : {
"post" : {
"operationId" : "XDRMediator:download_collection_skipped_xdrs",
"summary" : "download_collection_skipped_xdrs - This method enables an API user to get a file with the list of xDRs rejected due to parsing errors",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DownloadCollectionSkippedXDRsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DownloadCollectionSkippedXDRsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DownloadCollectionSkippedXDRsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"XDRMediator | XDR Mediator management"
]
}
},
"/DID_Provider/provision_number" : {
"post" : {
"operationId" : "DID_Provider:provision_number",
"summary" : "provision_number - This method allows an API user to allocate a DID number from the provider. If DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProvisionDIDResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProvisionDIDRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProvisionDIDRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID_Provider | DID auto-provisioning management"
]
}
},
"/Account/get_scheduled_commitment_record_replacement_info" : {
"post" : {
"operationId" : "Account:get_scheduled_commitment_record_replacement_info",
"summary" : "get_scheduled_commitment_record_replacement_info - The method enables an API user to get the information about a scheduled commitment replacement",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetScheduledCommitmentRecordReplacementResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetScheduledCommitmentRecordReplacementRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetScheduledCommitmentRecordReplacementRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/Account/get_used_vd_dest_group_list" : {
"post" : {
"operationId" : "Account:get_used_vd_dest_group_list",
"summary" : "get_used_vd_dest_group_list - This method enables an API user to obtain information about the volume discount destination groups used by the account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountUsedVdDestGroupListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountUsedVdDestGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountUsedVdDestGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Volume discount management"
]
}
},
"/MeasuredServices/delete_measured_metric" : {
"post" : {
"operationId" : "MeasuredServices:delete_measured_metric",
"summary" : "delete_measured_metric - This method enables an API user to delete a measured metric",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteMeasuredMetricResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteMeasuredMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteMeasuredMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Measured metric management"
]
}
},
"/CustomFields/delete_custom_field" : {
"post" : {
"operationId" : "CustomFields:delete_custom_field",
"summary" : "delete_custom_field - This method enables an API user to delete a custom field",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomFieldResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomFieldRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomFieldRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomFields | Custom field management"
]
}
},
"/WebLog/add_note" : {
"post" : {
"operationId" : "WebLog:add_note",
"summary" : "add_note - This method enables an API user to manually add an entry into an entity's web log",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddNoteResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddNoteRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddNoteRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"WebLog | Web log management"
]
}
},
"/UA/get_ua_info" : {
"post" : {
"operationId" : "UA:get_ua_info",
"summary" : "get_ua_info - This method enables an API user (administrator or reseller) to get the information about a UA device (IP phone) in the IP phone inventory",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUAInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUAInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUAInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | UA device management"
]
}
},
"/CallBarring/delete_call_barring_class" : {
"post" : {
"operationId" : "CallBarring:delete_call_barring_class",
"summary" : "delete_call_barring_class - This method enables an API user to delete a call barring class record from the DB",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCallBarringClassResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCallBarringClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCallBarringClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CallBarring | Call barring class management"
]
}
},
"/Customer/mark_xdr_out_of_turn" : {
"post" : {
"operationId" : "Customer:mark_xdr_out_of_turn",
"summary" : "mark_xdr_out_of_turn - This method allows an administrator to include a transaction on an out-of-turn invoice to be issued on demand",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MarkXdrOutOfTurnResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MarkXdrOutOfTurnRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MarkXdrOutOfTurnRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/DiscountPlan/update_topup_option" : {
"post" : {
"operationId" : "DiscountPlan:update_topup_option",
"summary" : "update_topup_option - This method allows an API user to update a topup option",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateVDTopupOptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVDTopupOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVDTopupOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Topup option management"
]
}
},
"/VoiceQualityProfile/update_profile" : {
"post" : {
"operationId" : "VoiceQualityProfile:update_profile",
"summary" : "update_profile - This method enables an API user to update a voice quality profile information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateVoiceQualityProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVoiceQualityProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVoiceQualityProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"VoiceQualityProfile | Voice quality profile management"
]
}
},
"/Metric/get_system_metric_data" : {
"post" : {
"operationId" : "Metric:get_system_metric_data",
"summary" : "get_system_metric_data - This method enables an API user to get data related to the selected system metrics",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSystemMetricDataResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSystemMetricDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSystemMetricDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Metric | System metric management"
]
}
},
"/CDR/get_netaccess_usage_record_list" : {
"post" : {
"operationId" : "CDR:get_netaccess_usage_record_list",
"summary" : "get_netaccess_usage_record_list - The method enables an API user to fetch detailed information about net access usage related to accounts' xDR(s)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNetaccessUsageRecordListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNetaccessUsageRecordListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNetaccessUsageRecordListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CDR | XDR management"
]
}
},
"/Destination/get_dest_group_info" : {
"post" : {
"operationId" : "Destination:get_dest_group_info",
"summary" : "get_dest_group_info - This method allows an API user to get information about a destination group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDestGroupInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestGroupInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestGroupInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group management"
]
}
},
"/DID/delete_vendor_batch" : {
"post" : {
"operationId" : "DID:delete_vendor_batch",
"summary" : "delete_vendor_batch - This method enables an API user to delete a vendor DID batch",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteVendorBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVendorBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVendorBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Vendor batch management"
]
}
},
"/Tariff/get_override_tariff_list" : {
"post" : {
"operationId" : "Tariff:get_override_tariff_list",
"summary" : "get_override_tariff_list - This method allows an API user to retrieve the list of override tariffs for a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetOverrideTariffListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOverrideTariffListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOverrideTariffListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Override tariff rule management"
]
}
},
"/Account/get_subscriptions" : {
"post" : {
"operationId" : "Account:get_subscriptions",
"summary" : "get_subscriptions - This method allows an API user to get the list of subscription records associated with an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountSubscriptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Subscription management"
]
}
},
"/User/get_ui_config_list" : {
"post" : {
"operationId" : "User:get_ui_config_list",
"summary" : "get_ui_config_list - This method enables an API user to get the list of the UI configs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUserUIConfigListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserUIConfigListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserUIConfigListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | Generic information management"
]
}
},
"/Customer/add_subreseller" : {
"post" : {
"operationId" : "Customer:add_subreseller",
"summary" : "add_subreseller - This method enables an API user to create a new subreseller record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateSubresellerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddSubresellerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddSubresellerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/Env/send_me_notification_sample" : {
"post" : {
"operationId" : "Env:send_me_notification_sample",
"summary" : "send_me_notification_sample - This method allows an API user to \"test\" the notification by sending a message sample to their email address or phone number. The notification is sent to the user that is currently logged in",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SendMeEnvNotificationSampleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SendMeEnvNotificationSampleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SendMeEnvNotificationSampleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Notification template management"
]
}
},
"/Commitment/get_commitment_list" : {
"post" : {
"operationId" : "Commitment:get_commitment_list",
"summary" : "get_commitment_list - The method enables an API user to get a set of commitment records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCommitmentListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommitmentListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommitmentListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/Customer/add_callqueue" : {
"post" : {
"operationId" : "Customer:add_callqueue",
"summary" : "add_callqueue - This method enables an API user to add the call queue to a hunt group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCallQueueResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/AddCallQueueRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/AddCallQueueRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Call queue management"
]
}
},
"/Customer/update_customer_huntgroup" : {
"post" : {
"operationId" : "Customer:update_customer_huntgroup",
"summary" : "update_customer_huntgroup - This method allows a retail customer to modify a huntgroup",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerHuntgroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerHuntgroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerHuntgroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Huntgroup management"
]
}
},
"/DID_Provider/get_did_provider_info" : {
"post" : {
"operationId" : "DID_Provider:get_did_provider_info",
"summary" : "get_did_provider_info - This method enables an API user to get the DID provider information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDProviderInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDProviderInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDProviderInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID_Provider | DID auto-provisioning management"
]
}
},
"/Calendar/update_dates_batch" : {
"post" : {
"operationId" : "Calendar:update_dates_batch",
"summary" : "update_dates_batch - This method enables an API user to update the list of calendar date records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDatesBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDatesBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDatesBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Calendar | Calendar management"
]
}
},
"/Account/get_payment_transaction_list" : {
"post" : {
"operationId" : "Account:get_payment_transaction_list",
"summary" : "get_payment_transaction_list - This method allows an API user to get a list of account's payment transactions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountPaymentTransactionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountPaymentTransactionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountPaymentTransactionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Payment and topup management"
]
}
},
"/Account/get_assigned_commitment_record_list" : {
"post" : {
"operationId" : "Account:get_assigned_commitment_record_list",
"summary" : "get_assigned_commitment_record_list - The method enables an API user to get the set of commitments assigned to an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAssignedCommitmentRecordListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAssignedCommitmentRecordListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAssignedCommitmentRecordListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/Invoice/generate_midterm_invoice" : {
"post" : {
"operationId" : "Invoice:generate_midterm_invoice",
"summary" : "generate_midterm_invoice - This method allows an administrator to generate a midterm invoice. For example, if during the middle of a billing period, a customer wants to pay for services consumed (up till now) and does not want to wait until the end for their invoice",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenerateMidtermInvoiceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateMidtermInvoiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateMidtermInvoiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Node/get_node_list" : {
"post" : {
"operationId" : "Node:get_node_list",
"summary" : "get_node_list - This method allows an API user to get the list of nodes",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNodeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNodeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNodeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Node | Node management"
]
}
},
"/DialingRule/get_dialing_rule_info" : {
"post" : {
"operationId" : "DialingRule:get_dialing_rule_info",
"summary" : "get_dialing_rule_info - This method allows an API user to get the dialing rule data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDialingRuleInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDialingRuleInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDialingRuleInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DialingRule | Dialing rule management"
]
}
},
"/Product/unbind_addon_product" : {
"post" : {
"operationId" : "Product:unbind_addon_product",
"summary" : "unbind_addon_product - This method allows an API user to unbind an add-on product from the main product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UnbindAddonProductResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UnbindAddonProductRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UnbindAddonProductRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/CallBarring/get_call_barring_class_info" : {
"post" : {
"operationId" : "CallBarring:get_call_barring_class_info",
"summary" : "get_call_barring_class_info - This method enables an API user to fetch the information about a call barring class",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCallBarringClassInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCallBarringClassInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCallBarringClassInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CallBarring | Call barring class management"
]
}
},
"/CustomerClass/update_notification_template" : {
"post" : {
"operationId" : "CustomerClass:update_notification_template",
"summary" : "update_notification_template - This method allows an API user to update the notification template configured for the customer class",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomerClassNotificationTemplateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerClassNotificationTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerClassNotificationTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Notification template management"
]
}
},
"/Template/update_template" : {
"post" : {
"operationId" : "Template:update_template",
"summary" : "update_template - Use this method to update the values of the template parameters such as the name, the description, the time zone",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTemplateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/CustomerClass/get_business_models_list" : {
"post" : {
"operationId" : "CustomerClass:get_business_models_list",
"summary" : "get_business_models_list - This method enables an API user to get the list of business model records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetBusinessModelsListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetBusinessModelsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetBusinessModelsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Business model management"
]
}
},
"/Session/ping" : {
"post" : {
"operationId" : "Session:ping",
"summary" : "ping - This method checks the validity of a previously opened session and returns the user_id on success. API Fault is thrown on failure",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PingResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/PingRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/PingRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Session | Authenticated session management"
]
}
},
"/DID/get_inventory_options" : {
"post" : {
"operationId" : "DID:get_inventory_options",
"summary" : "get_inventory_options - This method enables an API user to get DID inventory options",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDInventoryOptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDInventoryOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDInventoryOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Inventory management"
]
}
},
"/AsyncRequest/get_request_info" : {
"post" : {
"operationId" : "AsyncRequest:get_request_info",
"summary" : "get_request_info - This method enables an API user to check the status of the JSON request being executed in the asynchronous mode",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAsyncRequestInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAsyncRequestInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAsyncRequestInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AsyncRequest | Asynchronous request management"
]
}
},
"/Customer/update_zendesk_organization" : {
"post" : {
"operationId" : "Customer:update_zendesk_organization",
"summary" : "update_zendesk_organization - This method enables an API user to update an organization in the Zendesk platform",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateZendeskOrganizationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateZendeskOrganizationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateZendeskOrganizationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Support request management"
]
}
},
"/TrafficProfile/add_spending_constraint" : {
"post" : {
"operationId" : "TrafficProfile:add_spending_constraint",
"summary" : "add_spending_constraint - This method enables an API user to create a traffic profile spending constraint",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddSpendingConstraintResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddSpendingConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddSpendingConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Constraint management"
]
}
},
"/Tariff/get_resale_map_list" : {
"post" : {
"operationId" : "Tariff:get_resale_map_list",
"summary" : "get_resale_map_list - This method enables an API user to retrieve the list of mappings between a reseller's wholesale and resale tariffs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetResaleMapListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetResaleMapListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetResaleMapListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Reseller tariff management"
]
}
},
"/Account/get_auto_payment_info" : {
"post" : {
"operationId" : "Account:get_auto_payment_info",
"summary" : "get_auto_payment_info - This method enables an API user to get an account’s automated periodic payment record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAutoPaymentInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Auto-payment management"
]
}
},
"/Vendor/get_vendor_account_info" : {
"post" : {
"operationId" : "Vendor:get_vendor_account_info",
"summary" : "get_vendor_account_info - This method allows an API user to get a vendor account record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVendorAccountInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorAccountInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorAccountInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor account management"
]
}
},
"/Metric/add_measured_metric_data" : {
"post" : {
"operationId" : "Metric:add_measured_metric_data",
"summary" : "add_measured_metric_data - This method enables an API user to add one or more measured metrics into the system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddMeasuredMetricDataResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddMeasuredMetricDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddMeasuredMetricDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Metric | Measured service management"
]
}
},
"/TraceSession/get_trace_session_list" : {
"post" : {
"operationId" : "TraceSession:get_trace_session_list",
"summary" : "get_trace_session_list - This method enables an API user to fetch the list of the sessions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTraceSessionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTraceSessionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTraceSessionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TraceSession | Session information management"
]
}
},
"/Representative/get_xdr_list" : {
"post" : {
"operationId" : "Representative:get_xdr_list",
"summary" : "get_xdr_list - The method enables an API user to retrieve representative's XDR records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRepresentativeXDRListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRepresentativeXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRepresentativeXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Representative | Information and statistics management"
]
}
},
"/IVRApplications/add_access_number" : {
"post" : {
"operationId" : "IVRApplications:add_access_number",
"summary" : "add_access_number - This method enables an API user to add the IVR access number",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddAccessNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccessNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccessNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Access number management"
]
}
},
"/IVRApplications/get_ivr_application_list" : {
"post" : {
"operationId" : "IVRApplications:get_ivr_application_list",
"summary" : "get_ivr_application_list - This method enables an API user to get the list of IVR applications",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetIvrApplicationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetIvrApplicationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetIvrApplicationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Application management"
]
}
},
"/TrafficProfile/add_fraud_constraint" : {
"post" : {
"operationId" : "TrafficProfile:add_fraud_constraint",
"summary" : "add_fraud_constraint - This method enables an API user to create a traffic profile fraud constraint",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddFraudConstraintResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddFraudConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddFraudConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Constraint management"
]
}
},
"/Customer/get_call_barring_options" : {
"post" : {
"operationId" : "Customer:get_call_barring_options",
"summary" : "get_call_barring_options - This method enables an API user to retrieve all available options for customer call barring and check their status",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerCallBarringOptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerCallBarringOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerCallBarringOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Call barring rule management"
]
}
},
"/TrafficProfile/update_traffic_profile" : {
"post" : {
"operationId" : "TrafficProfile:update_traffic_profile",
"summary" : "update_traffic_profile - This method enables an API user to update a traffic profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTrafficProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTrafficProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTrafficProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Profile management"
]
}
},
"/Account/arrange_cp_rules" : {
"post" : {
"operationId" : "Account:arrange_cp_rules",
"summary" : "arrange_cp_rules - This method allows an API user to redefine the order in which call screening rules are applied",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ArrangeCPRulesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ArrangeCPRulesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ArrangeCPRulesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call screening management"
]
}
},
"/DiscountPlan/get_vd_threshold_list" : {
"post" : {
"operationId" : "DiscountPlan:get_vd_threshold_list",
"summary" : "get_vd_threshold_list - This method allows an API user to get the information about thresholds (discount scheme) for the specified discount record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVDThresholdListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVDThresholdListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVDThresholdListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Threshold management"
]
}
},
"/DID/add_owner_batch" : {
"post" : {
"operationId" : "DID:add_owner_batch",
"summary" : "add_owner_batch - This method allows an API user (administrator or reseller) to add DID Pricing Batch.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateOwnerBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateOwnerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateOwnerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Pricing batch management"
]
}
},
"/Customer/restore_customer_after_import" : {
"post" : {
"operationId" : "Customer:restore_customer_after_import",
"summary" : "restore_customer_after_import - This method enables an API user to restore a customer after import",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerRestoreCustomerAfterImportResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerRestoreCustomerAfterImportRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerRestoreCustomerAfterImportRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Internal"
]
}
},
"/Account/delete_auto_payment" : {
"post" : {
"operationId" : "Account:delete_auto_payment",
"summary" : "delete_auto_payment - This method enables an API user to delete an account's automated periodic payment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAutoPaymentResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAutoPaymentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAutoPaymentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Auto-payment management"
]
}
},
"/IVRApplications/obtain_access_number" : {
"post" : {
"operationId" : "IVRApplications:obtain_access_number",
"summary" : "obtain_access_number - This method enables an API user to assign a random IVR access number to an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ObtainAccessNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ObtainAccessNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ObtainAccessNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | IVR user application management"
]
}
},
"/Customer/delete_abbreviated_dialing_number" : {
"post" : {
"operationId" : "Customer:delete_abbreviated_dialing_number",
"summary" : "delete_abbreviated_dialing_number - This method allows an API user to remove an abbreviated dialing number",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerAbbreviatedDialingNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerAbbreviatedDialingNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerAbbreviatedDialingNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Abbreviated dialing number management"
]
}
},
"/MeasuredServices/get_customer_metrics_list" : {
"post" : {
"operationId" : "MeasuredServices:get_customer_metrics_list",
"summary" : "get_customer_metrics_list - This method allows an API user to retrieve measured services for a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerMetricListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerMetricListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerMetricListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Customer metric management"
]
}
},
"/Account/get_assigned_commitment_record_info" : {
"post" : {
"operationId" : "Account:get_assigned_commitment_record_info",
"summary" : "get_assigned_commitment_record_info - The method enables an API user to get the information about the commitment assigned to an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAssignedCommitmentRecordInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAssignedCommitmentRecordInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAssignedCommitmentRecordInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/Notification/send_me_notification_sample" : {
"post" : {
"operationId" : "Notification:send_me_notification_sample",
"summary" : "send_me_notification_sample - This method enables an API user to test the notification by sending a message sample to their email address or phone number. The notification is sent to the user that is currently logged in",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SendMeNotificationSampleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SendMeNotificationSampleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SendMeNotificationSampleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Notification | Notification management"
]
}
},
"/DID/get_did_group_list" : {
"post" : {
"operationId" : "DID:get_did_group_list",
"summary" : "get_did_group_list - This method enables an API user to get the list of DID group records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDGroupListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Group management"
]
}
},
"/Generic/get_config_data" : {
"post" : {
"operationId" : "Generic:get_config_data",
"summary" : "get_config_data - This method allows to get current values of configuration parameters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenericGetConfigDataResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetCommonInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetCommonInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Internal"
]
}
},
"/Template/delete_template" : {
"post" : {
"operationId" : "Template:delete_template",
"summary" : "delete_template - Use this method to delete a template record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteTemplateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/RoutingCriteria/add_routing_criteria" : {
"post" : {
"operationId" : "RoutingCriteria:add_routing_criteria",
"summary" : "add_routing_criteria - This method enables an API user to add a new routing criteria record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddRoutingCriteriaResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRoutingCriteriaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRoutingCriteriaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingCriteria | Routing criteria management"
]
}
},
"/Vendor/unblock_connection_destination_group" : {
"post" : {
"operationId" : "Vendor:unblock_connection_destination_group",
"summary" : "unblock_connection_destination_group - The method enables an API user to unblock a blocked destination group of the connection",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UnblockConnectionDestinationGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UnblockConnectionDestinationGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UnblockConnectionDestinationGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Connection management"
]
}
},
"/DID/update_vendor_batch" : {
"post" : {
"operationId" : "DID:update_vendor_batch",
"summary" : "update_vendor_batch - This method enables an API user to update a vendor DID batch record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateVendorBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVendorBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVendorBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Vendor batch management"
]
}
},
"/Customer/get_customer_extension_info" : {
"post" : {
"operationId" : "Customer:get_customer_extension_info",
"summary" : "get_customer_extension_info - This method enables an API user to get an extension record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerExtensionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerExtensionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerExtensionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Extension management"
]
}
},
"/Product/get_roles_list" : {
"post" : {
"operationId" : "Product:get_roles_list",
"summary" : "get_roles_list - This method enables an API user to get the list of roles for a product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetProductRolesListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductRolesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductRolesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/Product/get_group_info" : {
"post" : {
"operationId" : "Product:get_group_info",
"summary" : "get_group_info - This method allows an API user to get a product group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetProductGroupInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductGroupInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductGroupInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Group management"
]
}
},
"/Template/get_template_media_attribute_list" : {
"post" : {
"operationId" : "Template:get_template_media_attribute_list",
"summary" : "get_template_media_attribute_list - Use this method to receive the list of the template media attributes. These are the parameters which define data layout within the file (e.g. what separator to use in CSV files, where the data for components should be located in the file, etc.) and depend on the output file format (e.g. .csv, .xls or .pdf)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTemplateMediaAttributeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTemplateMediaAttributeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTemplateMediaAttributeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/EmergencyUnit/get_emergency_unit_list" : {
"post" : {
"operationId" : "EmergencyUnit:get_emergency_unit_list",
"summary" : "get_emergency_unit_list - This method enables an API user to retrieve the information about emergency routing units by their fields",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetEmergencyUnitListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEmergencyUnitListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEmergencyUnitListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"EmergencyUnit | Emergency routing unit management"
]
}
},
"/DiscountPlan/delete_discount_plan" : {
"post" : {
"operationId" : "DiscountPlan:delete_discount_plan",
"summary" : "delete_discount_plan - This method allows an API user to delete a volume discount plan",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteDiscountPlanResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDiscountPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDiscountPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount plan management"
]
}
},
"/Account/terminate_assigned_commitment_record" : {
"post" : {
"operationId" : "Account:terminate_assigned_commitment_record",
"summary" : "terminate_assigned_commitment_record - The method enables an API user to terminate a commitment. The user may set custom rules for applying termination penalties to the commitment itself, or overwrite the rule for applying penalties for separate terms",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminateAssignedCommitmentRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TerminateAssignedCommitmentRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TerminateAssignedCommitmentRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/RouteCategories/update_route_category" : {
"post" : {
"operationId" : "RouteCategories:update_route_category",
"summary" : "update_route_category - This method enables an API user to update a route category record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateRouteCategoryResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRouteCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRouteCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RouteCategories | Route category management"
]
}
},
"/RoutingPlan/delete_routing_plan" : {
"post" : {
"operationId" : "RoutingPlan:delete_routing_plan",
"summary" : "delete_routing_plan - This method allows an API user to delete a routing plan record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteRoutingPlanResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRoutingPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRoutingPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Routing plan management"
]
}
},
"/RoamingProfile/update_roaming_profile" : {
"post" : {
"operationId" : "RoamingProfile:update_roaming_profile",
"summary" : "update_roaming_profile - This method enables an API user to update the roaming profile information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRoamingProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRoamingProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRoamingProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoamingProfile | Roaming profile management"
]
}
},
"/Customer/get_custom_fields_schema" : {
"post" : {
"operationId" : "Customer:get_custom_fields_schema",
"summary" : "get_custom_fields_schema - This method allows an API user to get the list of customer's custom fields with information about their types and possible values",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerCustomFieldsSchemaResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerCustomFieldsSchemaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerCustomFieldsSchemaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Custom field management"
]
}
},
"/Account/update_alias" : {
"post" : {
"operationId" : "Account:update_alias",
"summary" : "update_alias - This method allows an API user to update an alias",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAccountAliasResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountAliasRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountAliasRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Alias management"
]
}
},
"/RouteCategories/get_route_category_info" : {
"post" : {
"operationId" : "RouteCategories:get_route_category_info",
"summary" : "get_route_category_info - This method enables an API user to get information about a route category record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRouteCategoryInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRouteCategoryInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRouteCategoryInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RouteCategories | Route category management"
]
}
},
"/Customer/make_tax_transaction" : {
"post" : {
"operationId" : "Customer:make_tax_transaction",
"summary" : "make_tax_transaction - This method enables an API user to issue a taxation transaction",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerMakeTaxTransactionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerMakeTaxTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerMakeTaxTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Internal"
]
}
},
"/IVRApplications/clone_ivr_application" : {
"post" : {
"operationId" : "IVRApplications:clone_ivr_application",
"summary" : "clone_ivr_application - This method enables an API user to clone the IVR application",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CloneIvrApplicationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneIvrApplicationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneIvrApplicationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Application management"
]
}
},
"/Account/register_transaction" : {
"post" : {
"operationId" : "Account:register_transaction",
"summary" : "register_transaction - This method enables an API user to register a transaction initiated for an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountRegisterTransactionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountRegisterTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountRegisterTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Transaction management"
]
}
},
"/Customer/add_customer_site" : {
"post" : {
"operationId" : "Customer:add_customer_site",
"summary" : "add_customer_site - This method allows an API user to create a cutomer site",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCustomerSiteResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCustomerSiteRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCustomerSiteRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Site management"
]
}
},
"/Account/delete_subscription" : {
"post" : {
"operationId" : "Account:delete_subscription",
"summary" : "delete_subscription - This method allows an API user to delete a pending subscription associated with an account. It requires an ID number returned, for example, by the add_subscription method",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAccountSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloseDeleteAccountSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloseDeleteAccountSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Subscription management"
]
}
},
"/DID_Provider/cancel_provision" : {
"post" : {
"operationId" : "DID_Provider:cancel_provision",
"summary" : "cancel_provision - This method allows an API user to release a DID number allocated earlier from the providerIf DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CancelDIDProvisionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CancelDIDProvisionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CancelDIDProvisionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID_Provider | DID auto-provisioning management"
]
}
},
"/Customer/get_selfcare_config_data" : {
"post" : {
"operationId" : "Customer:get_selfcare_config_data",
"summary" : "get_selfcare_config_data - This method enables an API user to get customer self-care page configuration values",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerGetSelfcareConfigDataResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerGetSelfcareConfigDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerGetSelfcareConfigDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Internal"
]
}
},
"/DID/assign_did_to_owner_batch" : {
"post" : {
"operationId" : "DID:assign_did_to_owner_batch",
"summary" : "assign_did_to_owner_batch - This method allows an API user to assign a DID number to the Pricing Batch.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssignDIDToOwnerBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignDIDToOwnerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignDIDToOwnerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Assignment management"
]
}
},
"/Currency/get_currency_info" : {
"post" : {
"operationId" : "Currency:get_currency_info",
"summary" : "get_currency_info - This method allows an API user to get information about a currency created in PortaBilling",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCurrencyInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCurrencyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCurrencyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Currency | Currency management"
]
}
},
"/MeasuredServices/add_measured_metric" : {
"post" : {
"operationId" : "MeasuredServices:add_measured_metric",
"summary" : "add_measured_metric - This method enables an API user to add a new measured metric",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddMeasuredMetricResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddMeasuredMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddMeasuredMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Measured metric management"
]
}
},
"/Vendor/get_connection_type_info" : {
"post" : {
"operationId" : "Vendor:get_connection_type_info",
"summary" : "get_connection_type_info - This method enables an API user to obtain information about a connection type",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetConnectionTypeInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConnectionTypeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConnectionTypeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Connection type management"
]
}
},
"/TaxationPlugin/add_tax_transaction_code" : {
"post" : {
"operationId" : "TaxationPlugin:add_tax_transaction_code",
"summary" : "add_tax_transaction_code - This method allows an API user to add a taxation code",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddTaxTransactionCodeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddTaxTransactionCodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddTaxTransactionCodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Code management"
]
}
},
"/Template/get_template_component_list" : {
"post" : {
"operationId" : "Template:get_template_component_list",
"summary" : "get_template_component_list - Use this method to receive the list of components of the template. These are the groups into which data is split within the template (e.g. Header, Footer, Fields, etc.)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTemplateComponentListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTemplateComponentListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTemplateComponentListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/DID/assign_did_to_account" : {
"post" : {
"operationId" : "DID:assign_did_to_account",
"summary" : "assign_did_to_account - This method allows an API user to assign a DID number to a customer's account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssignDIDToAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignDIDToAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignDIDToAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/Account/get_account_state" : {
"post" : {
"operationId" : "Account:get_account_state",
"summary" : "get_account_state - This method allows an administrator to obtain the current condition applied to the account by the Fraud Prevention feature (e.g. Active, Screened, Quarantined)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountStateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountStateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountStateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Fraud condition management"
]
}
},
"/Customer/suspend_customer" : {
"post" : {
"operationId" : "Customer:suspend_customer",
"summary" : "suspend_customer - This method allows to suspend all services to a retail customer, reseller or distributor",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SuspendCustomerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SuspendCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SuspendCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/Node/get_node_info" : {
"post" : {
"operationId" : "Node:get_node_info",
"summary" : "get_node_info - This method allows an API user to get a node record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNodeInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNodeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNodeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Node | Node management"
]
}
},
"/CommissionPlan/delete_commission_plan" : {
"post" : {
"operationId" : "CommissionPlan:delete_commission_plan",
"summary" : "delete_commission_plan - This method allows an API user to delete a commission plan record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCommissionPlanResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCommissionPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCommissionPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CommissionPlan | Commission plan management"
]
}
},
"/DiscountPlan/delete_vd_threshold" : {
"post" : {
"operationId" : "DiscountPlan:delete_vd_threshold",
"summary" : "delete_vd_threshold - This method allows an API user to delete a threshold from a discount record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteVDThresholdResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVDThresholdRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVDThresholdRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Threshold management"
]
}
},
"/Customer/get_extensions_list" : {
"post" : {
"operationId" : "Customer:get_extensions_list",
"summary" : "get_extensions_list - This method allows an API user to get the list of extensions for phone lines within a customer's IP Centrex environment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetExtensionsListInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetExtensionsListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetExtensionsListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Extension management"
]
}
},
"/Account/terminate_account" : {
"post" : {
"operationId" : "Account:terminate_account",
"summary" : "terminate_account - This method allows an API user to terminate an existing account record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminateAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TerminateAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TerminateAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account management"
]
}
},
"/Customer/delete_customer_huntgroup" : {
"post" : {
"operationId" : "Customer:delete_customer_huntgroup",
"summary" : "delete_customer_huntgroup - This method allows a retail customer to remove a huntgroup",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerHuntgroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerHuntgroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerHuntgroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Huntgroup management"
]
}
},
"/Account/delete_account" : {
"post" : {
"operationId" : "Account:delete_account",
"summary" : "delete_account - This method enables an API user to delete an existing account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountDeleteAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountDeleteAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountDeleteAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/Account/delete_cp_condition" : {
"post" : {
"operationId" : "Account:delete_cp_condition",
"summary" : "delete_cp_condition - This method enables an API user to delete an existing call screening condition",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCPConditionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCPConditionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCPConditionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call screening management"
]
}
},
"/Account/delete_cp_rule" : {
"post" : {
"operationId" : "Account:delete_cp_rule",
"summary" : "delete_cp_rule - This method allows an API user to delete an existing call screening rule",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCPRuleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCPRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCPRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call screening management"
]
}
},
"/Customer/enable_api_notifications" : {
"post" : {
"operationId" : "Customer:enable_api_notifications",
"summary" : "enable_api_notifications - Obsolete. Use CallControl.enable_api_notifications method instead",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EnableApiNotificationsCustomerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EnableApiNotificationsCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EnableApiNotificationsCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Async API notification management"
]
}
},
"/ContentBasedCharging/add_rating_group" : {
"post" : {
"operationId" : "ContentBasedCharging:add_rating_group",
"summary" : "add_rating_group - This method enables an API user to add a rating group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddRatingGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRatingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRatingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ContentBasedCharging | Rating group management"
]
}
},
"/Rate/add_rate_group" : {
"post" : {
"operationId" : "Rate:add_rate_group",
"summary" : "add_rate_group - This method allows an API user (administrator or reseller) to add a new rate for every destination in a destination group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddRateGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRateGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRateGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Group management"
]
}
},
"/Account/get_role_info" : {
"post" : {
"operationId" : "Account:get_role_info",
"summary" : "get_role_info - This method enables an API user to get the information about an account role by i_account_role",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountRoleInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountRoleInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountRoleInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account role management"
]
}
},
"/Product/delete_service_and_rating" : {
"post" : {
"operationId" : "Product:delete_service_and_rating",
"summary" : "delete_service_and_rating - This method allows an API user to delete an existing rating entry from a product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteServiceAndRatingResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteServiceAndRatingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteServiceAndRatingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Service and rating management"
]
}
},
"/RoutingPlan/add_rp_connection" : {
"post" : {
"operationId" : "RoutingPlan:add_rp_connection",
"summary" : "add_rp_connection - This method allows an API user to define custom routing per destination group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRPConnectionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRPConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRPConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Custom routing management"
]
}
},
"/CustomerClass/delete_customer_class" : {
"post" : {
"operationId" : "CustomerClass:delete_customer_class",
"summary" : "delete_customer_class - This method allows an API user to delete a customer class record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerClassResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Customer class management"
]
}
},
"/DID/update_number_list" : {
"post" : {
"operationId" : "DID:update_number_list",
"summary" : "update_number_list - The method enables an API user to update DID numbers in the inventory",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDIDNumberListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDIDNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDIDNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/Destination/match_destination_groups" : {
"post" : {
"operationId" : "Destination:match_destination_groups",
"summary" : "match_destination_groups - This method allows an administrator to locate a destination group by tariff and phone number",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MatchDestinationGroupsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MatchDestinationGroupsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MatchDestinationGroupsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group management"
]
}
},
"/CustomFields/get_custom_field_info" : {
"post" : {
"operationId" : "CustomFields:get_custom_field_info",
"summary" : "get_custom_field_info - This method enables an API user to get a custom field",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomFieldInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomFieldInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomFieldInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomFields | Custom field management"
]
}
},
"/Tariff/schedule_tariff_cloning" : {
"post" : {
"operationId" : "Tariff:schedule_tariff_cloning",
"summary" : "schedule_tariff_cloning - This method enables an API user to schedule tariff cloning",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ScheduleTariffCloningResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ScheduleTariffCloningRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ScheduleTariffCloningRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Tariff management"
]
}
},
"/Destination/delete_dest_group_set" : {
"post" : {
"operationId" : "Destination:delete_dest_group_set",
"summary" : "delete_dest_group_set - This method allows an API user to delete a destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteDestGroupSetResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDestGroupSetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDestGroupSetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group set management"
]
}
},
"/Payment/get_payment_methods_for_owner" : {
"post" : {
"operationId" : "Payment:get_payment_methods_for_owner",
"summary" : "get_payment_methods_for_owner - This method allows an API user to obtain a list of avalilable payment methods and processors for a given entity's currency.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPaymentMethodsForOwnerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPaymentMethodsForOwnerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPaymentMethodsForOwnerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Payment method management"
]
}
},
"/UA/delete_ua" : {
"post" : {
"operationId" : "UA:delete_ua",
"summary" : "delete_ua - This method allows an API user to delete a UA device, provided that it is not being used by any account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteUAResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteUARequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteUARequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | UA device management"
]
}
},
"/Generic/get_variable_format_list" : {
"post" : {
"operationId" : "Generic:get_variable_format_list",
"summary" : "get_variable_format_list - This method allows to get the list of notification template variables formats",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenericGetNotificationTemplateVariableFormatListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetNotificationTemplateVariableFormatListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetNotificationTemplateVariableFormatListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Internal"
]
}
},
"/Destination/get_dest_group_allowed_prefixes" : {
"post" : {
"operationId" : "Destination:get_dest_group_allowed_prefixes",
"summary" : "get_dest_group_allowed_prefixes - This method enables an API user to get a list of prefixes that can be used for the complete destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationGetDestGroupAllowedPrefixesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationGetDestGroupAllowedPrefixesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationGetDestGroupAllowedPrefixesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/Payment/register_transaction" : {
"post" : {
"operationId" : "Payment:register_transaction",
"summary" : "register_transaction - This method allows an API user to initiate an internal transaction in PortaBilling.Mainly used for making payments via processors with external authentication (the ones such as WorldPay Junior, Moneybookers, PayPal, PayNearMe and Luottokunta which require a user to go to their web page to get authenticated and confirm the transaction)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RegisterTransactionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RegisterTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RegisterTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Transaction management"
]
}
},
"/UA/add_ua" : {
"post" : {
"operationId" : "UA:add_ua",
"summary" : "add_ua - This method allows an API user to add a new UA device (IP phone) to the IP phone inventory",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUAResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUARequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUARequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | UA device management"
]
}
},
"/OLI/get_oli_info" : {
"post" : {
"operationId" : "OLI:get_oli_info",
"summary" : "get_oli_info - This method allows an API user to get an OLI record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetOliInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOliInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOliInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"OLI | OLI management"
]
}
},
"/ACL/get_my_permissions_for_objects" : {
"post" : {
"operationId" : "ACL:get_my_permissions_for_objects",
"summary" : "get_my_permissions_for_objects - This method allows an API user to get a list of ACL permissions for specific objects on the PortaBilling web interface",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMyAclForObjectsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMyAclForObjectsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMyAclForObjectsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ACL | ACL management"
]
}
},
"/Env/get_env_info" : {
"post" : {
"operationId" : "Env:get_env_info",
"summary" : "get_env_info - This method allows an API user to get an Environment record from the database. The user can get the information about the Environment to which he belongs. Superusers can get information about any Environment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetEnvInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEnvInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEnvInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Environment management"
]
}
},
"/Vendor/add_vendor" : {
"post" : {
"operationId" : "Vendor:add_vendor",
"summary" : "add_vendor - This method allows an API user to create a new vendor record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddVendorResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVendorRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVendorRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor management"
]
}
},
"/Customer/update_customer" : {
"post" : {
"operationId" : "Customer:update_customer",
"summary" : "update_customer - This method allows an API user to update an existing customer record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/Product/clone_product" : {
"post" : {
"operationId" : "Product:clone_product",
"summary" : "clone_product - This method enables an API user to clone the product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductCloneProductResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductCloneProductRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductCloneProductRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Internal"
]
}
},
"/Template/update_template_data_field_list" : {
"post" : {
"operationId" : "Template:update_template_data_field_list",
"summary" : "update_template_data_field_list - Use this method to update the values of the template data fields",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTemplateDataFieldListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTemplateDataFieldListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTemplateDataFieldListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/Vendor/delete_vendor" : {
"post" : {
"operationId" : "Vendor:delete_vendor",
"summary" : "delete_vendor - This method allows an API user to delete an existing vendor, provided it has no connections or CDRs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteVendorResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVendorRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVendorRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor management"
]
}
},
"/Customer/delete_migration" : {
"post" : {
"operationId" : "Customer:delete_migration",
"summary" : "delete_migration - This method enables an API user to delete a customer migration",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerMigrationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerMigrationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerMigrationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/Customer/get_spending_counter_info" : {
"post" : {
"operationId" : "Customer:get_spending_counter_info",
"summary" : "get_spending_counter_info - This method allows an API user to retrieve information about the traffic profile spending counter",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSpendingCounterResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSpendingCounterRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSpendingCounterRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Spending counter management"
]
}
},
"/Commitment/update_commitment_one_time_term" : {
"post" : {
"operationId" : "Commitment:update_commitment_one_time_term",
"summary" : "update_commitment_one_time_term - The method enables an API user to update a one-time term record associated with a commitment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCommitmentOneTimeTermResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCommitmentOneTimeTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCommitmentOneTimeTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/TimePeriod/get_time_period_info" : {
"post" : {
"operationId" : "TimePeriod:get_time_period_info",
"summary" : "get_time_period_info - This method enables an API user to retrieve the information about the time period",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTimePeriodInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTimePeriodInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTimePeriodInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TimePeriod | Time period management"
]
}
},
"/Product/update_product" : {
"post" : {
"operationId" : "Product:update_product",
"summary" : "update_product - This method allows an API user to update an existing product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateProductResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateProductRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateProductRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/TimePeriod/add_time_period" : {
"post" : {
"operationId" : "TimePeriod:add_time_period",
"summary" : "add_time_period - This method enables an API user to create a new time period record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddTimePeriodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddTimePeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddTimePeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TimePeriod | Time period management"
]
}
},
"/ContentBasedCharging/get_rating_group_info" : {
"post" : {
"operationId" : "ContentBasedCharging:get_rating_group_info",
"summary" : "get_rating_group_info - This method enables an API user to retrieve the information about a rating group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRatingGroupInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRatingGroupInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRatingGroupInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ContentBasedCharging | Rating group management"
]
}
},
"/ServiceFeatures/get_service_features_list" : {
"post" : {
"operationId" : "ServiceFeatures:get_service_features_list",
"summary" : "get_service_features_list - This method allows an administrator to get the list of service features",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServiceFeaturesListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceFeaturesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceFeaturesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ServiceFeatures | Service feature management"
]
}
},
"/DID/update_owner_batch" : {
"post" : {
"operationId" : "DID:update_owner_batch",
"summary" : "update_owner_batch - This method allows an API user (administrator or reseller) to update DID Pricing Batch.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateOwnerBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateOwnerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateOwnerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Pricing batch management"
]
}
},
"/Invoice/recalculate_invoices" : {
"post" : {
"operationId" : "Invoice:recalculate_invoices",
"summary" : "recalculate_invoices - This method allows an API user to recalculate invoices",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RecalculateInvoicesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RecalculateInvoicesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RecalculateInvoicesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Template/update_template_data_group_list" : {
"post" : {
"operationId" : "Template:update_template_data_group_list",
"summary" : "update_template_data_group_list - This method enables an API user to modify data groups of the template",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TemplateUpdateTemplateDataGroupListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateUpdateTemplateDataGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateUpdateTemplateDataGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Internal"
]
}
},
"/AccessRole/delete_access_role" : {
"post" : {
"operationId" : "AccessRole:delete_access_role",
"summary" : "delete_access_role - This method enables an API user to delete the access role record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAccessRoleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAccessRoleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAccessRoleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessRole | Access role management"
]
}
},
"/Template/get_template_scoped_list" : {
"post" : {
"operationId" : "Template:get_template_scoped_list",
"summary" : "get_template_scoped_list - This method enables an API user to get the list of scoped template records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TemplateGetTemplateScopedListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateGetTemplateScopedListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateGetTemplateScopedListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Internal"
]
}
},
"/AccessRole/get_access_role_list" : {
"post" : {
"operationId" : "AccessRole:get_access_role_list",
"summary" : "get_access_role_list - This method enables an API user to get the list of access role records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccessRoleListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessRoleListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessRoleListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessRole | Access role management"
]
}
},
"/SIMCard/get_card_info" : {
"post" : {
"operationId" : "SIMCard:get_card_info",
"summary" : "get_card_info - This method enables an API user to get a sim card record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSIMCardInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSIMCardInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSIMCardInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"SIMCard | SIM card management"
]
}
},
"/Customer/get_custom_xdr_report_list" : {
"post" : {
"operationId" : "Customer:get_custom_xdr_report_list",
"summary" : "get_custom_xdr_report_list - This method allows to obtain a list of custom xDR reports for a specific customer. In addition to the standard customer xDR report it is possible to obtain site-based reports. These reports can be downloaded by customers and administrators in CSV and PDF formats. Fields shown in the report can be configured separately for CSV and PDF files",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomXdrReportListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomXdrReportListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomXdrReportListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/CustomerClass/get_notification_category_list" : {
"post" : {
"operationId" : "CustomerClass:get_notification_category_list",
"summary" : "get_notification_category_list - This method enables an API user to get the list of notification categories of the customer class",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerClassNotificationCategoryListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassNotificationCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassNotificationCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Notification template management"
]
}
},
"/Generic/update_ui_config_list" : {
"post" : {
"operationId" : "Generic:update_ui_config_list",
"summary" : "update_ui_config_list - This method enables an API user to update the list of the UI configs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateUIConfigListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUIConfigListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUIConfigListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Generic information management"
]
}
},
"/UA/delete_ua_profile" : {
"post" : {
"operationId" : "UA:delete_ua_profile",
"summary" : "delete_ua_profile - This method enables an API user to delete а UA device (IP phone) profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteUAProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteUAProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteUAProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | Profile management"
]
}
},
"/Customer/add_auto_payment" : {
"post" : {
"operationId" : "Customer:add_auto_payment",
"summary" : "add_auto_payment - This method allows an API user to set up automated periodic payments. If you want to charge a customer’s credit card whenever his balance crosses a specified threshold, then specify the pay_amount and balance_threshold properties, and when the customer’s balance crosses this threshold, their credit card will be charged for the amount specified in the pay_amount field",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Auto-payment management"
]
}
},
"/BundlePromotion/add_criterion" : {
"post" : {
"operationId" : "BundlePromotion:add_criterion",
"summary" : "add_criterion - This method allows an API user to add a new bundle promotion criterion",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCriterionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCriterionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCriterionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BundlePromotion | Criterium management"
]
}
},
"/Account/get_vd_counter_history_list" : {
"post" : {
"operationId" : "Account:get_vd_counter_history_list",
"summary" : "get_vd_counter_history_list - The method enables an API user to retrieve a list of the counter updates",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountVdCounterHistoryListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountVdCounterHistoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountVdCounterHistoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/Customer/activate_subscriptions" : {
"post" : {
"operationId" : "Customer:activate_subscriptions",
"summary" : "activate_subscriptions - This method allows an API user to instantly activate a customer’s pending subscriptions, where the start date is equal to today’s date (in the customer’s time zone). An activation fee will be charged for each subscription, if applicable",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ActivateCustomerSubscriptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ActivateCustomerSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ActivateCustomerSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Subscription management"
]
}
},
"/EmergencyUnit/get_emergency_unit_info" : {
"post" : {
"operationId" : "EmergencyUnit:get_emergency_unit_info",
"summary" : "get_emergency_unit_info - This method enables an API user to get the information about an emergency routing unit",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetEmergencyUnitInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEmergencyUnitInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEmergencyUnitInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"EmergencyUnit | Emergency routing unit management"
]
}
},
"/Account/set_account_state" : {
"post" : {
"operationId" : "Account:set_account_state",
"summary" : "set_account_state - This method allows an administrator to change the account's condition for the Fraud Prevention feature (e.g. Active, Screened, Quarantined)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SetAccountStateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SetAccountStateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SetAccountStateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Fraud condition management"
]
}
},
"/AccessPolicy/add_access_policy" : {
"post" : {
"operationId" : "AccessPolicy:add_access_policy",
"summary" : "add_access_policy - This method enables an API user to create an access policy using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddAccessPolicyResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccessPolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccessPolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessPolicy | Access policy management"
]
}
},
"/Account/update_payment_method" : {
"post" : {
"operationId" : "Account:update_payment_method",
"summary" : "update_payment_method - This method enables an API user to assign a preferred payment method to an account. For online payment methods, all the information required by the payment processor should be provided, and an appropriate payment processor must be set up and properly configured beforehand. Note that the number, name, address, and / or zip fields are not mandatory in the PaymentMethodInfo structure as long as credit card was already set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAccountPaymentMethodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountPaymentMethodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountPaymentMethodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Payment and topup management"
]
}
},
"/Subscription/add_subscription" : {
"post" : {
"operationId" : "Subscription:add_subscription",
"summary" : "add_subscription - This method enables an API user to add a subscription",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Subscription | Subscription management"
]
}
},
"/Account/topup_account" : {
"post" : {
"operationId" : "Account:topup_account",
"summary" : "topup_account - This method allows an API user to top up an account using voucher",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TopupAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TopupAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TopupAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Payment and topup management"
]
}
},
"/Notification/update_notification_template" : {
"post" : {
"operationId" : "Notification:update_notification_template",
"summary" : "update_notification_template - This method enables an API user to update information about a notification template",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateNotificationTemplateInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateNotificationTemplateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateNotificationTemplateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Notification | Notification management"
]
}
},
"/Commitment/delete_commitment_one_time_term" : {
"post" : {
"operationId" : "Commitment:delete_commitment_one_time_term",
"summary" : "delete_commitment_one_time_term - The method enables an API user to delete a one-time term record associated with a commitment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCommitmentOneTimeTermResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCommitmentOneTimeTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCommitmentOneTimeTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/Customer/update_subscription" : {
"post" : {
"operationId" : "Customer:update_subscription",
"summary" : "update_subscription - This method allows an API user to update an existing subscription record assigned to a customer. It requires an ID number returned, for example, by the add_subscription method",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Subscription management"
]
}
},
"/IVRApplications/get_ivr_option_list" : {
"post" : {
"operationId" : "IVRApplications:get_ivr_option_list",
"summary" : "get_ivr_option_list - This method enables an API user to get the list of all IVR application options",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetIvrOptionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetIvrOptionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetIvrOptionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Application management"
]
}
},
"/Customer/get_moh_list_info" : {
"post" : {
"operationId" : "Customer:get_moh_list_info",
"summary" : "get_moh_list_info - This method allows an API user to get the list of music on hold entries",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMOHListInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMOHListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMOHListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/CDR/get_call_recording" : {
"post" : {
"operationId" : "CDR:get_call_recording",
"summary" : "get_call_recording - This method enables an API user to get the list of call recording records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCallRecordingResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCallRecordingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCallRecordingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CDR | Call recording management"
]
}
},
"/Account/generate_accounts" : {
"post" : {
"operationId" : "Account:generate_accounts",
"summary" : "generate_accounts - This method enables an API user to generate a batch of accounts",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenerateAccountsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateAccountsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateAccountsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Batch management"
]
}
},
"/EmergencyUnit/delete_emergency_unit" : {
"post" : {
"operationId" : "EmergencyUnit:delete_emergency_unit",
"summary" : "delete_emergency_unit - This method enables an API user to delete an emergency routing unit",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteEmergencyUnitResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteEmergencyUnitRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteEmergencyUnitRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"EmergencyUnit | Emergency routing unit management"
]
}
},
"/MOH/get_moh_file" : {
"post" : {
"operationId" : "MOH:get_moh_file",
"summary" : "get_moh_file - This method enables the API user to download custom MOH file from the system.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMOHFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMOHFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMOHFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MOH | Music on hold file management"
]
}
},
"/AsyncRequest/disable_api_notifications" : {
"post" : {
"operationId" : "AsyncRequest:disable_api_notifications",
"summary" : "disable_api_notifications - This method enables an API user to disable the receipt of notifications about the status of API requests execution in the asynchronous mode",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisableAsyncApiNotificationsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DisableAsyncApiNotificationsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DisableAsyncApiNotificationsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AsyncRequest | API notification management"
]
}
},
"/VoiceQualityProfile/add_profile" : {
"post" : {
"operationId" : "VoiceQualityProfile:add_profile",
"summary" : "add_profile - This method enables an API user to add a new voice quality profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateVoiceQualityProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVoiceQualityProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVoiceQualityProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"VoiceQualityProfile | Voice quality profile management"
]
}
},
"/UA/get_ua_profile_list" : {
"post" : {
"operationId" : "UA:get_ua_profile_list",
"summary" : "get_ua_profile_list - This method enables an API user to get the list of UA device (IP phone) profiles",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUAProfileListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUAProfileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUAProfileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | Profile management"
]
}
},
"/Commitment/get_commitment_info" : {
"post" : {
"operationId" : "Commitment:get_commitment_info",
"summary" : "get_commitment_info - The method enables an API user to get the information about a commitment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCommitmentInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommitmentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommitmentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/Destination/download_dest_group_set" : {
"post" : {
"operationId" : "Destination:download_dest_group_set",
"summary" : "download_dest_group_set - This method allows an API user to download a destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DownloadDGSetResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DownloadDGSetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DownloadDGSetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group set management"
]
}
},
"/CallBarring/update_call_barring_class" : {
"post" : {
"operationId" : "CallBarring:update_call_barring_class",
"summary" : "update_call_barring_class - This method enables an API user to modify a call barring class record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCallBarringClassResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCallBarringClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCallBarringClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CallBarring | Call barring class management"
]
}
},
"/DID_Provider/get_provider_info" : {
"post" : {
"operationId" : "DID_Provider:get_provider_info",
"summary" : "get_provider_info - This method enables an API user to get the DID provider information used by a customer (e.g., its currency). If DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetProviderInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProviderInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProviderInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID_Provider | DID auto-provisioning management"
]
}
},
"/AccessRole/get_access_role_info" : {
"post" : {
"operationId" : "AccessRole:get_access_role_info",
"summary" : "get_access_role_info - This method enables an API user to get an access role record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccessRoleInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessRoleInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessRoleInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessRole | Access role management"
]
}
},
"/Customer/update_customer_site" : {
"post" : {
"operationId" : "Customer:update_customer_site",
"summary" : "update_customer_site - This method allows an API user to update a cutomer site or its service features",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomerSiteResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerSiteRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerSiteRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Site management"
]
}
},
"/DiscountPlan/get_topup_option_list" : {
"post" : {
"operationId" : "DiscountPlan:get_topup_option_list",
"summary" : "get_topup_option_list - This method allows an API user to get a list of topup options",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVDTopupOptionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVDTopupOptionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVDTopupOptionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Topup option management"
]
}
},
"/Customer/get_transactions_total_info" : {
"post" : {
"operationId" : "Customer:get_transactions_total_info",
"summary" : "get_transactions_total_info - This method allows a customer to get the list of customer's transactions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerTransactionsTotalInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerTransactionsTotalInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerTransactionsTotalInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Transaction management"
]
}
},
"/Vendor/delete_connection" : {
"post" : {
"operationId" : "Vendor:delete_connection",
"summary" : "delete_connection - This method allows an API user to delete an existing vendor connection, provided it has no CDRs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteConnectionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Connection management"
]
}
},
"/Customer/get_prompt_file" : {
"post" : {
"operationId" : "Customer:get_prompt_file",
"summary" : "get_prompt_file - This method allows an API user to get information about a voice prompt and the prompt file itself in a MIME attachment to the API response (if available). This method can be used for both extensions and huntgroups",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPromptFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPromptFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPromptFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Voice prompt management"
]
}
},
"/Customer/update_customer_extension" : {
"post" : {
"operationId" : "Customer:update_customer_extension",
"summary" : "update_customer_extension - This method allows a retail customer to modify an extension",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerExtensionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerExtensionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerExtensionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Extension management"
]
}
},
"/DialingRule/test_translation_rule" : {
"post" : {
"operationId" : "DialingRule:test_translation_rule",
"summary" : "test_translation_rule - This method allows an API user to test a specific dialing rule (provided as a translation rule string) and a number",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestTranslationRuleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TestTranslationRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TestTranslationRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DialingRule | Dialing rule management"
]
}
},
"/CustomerClass/get_taxation_info" : {
"post" : {
"operationId" : "CustomerClass:get_taxation_info",
"summary" : "get_taxation_info - This method allows an API user to retrieve information about the plug-in module which is used to make tax calculations and its parameters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerClassTaxationInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassTaxationInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassTaxationInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Payments, taxation and invoice management"
]
}
},
"/TransferTo/get_destination_info" : {
"post" : {
"operationId" : "TransferTo:get_destination_info",
"summary" : "get_destination_info - This method allows an API user to get a predefined set of allowed values for the specified mobile network (configured by PortaSwitch administrator in a special \"mapping\" tariff)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDestinationInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestinationInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestinationInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TransferTo | Mobile remittance transaction management"
]
}
},
"/Env/get_custom_fields_schema" : {
"post" : {
"operationId" : "Env:get_custom_fields_schema",
"summary" : "get_custom_fields_schema - This method allows an API user to get the list of custom fields with information about their types and possible values",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomFieldsSchemaResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomFieldsSchemaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomFieldsSchemaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Custom field management"
]
}
},
"/UAProfileGenerator/generate_ua_profile" : {
"post" : {
"operationId" : "UAProfileGenerator:generate_ua_profile",
"summary" : "generate_ua_profile - This method allows an API user (administrator or reseller) to generate an IP device (also known as UA) profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenerateUaProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateUaProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateUaProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UAProfileGenerator | UA profile management"
]
}
},
"/Generic/get_internal_api_schema" : {
"post" : {
"operationId" : "Generic:get_internal_api_schema",
"summary" : "get_internal_api_schema - This method enables an API user to get the schema of porta-billing API methods (including internal ones)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAPISchemaResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetAPISchemaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetAPISchemaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | None"
]
}
},
"/Account/pause_assigned_commitment_record" : {
"post" : {
"operationId" : "Account:pause_assigned_commitment_record",
"summary" : "pause_assigned_commitment_record - The method enables an API user to temporary pause commitment conditions. The recurring charges won't be applied and the services won't be provided during the pause",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PauseAssignedCommitmentRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/PauseAssignedCommitmentRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/PauseAssignedCommitmentRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/Account/release_sim_card" : {
"post" : {
"operationId" : "Account:release_sim_card",
"summary" : "release_sim_card - This method enables an API user to release a previously assigned SIM card from an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReleaseSIMCardResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseSIMCardRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseSIMCardRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | SIM card management"
]
}
},
"/DID/delete_did_group" : {
"post" : {
"operationId" : "DID:delete_did_group",
"summary" : "delete_did_group - This method enables an API user to delete a DID group record from the DB",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteDIDGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDIDGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDIDGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Group management"
]
}
},
"/Generic/trigger_event" : {
"post" : {
"operationId" : "Generic:trigger_event",
"summary" : "trigger_event - This method puts an enabled event into the event queue in to be processed by handlers",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenericTriggerEventResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericTriggerEventRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericTriggerEventRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Internal"
]
}
},
"/DiscountPlan/delete_discount" : {
"post" : {
"operationId" : "DiscountPlan:delete_discount",
"summary" : "delete_discount - This method allows an API user to delete a discount (for a destination group)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteDiscountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDiscountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDiscountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount management"
]
}
},
"/Payment/get_transaction_actions_list" : {
"post" : {
"operationId" : "Payment:get_transaction_actions_list",
"summary" : "get_transaction_actions_list - This method enables an API user to get the list of transaction actions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransactionActionsListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TransactionActionsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TransactionActionsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Transaction management"
]
}
},
"/CustomerClass/update_notification_category_list" : {
"post" : {
"operationId" : "CustomerClass:update_notification_category_list",
"summary" : "update_notification_category_list - This method enables an API user to update the list of notification categories of customer class",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomerClassNotificationCategoryListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerClassNotificationCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerClassNotificationCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Notification template management"
]
}
},
"/RoutingPlan/update_rp_category" : {
"post" : {
"operationId" : "RoutingPlan:update_rp_category",
"summary" : "update_rp_category - This method enables an API user to update a route category from a routing plan",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRPCategoryResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRPCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRPCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Route category management"
]
}
},
"/MeasuredServices/get_customer_class_metrics_list" : {
"post" : {
"operationId" : "MeasuredServices:get_customer_class_metrics_list",
"summary" : "get_customer_class_metrics_list - This method allows an API user to retrieve measured services for a customer class",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerClassMetricListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassMetricListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassMetricListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Customer class metric management"
]
}
},
"/Customer/get_spending_counter_list" : {
"post" : {
"operationId" : "Customer:get_spending_counter_list",
"summary" : "get_spending_counter_list - This method enables an API user to retrieve the list of the traffic profile spending counter records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSpendingCounterListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSpendingCounterListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSpendingCounterListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Spending counter management"
]
}
},
"/Customer/prepare_customer_for_export" : {
"post" : {
"operationId" : "Customer:prepare_customer_for_export",
"summary" : "prepare_customer_for_export - This method enables an API user to export a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerPrepareCustomerForExportResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerPrepareCustomerForExportRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerPrepareCustomerForExportRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Internal"
]
}
},
"/Customer/modify_spending_limit" : {
"post" : {
"operationId" : "Customer:modify_spending_limit",
"summary" : "modify_spending_limit - This method allows an API user to modify a spending limit.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ModifySpendingLimitResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ModifySpendingLimitRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ModifySpendingLimitRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Spending counter management"
]
}
},
"/User/get_notification_list" : {
"post" : {
"operationId" : "User:get_notification_list",
"summary" : "get_notification_list - This method enables an API user to get the list of notifications of the administrative user",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUserNotificationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | Notification template management"
]
}
},
"/Template/upload_external_invoice_template_body" : {
"post" : {
"operationId" : "Template:upload_external_invoice_template_body",
"summary" : "upload_external_invoice_template_body - Use this method to replace the template file of the external invoice template",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadExternalInvoiceFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadExternalInvoiceFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/ServicePolicy/get_service_policy_info" : {
"post" : {
"operationId" : "ServicePolicy:get_service_policy_info",
"summary" : "get_service_policy_info - This method enables an API user to get a service policy and its attribute values",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServicePolicyInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServicePolicyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServicePolicyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ServicePolicy | Service policy management"
]
}
},
"/Customer/get_service_wallet_xdr_list" : {
"post" : {
"operationId" : "Customer:get_service_wallet_xdr_list",
"summary" : "get_service_wallet_xdr_list - This method enables the user to fetch the Customer Service Wallet XDRs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRetailCustomerSWXDRListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRetailCustomerSWXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRetailCustomerSWXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/RoutingPlan/delete_rp_connection" : {
"post" : {
"operationId" : "RoutingPlan:delete_rp_connection",
"summary" : "delete_rp_connection - This method allows an API user to remove custom routing per destination group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteRPConnectionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRPConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRPConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Custom routing management"
]
}
},
"/Customer/register_transaction" : {
"post" : {
"operationId" : "Customer:register_transaction",
"summary" : "register_transaction - This method enables an API user to register a transaction initiated for a retail customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerRegisterTransactionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerRegisterTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerRegisterTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Transaction management"
]
}
},
"/Vendor/get_vendor_list" : {
"post" : {
"operationId" : "Vendor:get_vendor_list",
"summary" : "get_vendor_list - This method allows an API user to obtain a list of vendors that satisfy search criteria",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVendorListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor management"
]
}
},
"/IVRApplications/add_access_number_list" : {
"post" : {
"operationId" : "IVRApplications:add_access_number_list",
"summary" : "add_access_number_list - This method enables an API user to add the IVR access numbers list",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddAccessNumberListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccessNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccessNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Access number management"
]
}
},
"/Customer/get_callqueue_prompt_file" : {
"post" : {
"operationId" : "Customer:get_callqueue_prompt_file",
"summary" : "get_callqueue_prompt_file - This method enables an API user to get the file with prompts for a specific call queue",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCQPromptFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCQPromptFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCQPromptFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Call queue management"
]
}
},
"/Destination/get_destination_list" : {
"post" : {
"operationId" : "Destination:get_destination_list",
"summary" : "get_destination_list - This method allows an administrator to retrieve the list of destinations",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDestinationPrefixListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestinationPrefixListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestinationPrefixListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination management"
]
}
},
"/Account/update_account_followme" : {
"post" : {
"operationId" : "Account:update_account_followme",
"summary" : "update_account_followme - This method allows an API user to update the follow-me settings associated with an account. It does not add or update follow-me entries",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAccountFollowMeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountFollowMeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountFollowMeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Follow-me settings management"
]
}
},
"/Destination/get_mcc_list" : {
"post" : {
"operationId" : "Destination:get_mcc_list",
"summary" : "get_mcc_list - This method enables an API user to get a list of mobile country code (MCC) records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationGetMCCListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationGetMCCMNCListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationGetMCCMNCListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/RoutingPlan/get_rp_connection_info" : {
"post" : {
"operationId" : "RoutingPlan:get_rp_connection_info",
"summary" : "get_rp_connection_info - This method allows an API user to get a custom routing record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRPConnectionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRPConnectionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRPConnectionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Custom routing management"
]
}
},
"/ContentBasedCharging/get_rating_group_list" : {
"post" : {
"operationId" : "ContentBasedCharging:get_rating_group_list",
"summary" : "get_rating_group_list - This method enables an API user to retrieve the list of existing rating groups",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRatingGroupListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRatingGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRatingGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ContentBasedCharging | Rating group management"
]
}
},
"/Account/delete_payment_method" : {
"post" : {
"operationId" : "Account:delete_payment_method",
"summary" : "delete_payment_method - This method allows an API user to delete the payment information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAccountPaymentMethodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAccountPaymentMethodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAccountPaymentMethodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Payment and topup management"
]
}
},
"/Account/get_ua_info" : {
"post" : {
"operationId" : "Account:get_ua_info",
"summary" : "get_ua_info - Obsolete. Use UA.get_ua_info method instead",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountUAInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountUAInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountUAInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | IP device assignment management"
]
}
},
"/Template/clone_template" : {
"post" : {
"operationId" : "Template:clone_template",
"summary" : "clone_template - Use this method to clone existing template",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CloneTemplateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/Customer/change_password" : {
"post" : {
"operationId" : "Customer:change_password",
"summary" : "change_password - This method allows a customer to change his password",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ChangePasswordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ChangeCustomerPasswordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ChangeCustomerPasswordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/Customer/get_zendesk_organization_list" : {
"post" : {
"operationId" : "Customer:get_zendesk_organization_list",
"summary" : "get_zendesk_organization_list - This method enables an API user to obtain organizations from the Zendesk platform",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetZendeskOrganizationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetZendeskOrganizationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetZendeskOrganizationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Support request management"
]
}
},
"/Destination/move_cset_group_dests" : {
"post" : {
"operationId" : "Destination:move_cset_group_dests",
"summary" : "move_cset_group_dests - This method enables an API user to move prefixes from one destination group to another (in complete destination group sets)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationMoveCSetGroupDestsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationMoveCSetGroupDestsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationMoveCSetGroupDestsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/Vendor/add_did_provider_account" : {
"post" : {
"operationId" : "Vendor:add_did_provider_account",
"summary" : "add_did_provider_account - This method allows an API user to create a DID provider account and connections with the specified DID provider to enable on-demand DID provisionong",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddVendorDIDProviderAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVendorDIDProviderAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVendorDIDProviderAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | DID provider account management"
]
}
},
"/UA/add_ua_profile" : {
"post" : {
"operationId" : "UA:add_ua_profile",
"summary" : "add_ua_profile - This method enables an API user to add a new UA device (IP phone) profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUAProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUAProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUAProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | Profile management"
]
}
},
"/Tariff/add_tariff" : {
"post" : {
"operationId" : "Tariff:add_tariff",
"summary" : "add_tariff - This method allows an API user to add a tariff",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddTariffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Tariff management"
]
}
},
"/Template/get_template_list" : {
"post" : {
"operationId" : "Template:get_template_list",
"summary" : "get_template_list - This method enables an API user to get the list of template records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTemplateListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTemplateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTemplateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/TimePeriod/delete_time_period" : {
"post" : {
"operationId" : "TimePeriod:delete_time_period",
"summary" : "delete_time_period - This method enables an API user to delete the time period record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteTimePeriodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteTimePeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteTimePeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TimePeriod | Time period management"
]
}
},
"/Account/update_auto_payment" : {
"post" : {
"operationId" : "Account:update_auto_payment",
"summary" : "update_auto_payment - This method enables an API user to update automated periodic payments",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Auto-payment management"
]
}
},
"/AuthzRule/rearrange_authz_rule_list" : {
"post" : {
"operationId" : "AuthzRule:rearrange_authz_rule_list",
"summary" : "rearrange_authz_rule_list - This method enables an API user to change the 'order_number' value of all existing manually created authentication rules",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RearrangeAuthzRuleListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RearrangeAuthzRuleListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RearrangeAuthzRuleListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AuthzRule | Authorization rule management"
]
}
},
"/User/delete_user" : {
"post" : {
"operationId" : "User:delete_user",
"summary" : "delete_user - This method allows an API user to delete an existing administrative user",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteUserResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteUserRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteUserRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | User management"
]
}
},
"/Representative/delete_representative" : {
"post" : {
"operationId" : "Representative:delete_representative",
"summary" : "delete_representative - This method allows an API user to delete representatives from the system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteRepresentativeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRepresentativeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRepresentativeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Representative | Representative management"
]
}
},
"/Product/update_service_and_rating" : {
"post" : {
"operationId" : "Product:update_service_and_rating",
"summary" : "update_service_and_rating - This method allows an API user to update an existing rating entry in a product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateServiceAndRatingResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateServiceAndRatingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateServiceAndRatingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Service and rating management"
]
}
},
"/Account/update_cp_condition" : {
"post" : {
"operationId" : "Account:update_cp_condition",
"summary" : "update_cp_condition - This method allows an API user to update an existing call screening condition",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCPConditionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCPConditionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCPConditionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call screening management"
]
}
},
"/Notification/get_notification_list" : {
"post" : {
"operationId" : "Notification:get_notification_list",
"summary" : "get_notification_list - This method enables an API user to get the list of notifications",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNotificationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Notification | Notification management"
]
}
},
"/DID/assign_did_to_reseller" : {
"post" : {
"operationId" : "DID:assign_did_to_reseller",
"summary" : "assign_did_to_reseller - This method allows an API user (administrator) to assign a DID number to a reseller",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssignDIDToResellerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignDIDToResellerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignDIDToResellerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/ContentBasedCharging/add_marketing_group" : {
"post" : {
"operationId" : "ContentBasedCharging:add_marketing_group",
"summary" : "add_marketing_group - This method enables an API user to add a marketing group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddMarketingGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddMarketingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddMarketingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ContentBasedCharging | Marketing group management"
]
}
},
"/Session/login" : {
"post" : {
"operationId" : "Session:login",
"summary" : "login - This method checks the validity of login and password or token and returns the session_id on success. API Fault is thrown on failure",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LoginResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/LoginRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/LoginRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Session | Authenticated session management"
]
}
},
"/Report/get_cost_revenue_file_list" : {
"post" : {
"operationId" : "Report:get_cost_revenue_file_list",
"summary" : "get_cost_revenue_file_list - This method enables an API user to obtain the list of Cost/Revenue report files",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCostRevenueFileListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCostRevenueFileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCostRevenueFileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Report | Cost/Revenue report management"
]
}
},
"/RoutingPlan/update_routing_plan" : {
"post" : {
"operationId" : "RoutingPlan:update_routing_plan",
"summary" : "update_routing_plan - This method allows an API user to update a routing plan using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRoutingPlanResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRoutingPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRoutingPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Routing plan management"
]
}
},
"/RoutingCriteria/delete_routing_criteria" : {
"post" : {
"operationId" : "RoutingCriteria:delete_routing_criteria",
"summary" : "delete_routing_criteria - This method enables an API user to delete a routing criteria record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteRoutingCriteriaResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRoutingCriteriaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRoutingCriteriaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingCriteria | Routing criteria management"
]
}
},
"/ServicePolicy/delete_service_policy" : {
"post" : {
"operationId" : "ServicePolicy:delete_service_policy",
"summary" : "delete_service_policy - This method enables an API user to delete the service policy",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteServicePolicyResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteServicePolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteServicePolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ServicePolicy | Service policy management"
]
}
},
"/Payment/get_payment_transaction_by_id" : {
"post" : {
"operationId" : "Payment:get_payment_transaction_by_id",
"summary" : "get_payment_transaction_by_id - This method allows an API user to get info about a transaction by its ID",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPaymentTransactionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPaymentTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPaymentTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Transaction management"
]
}
},
"/Vendor/get_transactions_total_info" : {
"post" : {
"operationId" : "Vendor:get_transactions_total_info",
"summary" : "get_transactions_total_info - This method enables an API user to get the list of a vendor's transactions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVendorTransactionsTotalInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorTransactionsTotalInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorTransactionsTotalInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Transaction management"
]
}
},
"/Account/enable_api_notifications" : {
"post" : {
"operationId" : "Account:enable_api_notifications",
"summary" : "enable_api_notifications - Obsolete. Use CallControl.enable_api_notifications method instead",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EnableApiNotificationsAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EnableApiNotificationsAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EnableApiNotificationsAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Async API notification management"
]
}
},
"/Service/get_service_info" : {
"post" : {
"operationId" : "Service:get_service_info",
"summary" : "get_service_info - This method enables an API user to get the service record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServiceInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Service management"
]
}
},
"/DID/get_number_list" : {
"post" : {
"operationId" : "DID:get_number_list",
"summary" : "get_number_list - This method allows an API user to get the list of active DID numbers filtered by various parameters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDNumberListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/Template/get_template_group_field_list" : {
"post" : {
"operationId" : "Template:get_template_group_field_list",
"summary" : "get_template_group_field_list - This method enables an API user to get the list of the group fields of the template",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TemplateGetTemplateGroupFieldListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateGetTemplateGroupFieldListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateGetTemplateGroupFieldListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Internal"
]
}
},
"/SIMCard/delete_sim_card" : {
"post" : {
"operationId" : "SIMCard:delete_sim_card",
"summary" : "delete_sim_card - This method enables an API user to delete a sim card record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteSIMCardResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteSIMCardRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteSIMCardRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"SIMCard | SIM card management"
]
}
},
"/DID/cancel_did_assignment" : {
"post" : {
"operationId" : "DID:cancel_did_assignment",
"summary" : "cancel_did_assignment - This method allows an API user to remove a previously assigned DID number from a customer's account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CancelDIDAssignmentResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CancelDIDAssignmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CancelDIDAssignmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/Destination/get_dest_group_set_info" : {
"post" : {
"operationId" : "Destination:get_dest_group_set_info",
"summary" : "get_dest_group_set_info - This method enables an API user to get the complete information about the destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDestGroupSetInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestGroupSetInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestGroupSetInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group set management"
]
}
},
"/Customer/get_batch_list" : {
"post" : {
"operationId" : "Customer:get_batch_list",
"summary" : "get_batch_list - This method allows an API user to get the list of batches of accounts",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerBatchListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerBatchList"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerBatchList"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Account batch management"
]
}
},
"/QuickForms/get_quick_form_info" : {
"post" : {
"operationId" : "QuickForms:get_quick_form_info",
"summary" : "get_quick_form_info - This method enables an API user to get the data of the quick form",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerQFInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerQFInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerQFInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"QuickForms | Quick form management"
]
}
},
"/BillingSession/get_active_sessions_list" : {
"post" : {
"operationId" : "BillingSession:get_active_sessions_list",
"summary" : "get_active_sessions_list - This method enables an API user to get the list of active sessions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetActiveSessionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetActiveSessionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetActiveSessionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BillingSession | Billing session management"
]
}
},
"/XDRMediator/reprocess_xdr_list" : {
"post" : {
"operationId" : "XDRMediator:reprocess_xdr_list",
"summary" : "reprocess_xdr_list - This method enables an API user to reprocess specific xdr list in the collection",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReprocessMediatorXDRListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReprocessMediatorXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReprocessMediatorXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"XDRMediator | XDR Mediator management"
]
}
},
"/Product/get_subscriptions" : {
"post" : {
"operationId" : "Product:get_subscriptions",
"summary" : "get_subscriptions - This method allows an API user to get the subscription included in this product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetProductSubscriptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Subscription management"
]
}
},
"/Tariff/update_override_tariff" : {
"post" : {
"operationId" : "Tariff:update_override_tariff",
"summary" : "update_override_tariff - This method allows an API user to update an existing override tariff rule",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateOverrideTariffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateOverrideTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateOverrideTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Override tariff rule management"
]
}
},
"/Template/get_template_data_field_list" : {
"post" : {
"operationId" : "Template:get_template_data_field_list",
"summary" : "get_template_data_field_list - Use this method to receive the list of the template data fields. Data fields describe a single element of data, such as \"invoice number\", \"price\" or \"company name\". They describe how to show the data element in the output file (e.g. to what format to convert it, what post-processing rule to apply to it, etc.)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTemplateDataFieldListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTemplateDataFieldListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTemplateDataFieldListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/CustomerClass/get_notification_list" : {
"post" : {
"operationId" : "CustomerClass:get_notification_list",
"summary" : "get_notification_list - This method enables an API user to get the list of notifications of the customer class",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerClassNotificationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Notification template management"
]
}
},
"/EmergencyUnit/update_emergency_unit" : {
"post" : {
"operationId" : "EmergencyUnit:update_emergency_unit",
"summary" : "update_emergency_unit - This method enables an API user to update an emergency routing unit",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateEmergencyUnitResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateEmergencyUnitRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateEmergencyUnitRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"EmergencyUnit | Emergency routing unit management"
]
}
},
"/Account/get_routing_options" : {
"post" : {
"operationId" : "Account:get_routing_options",
"summary" : "get_routing_options - This method enables an API user to obtain the routing options of the account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountGetRoutingOptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetRoutingOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetRoutingOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/Customer/delete_customer_extension" : {
"post" : {
"operationId" : "Customer:delete_customer_extension",
"summary" : "delete_customer_extension - This method allows a retail customer to remove an extension",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerExtensionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerExtensionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerExtensionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Extension management"
]
}
},
"/Account/get_sip_status" : {
"post" : {
"operationId" : "Account:get_sip_status",
"summary" : "get_sip_status - This method allows an API user to check if an account is currently being used by a SIP UA to register with the SIP server and retrieve registration information, such as the user agent’s identification or URI",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSipStatusResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSipStatusRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSipStatusRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/Vendor/update_did_provider_account" : {
"post" : {
"operationId" : "Vendor:update_did_provider_account",
"summary" : "update_did_provider_account - This method enables an API user to update a DID provider account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateVendorDIDProviderAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVendorDIDProviderAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVendorDIDProviderAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | DID provider account management"
]
}
},
"/Destination/delete_destination" : {
"post" : {
"operationId" : "Destination:delete_destination",
"summary" : "delete_destination - This method enables an API user to delete an existing destination",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteDestinationPrefixResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDestinationPrefixRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDestinationPrefixRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination management"
]
}
},
"/RoutingCriteria/get_routing_criteria_list" : {
"post" : {
"operationId" : "RoutingCriteria:get_routing_criteria_list",
"summary" : "get_routing_criteria_list - This method enables an API user to get a list of routing criteria records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRoutingCriteriaListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoutingCriteriaListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoutingCriteriaListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingCriteria | Routing criteria management"
]
}
},
"/CustomerClass/get_customer_class_list" : {
"post" : {
"operationId" : "CustomerClass:get_customer_class_list",
"summary" : "get_customer_class_list - This method allows an API user to get the list of customer class records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerClassListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Customer class management"
]
}
},
"/DID/release_did_from_reseller" : {
"post" : {
"operationId" : "DID:release_did_from_reseller",
"summary" : "release_did_from_reseller - This method allows an API user (administrator or reseller) to release a previously assigned DID number from a reseller",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReleaseDIDFromResellerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseDIDFromResellerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseDIDFromResellerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/IVRApplications/get_ivr_application_info" : {
"post" : {
"operationId" : "IVRApplications:get_ivr_application_info",
"summary" : "get_ivr_application_info - This method enables an API user to get the IVR application information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetIvrApplicationInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetIvrApplicationInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetIvrApplicationInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Application management"
]
}
},
"/Account/disable_api_notifications" : {
"post" : {
"operationId" : "Account:disable_api_notifications",
"summary" : "disable_api_notifications - Obsolete. Use CallControl.disable_api_notifications method instead",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisableApiNotificationsAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DisableApiNotificationsAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DisableApiNotificationsAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Async API notification management"
]
}
},
"/Template/get_template_info" : {
"post" : {
"operationId" : "Template:get_template_info",
"summary" : "get_template_info - Use this method to receive information about a template record (e.g. a name, a template type, the output file format, etc.)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTemplateInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTemplateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTemplateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/Account/arrange_followme_numbers" : {
"post" : {
"operationId" : "Account:arrange_followme_numbers",
"summary" : "arrange_followme_numbers - This method arranges follow-me entries in a specified order",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ArrangeFollowMeNumbersResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ArrangeFollowMeNumbersRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ArrangeFollowMeNumbersRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Follow-me settings management"
]
}
},
"/OffPeak/get_off_peak_list" : {
"post" : {
"operationId" : "OffPeak:get_off_peak_list",
"summary" : "get_off_peak_list - This method enables an API user to retrieve the list of off-peak periods",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetOffPeakListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOffPeakListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOffPeakListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"OffPeak | Off-peak period management"
]
}
},
"/Customer/add_abbreviated_dialing_number" : {
"post" : {
"operationId" : "Customer:add_abbreviated_dialing_number",
"summary" : "add_abbreviated_dialing_number - This method allows an API user to add an abbreviated dialing number for a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerAbbreviatedDialingNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerAbbreviatedDialingNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerAbbreviatedDialingNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Abbreviated dialing number management"
]
}
},
"/Invoice/get_type_info" : {
"post" : {
"operationId" : "Invoice:get_type_info",
"summary" : "get_type_info - This method enables getting the information about the type of an invoice",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetInvoiceTypeInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetInvoiceTypeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetInvoiceTypeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/RoutingCriteria/get_routing_criteria_info" : {
"post" : {
"operationId" : "RoutingCriteria:get_routing_criteria_info",
"summary" : "get_routing_criteria_info - This method enables an API user to get information about a routing criteria record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRoutingCriteriaInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoutingCriteriaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoutingCriteriaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingCriteria | Routing criteria management"
]
}
},
"/IVRApplications/update_access_number" : {
"post" : {
"operationId" : "IVRApplications:update_access_number",
"summary" : "update_access_number - This method allows an API user to update the IVR access number",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAccessNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccessNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccessNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Access number management"
]
}
},
"/ServicePolicy/get_service_policy_list" : {
"post" : {
"operationId" : "ServicePolicy:get_service_policy_list",
"summary" : "get_service_policy_list - This method enables an API user to get a list of service policy records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServicePolicyListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServicePolicyListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServicePolicyListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ServicePolicy | Service policy management"
]
}
},
"/RoutingPlan/get_routing_plan_list" : {
"post" : {
"operationId" : "RoutingPlan:get_routing_plan_list",
"summary" : "get_routing_plan_list - This method allows an API user to get the list of routing plans",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRoutingPlanListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoutingPlanListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoutingPlanListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Routing plan management"
]
}
},
"/RouteCategories/delete_route_category" : {
"post" : {
"operationId" : "RouteCategories:delete_route_category",
"summary" : "delete_route_category - This method enables an API user to delete a route category record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteRouteCategoryResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRouteCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRouteCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RouteCategories | Route category management"
]
}
},
"/MeasuredServices/update_customer_class_metric" : {
"post" : {
"operationId" : "MeasuredServices:update_customer_class_metric",
"summary" : "update_customer_class_metric - This method allows an API user to update a measured service for a customer class",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassMetricResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Customer class metric management"
]
}
},
"/Account/add_followme_number_list" : {
"post" : {
"operationId" : "Account:add_followme_number_list",
"summary" : "add_followme_number_list - This method allows an API user to add a list of follow-me entries (numbers) associated with an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateFollowMeNumberListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddFollowMeNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddFollowMeNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Follow-me settings management"
]
}
},
"/Invoice/review_invoice_list" : {
"post" : {
"operationId" : "Invoice:review_invoice_list",
"summary" : "review_invoice_list - This method enables an API user to either approve or regenerate invoices under review",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReviewInvoiceListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReviewInvoiceListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReviewInvoiceListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Rate/get_rate_info" : {
"post" : {
"operationId" : "Rate:get_rate_info",
"summary" : "get_rate_info - This method allows an API user to get information about a rate",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRateInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Rate management"
]
}
},
"/Representative/add_representative" : {
"post" : {
"operationId" : "Representative:add_representative",
"summary" : "add_representative - This method allows an API user to add representatives to the system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRepresentativeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRepresentativeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRepresentativeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Representative | Representative management"
]
}
},
"/Customer/close_billing_period" : {
"post" : {
"operationId" : "Customer:close_billing_period",
"summary" : "close_billing_period - This method enables an API user to schedule a customer's billing period closure. Can be used only for the customers that require administrator's approval for billing period closure",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CloseBillingPeriodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloseBillingPeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloseBillingPeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/Template/update_template_group_field_list" : {
"post" : {
"operationId" : "Template:update_template_group_field_list",
"summary" : "update_template_group_field_list - This method enables an API user to update template group fields",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TemplateUpdateTemplateGroupFieldListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateUpdateTemplateGroupFieldListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateUpdateTemplateGroupFieldListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Internal"
]
}
},
"/IVRApplications/get_voice_application_list" : {
"post" : {
"operationId" : "IVRApplications:get_voice_application_list",
"summary" : "get_voice_application_list - This method enables an API user to get the list of voice applications",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVoiceApplicationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVoiceApplicationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVoiceApplicationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Application management"
]
}
},
"/CommissionPlan/update_commission_plan" : {
"post" : {
"operationId" : "CommissionPlan:update_commission_plan",
"summary" : "update_commission_plan - This method allows an API user to update a commission plan record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCommissionPlanResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCommissionPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCommissionPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CommissionPlan | Commission plan management"
]
}
},
"/AccessControl/get_operation_access_id" : {
"post" : {
"operationId" : "AccessControl:get_operation_access_id",
"summary" : "get_operation_access_id - This method enables getting access ID for a particular operation. The ID will be sent to the email/mobile of the requestor",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetOperationAccessIdResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOperationAccessIdRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOperationAccessIdRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessControl | Access control management"
]
}
},
"/AccessRole/update_access_role" : {
"post" : {
"operationId" : "AccessRole:update_access_role",
"summary" : "update_access_role - This method enables an API user to update an access role record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAccessRoleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccessRoleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccessRoleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessRole | Access role management"
]
}
},
"/Customer/get_migration_info" : {
"post" : {
"operationId" : "Customer:get_migration_info",
"summary" : "get_migration_info - This method enables an API user to get information about customer migration",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerMigrationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerMigrationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerMigrationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/Commitment/estimate_commitment_price_for_first_billing_period" : {
"post" : {
"operationId" : "Commitment:estimate_commitment_price_for_first_billing_period",
"summary" : "estimate_commitment_price_for_first_billing_period - The method enables an API user to estimate the cost of a commitment in the first billing period",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EstimateCommitmentPriceForFirstBillingPeriodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EstimateCommitmentPriceForFirstBillingPeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EstimateCommitmentPriceForFirstBillingPeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/Account/generate_aliases" : {
"post" : {
"operationId" : "Account:generate_aliases",
"summary" : "generate_aliases - This method enables an API user to generate a batch of aliases",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenerateAliasesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateAliasesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateAliasesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Batch management"
]
}
},
"/DID/release_did_from_customer" : {
"post" : {
"operationId" : "DID:release_did_from_customer",
"summary" : "release_did_from_customer - This method allows an API user to release a DID number previously assigned to a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReleaseDIDFromCustomerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseDIDFromCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseDIDFromCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/Destination/add_cset_group" : {
"post" : {
"operationId" : "Destination:add_cset_group",
"summary" : "add_cset_group - This method enables an API user to add a group of a complete destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationAddCSetGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationAddUpdateCSetGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationAddUpdateCSetGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/Vendor/get_xdr_list" : {
"post" : {
"operationId" : "Vendor:get_xdr_list",
"summary" : "get_xdr_list - The method enables an API user to retrieve vendor XDR records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVendorXDRListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Information and statistics management"
]
}
},
"/TrafficProfile/get_spending_constraint_info" : {
"post" : {
"operationId" : "TrafficProfile:get_spending_constraint_info",
"summary" : "get_spending_constraint_info - This method enables an API user to get the information about a traffic profile spending constraint",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSpendingConstraintInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSpendingConstraintInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSpendingConstraintInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Constraint management"
]
}
},
"/Payment/delete_merchant" : {
"post" : {
"operationId" : "Payment:delete_merchant",
"summary" : "delete_merchant - This method allows an API user to delete a payment or payment remittance system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteMerchantAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteMerchantAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteMerchantAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Merchant account management"
]
}
},
"/DiscountPlan/get_vd_threshold_info" : {
"post" : {
"operationId" : "DiscountPlan:get_vd_threshold_info",
"summary" : "get_vd_threshold_info - This method allows an API user to get the information about a threshold (discount scheme) for the specified discount record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVDThresholdInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVDThresholdInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVDThresholdInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Threshold management"
]
}
},
"/DiscountPlan/delete_topup_option" : {
"post" : {
"operationId" : "DiscountPlan:delete_topup_option",
"summary" : "delete_topup_option - This method allows an API user to delete a topup option",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteVDTopupOptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVDTopupOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVDTopupOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Topup option management"
]
}
},
"/Account/estimate_taxes" : {
"post" : {
"operationId" : "Account:estimate_taxes",
"summary" : "estimate_taxes - TThis method enables an API user to show tax rates or calculate the tax for a list of xDRs. To calculate the tax, the provided xDRs must have charged_amount specified. All other properties are optional.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountEstimateTaxesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountEstimateTaxesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountEstimateTaxesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Payment and topup management"
]
}
},
"/AsyncRequest/delete_request_list" : {
"post" : {
"operationId" : "AsyncRequest:delete_request_list",
"summary" : "delete_request_list - This method enables deleting async requests",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAsyncRequestListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAsyncRequestListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAsyncRequestListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AsyncRequest | Asynchronous request management"
]
}
},
"/RouteCategories/add_route_category" : {
"post" : {
"operationId" : "RouteCategories:add_route_category",
"summary" : "add_route_category - This method enables an API user to add a new route category record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddRouteCategoryResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRouteCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRouteCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RouteCategories | Route category management"
]
}
},
"/Customer/charge_subscription_fees" : {
"post" : {
"operationId" : "Customer:charge_subscription_fees",
"summary" : "charge_subscription_fees - This method enables an administrator to immediately charge all of a customer’s active subscriptions (e.g. if you have just applied a subscription to a customer with a daily billing period). Otherwise, it will be done automatically within the hour",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ChargeCustomerSubscriptionFeesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ChargeCustomerSubscriptionFeesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ChargeCustomerSubscriptionFeesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Subscription management"
]
}
},
"/DID_Provider/return_number" : {
"post" : {
"operationId" : "DID_Provider:return_number",
"summary" : "return_number - This method enables an API user to return a DID number to the pool",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReturnDIDNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReturnDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReturnDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID_Provider | DID auto-provisioning management"
]
}
},
"/MOH/upload_moh_file" : {
"post" : {
"operationId" : "MOH:upload_moh_file",
"summary" : "upload_moh_file - This method enables an API user to upload and apply a new MOH file to an account or customer.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadMOHFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadMOHFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MOH | Music on hold file management"
]
}
},
"/Destination/update_dest_group_set" : {
"post" : {
"operationId" : "Destination:update_dest_group_set",
"summary" : "update_dest_group_set - This method allows an API user to update a destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateDestGroupSetResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateDestGroupSetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateDestGroupSetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group set management"
]
}
},
"/Session/login_to_realm" : {
"post" : {
"operationId" : "Session:login_to_realm",
"summary" : "login_to_realm - This method creates a session for the specific login and realm",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LoginToRealmResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/LoginToRealmRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/LoginToRealmRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Session | Authenticated session management"
]
}
},
"/Customer/set_callqueue_moh_file" : {
"post" : {
"operationId" : "Customer:set_callqueue_moh_file",
"summary" : "set_callqueue_moh_file - This method enables an API user to specify the file with the music on hold for a specific call queue",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerSetCallQueueMohFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/CustomerSetCallQueueMohFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/CustomerSetCallQueueMohFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Internal"
]
}
},
"/TimePeriod/update_time_period" : {
"post" : {
"operationId" : "TimePeriod:update_time_period",
"summary" : "update_time_period - This method enables an API user to update the time period record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTimePeriodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTimePeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTimePeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TimePeriod | Time period management"
]
}
},
"/Customer/update_taxation" : {
"post" : {
"operationId" : "Customer:update_taxation",
"summary" : "update_taxation - This method allows an API user to set which plugin module will be used to make tax calculations and set up parameters that affect taxation",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomerTaxationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerTaxationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerTaxationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Payments, taxation and invoice management"
]
}
},
"/DiscountPlan/add_discount_plan" : {
"post" : {
"operationId" : "DiscountPlan:add_discount_plan",
"summary" : "add_discount_plan - This method allows an API user to add a volume discount plan",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddDiscountPlanResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDiscountPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDiscountPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount plan management"
]
}
},
"/Product/check_content_based_charging" : {
"post" : {
"operationId" : "Product:check_content_based_charging",
"summary" : "check_content_based_charging - This method checks the content-based charging configuration of the product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductCheckContentBasedChargingResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductCheckContentBasedChargingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductCheckContentBasedChargingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Internal"
]
}
},
"/Account/schedule_commitment_record_replacement" : {
"post" : {
"operationId" : "Account:schedule_commitment_record_replacement",
"summary" : "schedule_commitment_record_replacement - The method enables an API user to schedule a commitment replacement with a new one. The new addon product, specified in the request, will be assigned to the account until the specified replacement date",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ScheduleCommitmentRecordReplacementResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ScheduleCommitmentRecordReplacementRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ScheduleCommitmentRecordReplacementRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/Customer/get_metrics_data" : {
"post" : {
"operationId" : "Customer:get_metrics_data",
"summary" : "get_metrics_data - This method allows an API user to get the collected data (for instance, the number of concurrent calls for a period of time) of the customer's metrics. Used for charts",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMetricsDataResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMetricsDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMetricsDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Measured service management"
]
}
},
"/Account/add_preferable_account" : {
"post" : {
"operationId" : "Account:add_preferable_account",
"summary" : "add_preferable_account - This method enables an API user to add a record to the account’s Favourites list",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddPreferableAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddPreferableAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddPreferableAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Favourites list management"
]
}
},
"/CallBarring/add_call_barring_class" : {
"post" : {
"operationId" : "CallBarring:add_call_barring_class",
"summary" : "add_call_barring_class - This method enables an API user to create a new call barring class record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCallBarringClassResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCallBarringClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCallBarringClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CallBarring | Call barring class management"
]
}
},
"/Customer/update_callqueue" : {
"post" : {
"operationId" : "Customer:update_callqueue",
"summary" : "update_callqueue - This method allows an API user to update the call queue configured for a huntgroup",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCallQueueResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UpdateCallQueueRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UpdateCallQueueRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Call queue management"
]
}
},
"/Account/update_preferable_account" : {
"post" : {
"operationId" : "Account:update_preferable_account",
"summary" : "update_preferable_account - This method enables an API user to update a record in the account’s Favourites list",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdatePreferableAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdatePreferableAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdatePreferableAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Favourites list management"
]
}
},
"/Tariff/rerate_xdrs" : {
"post" : {
"operationId" : "Tariff:rerate_xdrs",
"summary" : "rerate_xdrs - The method enables an API user to re-rate xDRs. It helps the API user to fix incorrect pricing information entered into a tariff",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RerateXDRsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RerateXDRsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RerateXDRsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Information and statistics management"
]
}
},
"/Product/get_service_and_rating_list" : {
"post" : {
"operationId" : "Product:get_service_and_rating_list",
"summary" : "get_service_and_rating_list - This method allows an API user to get the list of a product's rating entries. Rating entry is the main component of a product definition. It specifies where your customers are allowed to use a service and how they should be charged for it",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServiceAndRatingListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceAndRatingListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceAndRatingListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Service and rating management"
]
}
},
"/Account/activate_subscriptions" : {
"post" : {
"operationId" : "Account:activate_subscriptions",
"summary" : "activate_subscriptions - This method allows an API user to instantly activate an accounts's pending subscriptions, where the start date is less than or equal to today's date (in the customer’s time zone). An activation fee will be charged for each subscription, if applicable",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ActivateAccountSubscriptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ActivateAccountSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ActivateAccountSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Subscription management"
]
}
},
"/Account/get_cp_rule_list" : {
"post" : {
"operationId" : "Account:get_cp_rule_list",
"summary" : "get_cp_rule_list - This method allows an API user to retrieve the information about defined call screening rules",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCPRuleListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCPRuleListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCPRuleListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call screening management"
]
}
},
"/AccessRole/add_access_role" : {
"post" : {
"operationId" : "AccessRole:add_access_role",
"summary" : "add_access_role - This method enables an API user to create a new access role record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAccessRoleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccessRoleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccessRoleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessRole | Access role management"
]
}
},
"/MeasuredServices/add_customer_metric" : {
"post" : {
"operationId" : "MeasuredServices:add_customer_metric",
"summary" : "add_customer_metric - This method allows an API user to add a new measured service for a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerMetricResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Customer metric management"
]
}
},
"/TransferTo/make_transfer" : {
"post" : {
"operationId" : "TransferTo:make_transfer",
"summary" : "make_transfer - This method allows an API user to initiate a mobile remittance transaction. Funds are withdrawn from the account in PortaSwitch and the remittance processor is instructed to transfer the funds to B's mobile phone",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MakeTransferResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeTransferRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeTransferRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TransferTo | Mobile remittance transaction management"
]
}
},
"/Account/update_assigned_commitment_record" : {
"post" : {
"operationId" : "Account:update_assigned_commitment_record",
"summary" : "update_assigned_commitment_record - The method enables an API user to update a commitment assigned to an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAssignedCommitmentRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAssignedCommitmentRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAssignedCommitmentRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/Account/add_account_with_topup" : {
"post" : {
"operationId" : "Account:add_account_with_topup",
"summary" : "add_account_with_topup - This method enables an API user to create a new account and recharge it with the voucher",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountAddAccountWithTopupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountAddAccountWithTopupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountAddAccountWithTopupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/RoutingPlan/delete_rp_category" : {
"post" : {
"operationId" : "RoutingPlan:delete_rp_category",
"summary" : "delete_rp_category - This method enables an API user to delete a route category from a routing plan",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteRPCategoryResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRPCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRPCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Route category management"
]
}
},
"/Account/get_permitted_sip_proxies_info" : {
"post" : {
"operationId" : "Account:get_permitted_sip_proxies_info",
"summary" : "get_permitted_sip_proxies_info - This method allows an API user to get the list of permitted IP addresses for proxying",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountPermittedProxyInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountPermittedProxyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountPermittedProxyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/Customer/update_service_features" : {
"post" : {
"operationId" : "Customer:update_service_features",
"summary" : "update_service_features - This method allows an API user to update settings for customer service features",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomerServiceFeaturesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerServiceFeaturesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerServiceFeaturesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Service features management"
]
}
},
"/Customer/get_site_info" : {
"post" : {
"operationId" : "Customer:get_site_info",
"summary" : "get_site_info - This method allows an API user to get information about a customer site and its service features",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSiteInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSiteInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSiteInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Site management"
]
}
},
"/Account/release_ua" : {
"post" : {
"operationId" : "Account:release_ua",
"summary" : "release_ua - This method allows an API user to release an account's UA",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReleaseUAResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseUARequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseUARequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | IP device assignment management"
]
}
},
"/Account/update_subscription" : {
"post" : {
"operationId" : "Account:update_subscription",
"summary" : "update_subscription - This method allows an API user to update an existing subscription record associated with an account. It requires an ID number returned, for example, by the add_subscription method",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAccountSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Subscription management"
]
}
},
"/Customer/get_accounts_subscriptions" : {
"post" : {
"operationId" : "Customer:get_accounts_subscriptions",
"summary" : "get_accounts_subscriptions - This method enables an API user to retrieve a customer's accounts' subscriptions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerGetCustomerAccountsSubscriptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerGetCustomerAccountsSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerGetCustomerAccountsSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Internal"
]
}
},
"/UA/get_ua_profile_metainfo" : {
"post" : {
"operationId" : "UA:get_ua_profile_metainfo",
"summary" : "get_ua_profile_metainfo - This method enables an API user to get the information about UA profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UAGetUAProfileMetaInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UAGetUAProfileMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UAGetUAProfileMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | Internal"
]
}
},
"/Account/get_assigned_commitment_terms" : {
"post" : {
"operationId" : "Account:get_assigned_commitment_terms",
"summary" : "get_assigned_commitment_terms - The method enables an API user to get account commitment terms associated with an assigned commitment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAssignedCommitmentTermsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAssignedCommitmentTermsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAssignedCommitmentTermsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/IVRApplications/delete_access_number" : {
"post" : {
"operationId" : "IVRApplications:delete_access_number",
"summary" : "delete_access_number - This method enables an API user to delete the IVR access number",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAccessNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAccessNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAccessNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Access number management"
]
}
},
"/RoutingPlan/add_rp_category" : {
"post" : {
"operationId" : "RoutingPlan:add_rp_category",
"summary" : "add_rp_category - This method enables an API user to add a route category to a routing plan",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRPCategoryResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRPCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRPCategoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Route category management"
]
}
},
"/ACL/get_acl_list" : {
"post" : {
"operationId" : "ACL:get_acl_list",
"summary" : "get_acl_list - This method allows an API user to get the list of ACL",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAclListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAclListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAclListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ACL | ACL management"
]
}
},
"/CDR/get_aux_xdr_type_list" : {
"post" : {
"operationId" : "CDR:get_aux_xdr_type_list",
"summary" : "get_aux_xdr_type_list - The method enables an API user to fetch information about auxiliary XDR types",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAuxXDRTypeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAuxXDRTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAuxXDRTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CDR | XDR management"
]
}
},
"/User/update_notification_category_list" : {
"post" : {
"operationId" : "User:update_notification_category_list",
"summary" : "update_notification_category_list - This method enables an API user to update the list of notification categories of the administrative user",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateUserNotificationCategoryListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUserNotificationCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUserNotificationCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | Notification template management"
]
}
},
"/Product/get_subrealms_list" : {
"post" : {
"operationId" : "Product:get_subrealms_list",
"summary" : "get_subrealms_list - This method enables an API user to get a list of subrealms",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSubrealmsListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSubrealmsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSubrealmsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/MeasuredServices/add_customer_class_metric" : {
"post" : {
"operationId" : "MeasuredServices:add_customer_class_metric",
"summary" : "add_customer_class_metric - This method allows an API user to add a new measured service for a customer class",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassMetricResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Customer class metric management"
]
}
},
"/DID/delete_number" : {
"post" : {
"operationId" : "DID:delete_number",
"summary" : "delete_number - This method allows an API user to delete a DID number from the DID inventory",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteDIDNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/Service/delete_service" : {
"post" : {
"operationId" : "Service:delete_service",
"summary" : "delete_service - This method enables an API user to delete the service record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteServiceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteServiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteServiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Service management"
]
}
},
"/Service/get_service_type_info" : {
"post" : {
"operationId" : "Service:get_service_type_info",
"summary" : "get_service_type_info - This method allows an API user to get a service type record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServiceTypeInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceTypeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceTypeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Type management"
]
}
},
"/Generic/get_property_history_catalog_info" : {
"post" : {
"operationId" : "Generic:get_property_history_catalog_info",
"summary" : "get_property_history_catalog_info - This method enables an API user to get the information about a property history catalog record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenericGetPropertyHistoryCatalogInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetPropertyHistoryCatalogInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetPropertyHistoryCatalogInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Internal"
]
}
},
"/Account/validate_account_info" : {
"post" : {
"operationId" : "Account:validate_account_info",
"summary" : "validate_account_info - This method enables an API user to check if the supplied data can be used to create a new account record or update an existing one. If successful, the completed data is returned. Note that if a user is not allowed to manage (create/read/update/delete access types) some field by an ACL, then the client application must not send this property in the request (Otherwise PortaBilling® will reject the whole request). That is why we recommend you to make sure that your customer portals and other external applications correspond to the ACL configuration in PortaBilling®. Use the get_my_permissions_for_objects method to find out the permissions for every object on the PortaBilling® web interface.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ValidateAccountInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ValidateAccountInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ValidateAccountInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account management"
]
}
},
"/DID/add_did_group" : {
"post" : {
"operationId" : "DID:add_did_group",
"summary" : "add_did_group - This method enables an API user to create a DID group record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddDIDGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDIDGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDIDGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Group management"
]
}
},
"/Customer/get_sites" : {
"post" : {
"operationId" : "Customer:get_sites",
"summary" : "get_sites - This method allows an API user to retrieve the list of customer sites (a group of customer's accounts managed as a single entity)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerSitesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerSitesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerSitesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Site management"
]
}
},
"/DID/add_number" : {
"post" : {
"operationId" : "DID:add_number",
"summary" : "add_number - This method allows an API user to add a DID number to the DID inventory",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/XDRMediator/batch_process_collection" : {
"post" : {
"operationId" : "XDRMediator:batch_process_collection",
"summary" : "batch_process_collection - This method enables an API user to launch the reprocessing of the collection that contains rejected xDRs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProcessCollectionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProcessCollectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProcessCollectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"XDRMediator | XDR Mediator management"
]
}
},
"/Invoice/get_template_list" : {
"post" : {
"operationId" : "Invoice:get_template_list",
"summary" : "get_template_list - This method allows an API user to get the list of invoice template records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetInvoiceTemplateListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetInvoiceTemplateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetInvoiceTemplateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Template management"
]
}
},
"/RoutingPlan/update_rp_connection" : {
"post" : {
"operationId" : "RoutingPlan:update_rp_connection",
"summary" : "update_rp_connection - This method allows an API user to change custom routing per destination group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRPConnectionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRPConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRPConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Custom routing management"
]
}
},
"/Destination/list_cset_group_dests" : {
"post" : {
"operationId" : "Destination:list_cset_group_dests",
"summary" : "list_cset_group_dests - This method enables an API user to get a list of destinations of the complete destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationListCSetGroupDestsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationListCSetGroupDestsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationListCSetGroupDestsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/DID/upload_did_numbers" : {
"post" : {
"operationId" : "DID:upload_did_numbers",
"summary" : "upload_did_numbers - This method enables an API user to upload DID numbers into the system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadDIDNumbersResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadDIDNumbersRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/Destination/update_dest_group" : {
"post" : {
"operationId" : "Destination:update_dest_group",
"summary" : "update_dest_group - This method allows an API user to update an existing destination group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDestGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group management"
]
}
},
"/Destination/batch_add_destination" : {
"post" : {
"operationId" : "Destination:batch_add_destination",
"summary" : "batch_add_destination - This method enables an API user to add new destinations in batches",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationBatchAddDestinationPrefixResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationBatchAddDestinationPrefixRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationBatchAddDestinationPrefixRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/Invoice/regenerate_invoice" : {
"post" : {
"operationId" : "Invoice:regenerate_invoice",
"summary" : "regenerate_invoice - This method enables an API user to store an invoice PDF creation task",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RegenerateInvoiceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RegenerateInvoiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RegenerateInvoiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Account/add_subscription" : {
"post" : {
"operationId" : "Account:add_subscription",
"summary" : "add_subscription - This method allows an API user to add a new subscription associated with an account. If successful, a new subscription ID is returned",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAccountSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccountSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccountSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Subscription management"
]
}
},
"/RoamingProfile/get_roaming_country_list" : {
"post" : {
"operationId" : "RoamingProfile:get_roaming_country_list",
"summary" : "get_roaming_country_list - This method enables an API user to get the list of roaming countries",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRoamingCountryListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoamingCountryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoamingCountryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoamingProfile | Roaming profile management"
]
}
},
"/UA/update_ua" : {
"post" : {
"operationId" : "UA:update_ua",
"summary" : "update_ua - This method allows an API user to update a UA device (IP phone) in the IP phone inventory",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateUAResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUARequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUARequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | UA device management"
]
}
},
"/Tariff/get_tariff_info" : {
"post" : {
"operationId" : "Tariff:get_tariff_info",
"summary" : "get_tariff_info - This method allows an API user to get information about a tariff",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTariffInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTariffInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTariffInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Tariff management"
]
}
},
"/BundlePromotion/delete_criterion" : {
"post" : {
"operationId" : "BundlePromotion:delete_criterion",
"summary" : "delete_criterion - This method allows an API user to delete the bundle promotion criterion",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCriterionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCriterionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCriterionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BundlePromotion | Criterium management"
]
}
},
"/TimePeriod/get_time_period_list" : {
"post" : {
"operationId" : "TimePeriod:get_time_period_list",
"summary" : "get_time_period_list - This method enables an API user to retrieve the list of time periods",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTimePeriodListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTimePeriodListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTimePeriodListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TimePeriod | Time period management"
]
}
},
"/Subscription/get_subscription_list" : {
"post" : {
"operationId" : "Subscription:get_subscription_list",
"summary" : "get_subscription_list - This method allows an API user (administrator or reseller) to get a list of subscriptions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSubscriptionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSubscriptionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSubscriptionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Subscription | Subscription management"
]
}
},
"/AuthzRule/update_authz_rule" : {
"post" : {
"operationId" : "AuthzRule:update_authz_rule",
"summary" : "update_authz_rule - This method allows an API user to update manual authentication rules to change how PortaSIP servers handle incoming calls",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAuthzRuleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAuthzRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAuthzRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AuthzRule | Authorization rule management"
]
}
},
"/Account/get_member_of_huntgroups_list" : {
"post" : {
"operationId" : "Account:get_member_of_huntgroups_list",
"summary" : "get_member_of_huntgroups_list - This method allows an API user to get account's huntgroup",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetHGListInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMemberOfHuntgroupsList"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMemberOfHuntgroupsList"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/AccessRole/get_access_role_type_list" : {
"post" : {
"operationId" : "AccessRole:get_access_role_type_list",
"summary" : "get_access_role_type_list - This method enables an API user to get the list of access role type records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccessRoleTypeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessRoleTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessRoleTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessRole | Access role management"
]
}
},
"/NumberPorting/get_request_list" : {
"post" : {
"operationId" : "NumberPorting:get_request_list",
"summary" : "get_request_list - This method allows an API user to get the list of number porting requests",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRequestListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRequestListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRequestListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"NumberPorting | Number porting management"
]
}
},
"/RoutingPlan/get_rp_connection_list" : {
"post" : {
"operationId" : "RoutingPlan:get_rp_connection_list",
"summary" : "get_rp_connection_list - This method allows an API user to get a list of custom routing records from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRPConnectionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRPConnectionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRPConnectionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Custom routing management"
]
}
},
"/Payment/list_processors" : {
"post" : {
"operationId" : "Payment:list_processors",
"summary" : "list_processors - This method allows an API user to get a list of payment processors.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListPaymentProcessorsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ListPaymentProcessorsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ListPaymentProcessorsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Processor management"
]
}
},
"/Customer/terminate_customer" : {
"post" : {
"operationId" : "Customer:terminate_customer",
"summary" : "terminate_customer - This method allows an API user to terminate an existing retail customer or reseller",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TerminateCustomerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TerminateCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TerminateCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/Account/get_account_list" : {
"post" : {
"operationId" : "Account:get_account_list",
"summary" : "get_account_list - This method allows an API user to get the list of account records. The account must be viewable (owned) by the user making the request",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account management"
]
}
},
"/TrafficProfile/delete_traffic_profile" : {
"post" : {
"operationId" : "TrafficProfile:delete_traffic_profile",
"summary" : "delete_traffic_profile - This method enables an API user to delete a traffic profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteTrafficProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteTrafficProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteTrafficProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Profile management"
]
}
},
"/Account/assign_ua" : {
"post" : {
"operationId" : "Account:assign_ua",
"summary" : "assign_ua - This method allows an API user to assign a UA to an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssignUAResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignUARequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignUARequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | IP device assignment management"
]
}
},
"/QuickForms/set_quick_form_fields" : {
"post" : {
"operationId" : "QuickForms:set_quick_form_fields",
"summary" : "set_quick_form_fields - This method enables an API user to modify the fields of the quick form",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateQFFieldsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateQFFieldsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateQFFieldsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"QuickForms | Field management"
]
}
},
"/Account/close_subscription" : {
"post" : {
"operationId" : "Account:close_subscription",
"summary" : "close_subscription - This method allows an API user to close an existing active subscription associated with an account. It requires an ID number returned, for example, by the add_subscription method",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CloseAccountSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloseDeleteAccountSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloseDeleteAccountSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Subscription management"
]
}
},
"/IVRApplications/get_conference_settings" : {
"post" : {
"operationId" : "IVRApplications:get_conference_settings",
"summary" : "get_conference_settings - This method enables an API user to get a list of conference room parameters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetConferenceSettingsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConferenceSettingsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConferenceSettingsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Application management"
]
}
},
"/Tariff/add_override_tariff" : {
"post" : {
"operationId" : "Tariff:add_override_tariff",
"summary" : "add_override_tariff - This method allows an API user to add an override tariff rule",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateOverrideTariffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateOverrideTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateOverrideTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Override tariff rule management"
]
}
},
"/Account/get_payment_method_info" : {
"post" : {
"operationId" : "Account:get_payment_method_info",
"summary" : "get_payment_method_info - This method allows an API user to retrieve the information about the payment method (e.g. payment card info) assigned to an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountPaymentMethodInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountPaymentMethodInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountPaymentMethodInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Payment and topup management"
]
}
},
"/RouteCategories/get_route_category_list" : {
"post" : {
"operationId" : "RouteCategories:get_route_category_list",
"summary" : "get_route_category_list - This method enables an API user to get a list of route category records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRouteCategoryListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRouteCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRouteCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RouteCategories | Route category management"
]
}
},
"/Env/get_env_list" : {
"post" : {
"operationId" : "Env:get_env_list",
"summary" : "get_env_list - This method enables an API user (super user) to get environment records from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetEnvListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEnvListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEnvListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Environment management"
]
}
},
"/Env/get_notification_template_info" : {
"post" : {
"operationId" : "Env:get_notification_template_info",
"summary" : "get_notification_template_info - This method allows an API user to retrieve information about the notification template",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetEnvNotificationTemplateInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEnvNotificationTemplateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEnvNotificationTemplateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Notification template management"
]
}
},
"/CDR/batch_delete_call_recording" : {
"post" : {
"operationId" : "CDR:batch_delete_call_recording",
"summary" : "batch_delete_call_recording - This method enables an API user to delete a call recording record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/BatchDeleteCallRecordingResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/BatchDeleteCallRecordingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/BatchDeleteCallRecordingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CDR | Call recording management"
]
}
},
"/MeasuredServices/update_customer_metric" : {
"post" : {
"operationId" : "MeasuredServices:update_customer_metric",
"summary" : "update_customer_metric - This method allows an API user to update a measured service for a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerMetricResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Customer metric management"
]
}
},
"/Product/add_product" : {
"post" : {
"operationId" : "Product:add_product",
"summary" : "add_product - This method allows an API user to add a product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddProductResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddProductRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddProductRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/Product/get_subscription_info" : {
"post" : {
"operationId" : "Product:get_subscription_info",
"summary" : "get_subscription_info - This method enables an API user to get information about a product subscription",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductGetSubscriptionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductGetSubscriptionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductGetSubscriptionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Internal"
]
}
},
"/Generic/get_billing_period_list" : {
"post" : {
"operationId" : "Generic:get_billing_period_list",
"summary" : "get_billing_period_list - This method allows an API user to get information about billing periods",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetBillingPeriodListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetBillingPeriodListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetBillingPeriodListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Billing period management"
]
}
},
"/Tariff/get_override_tariff" : {
"post" : {
"operationId" : "Tariff:get_override_tariff",
"summary" : "get_override_tariff - This method allows an API user to retrieve the override tariff",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetOverrideTariffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOverrideTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOverrideTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Override tariff rule management"
]
}
},
"/Calendar/delete_dates_batch" : {
"post" : {
"operationId" : "Calendar:delete_dates_batch",
"summary" : "delete_dates_batch - This method enables an API user to delete the list of calendar date records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteDatesBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDatesBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDatesBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Calendar | Calendar management"
]
}
},
"/Account/update_followme_number_list" : {
"post" : {
"operationId" : "Account:update_followme_number_list",
"summary" : "update_followme_number_list - This method enables an API user to update, add or remove numbers from the list of follow-me entries associated with an account. It requires an ID number to be returned, for example, by the add_followme_number method. For adding new follow-me entries to the list, this method requires specifying such parameters as i_follow_me, name, redirect_number, and active. For removing unnecessary follow-me entries from the list, their IDs must not be included in the request",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateFollowMeNumberListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateFollowMeNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateFollowMeNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Follow-me settings management"
]
}
},
"/VoiceQualityProfile/delete_profile" : {
"post" : {
"operationId" : "VoiceQualityProfile:delete_profile",
"summary" : "delete_profile - This method enables an API user to delete a voice quality profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteVoiceQualityProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVoiceQualityProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVoiceQualityProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"VoiceQualityProfile | Voice quality profile management"
]
}
},
"/DID/add_vendor_batch" : {
"post" : {
"operationId" : "DID:add_vendor_batch",
"summary" : "add_vendor_batch - This method enables an API user to create a new vendor DID batch",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddVendorBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVendorBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVendorBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Vendor batch management"
]
}
},
"/Commitment/update_commitment" : {
"post" : {
"operationId" : "Commitment:update_commitment",
"summary" : "update_commitment - The method enables an API user to update the commitment information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCommitmentResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCommitmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCommitmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/Product/reapply_subscriptions" : {
"post" : {
"operationId" : "Product:reapply_subscriptions",
"summary" : "reapply_subscriptions - This method allows an API user to update the subscription for existing accounts with this product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReapplyProductSubscriptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReapplyProductSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReapplyProductSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Subscription management"
]
}
},
"/CustomerClass/clone_customer_class" : {
"post" : {
"operationId" : "CustomerClass:clone_customer_class",
"summary" : "clone_customer_class - This method enables an API user to clone a customer class record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CloneCustomerClassResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneCustomerClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneCustomerClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Customer class management"
]
}
},
"/RoamingProfile/delete_roaming_profile" : {
"post" : {
"operationId" : "RoamingProfile:delete_roaming_profile",
"summary" : "delete_roaming_profile - This method enables an API user to delete the roaming profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteRoamingProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRoamingProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRoamingProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoamingProfile | Roaming profile management"
]
}
},
"/NumberPorting/get_request_info" : {
"post" : {
"operationId" : "NumberPorting:get_request_info",
"summary" : "get_request_info - This method allows an API user to get the number porting request information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPortingRequestResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPortingRequestRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPortingRequestRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"NumberPorting | Number porting management"
]
}
},
"/Account/unpause_assigned_commitment_record" : {
"post" : {
"operationId" : "Account:unpause_assigned_commitment_record",
"summary" : "unpause_assigned_commitment_record - The method enables an API user to unpause a previously paused commitment record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UnpauseAssignedCommitmentRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UnpauseAssignedCommitmentRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UnpauseAssignedCommitmentRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/TrafficProfile/get_traffic_profile_info" : {
"post" : {
"operationId" : "TrafficProfile:get_traffic_profile_info",
"summary" : "get_traffic_profile_info - This method enables an API user to get the information about a traffic profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTrafficProfileInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTrafficProfileInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTrafficProfileInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Profile management"
]
}
},
"/Product/get_service_and_rating_info" : {
"post" : {
"operationId" : "Product:get_service_and_rating_info",
"summary" : "get_service_and_rating_info - This method allows an API user to get a product's rating entry record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServiceAndRatingInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceAndRatingInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceAndRatingInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Service and rating management"
]
}
},
"/Product/delete_product" : {
"post" : {
"operationId" : "Product:delete_product",
"summary" : "delete_product - This method allows an API user to delete an existing product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteProductResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteProductRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteProductRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/BillingSession/disconnect_session" : {
"post" : {
"operationId" : "BillingSession:disconnect_session",
"summary" : "disconnect_session - This method enables an administrator to disconnect the current voice call or Internet session",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisconnectSessionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DisconnectSessionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DisconnectSessionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BillingSession | Billing session management"
]
}
},
"/Product/get_product_info" : {
"post" : {
"operationId" : "Product:get_product_info",
"summary" : "get_product_info - This method allows an API user to get a product record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetProductInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/Currency/add_currency" : {
"post" : {
"operationId" : "Currency:add_currency",
"summary" : "add_currency - This method allows an API user to add a currency",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCurrencyResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCurrencyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCurrencyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Currency | Currency management"
]
}
},
"/Customer/set_callqueue_prompt_file" : {
"post" : {
"operationId" : "Customer:set_callqueue_prompt_file",
"summary" : "set_callqueue_prompt_file - This method enables an API user to specify the intro prompt for a specific call queue",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerSetCallQueuePromptFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/CustomerSetCallQueuePromptFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/CustomerSetCallQueuePromptFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Internal"
]
}
},
"/Customer/get_zendesk_ticket_list" : {
"post" : {
"operationId" : "Customer:get_zendesk_ticket_list",
"summary" : "get_zendesk_ticket_list - This method enables an API user to obtain tickets for a customer from the Zendesk platform",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetZendeskTicketListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetZendeskTicketListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetZendeskTicketListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Support request management"
]
}
},
"/AccessControl/create_otp" : {
"post" : {
"operationId" : "AccessControl:create_otp",
"summary" : "create_otp - This method enables getting the session one-time-password and sending to the recipient via the notification type",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateOtpResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CreateOtpRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CreateOtpRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessControl | Access control management"
]
}
},
"/TaxationPlugin/get_tax_transaction_code_info" : {
"post" : {
"operationId" : "TaxationPlugin:get_tax_transaction_code_info",
"summary" : "get_tax_transaction_code_info - This method enables an API user to get information about a taxation code",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTaxTransactionCodeInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTaxTransactionCodeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTaxTransactionCodeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Code management"
]
}
},
"/Notification/get_notification_template_info" : {
"post" : {
"operationId" : "Notification:get_notification_template_info",
"summary" : "get_notification_template_info - This method enables an API user to get the information about the notification template",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNotificationTemplateInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNotificationTemplateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNotificationTemplateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Notification | Notification management"
]
}
},
"/AuthzRule/get_authz_method_type_list" : {
"post" : {
"operationId" : "AuthzRule:get_authz_method_type_list",
"summary" : "get_authz_method_type_list - This method enables an API user to get the list of authentication method types",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAuthzMethodTypeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAuthzMethodTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAuthzMethodTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AuthzRule | Authorization rule management"
]
}
},
"/AuthzRule/get_authz_rule_list" : {
"post" : {
"operationId" : "AuthzRule:get_authz_rule_list",
"summary" : "get_authz_rule_list - This method allows an API user to get a list of authentication rules that show how PortaSIP servers handle incoming calls. An authentication rule combines an authorization method and call parameters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAuthzRuleListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAuthzRuleListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAuthzRuleListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AuthzRule | Authorization rule management"
]
}
},
"/Customer/delete_payment_method" : {
"post" : {
"operationId" : "Customer:delete_payment_method",
"summary" : "delete_payment_method - This method allows an API user to delete the payment information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerPaymentMethodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerPaymentMethodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerPaymentMethodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Payments, taxation and invoice management"
]
}
},
"/Customer/cleanup_personal_data" : {
"post" : {
"operationId" : "Customer:cleanup_personal_data",
"summary" : "cleanup_personal_data - This method enables an API user to cleanup personal data of an existing retail customer or reseller",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CleanupPersonalDataResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CleanupPersonalDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CleanupPersonalDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/QuickForms/add_quick_form" : {
"post" : {
"operationId" : "QuickForms:add_quick_form",
"summary" : "add_quick_form - This method enables an API user to create a quick form",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddQFResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddQFRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddQFRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"QuickForms | Quick form management"
]
}
},
"/NumberPorting/modify_request" : {
"post" : {
"operationId" : "NumberPorting:modify_request",
"summary" : "modify_request - This method allows an API user to modify the number porting request",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ModifyRequestResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ModifyRequestRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ModifyRequestRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"NumberPorting | Number porting management"
]
}
},
"/Customer/get_service_features_metainfo" : {
"post" : {
"operationId" : "Customer:get_service_features_metainfo",
"summary" : "get_service_features_metainfo - This method enables an API user to get the service features values of the customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerGetCustomerServiceFeaturesMetaInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerGetCustomerServiceFeaturesMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerGetCustomerServiceFeaturesMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Internal"
]
}
},
"/TransferTo/get_transfer_info" : {
"post" : {
"operationId" : "TransferTo:get_transfer_info",
"summary" : "get_transfer_info - This method allows an API user to get a transaction status.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTransferInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTransferInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTransferInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TransferTo | Mobile remittance transaction management"
]
}
},
"/Account/transfer_assigned_commitment_record" : {
"post" : {
"operationId" : "Account:transfer_assigned_commitment_record",
"summary" : "transfer_assigned_commitment_record - The method enables an API user to move an assigned commitment to another account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TransferAssignedCommitmentRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TransferAssignedCommitmentRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TransferAssignedCommitmentRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/User/update_notification_list" : {
"post" : {
"operationId" : "User:update_notification_list",
"summary" : "update_notification_list - This method enables an API user to update the list of notifications of the administrative user",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateUserNotificationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUserNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUserNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | Notification template management"
]
}
},
"/Representative/get_representative_list" : {
"post" : {
"operationId" : "Representative:get_representative_list",
"summary" : "get_representative_list - This method allows an API user to get a list of representative records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRepresentativeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRepresentativeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRepresentativeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Representative | Representative management"
]
}
},
"/CommissionPlan/get_commission_plan_list" : {
"post" : {
"operationId" : "CommissionPlan:get_commission_plan_list",
"summary" : "get_commission_plan_list - This method allows an API user to get a list of commission plans from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCommissionPlanListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommissionPlanListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommissionPlanListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CommissionPlan | Commission plan management"
]
}
},
"/DiscountPlan/add_discount" : {
"post" : {
"operationId" : "DiscountPlan:add_discount",
"summary" : "add_discount - This method allows an API user to add a new discount (for a destination group)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddDiscountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDiscountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDiscountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount management"
]
}
},
"/Service/get_service_pool_info" : {
"post" : {
"operationId" : "Service:get_service_pool_info",
"summary" : "get_service_pool_info - This method enables an API user to get the service pool info",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServicePoolInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServicePoolInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServicePoolInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Service pool management"
]
}
},
"/Node/get_node_type_list" : {
"post" : {
"operationId" : "Node:get_node_type_list",
"summary" : "get_node_type_list - This method enables an API user to get the list of node types",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNodeTypeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNodeTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNodeTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Node | Node management"
]
}
},
"/Account/get_custom_fields_schema" : {
"post" : {
"operationId" : "Account:get_custom_fields_schema",
"summary" : "get_custom_fields_schema - This method allows an API user to get the list of account's custom fields with information about their types and allowed values",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountCustomFieldsSchemaResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountCustomFieldsSchemaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountCustomFieldsSchemaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Custom field management"
]
}
},
"/AccessRole/get_my_permissions" : {
"post" : {
"operationId" : "AccessRole:get_my_permissions",
"summary" : "get_my_permissions - This method enables an API user to access the permissions of the assigned role",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccessRoleGetMyAccessRolePermissionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccessRoleGetMyAccessRolePermissionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccessRoleGetMyAccessRolePermissionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessRole | Internal"
]
}
},
"/Account/update_followme_number" : {
"post" : {
"operationId" : "Account:update_followme_number",
"summary" : "update_followme_number - This method allows an API user to update an existing follow-me entry (number) associated with an account. It requires an ID number returned, for example, by the add_followme_number method",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateFollowMeNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateFollowMeNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateFollowMeNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Follow-me settings management"
]
}
},
"/Commitment/update_commitment_recurring_term" : {
"post" : {
"operationId" : "Commitment:update_commitment_recurring_term",
"summary" : "update_commitment_recurring_term - The method enables an API user to update a recurring term record associated with a commitment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCommitmentRecurringTermResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCommitmentRecurringTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCommitmentRecurringTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/Destination/get_mnc_list" : {
"post" : {
"operationId" : "Destination:get_mnc_list",
"summary" : "get_mnc_list - This method enables an API user to get a list of mobile network code (MNC) records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationGetMNCListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationGetMCCMNCListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationGetMCCMNCListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/User/add_user" : {
"post" : {
"operationId" : "User:add_user",
"summary" : "add_user - This method allows an API user to add an administrative user",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUserResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUserRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUserRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | User management"
]
}
},
"/Customer/get_custom_xdr_report" : {
"post" : {
"operationId" : "Customer:get_custom_xdr_report",
"summary" : "get_custom_xdr_report - This method allows to obtain a custom xDR report for a specific customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomXdrReportResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomXdrReportRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomXdrReportRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/Session/set_session_context" : {
"post" : {
"operationId" : "Session:set_session_context",
"summary" : "set_session_context - This method enables an API user to change the euuid for the current session",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SetSessionContextResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SetSessionContextRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SetSessionContextRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Session | Authenticated session management"
]
}
},
"/QuickForms/delete_quick_form" : {
"post" : {
"operationId" : "QuickForms:delete_quick_form",
"summary" : "delete_quick_form - This method allows an API user to delete a quick form",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteQFResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteQFRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteQFRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"QuickForms | Quick form management"
]
}
},
"/Account/add_allowed_location" : {
"post" : {
"operationId" : "Account:add_allowed_location",
"summary" : "add_allowed_location - This method enables an API user to add a new allowed location",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddAllowedLocationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAllowedLocationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAllowedLocationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Location management"
]
}
},
"/RoamingProfile/get_roaming_profile_info" : {
"post" : {
"operationId" : "RoamingProfile:get_roaming_profile_info",
"summary" : "get_roaming_profile_info - This method enables an API user to get the roaming profile information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRoamingProfileInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoamingProfileInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoamingProfileInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoamingProfile | Roaming profile management"
]
}
},
"/Destination/get_destination_info" : {
"post" : {
"operationId" : "Destination:get_destination_info",
"summary" : "get_destination_info - This method allows an API user to get information about a destination",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDestinationPrefixInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestinationPrefixInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestinationPrefixInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination management"
]
}
},
"/Account/update_custom_fields_values" : {
"post" : {
"operationId" : "Account:update_custom_fields_values",
"summary" : "update_custom_fields_values - This method allows an API user to modify customer's custom fields",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAccountCustomFieldsValuesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountCustomFieldsValuesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountCustomFieldsValuesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Custom field management"
]
}
},
"/Customer/get_service_features" : {
"post" : {
"operationId" : "Customer:get_service_features",
"summary" : "get_service_features - This method allows an API user to access service features data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerServiceFeaturesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerServiceFeaturesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerServiceFeaturesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Service features management"
]
}
},
"/Account/assign_sim_card" : {
"post" : {
"operationId" : "Account:assign_sim_card",
"summary" : "assign_sim_card - This method enables an API user to assign a SIM card from the SIM card inventory to an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssignSIMCardResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignSIMCardRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignSIMCardRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | SIM card management"
]
}
},
"/CodecConverter/get_file" : {
"post" : {
"operationId" : "CodecConverter:get_file",
"summary" : "get_file - This method enables an API user to get the file",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCodecConverterFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCodecConverterFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCodecConverterFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CodecConverter | Codec converter file management"
]
}
},
"/Vendor/update_vendor_account" : {
"post" : {
"operationId" : "Vendor:update_vendor_account",
"summary" : "update_vendor_account - This method allows an API user to update a vendor account used for digest authentication",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateVendorAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVendorAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVendorAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor account management"
]
}
},
"/CCStaff/delete_cc_staff" : {
"post" : {
"operationId" : "CCStaff:delete_cc_staff",
"summary" : "delete_cc_staff - This method enables an API user to delete a CC staff record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCCStaffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCCStaffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCCStaffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CCStaff | CC staff management"
]
}
},
"/Vendor/add_connection" : {
"post" : {
"operationId" : "Vendor:add_connection",
"summary" : "add_connection - This method allows an API user to create a new vendor connection record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddConnectionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Connection management"
]
}
},
"/IVRApplications/release_access_number" : {
"post" : {
"operationId" : "IVRApplications:release_access_number",
"summary" : "release_access_number - This method enables an API user to release an IVR access number from an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReleaseAccessNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseAccessNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseAccessNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | IVR user application management"
]
}
},
"/TrafficProfile/update_spending_constraint" : {
"post" : {
"operationId" : "TrafficProfile:update_spending_constraint",
"summary" : "update_spending_constraint - This method enables an API user to update a traffic profile spending constraint",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateSpendingConstraintResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateSpendingConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateSpendingConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Constraint management"
]
}
},
"/Customer/update_abbreviated_dialing_number" : {
"post" : {
"operationId" : "Customer:update_abbreviated_dialing_number",
"summary" : "update_abbreviated_dialing_number - This method allows an API user to update an existing abbreviated dialing number",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerAbbreviatedDialingNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerAbbreviatedDialingNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerAbbreviatedDialingNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Abbreviated dialing number management"
]
}
},
"/Destination/delete_cset_group" : {
"post" : {
"operationId" : "Destination:delete_cset_group",
"summary" : "delete_cset_group - This method enables an API user to delete a group of a complete destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationDeleteCSetGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationDeleteCSetGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationDeleteCSetGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/TaxationPlugin/get_tax_transaction_code_list" : {
"post" : {
"operationId" : "TaxationPlugin:get_tax_transaction_code_list",
"summary" : "get_tax_transaction_code_list - The method enables an API user to obtain tax transaction codes",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTaxTransactionCodeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTaxTransactionCodeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTaxTransactionCodeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Code management"
]
}
},
"/Account/mark_xdr_out_of_turn" : {
"post" : {
"operationId" : "Account:mark_xdr_out_of_turn",
"summary" : "mark_xdr_out_of_turn - This method allows an administrator to include a transaction on an out-of-turn invoice to be issued on demand",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MarkXdrOutOfTurnResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MarkXdrOutOfTurnRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MarkXdrOutOfTurnRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/AccessPolicy/update_access_policy" : {
"post" : {
"operationId" : "AccessPolicy:update_access_policy",
"summary" : "update_access_policy - This method enables an API user to modify an existing access policy using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAccessPolicyResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccessPolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccessPolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessPolicy | Access policy management"
]
}
},
"/IPTV/get_service_package_list" : {
"post" : {
"operationId" : "IPTV:get_service_package_list",
"summary" : "get_service_package_list - A service package is a set of auxiliary IPTV services such as pay per view or video on demand, multi-platform player, etc. Use this method to retrieve the list of IPTV service packages imported in PortaBilling",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetIPTVServicePackageListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetIPTVServicePackageListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetIPTVServicePackageListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IPTV | Service package management"
]
}
},
"/DID/delete_number_list" : {
"post" : {
"operationId" : "DID:delete_number_list",
"summary" : "delete_number_list - The method enables an API user to remove DID numbers from the inventory",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteDIDNumberListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDIDNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDIDNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/DID/get_inventory_option_info" : {
"post" : {
"operationId" : "DID:get_inventory_option_info",
"summary" : "get_inventory_option_info - This method enables an API user to get DID inventory option information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDInventoryOptionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDInventoryOptionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDInventoryOptionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Inventory management"
]
}
},
"/DiscountPlan/update_discount_plan" : {
"post" : {
"operationId" : "DiscountPlan:update_discount_plan",
"summary" : "update_discount_plan - This method allows an API user to update a volume discount plan",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDiscountPlanResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDiscountPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDiscountPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount plan management"
]
}
},
"/Account/update_cp_rule" : {
"post" : {
"operationId" : "Account:update_cp_rule",
"summary" : "update_cp_rule - This method allows an API user to update an existing call screening rule",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCPRuleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCPRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCPRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call screening management"
]
}
},
"/Notification/get_preset_category_list" : {
"post" : {
"operationId" : "Notification:get_preset_category_list",
"summary" : "get_preset_category_list - This method enables an API user to get the list of notification preset categories",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPresetCategoryListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPresetCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPresetCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Notification | Notification management"
]
}
},
"/CDR/get_disconnect_reason_list" : {
"post" : {
"operationId" : "CDR:get_disconnect_reason_list",
"summary" : "get_disconnect_reason_list - The method enables an API user to fetch the list of available xDR disconnect reasons",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDisconnectReasonListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDisconnectReasonListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDisconnectReasonListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CDR | Disconnect reason management"
]
}
},
"/Notification/get_notification_preset_info" : {
"post" : {
"operationId" : "Notification:get_notification_preset_info",
"summary" : "get_notification_preset_info - This method enables an API user to get the information about the notification preset",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNotificationPresetInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNotificationPresetInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNotificationPresetInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Notification | Notification management"
]
}
},
"/Rate/delete_rate" : {
"post" : {
"operationId" : "Rate:delete_rate",
"summary" : "delete_rate - This method allows an API user to delete an existing rate for a destination",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteRateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Rate management"
]
}
},
"/Vendor/get_did_provider_account_list" : {
"post" : {
"operationId" : "Vendor:get_did_provider_account_list",
"summary" : "get_did_provider_account_list - This method enables an API user to obtain the list of DID provider accounts",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVendorDIDProviderAccountListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorDIDProviderAccountListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorDIDProviderAccountListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | DID provider account management"
]
}
},
"/Account/get_preferable_account_list" : {
"post" : {
"operationId" : "Account:get_preferable_account_list",
"summary" : "get_preferable_account_list - This method enables an API user to obtain the list of the account’s Favourites list records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPreferableAccountListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPreferableAccountListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPreferableAccountListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Favourites list management"
]
}
},
"/Account/estimate_call_price" : {
"post" : {
"operationId" : "Account:estimate_call_price",
"summary" : "estimate_call_price - This method allows an API user to see the price for calls to a specific destination (e.g. to a number from a user’s contact list) with applicable volume discounts",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountEstimateCallPriceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountEstimateCallPriceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountEstimateCallPriceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Phonebook management"
]
}
},
"/Commitment/add_commitment_recurring_term" : {
"post" : {
"operationId" : "Commitment:add_commitment_recurring_term",
"summary" : "add_commitment_recurring_term - The method enables an API user to add a recurring term to the commitment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCommitmentRecurringTermResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCommitmentRecurringTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCommitmentRecurringTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/Service/get_service_type_list" : {
"post" : {
"operationId" : "Service:get_service_type_list",
"summary" : "get_service_type_list - This method allows an API user to get the list of service types",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServiceTypeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Type management"
]
}
},
"/Account/update_account" : {
"post" : {
"operationId" : "Account:update_account",
"summary" : "update_account - This method enables an API user to update an existing account record using the supplied data. Note that if a user is not allowed to manage (create/read/update/delete access types) some field by an ACL, then the client application must not send this property in the request (Otherwise PortaBilling® will reject the whole request). That is why we recommend you to make sure that your customer portals and other external applications correspond to the ACL configuration in PortaBilling®. Use the get_my_permissions_for_objects method to find out the permissions for every object on the PortaBilling® web interface.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account management"
]
}
},
"/Service/update_service_pool" : {
"post" : {
"operationId" : "Service:update_service_pool",
"summary" : "update_service_pool - This method enables an API user to update the service pool record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateServicePoolResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateServicePoolRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateServicePoolRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Service pool management"
]
}
},
"/CustomerClass/update_taxation" : {
"post" : {
"operationId" : "CustomerClass:update_taxation",
"summary" : "update_taxation - This method allows an API user to set which plugin module will be used to make tax calculations and set up parameters that affect taxation",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomerClassTaxationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerClassTaxationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerClassTaxationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Payments, taxation and invoice management"
]
}
},
"/Payment/get_payment_transaction_list" : {
"post" : {
"operationId" : "Payment:get_payment_transaction_list",
"summary" : "get_payment_transaction_list - This method allows an API user to get a list of payment transactions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PaymentTransactionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/PaymentTransactionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/PaymentTransactionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Transaction management"
]
}
},
"/Invoice/get_invoice_info" : {
"post" : {
"operationId" : "Invoice:get_invoice_info",
"summary" : "get_invoice_info - This method allows an API user to get an invoice record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetInvoiceInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetInvoiceInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetInvoiceInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Account/get_allowed_location_list" : {
"post" : {
"operationId" : "Account:get_allowed_location_list",
"summary" : "get_allowed_location_list - This method enables an API user to get the list of allowed locations",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAllowedLocationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAllowedLocationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAllowedLocationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Location management"
]
}
},
"/TrafficProfile/get_fraud_traffic_alert_list" : {
"post" : {
"operationId" : "TrafficProfile:get_fraud_traffic_alert_list",
"summary" : "get_fraud_traffic_alert_list - This method enables an API user to get the list of fraud traffic alerts",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetFraudTrafficAlertListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetFraudTrafficAlertListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetFraudTrafficAlertListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Alert management"
]
}
},
"/Customer/get_auto_payment_info" : {
"post" : {
"operationId" : "Customer:get_auto_payment_info",
"summary" : "get_auto_payment_info - This method allows an API user to get a customer’s automated periodic payment record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAutoPaymentInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Auto-payment management"
]
}
},
"/DialingRule/update_dialing_rule" : {
"post" : {
"operationId" : "DialingRule:update_dialing_rule",
"summary" : "update_dialing_rule - This method allows an API user to update a dialing rule",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateDialingRuleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateDialingRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateDialingRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DialingRule | Dialing rule management"
]
}
},
"/RoutingPlan/get_rp_category_list" : {
"post" : {
"operationId" : "RoutingPlan:get_rp_category_list",
"summary" : "get_rp_category_list - This method enables an API user to get the route categories assigned to a routing plan",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRPCategoryListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRPCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRPCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Route category management"
]
}
},
"/Account/get_cp_condition_info" : {
"post" : {
"operationId" : "Account:get_cp_condition_info",
"summary" : "get_cp_condition_info - This method enables an API user to retrieve the info about a call screening condition",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCPConditionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCPConditionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCPConditionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call screening management"
]
}
},
"/User/update_ui_config_list" : {
"post" : {
"operationId" : "User:update_ui_config_list",
"summary" : "update_ui_config_list - This method enables an API user to update the list of the UI configs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateUserUIConfigListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUserUIConfigListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUserUIConfigListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | Generic information management"
]
}
},
"/Customer/disable_api_notifications" : {
"post" : {
"operationId" : "Customer:disable_api_notifications",
"summary" : "disable_api_notifications - Obsolete. Use CallControl.disable_api_notifications method instead",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DisableApiNotificationsCustomerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DisableApiNotificationsCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DisableApiNotificationsCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Async API notification management"
]
}
},
"/Account/delete_alias" : {
"post" : {
"operationId" : "Account:delete_alias",
"summary" : "delete_alias - This method allows an API user to remove an alias",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAccountAliasResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAccountAliasRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAccountAliasRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Alias management"
]
}
},
"/Payment/list_merchants" : {
"post" : {
"operationId" : "Payment:list_merchants",
"summary" : "list_merchants - This method allows an API user to obtain the list of avalilable payment and payment remittance systems for a given customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListMerchantAccountsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ListMerchantAccountsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ListMerchantAccountsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Merchant account management"
]
}
},
"/Generic/get_realm_info" : {
"post" : {
"operationId" : "Generic:get_realm_info",
"summary" : "get_realm_info - This method enables an API user to get realm of the current session",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenericGetRealmInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetCommonInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetCommonInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Internal"
]
}
},
"/DID/get_vendor_batch_list" : {
"post" : {
"operationId" : "DID:get_vendor_batch_list",
"summary" : "get_vendor_batch_list - This method allows an API user (administrator or reseller) to get the list of DID vendor batches filtered by various parameters. The DID inventory must be accessible to the user making the request. Only those batches containing DID numbers owned by the user will be returned",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVendorBatchListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorBatchListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorBatchListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Vendor batch management"
]
}
},
"/TrafficProfile/delete_fraud_constraint" : {
"post" : {
"operationId" : "TrafficProfile:delete_fraud_constraint",
"summary" : "delete_fraud_constraint - This method enables an API user to delete a traffic profile fraud constraint",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteFraudConstraintResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteFraudConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteFraudConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Constraint management"
]
}
},
"/DiscountPlan/make_transaction" : {
"post" : {
"operationId" : "DiscountPlan:make_transaction",
"summary" : "make_transaction - This method enables an API user to make transactions between DiscountPlan entites, that is, transfer services between service wallets / quotas",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MakeVDTransactionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeVDTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeVDTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Transaction management"
]
}
},
"/IVRApplications/add_ivr_application" : {
"post" : {
"operationId" : "IVRApplications:add_ivr_application",
"summary" : "add_ivr_application - This method enables an API user to add the IVR application",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddIvrApplicationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddIvrApplicationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddIvrApplicationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Application management"
]
}
},
"/XDRMediator/get_xdr_collection_info" : {
"post" : {
"operationId" : "XDRMediator:get_xdr_collection_info",
"summary" : "get_xdr_collection_info - This method enables an API user to get the information about the xDR collection",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetXDRCollectionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetXDRCollectionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetXDRCollectionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"XDRMediator | XDR Mediator management"
]
}
},
"/Account/delete_followme_number" : {
"post" : {
"operationId" : "Account:delete_followme_number",
"summary" : "delete_followme_number - This method allows an API user to delete an existing follow-me entry (number) associated with the account. It requires an ID number returned, for example, by the add_followme_number method",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteFollowMeNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteFollowMeNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteFollowMeNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Follow-me settings management"
]
}
},
"/BundlePromotion/get_bundle_promotion_info" : {
"post" : {
"operationId" : "BundlePromotion:get_bundle_promotion_info",
"summary" : "get_bundle_promotion_info - This method allows an API user to get the bundle promotion information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetBundlePromotionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDeleteBundlePromotionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDeleteBundlePromotionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BundlePromotion | Bundle promotion management"
]
}
},
"/SIMCard/update_sim_card" : {
"post" : {
"operationId" : "SIMCard:update_sim_card",
"summary" : "update_sim_card - This method enables an API user to update a sim card record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateSIMCardResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateSIMCardRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateSIMCardRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"SIMCard | SIM card management"
]
}
},
"/AccessPolicy/delete_access_policy" : {
"post" : {
"operationId" : "AccessPolicy:delete_access_policy",
"summary" : "delete_access_policy - This method enables an API user to delete an existing access policy",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAccessPolicyResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAccessPolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAccessPolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessPolicy | Access policy management"
]
}
},
"/Product/update_group" : {
"post" : {
"operationId" : "Product:update_group",
"summary" : "update_group - This method allows an API user to update a product group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateProductGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateProductGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateProductGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Group management"
]
}
},
"/Tariff/get_tariff_list" : {
"post" : {
"operationId" : "Tariff:get_tariff_list",
"summary" : "get_tariff_list - This method allows an API user to retrieve the list of tariffs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTariffListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTariffListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTariffListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Tariff management"
]
}
},
"/Generic/get_version" : {
"post" : {
"operationId" : "Generic:get_version",
"summary" : "get_version - This method allows an API user to get the version of PortaBilling version",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVersionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVersionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVersionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Generic information management"
]
}
},
"/Account/trace_xdr" : {
"post" : {
"operationId" : "Account:trace_xdr",
"summary" : "trace_xdr - This method marks the last account's call as traced",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountTraceXdrResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountTraceXdrRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountTraceXdrRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/ServicePolicy/get_attribute_list" : {
"post" : {
"operationId" : "ServicePolicy:get_attribute_list",
"summary" : "get_attribute_list - This method enables an API user to get a list of service policy attributes",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServicePolicyAttributeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServicePolicyAttributeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServicePolicyAttributeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ServicePolicy | Service policy management"
]
}
},
"/Account/get_full_vd_counter_info" : {
"post" : {
"operationId" : "Account:get_full_vd_counter_info",
"summary" : "get_full_vd_counter_info - This method allows an API user to get full information about volume discount counters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetFullVDCounterListInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountFullVDCounterListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountFullVDCounterListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Volume discount management"
]
}
},
"/BillingSession/get_active_calls_list" : {
"post" : {
"operationId" : "BillingSession:get_active_calls_list",
"summary" : "get_active_calls_list - This method allows an API user to get the list of active calls",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetActiveCallsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetActiveCallsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetActiveCallsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BillingSession | Billing session management"
]
}
},
"/TrafficProfile/assess_fraud_traffic" : {
"post" : {
"operationId" : "TrafficProfile:assess_fraud_traffic",
"summary" : "assess_fraud_traffic - This method enables an API user to assess fraud traffic",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssessFraudTrafficResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssessFraudTrafficRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssessFraudTrafficRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Fraud traffic management"
]
}
},
"/XDRMediator/get_xdr_list" : {
"post" : {
"operationId" : "XDRMediator:get_xdr_list",
"summary" : "get_xdr_list - This method enables an API user to get the list of xDRs in the collection",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetXDRListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"XDRMediator | XDR Mediator management"
]
}
},
"/BillingSession/manage_active_call_recording" : {
"post" : {
"operationId" : "BillingSession:manage_active_call_recording",
"summary" : "manage_active_call_recording - This method allows an API user to start or stop recording during the call",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ManageActiveCallRecordingResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ManageActiveCallRecordingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ManageActiveCallRecordingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BillingSession | Call recording management"
]
}
},
"/RoutingCriteria/delete_routing_criteria_dest_group" : {
"post" : {
"operationId" : "RoutingCriteria:delete_routing_criteria_dest_group",
"summary" : "delete_routing_criteria_dest_group - This method enables an API user to delete a destination group for a routing criteria record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteRoutingCriteriaDestGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRoutingCriteriaDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRoutingCriteriaDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingCriteria | Destination group management"
]
}
},
"/Customer/get_credit_limit_history" : {
"post" : {
"operationId" : "Customer:get_credit_limit_history",
"summary" : "get_credit_limit_history - This method enables an API user to get the credit limit history",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCreditLimitHistoryResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCreditLimitHistoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCreditLimitHistoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/Customer/get_huntgroup_list" : {
"post" : {
"operationId" : "Customer:get_huntgroup_list",
"summary" : "get_huntgroup_list - This method allows a retail customer to get the list of huntgroups (except for a huntgroup specified in the self_ref property)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetHGListInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetHGListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetHGListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Huntgroup management"
]
}
},
"/Vendor/delete_did_provider_account" : {
"post" : {
"operationId" : "Vendor:delete_did_provider_account",
"summary" : "delete_did_provider_account - This method allows an API user to delete a DID provider account and the associated connections with the DID provider",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteVendorDIDProviderAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVendorDIDProviderAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVendorDIDProviderAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | DID provider account management"
]
}
},
"/Session/logout" : {
"post" : {
"operationId" : "Session:logout",
"summary" : "logout - This method enables an API user to terminate a session. Call logout() to terminate the session properly",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/LogoutResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/LogoutRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/LogoutRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Session | Authenticated session management"
]
}
},
"/Account/add_alias" : {
"post" : {
"operationId" : "Account:add_alias",
"summary" : "add_alias - This method allows an API user to add an alias",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddAccountAliasResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccountAliasRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccountAliasRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Alias management"
]
}
},
"/Account/update_call_barring_options" : {
"post" : {
"operationId" : "Account:update_call_barring_options",
"summary" : "update_call_barring_options - This method allows an API user to update options for account call barring, i.e. enable or disable the corresponding items",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCallBarringOptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCallBarringOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCallBarringOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call barring rules management"
]
}
},
"/Product/add_group" : {
"post" : {
"operationId" : "Product:add_group",
"summary" : "add_group - This method allows an API user to create a product group to provide customers with effective add-on management tools",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateProductGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateProductGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateProductGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Group management"
]
}
},
"/DID/update_inventory_options" : {
"post" : {
"operationId" : "DID:update_inventory_options",
"summary" : "update_inventory_options - This method enables an API user to update DID inventory options",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDIDInventoryOptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDIDInventoryOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDIDInventoryOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Inventory management"
]
}
},
"/Template/add_built_in_invoice_template" : {
"post" : {
"operationId" : "Template:add_built_in_invoice_template",
"summary" : "add_built_in_invoice_template - This method enables an API user to add a template using in-built functionality",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TemplateAddBuildInTemplateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateAddBuildInTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateAddBuildInTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Internal"
]
}
},
"/Generic/get_api_error_file" : {
"post" : {
"operationId" : "Generic:get_api_error_file",
"summary" : "get_api_error_file - This method enables an API user to get a file with extended error messages",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAPIErrorFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAPIErrorFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAPIErrorFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Generic information management"
]
}
},
"/UA/get_ua_list" : {
"post" : {
"operationId" : "UA:get_ua_list",
"summary" : "get_ua_list - This method allows an API user (administrator or reseller) to get the list of UA devices (IP phones) in the IP phone inventory, filtered by various parameters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUAListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUAListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUAListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | UA device management"
]
}
},
"/ServicePolicy/update_service_policy" : {
"post" : {
"operationId" : "ServicePolicy:update_service_policy",
"summary" : "update_service_policy - This method enables an API user to update the service policy and its attribute values",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateServicePolicyResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateServicePolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateServicePolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ServicePolicy | Service policy management"
]
}
},
"/Product/get_product_list" : {
"post" : {
"operationId" : "Product:get_product_list",
"summary" : "get_product_list - This method allows an API user to get the list of products",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetProductListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/Payment/get_processor" : {
"post" : {
"operationId" : "Payment:get_processor",
"summary" : "get_processor - This method allows an API user to get a payment processor data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPaymentProcessorResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPaymentProcessorRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPaymentProcessorRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Processor management"
]
}
},
"/QuickForms/get_quick_forms_list" : {
"post" : {
"operationId" : "QuickForms:get_quick_forms_list",
"summary" : "get_quick_forms_list - This method allows an API user to obtain the list of quick forms",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerQFListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerQFListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerQFListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"QuickForms | Quick form management"
]
}
},
"/Metric/upload_measured_metric_data" : {
"post" : {
"operationId" : "Metric:upload_measured_metric_data",
"summary" : "upload_measured_metric_data - This method enables an API user to upload measured metrics data into the system as a file",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadMeasuredMetricDataResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadMeasuredMetricDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Metric | Measured service management"
]
}
},
"/CDR/revert_xdr_list" : {
"post" : {
"operationId" : "CDR:revert_xdr_list",
"summary" : "revert_xdr_list - The method enables an API user to revert all transactions for a list of xDRs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RevertXDRListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RevertXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RevertXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CDR | XDR management"
]
}
},
"/CCStaff/get_cc_staff_list" : {
"post" : {
"operationId" : "CCStaff:get_cc_staff_list",
"summary" : "get_cc_staff_list - This method enables an API user to get a list of CC staff info records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCCStaffListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCCStaffListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCCStaffListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CCStaff | CC staff management"
]
}
},
"/Calendar/add_dates_batch" : {
"post" : {
"operationId" : "Calendar:add_dates_batch",
"summary" : "add_dates_batch - This method enables an API user to add the list of calendar date records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddDatesBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDatesBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDatesBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Calendar | Calendar management"
]
}
},
"/Product/get_product_discount_plan_list" : {
"post" : {
"operationId" : "Product:get_product_discount_plan_list",
"summary" : "get_product_discount_plan_list - This method allows an API user to get the discount plans allowed for this product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductGetProductDiscountPlanListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductGetProductDiscountPlanListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductGetProductDiscountPlanListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Internal"
]
}
},
"/Customer/get_customer_info" : {
"post" : {
"operationId" : "Customer:get_customer_info",
"summary" : "get_customer_info - This method allows an API user to get a customer record from the database. The customer must be viewable (owned) by the user making the request",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/MeasuredServices/get_metric_charge_methods_list" : {
"post" : {
"operationId" : "MeasuredServices:get_metric_charge_methods_list",
"summary" : "get_metric_charge_methods_list - This method allows an API user to retrieve charge methods for measured services",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetChargeMethodsListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetChargeMethodsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetChargeMethodsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Measured service management"
]
}
},
"/Product/add_subscription" : {
"post" : {
"operationId" : "Product:add_subscription",
"summary" : "add_subscription - This method allows an API user to add a subscription to the product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddProductSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddProductSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddProductSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Subscription management"
]
}
},
"/Rate/update_rate" : {
"post" : {
"operationId" : "Rate:update_rate",
"summary" : "update_rate - This method allows an API user to update an existing rate for a destination",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateRateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Rate management"
]
}
},
"/Account/add_cp_condition" : {
"post" : {
"operationId" : "Account:add_cp_condition",
"summary" : "add_cp_condition - This method allows an API user to add a call screening condition",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCPConditionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCPConditionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCPConditionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call screening management"
]
}
},
"/Session/generate_captcha" : {
"post" : {
"operationId" : "Session:generate_captcha",
"summary" : "generate_captcha - Enables an API user to generate a captcha image",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenerateCaptchaResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateCaptchaRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateCaptchaRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Session | Authenticated session management"
]
}
},
"/Currency/sync_exchange_rates" : {
"post" : {
"operationId" : "Currency:sync_exchange_rates",
"summary" : "sync_exchange_rates - This method enables an API user to synchronize exchange rates with their external sources",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SyncXratesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SyncXratesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SyncXratesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Currency | Currencies exchange management"
]
}
},
"/Rate/cleanup_inactive_rates" : {
"post" : {
"operationId" : "Rate:cleanup_inactive_rates",
"summary" : "cleanup_inactive_rates - This method enables an API user to clean up inactive rates",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CleanUpInactiveRatesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CleanUpInactiveRatesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CleanUpInactiveRatesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Rate management"
]
}
},
"/DID/get_owner_batch_info" : {
"post" : {
"operationId" : "DID:get_owner_batch_info",
"summary" : "get_owner_batch_info - This method allows an API user (administrator or reseller) to get DID Pricing Batch info.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetOwnerBatchInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOwnerBatchInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOwnerBatchInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Pricing batch management"
]
}
},
"/Account/update_service_features" : {
"post" : {
"operationId" : "Account:update_service_features",
"summary" : "update_service_features - This method allows an API user to update settings for account service features",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAccountServiceFeaturesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountServiceFeaturesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountServiceFeaturesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Service features management"
]
}
},
"/Tariff/delete_tariff" : {
"post" : {
"operationId" : "Tariff:delete_tariff",
"summary" : "delete_tariff - This method allows an API user to delete an existing tariff",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteTariffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Tariff management"
]
}
},
"/Customer/estimate_taxes" : {
"post" : {
"operationId" : "Customer:estimate_taxes",
"summary" : "estimate_taxes - This method allows an API user to show tax rates or calculate the tax for a list of xDRs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerEstimateTaxesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerEstimateTaxesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerEstimateTaxesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Payments, taxation and invoice management"
]
}
},
"/DID_Provider/get_did_provider_list" : {
"post" : {
"operationId" : "DID_Provider:get_did_provider_list",
"summary" : "get_did_provider_list - This method enables an API user to get information about supported DID providers",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDProviderListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDProviderListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDProviderListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID_Provider | DID auto-provisioning management"
]
}
},
"/Customer/get_callqueue_moh_file" : {
"post" : {
"operationId" : "Customer:get_callqueue_moh_file",
"summary" : "get_callqueue_moh_file - This method enables an API user to get the file with the music on hold for a specific call queue",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCQMohFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCQMohFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCQMohFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Call queue management"
]
}
},
"/Account/add_account" : {
"post" : {
"operationId" : "Account:add_account",
"summary" : "add_account - This method allows an API user to create a new account record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account management"
]
}
},
"/Commitment/get_commitment_terms" : {
"post" : {
"operationId" : "Commitment:get_commitment_terms",
"summary" : "get_commitment_terms - The method enables an API user to get the set of the recurring and one-time commitment terms associated with a commitment record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCommitmentTermsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommitmentTermsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommitmentTermsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/AsyncRequest/get_request_list" : {
"post" : {
"operationId" : "AsyncRequest:get_request_list",
"summary" : "get_request_list - This method enables getting the list of async requests",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAsyncRequestListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAsyncRequestListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAsyncRequestListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AsyncRequest | Asynchronous request management"
]
}
},
"/Customer/update_batch" : {
"post" : {
"operationId" : "Customer:update_batch",
"summary" : "update_batch - This method allows an API user to update the existing batch",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Account batch management"
]
}
},
"/RoutingPlan/add_routing_plan" : {
"post" : {
"operationId" : "RoutingPlan:add_routing_plan",
"summary" : "add_routing_plan - This method allows an API user to create a new routing plan using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRoutingPlanResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRoutingPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateRoutingPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Routing plan management"
]
}
},
"/Customer/get_vd_notification_list" : {
"post" : {
"operationId" : "Customer:get_vd_notification_list",
"summary" : "get_vd_notification_list - The method enables an API user to retrieve the list of volume discount notifications for the customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerVdNotificationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerVdNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerVdNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/Account/get_service_features" : {
"post" : {
"operationId" : "Account:get_service_features",
"summary" : "get_service_features - This method allows an API user to access service features data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountServiceFeaturesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountServiceFeaturesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountServiceFeaturesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Service features management"
]
}
},
"/Customer/get_taxation_info" : {
"post" : {
"operationId" : "Customer:get_taxation_info",
"summary" : "get_taxation_info - This method allows an API user to retrieve information about the plug-in module which is used to make tax calculations and its parameters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerTaxationInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerTaxationInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerTaxationInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Payments, taxation and invoice management"
]
}
},
"/Env/update_notification_template" : {
"post" : {
"operationId" : "Env:update_notification_template",
"summary" : "update_notification_template - This method allows an API user to update the notification template",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateEnvNotificationTemplateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateEnvNotificationTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateEnvNotificationTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Notification template management"
]
}
},
"/DID/get_number_list_statistics" : {
"post" : {
"operationId" : "DID:get_number_list_statistics",
"summary" : "get_number_list_statistics - This method enables an API user to get the DID number list statistics",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDNumberListStatisticsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDNumberListStatisticsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDNumberListStatisticsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/DID_Provider/get_areas_list" : {
"post" : {
"operationId" : "DID_Provider:get_areas_list",
"summary" : "get_areas_list - This method allows an API user to retrieve the list of areas in a specified country where a number can be allocated from via the DID provider. If DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDAreasListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDAreasListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDAreasListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID_Provider | DID auto-provisioning management"
]
}
},
"/Destination/add_dest_group_set" : {
"post" : {
"operationId" : "Destination:add_dest_group_set",
"summary" : "add_dest_group_set - This method allows an API user to add a destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateDestGroupSetResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateDestGroupSetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateDestGroupSetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group set management"
]
}
},
"/Customer/add_customer" : {
"post" : {
"operationId" : "Customer:add_customer",
"summary" : "add_customer - This method allows an API user to create a new customer record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/CustomerClass/send_me_notification_sample" : {
"post" : {
"operationId" : "CustomerClass:send_me_notification_sample",
"summary" : "send_me_notification_sample - This method allows an API user to send a sample notification",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SendMeCustomerClassNotificationSampleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SendMeCustomerClassNotificationSampleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SendMeCustomerClassNotificationSampleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Notification template management"
]
}
},
"/CustomerClass/get_default_customer_class" : {
"post" : {
"operationId" : "CustomerClass:get_default_customer_class",
"summary" : "get_default_customer_class - This method allows an API user to get information about the default customer class records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDefaultCustomerClassResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDefaultCustomerClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDefaultCustomerClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Customer class management"
]
}
},
"/Customer/get_network_connectivity_list" : {
"post" : {
"operationId" : "Customer:get_network_connectivity_list",
"summary" : "get_network_connectivity_list - This method allows an API user to get the list of network connectivity profiles defined in PortaBilling",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNetworkConnectivityListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNetworkConnectivityListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNetworkConnectivityListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Site management"
]
}
},
"/Product/get_product_info_detailed" : {
"post" : {
"operationId" : "Product:get_product_info_detailed",
"summary" : "get_product_info_detailed - This method enables an API user to get the information about the product with additional information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductGetProductInfoDetailedResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Internal"
]
}
},
"/Account/cancel_scheduled_commitment_replacement" : {
"post" : {
"operationId" : "Account:cancel_scheduled_commitment_replacement",
"summary" : "cancel_scheduled_commitment_replacement - The method enables an API user to cancel a scheduled commitment replacement",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteScheduledCommitmentRecordReplacementResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteScheduledCommitmentRecordReplacementRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteScheduledCommitmentRecordReplacementRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/Payment/update_merchant" : {
"post" : {
"operationId" : "Payment:update_merchant",
"summary" : "update_merchant - This method allows an API user to update a payment or payment remittance system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateMerchantAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateMerchantAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateMerchantAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Merchant account management"
]
}
},
"/Commitment/add_commitment" : {
"post" : {
"operationId" : "Commitment:add_commitment",
"summary" : "add_commitment - The method enables an API user to add a new commitment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCommitmentResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCommitmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCommitmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/Tariff/add_resale_tariff_mappings" : {
"post" : {
"operationId" : "Tariff:add_resale_tariff_mappings",
"summary" : "add_resale_tariff_mappings - This method enables your resellers to define the usage charges for their subresellers. This is the tariff according to which the subreseller pays their reseller for reselling the service. It is derived from the reseller's buying tariff, i.e. the tariff the administrator uses to charge the reseller. Thus, the usage charges list is the mapping between the reseller's buying tariff (i_tariff_buy) and the selling tariff (i_tariff_sell)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddResaleTariffMappingsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddResaleTariffMappingsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddResaleTariffMappingsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Reseller tariff management"
]
}
},
"/TrafficProfile/delete_spending_constraint" : {
"post" : {
"operationId" : "TrafficProfile:delete_spending_constraint",
"summary" : "delete_spending_constraint - This method enables an API user to delete a traffic profile spending constraint",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteSpendingConstraintResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteSpendingConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteSpendingConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Constraint management"
]
}
},
"/AccessRole/get_access_role_type_info" : {
"post" : {
"operationId" : "AccessRole:get_access_role_type_info",
"summary" : "get_access_role_type_info - This method enables an API user to get the access role type info",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccessRoleTypeInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessRoleTypeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessRoleTypeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessRole | Access role management"
]
}
},
"/Customer/get_services_consumption" : {
"post" : {
"operationId" : "Customer:get_services_consumption",
"summary" : "get_services_consumption - This method allows an API user to get information about services consumed by a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerConsumedServiceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerConsumedServiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerConsumedServiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/User/get_notification_category_list" : {
"post" : {
"operationId" : "User:get_notification_category_list",
"summary" : "get_notification_category_list - This method enables an API user to get the list of notification categories of the administrative user",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUserNotificationCategoryListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserNotificationCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserNotificationCategoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | Notification template management"
]
}
},
"/DialingRule/get_dialing_rules_list" : {
"post" : {
"operationId" : "DialingRule:get_dialing_rules_list",
"summary" : "get_dialing_rules_list - This method allows an API user to get the list of dialing rules",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDialingRulesListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDialingRulesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDialingRulesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DialingRule | Dialing rule management"
]
}
},
"/Product/get_priorities_list" : {
"post" : {
"operationId" : "Product:get_priorities_list",
"summary" : "get_priorities_list - This method that allows to get the list of product priorities",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetProductPrioritiesListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductPrioritiesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductPrioritiesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/Product/get_allowed_addons" : {
"post" : {
"operationId" : "Product:get_allowed_addons",
"summary" : "get_allowed_addons - This method that allows to get a list of allowable add-on products that are compatible with a main product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAllowedAddonsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAllowedAddonsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAllowedAddonsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/Customer/update_auto_payment" : {
"post" : {
"operationId" : "Customer:update_auto_payment",
"summary" : "update_auto_payment - This method allows an API user to update automated periodic payments. A customer's credit card will be charged when the billing period is closed. If you want to charge a customer's credit card whenever his balance crosses a specified threshold, then specify the pay_amount and balance_threshold properties, and when the customer's balance crosses this threshold, their credit card will be charged for the amount specified in the pay_amount field",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Auto-payment management"
]
}
},
"/DID/get_customer_numbers" : {
"post" : {
"operationId" : "DID:get_customer_numbers",
"summary" : "get_customer_numbers - This method allows an API user to obtain the list of DID numbers owned by him. An administrator can obtain the list of DID numbers owned by a retail customer (but not a reseller)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerDIDNumbersResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerDIDNumbersRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerDIDNumbersRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/EmergencyUnit/upload_emergency_units" : {
"post" : {
"operationId" : "EmergencyUnit:upload_emergency_units",
"summary" : "upload_emergency_units - This method enables an API user to upload emergency routing units into the system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadEmergencyUnitsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadEmergencyUnitsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"EmergencyUnit | Emergency routing unit management"
]
}
},
"/Account/delete_preferable_account" : {
"post" : {
"operationId" : "Account:delete_preferable_account",
"summary" : "delete_preferable_account - This method enables an API user to delete a record in the account’s Favourites list",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeletePreferableAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeletePreferableAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeletePreferableAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Favourites list management"
]
}
},
"/Customer/update_call_barring_options" : {
"post" : {
"operationId" : "Customer:update_call_barring_options",
"summary" : "update_call_barring_options - This method enables an API user to update the options for customer call barring, i.e. enable or disable the corresponding items",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomerCallBarringOptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerCallBarringOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerCallBarringOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Call barring rule management"
]
}
},
"/Generic/get_extended_data_list" : {
"post" : {
"operationId" : "Generic:get_extended_data_list",
"summary" : "get_extended_data_list - This method enables an API user to the get list of any records from the following tables: Accounts, Products, Customers, Customer_Classes, Account_Product_Addons_At, Invoices.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetExtendedDataListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetExtendedDataListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetExtendedDataListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Extended information management"
]
}
},
"/Template/upload_external_invoice_template_image" : {
"post" : {
"operationId" : "Template:upload_external_invoice_template_image",
"summary" : "upload_external_invoice_template_image - Use this method to upload images (e.g. logos, pictures) required for an external invoice template. Supported file formats are .gif, .png, .jpg, .jpeg, .jpe, .bmp",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadExternalInvoiceFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadExternalInvoiceFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/NumberPorting/create_portin_request" : {
"post" : {
"operationId" : "NumberPorting:create_portin_request",
"summary" : "create_portin_request - This method allows an API user to create a number porting request",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreatePortInRequestResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CreatePortInRequestRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CreatePortInRequestRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"NumberPorting | Number porting management"
]
}
},
"/Generic/get_time_zone_list" : {
"post" : {
"operationId" : "Generic:get_time_zone_list",
"summary" : "get_time_zone_list - This method allows an API user to get information about time zones",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTimeZoneListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTimeZoneListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTimeZoneListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Time zone management"
]
}
},
"/TraceSession/send_to_rt" : {
"post" : {
"operationId" : "TraceSession:send_to_rt",
"summary" : "send_to_rt - This method enables an API user to send session log to RT",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SendLogToRTResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/SendLogToRTRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TraceSession | Session information management"
]
}
},
"/UA/update_ua_profile" : {
"post" : {
"operationId" : "UA:update_ua_profile",
"summary" : "update_ua_profile - This method enables an API user to update а UA device (IP phone) profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateUAProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUAProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUAProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | Profile management"
]
}
},
"/AsyncRequest/enable_api_notifications" : {
"post" : {
"operationId" : "AsyncRequest:enable_api_notifications",
"summary" : "enable_api_notifications - This method enables an API user to receive notifications about the status of API requests execution in the asynchronous mode",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EnableAsyncApiNotificationsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EnableAsyncApiNotificationsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EnableAsyncApiNotificationsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AsyncRequest | API notification management"
]
}
},
"/CodecConverter/get_file_list" : {
"post" : {
"operationId" : "CodecConverter:get_file_list",
"summary" : "get_file_list - This method enables an API user to get the file list",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCodecConverterFileListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCodecConverterFileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCodecConverterFileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CodecConverter | Codec converter file management"
]
}
},
"/Service/add_service_pool" : {
"post" : {
"operationId" : "Service:add_service_pool",
"summary" : "add_service_pool - This method enables an API user to create a new service pool record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateServicePoolResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateServicePoolRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateServicePoolRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Service pool management"
]
}
},
"/RoutingCriteria/update_routing_criteria" : {
"post" : {
"operationId" : "RoutingCriteria:update_routing_criteria",
"summary" : "update_routing_criteria - This method enables an API user to update a routing criteria record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateRoutingCriteriaResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRoutingCriteriaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRoutingCriteriaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingCriteria | Routing criteria management"
]
}
},
"/CCStaff/add_cc_staff" : {
"post" : {
"operationId" : "CCStaff:add_cc_staff",
"summary" : "add_cc_staff - This method allows an API user to add a CC staff record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCCStaffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCCStaffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCCStaffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CCStaff | CC staff management"
]
}
},
"/Template/update_template_media_attribute_list" : {
"post" : {
"operationId" : "Template:update_template_media_attribute_list",
"summary" : "update_template_media_attribute_list - Use this method to update the values of the template media attributes",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTemplateMediaAttributeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTemplateMediaAttributeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTemplateMediaAttributeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/Customer/update_payment_method" : {
"post" : {
"operationId" : "Customer:update_payment_method",
"summary" : "update_payment_method - This method allows an API user to assign a preferred payment method to a customer. For online payment methods, all the information required by the payment processor should be provided, and an appropriate payment processor must be set up and properly configured beforehand. Note that \"number\", \"name\", \"address\", and / or \"zip\" fields are not mandatory in the PaymentMethodInfo structure as long as credit card was already set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomerPaymentMethodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerPaymentMethodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerPaymentMethodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Payments, taxation and invoice management"
]
}
},
"/Env/add_custom_tax_option" : {
"post" : {
"operationId" : "Env:add_custom_tax_option",
"summary" : "add_custom_tax_option - This method allows an API user to add a new custom tax",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomTaxOptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomTaxOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomTaxOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Custom tax management"
]
}
},
"/Generic/get_ui_config_list" : {
"post" : {
"operationId" : "Generic:get_ui_config_list",
"summary" : "get_ui_config_list - This method enables an API user to get the list of the UI configs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUIConfigListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUIConfigListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUIConfigListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Generic information management"
]
}
},
"/Env/list_custom_tax_options" : {
"post" : {
"operationId" : "Env:list_custom_tax_options",
"summary" : "list_custom_tax_options - This method allows an API user to retrieve the list of custom taxes",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ListCustomTaxOptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ListCustomTaxOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ListCustomTaxOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Custom tax management"
]
}
},
"/Account/get_alias_list" : {
"post" : {
"operationId" : "Account:get_alias_list",
"summary" : "get_alias_list - This method allows an API user to get the list of aliases",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountAliasListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountAliasListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountAliasListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Alias management"
]
}
},
"/User/get_user_info" : {
"post" : {
"operationId" : "User:get_user_info",
"summary" : "get_user_info - This method allows an API user to get information about an administrative user",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUserInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | User management"
]
}
},
"/Currency/update_currency" : {
"post" : {
"operationId" : "Currency:update_currency",
"summary" : "update_currency - This method allows an API user to update a currency",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCurrencyResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCurrencyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCurrencyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Currency | Currency management"
]
}
},
"/Customer/get_batch_info" : {
"post" : {
"operationId" : "Customer:get_batch_info",
"summary" : "get_batch_info - This method allows an API user to obtain the information about the batch parameters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerBatchInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerBatchInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerBatchInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Account batch management"
]
}
},
"/Invoice/get_pay_required_invoices_summary" : {
"post" : {
"operationId" : "Invoice:get_pay_required_invoices_summary",
"summary" : "get_pay_required_invoices_summary - This method allows an API user to get the summary of the invoice records which should be paid",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPayRequiredInvoicesSummaryResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPayRequiredInvoicesSummaryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPayRequiredInvoicesSummaryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Template/add_external_invoice_template" : {
"post" : {
"operationId" : "Template:add_external_invoice_template",
"summary" : "add_external_invoice_template - Use this method to create your custom invoice template in the system. Such custom templates are called external invoice templates. You will need to upload an external template file (e.g. an HTML+CSS file) and, optionally, images",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddExternalTemplateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/AddExternalTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/Customer/get_huntgroup_info" : {
"post" : {
"operationId" : "Customer:get_huntgroup_info",
"summary" : "get_huntgroup_info - This method enables an API user to retrieve a huntgroup record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetHGInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetHGInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetHGInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Huntgroup management"
]
}
},
"/Account/get_account_product_info" : {
"post" : {
"operationId" : "Account:get_account_product_info",
"summary" : "get_account_product_info - This method allows an API user to get the information about the account's product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetProductInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountProductInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountProductInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/Service/get_service_pool_list" : {
"post" : {
"operationId" : "Service:get_service_pool_list",
"summary" : "get_service_pool_list - This method enables an API user to get the list of all configured service pools for the current environment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServicePoolListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServicePoolListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServicePoolListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Service pool management"
]
}
},
"/BundlePromotion/update_bundle_promotion" : {
"post" : {
"operationId" : "BundlePromotion:update_bundle_promotion",
"summary" : "update_bundle_promotion - This method allows an API user to update the bundle promotion information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateBundlePromotionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateBundlePromotionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateBundlePromotionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BundlePromotion | Bundle promotion management"
]
}
},
"/User/login_to_env" : {
"post" : {
"operationId" : "User:login_to_env",
"summary" : "login_to_env - This method enables an administrative user to change their current environment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserLoginToEnvResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UserLoginToEnvRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UserLoginToEnvRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | Internal"
]
}
},
"/User/get_rt_ticket_list" : {
"post" : {
"operationId" : "User:get_rt_ticket_list",
"summary" : "get_rt_ticket_list - This method allows to obtain tickets for a user from the RT server",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUserRTTicketListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserRTTicketListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserRTTicketListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | User management"
]
}
},
"/TraceSession/get_log_info" : {
"post" : {
"operationId" : "TraceSession:get_log_info",
"summary" : "get_log_info - This method enables an API user to fetch the log of the sessions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSessionLogInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSessionLogInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSessionLogInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TraceSession | Session information management"
]
}
},
"/UA/get_ua_profile_info" : {
"post" : {
"operationId" : "UA:get_ua_profile_info",
"summary" : "get_ua_profile_info - This method enables an API user to get the information of UA device (IP phone) profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUAProfileInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUAProfileInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUAProfileInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | Profile management"
]
}
},
"/Payment/add_merchant" : {
"post" : {
"operationId" : "Payment:add_merchant",
"summary" : "add_merchant - This method allows an API user to add a payment or payment remittance system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddMerchantAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddMerchantAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddMerchantAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Merchant account management"
]
}
},
"/Invoice/generate_out_of_turn_invoice" : {
"post" : {
"operationId" : "Invoice:generate_out_of_turn_invoice",
"summary" : "generate_out_of_turn_invoice - This method allows an administrator to generate an out-of-turn invoice (with some transactions included)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenerateOutOfTurnInvoiceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateOutOfTurnInvoiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenerateOutOfTurnInvoiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Report/get_asr_file_list" : {
"post" : {
"operationId" : "Report:get_asr_file_list",
"summary" : "get_asr_file_list - This method enables an API user to obtain the list of ASR files",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetASRFileListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetASRFileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetASRFileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Report | ASR report management"
]
}
},
"/Vendor/add_vendor_advanced" : {
"post" : {
"operationId" : "Vendor:add_vendor_advanced",
"summary" : "add_vendor_advanced - This method allows an API user to create a new vendor record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddVendorResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVendorRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVendorRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor management"
]
}
},
"/Destination/update_destination" : {
"post" : {
"operationId" : "Destination:update_destination",
"summary" : "update_destination - This method allows an API user to update an existing destination",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDestinationPrefixResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDestinationPrefixRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDestinationPrefixRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination management"
]
}
},
"/RoutingCriteria/add_routing_criteria_dest_group" : {
"post" : {
"operationId" : "RoutingCriteria:add_routing_criteria_dest_group",
"summary" : "add_routing_criteria_dest_group - This method enables an API user to add a new destination group to a routing criteria record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddRoutingCriteriaDestGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRoutingCriteriaDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRoutingCriteriaDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingCriteria | Destination group management"
]
}
},
"/DID/update_number" : {
"post" : {
"operationId" : "DID:update_number",
"summary" : "update_number - This method enables an API user to update a DID number description in the DID inventory",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDIDNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/BundlePromotion/delete_bundle_promotion" : {
"post" : {
"operationId" : "BundlePromotion:delete_bundle_promotion",
"summary" : "delete_bundle_promotion - This method allows an API user to delete the bundle promotion",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteBundlePromotionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDeleteBundlePromotionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDeleteBundlePromotionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BundlePromotion | Bundle promotion management"
]
}
},
"/Customer/get_subscriptions" : {
"post" : {
"operationId" : "Customer:get_subscriptions",
"summary" : "get_subscriptions - This method allows an API user to get the list of subscription records associated with a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerSubscriptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerSubscriptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Subscription management"
]
}
},
"/Account/get_service_features_metainfo" : {
"post" : {
"operationId" : "Account:get_service_features_metainfo",
"summary" : "get_service_features_metainfo - This method enables getting service features values of the account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountGetServiceFeaturesMetaInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetServiceFeaturesMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetServiceFeaturesMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/TrafficProfile/get_fraud_constraint_list" : {
"post" : {
"operationId" : "TrafficProfile:get_fraud_constraint_list",
"summary" : "get_fraud_constraint_list - This method enables an API user to get the list of traffic profile fraud constraint records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetFraudConstraintListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetFraudConstraintListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetFraudConstraintListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Constraint management"
]
}
},
"/DiscountPlan/clone_discount_plan" : {
"post" : {
"operationId" : "DiscountPlan:clone_discount_plan",
"summary" : "clone_discount_plan - This method allows an API user to clone a volume discount plan",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CloneDiscountPlanResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneDiscountPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneDiscountPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount plan management"
]
}
},
"/Service/update_service" : {
"post" : {
"operationId" : "Service:update_service",
"summary" : "update_service - This method enables an API user to update the service record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateServiceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateServiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateServiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Service management"
]
}
},
"/CustomerClass/update_customer_class" : {
"post" : {
"operationId" : "CustomerClass:update_customer_class",
"summary" : "update_customer_class - This method allows an API user to update a customer class record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Customer class management"
]
}
},
"/TaxationPlugin/delete_tax_transaction_code" : {
"post" : {
"operationId" : "TaxationPlugin:delete_tax_transaction_code",
"summary" : "delete_tax_transaction_code - This method allows an API user to delete a taxation code",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteTaxTransactionCodeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteTaxTransactionCodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteTaxTransactionCodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Code management"
]
}
},
"/Generic/get_codec_list" : {
"post" : {
"operationId" : "Generic:get_codec_list",
"summary" : "get_codec_list - This method enables an API user to get the list of available codecs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCodecListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCodecListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCodecListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Generic information management"
]
}
},
"/Generic/get_locale_languages_list" : {
"post" : {
"operationId" : "Generic:get_locale_languages_list",
"summary" : "get_locale_languages_list - This method enables an API user to get the list of locale language records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetLocaleLanguagesListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetLocaleLanguagesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetLocaleLanguagesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Generic information management"
]
}
},
"/Customer/get_rt_requestor_list" : {
"post" : {
"operationId" : "Customer:get_rt_requestor_list",
"summary" : "get_rt_requestor_list - This method allows to obtain a list of RT requestors",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerRTRequestorListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerRTRequestorListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerRTRequestorListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/Account/update_allowed_location" : {
"post" : {
"operationId" : "Account:update_allowed_location",
"summary" : "update_allowed_location - This method enables an API user to update an allowed location",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAllowedLocationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAllowedLocationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAllowedLocationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Location management"
]
}
},
"/AuthzRule/add_authz_rule" : {
"post" : {
"operationId" : "AuthzRule:add_authz_rule",
"summary" : "add_authz_rule - This method allows an API user to define manual authentication rules allowing PortaSIP servers to handle incoming calls in the desired manner",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAuthzRuleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAuthzRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAuthzRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AuthzRule | Authorization rule management"
]
}
},
"/ContentBasedCharging/update_marketing_group" : {
"post" : {
"operationId" : "ContentBasedCharging:update_marketing_group",
"summary" : "update_marketing_group - This method enables an API user to update the information about a marketing group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateMarketingGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateMarketingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateMarketingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ContentBasedCharging | Marketing group management"
]
}
},
"/BundlePromotion/update_criterion" : {
"post" : {
"operationId" : "BundlePromotion:update_criterion",
"summary" : "update_criterion - This method allows an API user to update the bundle promotion criterion",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCriterionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCriterionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCriterionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BundlePromotion | Criterium management"
]
}
},
"/DID/get_vendor_batch_info" : {
"post" : {
"operationId" : "DID:get_vendor_batch_info",
"summary" : "get_vendor_batch_info - This method enables an API user (administrator or reseller) to get the information about the DID vendor batch",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVendorBatchInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorBatchInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorBatchInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Vendor batch management"
]
}
},
"/ServicePolicy/add_service_policy" : {
"post" : {
"operationId" : "ServicePolicy:add_service_policy",
"summary" : "add_service_policy - This method enables an API user to create a new service policy",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddServicePolicyResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddServicePolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddServicePolicyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ServicePolicy | Service policy management"
]
}
},
"/Generic/get_subdivisions_list" : {
"post" : {
"operationId" : "Generic:get_subdivisions_list",
"summary" : "get_subdivisions_list - This method allows an API user to get the list of country subdivisions for a specific counry",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSubdivisionsListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSubdivisionsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSubdivisionsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Generic information management"
]
}
},
"/Service/add_service" : {
"post" : {
"operationId" : "Service:add_service",
"summary" : "add_service - This method enables an API user to create a new service record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateServiceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddServiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddServiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Service management"
]
}
},
"/WebLog/get_web_log_list" : {
"post" : {
"operationId" : "WebLog:get_web_log_list",
"summary" : "get_web_log_list - This method enables an API user to get the list of web log records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetWebLogListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetWebLogListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetWebLogListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"WebLog | Web log management"
]
}
},
"/Template/get_template_data_group_list" : {
"post" : {
"operationId" : "Template:get_template_data_group_list",
"summary" : "get_template_data_group_list - This method enables an API user to get the list of the data groups of the template",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TemplateGetTemplateDataGroupListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateGetTemplateDataGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TemplateGetTemplateDataGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Internal"
]
}
},
"/Destination/get_default_destination_list" : {
"post" : {
"operationId" : "Destination:get_default_destination_list",
"summary" : "get_default_destination_list - This method enables an API user to retrieve the list of default destination pre-set in a spreadsheet attachment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDefaultDestinationPrefixListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDefaultDestinationPrefixListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDefaultDestinationPrefixListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination management"
]
}
},
"/ContentBasedCharging/get_marketing_group_list" : {
"post" : {
"operationId" : "ContentBasedCharging:get_marketing_group_list",
"summary" : "get_marketing_group_list - This method enables an API user to retrieve the list of existing marketing groups",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMarketingGroupListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMarketingGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMarketingGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ContentBasedCharging | Marketing group management"
]
}
},
"/Node/delete_node" : {
"post" : {
"operationId" : "Node:delete_node",
"summary" : "delete_node - This method enables an API user to delete a node",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteNodeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteNodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteNodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Node | Node management"
]
}
},
"/Customer/delete_callqueue" : {
"post" : {
"operationId" : "Customer:delete_callqueue",
"summary" : "delete_callqueue - This method allows an API user to remove the call queue from a huntgroup",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCallQueueResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCallQueueRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCallQueueRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Call queue management"
]
}
},
"/UA/clone_ua_profile" : {
"post" : {
"operationId" : "UA:clone_ua_profile",
"summary" : "clone_ua_profile - This method enables an API user to clone an UA device (IP phone) profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CloneUAProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneUAProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneUAProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | Profile management"
]
}
},
"/Product/validate_addons_combination" : {
"post" : {
"operationId" : "Product:validate_addons_combination",
"summary" : "validate_addons_combination - This method allows an API user to validate a combination of add-on products. Every add-on product has a list of allowable main products that are compatible with it, and can be assigned to an account together with this main product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ValidateAddonsCombinationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ValidateAddonsCombinationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ValidateAddonsCombinationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Product management"
]
}
},
"/Account/get_selfcare_config_data" : {
"post" : {
"operationId" : "Account:get_selfcare_config_data",
"summary" : "get_selfcare_config_data - This method enables an API user to get the account self-care page configuration values",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountGetSelfcareConfigDataResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetSelfcareConfigDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetSelfcareConfigDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/AuthzRule/delete_authz_rule" : {
"post" : {
"operationId" : "AuthzRule:delete_authz_rule",
"summary" : "delete_authz_rule - This method allows an API user to delete authentication rules",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAuthzRuleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAuthzRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAuthzRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AuthzRule | Authorization rule management"
]
}
},
"/Product/delete_subscription" : {
"post" : {
"operationId" : "Product:delete_subscription",
"summary" : "delete_subscription - This method allows an API user to delete a subscription from the product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteProductSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteProductSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteProductSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Subscription management"
]
}
},
"/Account/assign_commitment" : {
"post" : {
"operationId" : "Account:assign_commitment",
"summary" : "assign_commitment - The method enables an API user to assign a commitment to an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssignCommitmentResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignCommitmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignCommitmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/Destination/upload" : {
"post" : {
"operationId" : "Destination:upload",
"summary" : "upload - This method enables an API user to upload destinations",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadDestResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadDestRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadDestRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination management"
]
}
},
"/IVRApplications/delete_ivr_application" : {
"post" : {
"operationId" : "IVRApplications:delete_ivr_application",
"summary" : "delete_ivr_application - This method enables an API user to delete the IVR application",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteIvrApplicationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteIvrApplicationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteIvrApplicationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Application management"
]
}
},
"/Representative/make_transaction" : {
"post" : {
"operationId" : "Representative:make_transaction",
"summary" : "make_transaction - This method allows an API user to correct a representative's balance",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MakeRepresentativeTransactionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeRepresentativeTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeRepresentativeTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Representative | Transaction management"
]
}
},
"/Customer/get_callqueue_info" : {
"post" : {
"operationId" : "Customer:get_callqueue_info",
"summary" : "get_callqueue_info - This method allows an API user to get call queue information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCQInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCQInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCQInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Call queue management"
]
}
},
"/CustomFields/add_custom_field" : {
"post" : {
"operationId" : "CustomFields:add_custom_field",
"summary" : "add_custom_field - This method enables an API user to add a custom field",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCustomFieldResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCustomFieldRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCustomFieldRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomFields | Custom field management"
]
}
},
"/Customer/delete_customer" : {
"post" : {
"operationId" : "Customer:delete_customer",
"summary" : "delete_customer - This method allows an API user to delete an existing retail customer or reseller, provided it has no accounts, subcustomers, CDRs or managed objects",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/Session/get_session_context" : {
"post" : {
"operationId" : "Session:get_session_context",
"summary" : "get_session_context - This method enables an API user to get the euuid for the current session",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSessionContextResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSessionContextRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSessionContextRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Session | Authenticated session management"
]
}
},
"/CommissionPlan/add_commission_plan" : {
"post" : {
"operationId" : "CommissionPlan:add_commission_plan",
"summary" : "add_commission_plan - This method allows an API user to add a commission plan record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCommissionPlanResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCommissionPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCommissionPlanRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CommissionPlan | Commission plan management"
]
}
},
"/Rate/update_rate_group" : {
"post" : {
"operationId" : "Rate:update_rate_group",
"summary" : "update_rate_group - This method allows an API user to update the existing rate for every destination in a destination group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateRateGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRateGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRateGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Group management"
]
}
},
"/Destination/add_dest_group" : {
"post" : {
"operationId" : "Destination:add_dest_group",
"summary" : "add_dest_group - This method allows an API user to add a destination group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddDestGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group management"
]
}
},
"/CustomerClass/get_customer_class_info" : {
"post" : {
"operationId" : "CustomerClass:get_customer_class_info",
"summary" : "get_customer_class_info - This method allows an API user to get information about the customer class records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerClassInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Customer class management"
]
}
},
"/Customer/get_zendesk_organization_info" : {
"post" : {
"operationId" : "Customer:get_zendesk_organization_info",
"summary" : "get_zendesk_organization_info - This method allows an API user to get information about an organization from the Zendesk platform",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetZendeskOrganizationInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetZendeskOrganizationInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetZendeskOrganizationInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Support request management"
]
}
},
"/Account/add_cp_rule" : {
"post" : {
"operationId" : "Account:add_cp_rule",
"summary" : "add_cp_rule - This method allows an API user to create a new call screening rule",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCPRuleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCPRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCPRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call screening management"
]
}
},
"/RoutingPlan/get_route_list" : {
"post" : {
"operationId" : "RoutingPlan:get_route_list",
"summary" : "get_route_list - This method allows an API user to test a dialplan for a specific telephone number or certain destinations at any moment in time",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRouteListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRouteListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRouteListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Routing plan management"
]
}
},
"/Customer/get_customer_billing_periods_history" : {
"post" : {
"operationId" : "Customer:get_customer_billing_periods_history",
"summary" : "get_customer_billing_periods_history - This method allows an API user to get the history of a customer's billing periods. Used for information about previous measured service charges",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerBillingPeriodsHistoryResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerBillingPeriodsHistoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerBillingPeriodsHistoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Measured service management"
]
}
},
"/Product/get_product_list_detailed" : {
"post" : {
"operationId" : "Product:get_product_list_detailed",
"summary" : "get_product_list_detailed - This method enables an API user to get the list of products with additional information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductGetProductListDetailedResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductGetProductListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductGetProductListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Internal"
]
}
},
"/Metric/get_measured_metric_data_list" : {
"post" : {
"operationId" : "Metric:get_measured_metric_data_list",
"summary" : "get_measured_metric_data_list - This method enables an API user to get data related to the selected measured metrics",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMeasuredMetricDataResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMeasuredMetricDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMeasuredMetricDataRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Metric | Measured metric management"
]
}
},
"/Account/get_cp_condition_list" : {
"post" : {
"operationId" : "Account:get_cp_condition_list",
"summary" : "get_cp_condition_list - This method allows an API user to retrieve the list of call screening conditions defined for a given customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCPConditionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCPConditionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCPConditionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call screening management"
]
}
},
"/OLI/get_oli_list" : {
"post" : {
"operationId" : "OLI:get_oli_list",
"summary" : "get_oli_list - This method allows an API user to get the list of OLI",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetOliListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOliListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOliListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"OLI | OLI management"
]
}
},
"/Vendor/update_vendor" : {
"post" : {
"operationId" : "Vendor:update_vendor",
"summary" : "update_vendor - This method allows an API user to update an existing vendor record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateVendorResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVendorRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVendorRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor management"
]
}
},
"/Customer/add_customer_extension" : {
"post" : {
"operationId" : "Customer:add_customer_extension",
"summary" : "add_customer_extension - This method allows a retail customer to add an extension",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerExtensionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/AddCustomerExtensionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/AddCustomerExtensionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Extension management"
]
}
},
"/Customer/close_subscription" : {
"post" : {
"operationId" : "Customer:close_subscription",
"summary" : "close_subscription - This method allows an API user to close an existing active subscription assigned to a customer. It requires an ID number returned, for example, by the add_subscription method",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CloseCustomerSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloseDeleteCustomerSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloseDeleteCustomerSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Subscription management"
]
}
},
"/SIMCard/add_sim_card" : {
"post" : {
"operationId" : "SIMCard:add_sim_card",
"summary" : "add_sim_card - This method enables an API user to create a new sim card record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateSIMCardResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddSIMCardRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddSIMCardRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"SIMCard | SIM card management"
]
}
},
"/DiscountPlan/get_topup_option_info" : {
"post" : {
"operationId" : "DiscountPlan:get_topup_option_info",
"summary" : "get_topup_option_info - This method allows an API user to get the information about a topup option",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVDTopupOptionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVDTopupOptionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVDTopupOptionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Topup option management"
]
}
},
"/BundlePromotion/get_bundle_promotion_list" : {
"post" : {
"operationId" : "BundlePromotion:get_bundle_promotion_list",
"summary" : "get_bundle_promotion_list - This method allows an API user to get the list of bundle promotions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetBundlePromotionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetBundlePromotionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetBundlePromotionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BundlePromotion | Bundle promotion management"
]
}
},
"/Vendor/get_connection_list" : {
"post" : {
"operationId" : "Vendor:get_connection_list",
"summary" : "get_connection_list - This method allows an API user to obtain a list of connections that satisfy search criteria",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetConnectionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConnectionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConnectionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Connection management"
]
}
},
"/IVRApplications/get_access_number_info" : {
"post" : {
"operationId" : "IVRApplications:get_access_number_info",
"summary" : "get_access_number_info - This method enables an API user to get the IVR access number information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccessNumberInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessNumberInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessNumberInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Access number management"
]
}
},
"/Customer/get_last_billing_date_constraint_list" : {
"post" : {
"operationId" : "Customer:get_last_billing_date_constraint_list",
"summary" : "get_last_billing_date_constraint_list - The method enables an API user to get constraints related to last billing date",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetLastBillingDateConstraintListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetLastBillingDateConstraintListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetLastBillingDateConstraintListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/TaxationPlugin/set_tax_plugin_parameters" : {
"post" : {
"operationId" : "TaxationPlugin:set_tax_plugin_parameters",
"summary" : "set_tax_plugin_parameters - This method enables an API user to configure the taxation plugin parameters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SetTaxPluginParametersResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SetTaxPluginParametersRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SetTaxPluginParametersRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Taxation plugin management"
]
}
},
"/User/get_user_list" : {
"post" : {
"operationId" : "User:get_user_list",
"summary" : "get_user_list - This method allows an API user to retrieve the list of administrative users",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUserInfoListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserInfoListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserInfoListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | User management"
]
}
},
"/TrafficProfile/update_fraud_constraint" : {
"post" : {
"operationId" : "TrafficProfile:update_fraud_constraint",
"summary" : "update_fraud_constraint - This method enables an API user to update a traffic profile fraud constraint",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateFraudConstraintResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateFraudConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateFraudConstraintRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Constraint management"
]
}
},
"/Account/get_preferable_account" : {
"post" : {
"operationId" : "Account:get_preferable_account",
"summary" : "get_preferable_account - This method enables an API user to obtain information about the account’s Favourites list record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPreferableAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPreferableAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPreferableAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Favourites list management"
]
}
},
"/Invoice/set_invoice_state" : {
"post" : {
"operationId" : "Invoice:set_invoice_state",
"summary" : "set_invoice_state - This method allows an API user to change an invoice status (either opened or closed).",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SetInvoiceStateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SetInvoiceStateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SetInvoiceStateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Customer/delete_auto_payment" : {
"post" : {
"operationId" : "Customer:delete_auto_payment",
"summary" : "delete_auto_payment - This method enables an API user to delete customer's automated periodic payments",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAutoPaymentResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAutoPaymentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAutoPaymentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Auto-payment management"
]
}
},
"/IPTV/get_channel_package_list" : {
"post" : {
"operationId" : "IPTV:get_channel_package_list",
"summary" : "get_channel_package_list - A channel package is a set of IPTV channels available within this package (e.g. a Basic channel package includes only local TV channels while a Gold package also includes sport, movie, music and news channels). Use this method to retrieve the list of IPTV channel packages imported in PortaBilling",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetIPTVChannelPackageListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetIPTVChannelPackageListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetIPTVChannelPackageListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IPTV | Channel package management"
]
}
},
"/Vendor/delete_vendor_account" : {
"post" : {
"operationId" : "Vendor:delete_vendor_account",
"summary" : "delete_vendor_account - This method allows an API user to delete a vendor account used for digest authentication",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteVendorAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVendorAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteVendorAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor account management"
]
}
},
"/Currency/get_currency_list" : {
"post" : {
"operationId" : "Currency:get_currency_list",
"summary" : "get_currency_list - This method allows an API user to get the list of currencies created in PortaBilling",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCurrencyListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCurrencyListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCurrencyListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Currency | Currency management"
]
}
},
"/Customer/add_subscription" : {
"post" : {
"operationId" : "Customer:add_subscription",
"summary" : "add_subscription - This method allows an API user to create a new subscription and assign it to a customer. If successful, a new subscription ID is returned",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCustomerSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCustomerSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Subscription management"
]
}
},
"/DID/delete_owner_batch" : {
"post" : {
"operationId" : "DID:delete_owner_batch",
"summary" : "delete_owner_batch - This method allows an API user (administrator or reseller) to delete DID Pricing Batch.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteOwnerBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteOwnerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteOwnerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Pricing batch management"
]
}
},
"/MeasuredServices/get_measured_metrics_list" : {
"post" : {
"operationId" : "MeasuredServices:get_measured_metrics_list",
"summary" : "get_measured_metrics_list - This method allows an API user to retrieve a list of measured services",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMeasuredMetricsListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMeasuredMetricsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMeasuredMetricsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Measured service management"
]
}
},
"/Notification/add_notification_preset" : {
"post" : {
"operationId" : "Notification:add_notification_preset",
"summary" : "add_notification_preset - This method enables an API user to add a notification preset",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateNotificationPresetResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateNotificationPresetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateNotificationPresetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Notification | Notification management"
]
}
},
"/TaxationPlugin/get_tax_plugin_parameters_metainfo" : {
"post" : {
"operationId" : "TaxationPlugin:get_tax_plugin_parameters_metainfo",
"summary" : "get_tax_plugin_parameters_metainfo - This method enables an API user to obtain the list of available parameters of a taxation plugin",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TaxationPluginGetTaxPluginParametersMetaInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TaxationPluginGetTaxPluginParametersMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TaxationPluginGetTaxPluginParametersMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Internal"
]
}
},
"/User/update_user" : {
"post" : {
"operationId" : "User:update_user",
"summary" : "update_user - This method allows an API user to update an existing administrative user",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateUserResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUserRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateUserRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | User management"
]
}
},
"/Tariff/delete_override_tariff" : {
"post" : {
"operationId" : "Tariff:delete_override_tariff",
"summary" : "delete_override_tariff - This method allows an API user to delete an existing override tariff rule",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteOverrideTariffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteOverrideTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteOverrideTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Override tariff rule management"
]
}
},
"/Customer/get_number_sequence_info" : {
"post" : {
"operationId" : "Customer:get_number_sequence_info",
"summary" : "get_number_sequence_info - This method enables an API user to get the information about a customer invoice number sequence",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerGetCustomerNumberSequenceInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerGetCustomerNumberSequenceInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerGetCustomerNumberSequenceInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Internal"
]
}
},
"/Invoice/upload_invoice_pdf" : {
"post" : {
"operationId" : "Invoice:upload_invoice_pdf",
"summary" : "upload_invoice_pdf - This method allows to upload pdf file for the invoice",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/InvoiceUploadInvoicePdfResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/InvoiceUploadInvoicePdfRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Internal"
]
}
},
"/SIMCard/upload_sim_cards" : {
"post" : {
"operationId" : "SIMCard:upload_sim_cards",
"summary" : "upload_sim_cards - This method enables an API user to upload sim cards into the system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadSIMCardsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadSIMCardsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"SIMCard | SIM card management"
]
}
},
"/Notification/update_notification_preset" : {
"post" : {
"operationId" : "Notification:update_notification_preset",
"summary" : "update_notification_preset - This method enables an API user to update a notification preset",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateNotificationPresetResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateNotificationPresetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateNotificationPresetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Notification | Notification management"
]
}
},
"/DiscountPlan/get_discount_list" : {
"post" : {
"operationId" : "DiscountPlan:get_discount_list",
"summary" : "get_discount_list - This method allows an API user to get the information about discounts (per destination group) in the specified volume discount plan",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDiscountListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDiscountListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDiscountListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount management"
]
}
},
"/Vendor/get_connection_info" : {
"post" : {
"operationId" : "Vendor:get_connection_info",
"summary" : "get_connection_info - This method allows an API user to get a connection record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetConnectionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConnectionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConnectionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Connection management"
]
}
},
"/Calendar/upload_dates" : {
"post" : {
"operationId" : "Calendar:upload_dates",
"summary" : "upload_dates - This method enables an API user to upload a file with calendar date records information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadDatesBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadDatesBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Calendar | Calendar management"
]
}
},
"/Node/update_node" : {
"post" : {
"operationId" : "Node:update_node",
"summary" : "update_node - This method enables an API user to update a node",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateNodeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateNodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateNodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Node | Node management"
]
}
},
"/MeasuredServices/delete_customer_class_metric" : {
"post" : {
"operationId" : "MeasuredServices:delete_customer_class_metric",
"summary" : "delete_customer_class_metric - This method allows an API user to delete a customer class's measured service",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerClassMetricResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerClassMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerClassMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Customer class metric management"
]
}
},
"/Notification/delete_notification_preset" : {
"post" : {
"operationId" : "Notification:delete_notification_preset",
"summary" : "delete_notification_preset - This method enables an API user to delete a notification preset",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteNotificationPresetResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteNotificationPresetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteNotificationPresetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Notification | Notification management"
]
}
},
"/Customer/delete_subscription" : {
"post" : {
"operationId" : "Customer:delete_subscription",
"summary" : "delete_subscription - This method allows an API user to delete a pending subscription assigned to a customer. It requires an ID number returned, for example, by the add_subscription method",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloseDeleteCustomerSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloseDeleteCustomerSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Subscription management"
]
}
},
"/Account/get_role_list" : {
"post" : {
"operationId" : "Account:get_role_list",
"summary" : "get_role_list - This method enables an API user to retrieve the information about account roles by their fields",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountRoleListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountRoleListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountRoleListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account role management"
]
}
},
"/Account/get_phonebook_record" : {
"post" : {
"operationId" : "Account:get_phonebook_record",
"summary" : "get_phonebook_record - This method allows an API user to obtain the account's Phonebook record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPhoneBookRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPhoneBookRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPhoneBookRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Phonebook management"
]
}
},
"/Template/delete_external_invoice_template_image" : {
"post" : {
"operationId" : "Template:delete_external_invoice_template_image",
"summary" : "delete_external_invoice_template_image - Use this method to delete an image from an external invoice template",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteExternalTemplateImageResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteExternalTemplateImageRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteExternalTemplateImageRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/Account/get_provisioning_status_list" : {
"post" : {
"operationId" : "Account:get_provisioning_status_list",
"summary" : "get_provisioning_status_list - The method enables an API user to retrieve the list of account provisioning statuses",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountProvisioningStatusListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountProvisioningStatusListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountProvisioningStatusListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account management"
]
}
},
"/Vendor/get_connection_type_list" : {
"post" : {
"operationId" : "Vendor:get_connection_type_list",
"summary" : "get_connection_type_list - This method enables an API user to obtain the list of connection types",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetConnectionTypeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConnectionTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConnectionTypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Connection type management"
]
}
},
"/Account/update_phonebook_record" : {
"post" : {
"operationId" : "Account:update_phonebook_record",
"summary" : "update_phonebook_record - This method allows an API user to update a record in the account's Phonebook",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdatePhoneBookRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdatePhoneBookRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdatePhoneBookRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Phonebook management"
]
}
},
"/Customer/make_transaction" : {
"post" : {
"operationId" : "Customer:make_transaction",
"summary" : "make_transaction - This method allows an API user to adjust a customer’s balance or issue a payment transaction, including e-commerce transactions.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MakeCustomerTransactionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeCustomerTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeCustomerTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Transaction management"
]
}
},
"/Account/get_services_consumption" : {
"post" : {
"operationId" : "Account:get_services_consumption",
"summary" : "get_services_consumption - This method allows an API user to get the information about services consumed by an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountConsumedServiceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountConsumedServiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountConsumedServiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/Session/change_password" : {
"post" : {
"operationId" : "Session:change_password",
"summary" : "change_password - The API method enables an API user to change their password (also changes expired passwords)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SessionChangePasswordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SessionChangePasswordRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SessionChangePasswordRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Session | Authenticated session management"
]
}
},
"/CustomerClass/get_notification_template_info" : {
"post" : {
"operationId" : "CustomerClass:get_notification_template_info",
"summary" : "get_notification_template_info - This method allows an API user to get information about the notification template configured for a customer class",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerClassNotificationTemplateInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassNotificationTemplateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerClassNotificationTemplateInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Notification template management"
]
}
},
"/Customer/get_xdr_quality_info" : {
"post" : {
"operationId" : "Customer:get_xdr_quality_info",
"summary" : "get_xdr_quality_info - The method enables an API user to fetch the information about XDR metric data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRetailCustomerXDRQualityInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRetailCustomerXDRQualityInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRetailCustomerXDRQualityInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/TaxationPlugin/get_tax_plugin_codes_list" : {
"post" : {
"operationId" : "TaxationPlugin:get_tax_plugin_codes_list",
"summary" : "get_tax_plugin_codes_list - This method allows an API user to get the list of all taxation codes for the specified taxation plugin",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTaxPluginCodesListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTaxPluginCodesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTaxPluginCodesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Code management"
]
}
},
"/Rate/get_rate_match_mode_info" : {
"post" : {
"operationId" : "Rate:get_rate_match_mode_info",
"summary" : "get_rate_match_mode_info - This method enables an API user to get the rate match mode information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RateGetRateMatchModeInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RateGetRateMatchModeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RateGetRateMatchModeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Internal"
]
}
},
"/Generic/get_api_schema" : {
"post" : {
"operationId" : "Generic:get_api_schema",
"summary" : "get_api_schema - This method enables an API user to get the schema of porta-billing API methods",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAPISchemaResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAPISchemaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAPISchemaRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Generic information management"
]
}
},
"/CCStaff/get_cc_staff_info" : {
"post" : {
"operationId" : "CCStaff:get_cc_staff_info",
"summary" : "get_cc_staff_info - This method enables an API user to get a CC staff info",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCCStaffInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCCStaffInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCCStaffInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CCStaff | CC staff management"
]
}
},
"/Product/update_product_detailed" : {
"post" : {
"operationId" : "Product:update_product_detailed",
"summary" : "update_product_detailed - This method enables an API user to update an existing product with additional properties specified",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductUpdateProductDetailedResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductUpdateProductDetailedRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductUpdateProductDetailedRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Internal"
]
}
},
"/Account/get_vd_counter_list" : {
"post" : {
"operationId" : "Account:get_vd_counter_list",
"summary" : "get_vd_counter_list - This method allows an API user to get the information about volume discount counters for the specified account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountVDCounterListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountVDCounterListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountVDCounterListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Volume discount management"
]
}
},
"/Account/delete_phonebook_record" : {
"post" : {
"operationId" : "Account:delete_phonebook_record",
"summary" : "delete_phonebook_record - This method allows an API user to delete a record from the account's Phonebook",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeletePhoneBookRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeletePhoneBookRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeletePhoneBookRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Phonebook management"
]
}
},
"/Template/add_tariff_download_template" : {
"post" : {
"operationId" : "Template:add_tariff_download_template",
"summary" : "add_tariff_download_template - Use this method to create a template for tariff download",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddTariffDownloadTemplateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddTariffDownloadTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddTariffDownloadTemplateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Template | Template management"
]
}
},
"/CCStaff/add_cc_staff_advanced" : {
"post" : {
"operationId" : "CCStaff:add_cc_staff_advanced",
"summary" : "add_cc_staff_advanced - This method allows an API user to add a CC staff record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCCStaffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCCStaffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCCStaffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CCStaff | CC staff management"
]
}
},
"/CodecConverter/delete_file" : {
"post" : {
"operationId" : "CodecConverter:delete_file",
"summary" : "delete_file - This method enables an API user to delete the file",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCodecConverterFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCodecConverterFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCodecConverterFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CodecConverter | Codec converter file management"
]
}
},
"/QuickForms/get_quick_form_fields_list" : {
"post" : {
"operationId" : "QuickForms:get_quick_form_fields_list",
"summary" : "get_quick_form_fields_list - This method enables an API user to get the list of fields of the quick form",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetQFFieldsListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetQFFieldsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetQFFieldsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"QuickForms | Field management"
]
}
},
"/Customer/get_vd_counter_list" : {
"post" : {
"operationId" : "Customer:get_vd_counter_list",
"summary" : "get_vd_counter_list - This method allows an API user to get the information about volume discount counters for the specified customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerVDCounterListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerVDCounterListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerVDCounterListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Volume discount management"
]
}
},
"/Product/delete_group" : {
"post" : {
"operationId" : "Product:delete_group",
"summary" : "delete_group - This method allows an API user to delete a product group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteProductGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteProductGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteProductGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Group management"
]
}
},
"/Customer/add_zendesk_organization" : {
"post" : {
"operationId" : "Customer:add_zendesk_organization",
"summary" : "add_zendesk_organization - This method enables an API user to add an organization in the Zendesk platform",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateZendeskOrganizationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddZendeskOrganizationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddZendeskOrganizationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Support request management"
]
}
},
"/Account/add_phonebook_record" : {
"post" : {
"operationId" : "Account:add_phonebook_record",
"summary" : "add_phonebook_record - This method allows an API user to add a record to the account's Phonebook",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdatePhoneBookRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdatePhoneBookRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdatePhoneBookRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Phonebook management"
]
}
},
"/Tariff/update_resale_map_record" : {
"post" : {
"operationId" : "Tariff:update_resale_map_record",
"summary" : "update_resale_map_record - This method allows an API user (reseller) to update mapping between a reseller's wholesale and resale tariffs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateResaleMapRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateResaleMapRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateResaleMapRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Reseller tariff management"
]
}
},
"/Customer/add_batch" : {
"post" : {
"operationId" : "Customer:add_batch",
"summary" : "add_batch - This method allows an API user to add a new batch",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Account batch management"
]
}
},
"/DID_Provider/get_countries_list" : {
"post" : {
"operationId" : "DID_Provider:get_countries_list",
"summary" : "get_countries_list - This method allows an API user to retrieve the list of countries where a number can be allocated from via the DID provider. If DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDCountriesListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDCountriesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDCountriesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID_Provider | DID auto-provisioning management"
]
}
},
"/Account/get_simple_account_info" : {
"post" : {
"operationId" : "Account:get_simple_account_info",
"summary" : "get_simple_account_info - This is a simplified method that enables getting an account record from the database more quickly",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountGetSimpleAccountInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetSimpleAccountInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetSimpleAccountInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/Vendor/get_vendor_account_list" : {
"post" : {
"operationId" : "Vendor:get_vendor_account_list",
"summary" : "get_vendor_account_list - This method allows an API user to obtain a list of specific vendor's accounts used for digest authentication",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVendorAccountListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorAccountListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorAccountListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor account management"
]
}
},
"/CustomFields/update_custom_field" : {
"post" : {
"operationId" : "CustomFields:update_custom_field",
"summary" : "update_custom_field - This method enables an API user to update a custom field",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomFieldResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomFieldRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomFieldRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomFields | Custom field management"
]
}
},
"/TrafficProfile/get_traffic_profile_list" : {
"post" : {
"operationId" : "TrafficProfile:get_traffic_profile_list",
"summary" : "get_traffic_profile_list - This method enables an API user to get the list of traffic profile records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTrafficProfileListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTrafficProfileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTrafficProfileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Profile management"
]
}
},
"/Generic/get_countries_list" : {
"post" : {
"operationId" : "Generic:get_countries_list",
"summary" : "get_countries_list - This method allows an API user to get the list of countries",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCountriesListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCountriesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCountriesListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Generic information management"
]
}
},
"/Session/get_espf_api_token" : {
"post" : {
"operationId" : "Session:get_espf_api_token",
"summary" : "get_espf_api_token - This method enables an API user to get the ESPF API token",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetEspfApiTokenResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEspfApiTokenRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetEspfApiTokenRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Session | Authenticated session management"
]
}
},
"/Account/make_transaction" : {
"post" : {
"operationId" : "Account:make_transaction",
"summary" : "make_transaction - This method allows an API user to adjust an account's balance or issue a payment transaction, including e-commerce transactions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MakeAccountTransactionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeAccountTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeAccountTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Transaction management"
]
}
},
"/Customer/get_vd_counter_info" : {
"post" : {
"operationId" : "Customer:get_vd_counter_info",
"summary" : "get_vd_counter_info - This method enables an API user to retrieve the information about a customer-level counter",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerVdCounterInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerVdCounterInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerVdCounterInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Volume discount management"
]
}
},
"/Account/get_xdr_quality_info" : {
"post" : {
"operationId" : "Account:get_xdr_quality_info",
"summary" : "get_xdr_quality_info - The method enables an API user to fetch the information about XDR metric data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountXDRQualityInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountXDRQualityInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountXDRQualityInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/NegotiatedFeatures/update_negotiated_feature_list" : {
"post" : {
"operationId" : "NegotiatedFeatures:update_negotiated_feature_list",
"summary" : "update_negotiated_feature_list - {This method enables an API user to update the list of the negotiated features applied to a routing plan or connection",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateNegotiatedFeatureListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateNegotiatedFeatureListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateNegotiatedFeatureListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"NegotiatedFeatures | Negotiated feature management"
]
}
},
"/DID/update_did_group" : {
"post" : {
"operationId" : "DID:update_did_group",
"summary" : "update_did_group - This method enables an API user to update a DID group record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDIDGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDIDGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDIDGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Group management"
]
}
},
"/EmergencyUnit/add_emergency_unit" : {
"post" : {
"operationId" : "EmergencyUnit:add_emergency_unit",
"summary" : "add_emergency_unit - This method enables an API user to add a new emergency routing unit",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateEmergencyUnitResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddEmergencyUnitRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddEmergencyUnitRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"EmergencyUnit | Emergency routing unit management"
]
}
},
"/RoamingProfile/add_roaming_profile" : {
"post" : {
"operationId" : "RoamingProfile:add_roaming_profile",
"summary" : "add_roaming_profile - This method enables an API user to add a new roaming profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRoamingProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRoamingProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRoamingProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoamingProfile | Roaming profile management"
]
}
},
"/Representative/get_transactions_total_info" : {
"post" : {
"operationId" : "Representative:get_transactions_total_info",
"summary" : "get_transactions_total_info - This method enables an API user to get the list of a representative's transactions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRepresentativeTransactionsTotalInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRepresentativeTransactionsTotalInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRepresentativeTransactionsTotalInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Representative | Transaction management"
]
}
},
"/Commitment/add_commitment_one_time_term" : {
"post" : {
"operationId" : "Commitment:add_commitment_one_time_term",
"summary" : "add_commitment_one_time_term - The method enables an API user to add a one-time term to the commitment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCommitmentOneTimeTermResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCommitmentOneTimeTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCommitmentOneTimeTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/DID/get_number_info" : {
"post" : {
"operationId" : "DID:get_number_info",
"summary" : "get_number_info - This method allows an API user to get a DID number record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDNumberInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDNumberInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDNumberInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/DID/release_did_from_owner_batch" : {
"post" : {
"operationId" : "DID:release_did_from_owner_batch",
"summary" : "release_did_from_owner_batch - This method allows an API user to release a DID number previously assigned to the Pricing Batch.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReleaseDIDFromOwnerBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseDIDFromOwnerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseDIDFromOwnerBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Assignment management"
]
}
},
"/Generic/get_time_zone_info" : {
"post" : {
"operationId" : "Generic:get_time_zone_info",
"summary" : "get_time_zone_info - This method allows an API user to get information about a specific time zone",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTimeZoneInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTimeZoneInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTimeZoneInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Time zone management"
]
}
},
"/CallBarring/add_default_cb_option" : {
"post" : {
"operationId" : "CallBarring:add_default_cb_option",
"summary" : "add_default_cb_option - This method enables an API user to add a new default call barring option record using supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddDefaultCallBarringOptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddGetDefaultCallBarringOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddGetDefaultCallBarringOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CallBarring | Call barring options management"
]
}
},
"/Vendor/update_connection" : {
"post" : {
"operationId" : "Vendor:update_connection",
"summary" : "update_connection - This method allows an API user to update an existing vendor connection record using the supplied data",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateConnectionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateConnectionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Connection management"
]
}
},
"/Generic/get_global_currency_list" : {
"post" : {
"operationId" : "Generic:get_global_currency_list",
"summary" : "get_global_currency_list - This method allows an API user to get information about all actual and outdated world currencies",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetGlobalCurrencyListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetGlobalCurrencyListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetGlobalCurrencyListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Currency management"
]
}
},
"/UA/get_ua_type_usage_statistics" : {
"post" : {
"operationId" : "UA:get_ua_type_usage_statistics",
"summary" : "get_ua_type_usage_statistics - This method enables an API user to get the UA device (IP phone) usage statistics grouped by type",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUATypeUsageStatisticsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUATypeUsageStatisticsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUATypeUsageStatisticsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | Inventory management"
]
}
},
"/Account/get_account_followme" : {
"post" : {
"operationId" : "Account:get_account_followme",
"summary" : "get_account_followme - This method retrieves the follow-me settings associated with an account. Follow-me entries (numbers) are returned in the order of their priority",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountFollowMeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountFollowMeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountFollowMeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Follow-me settings management"
]
}
},
"/Customer/get_status_history" : {
"post" : {
"operationId" : "Customer:get_status_history",
"summary" : "get_status_history - This method allows an API user to track important events in a customer's lifecycle, such as when a customer was blocked / unblocked, suspended / unsuspended or terminated",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerStatusHistoryResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerStatusHistoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerStatusHistoryRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/AccessControl/verify_otp" : {
"post" : {
"operationId" : "AccessControl:verify_otp",
"summary" : "verify_otp - This method verifies one-time-password by current session_id",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VerifyOtpResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/VerifyOtpRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/VerifyOtpRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessControl | Access control management"
]
}
},
"/Payment/get_merchant" : {
"post" : {
"operationId" : "Payment:get_merchant",
"summary" : "get_merchant - This method allows an API user to get a payment or payment remittance system data.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMerchantAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMerchantAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMerchantAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Payment | Merchant account management"
]
}
},
"/Product/get_group_list" : {
"post" : {
"operationId" : "Product:get_group_list",
"summary" : "get_group_list - This method allows an API user to create a product group to provide customers with effective add-on management tools",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetProductGroupListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetProductGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Group management"
]
}
},
"/User/get_rt_requestor_list" : {
"post" : {
"operationId" : "User:get_rt_requestor_list",
"summary" : "get_rt_requestor_list - This method allows to obtain a list of RT requestors",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUserRTRequestorListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserRTRequestorListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUserRTRequestorListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"User | User management"
]
}
},
"/Currency/convert_money" : {
"post" : {
"operationId" : "Currency:convert_money",
"summary" : "convert_money - This method allows an API user to convert an amount from one currency to another",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ConvertMoneyResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ConvertMoneyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ConvertMoneyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Currency | Currencies exchange management"
]
}
},
"/Env/get_custom_tax_option" : {
"post" : {
"operationId" : "Env:get_custom_tax_option",
"summary" : "get_custom_tax_option - This method allows an API user to retrieve information about the custom tax",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomTaxOptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomTaxOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomTaxOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Custom tax management"
]
}
},
"/Service/get_service_list" : {
"post" : {
"operationId" : "Service:get_service_list",
"summary" : "get_service_list - This method allows an API user to get the list of services",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetServiceListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetServiceListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Service | Service management"
]
}
},
"/Rate/search_rate_list" : {
"post" : {
"operationId" : "Rate:search_rate_list",
"summary" : "search_rate_list - This method enables an API user to retrieve the list of rates selected by specific criteria",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/SearchRateListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SearchRateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/SearchRateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Rate management"
]
}
},
"/Node/add_node" : {
"post" : {
"operationId" : "Node:add_node",
"summary" : "add_node - This method enables an API user to add a node",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddNodeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddNodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddNodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Node | Node management"
]
}
},
"/Account/charge_subscription_fees" : {
"post" : {
"operationId" : "Account:charge_subscription_fees",
"summary" : "charge_subscription_fees - This method allows an administrator to immediately charge all of an account's subscriptions (otherwise later this will be done automatically)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ChargeAccountSubscriptionFeesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ChargeAccountSubscriptionFeesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ChargeAccountSubscriptionFeesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Subscription management"
]
}
},
"/TaxationPlugin/get_tax_plugins_list" : {
"post" : {
"operationId" : "TaxationPlugin:get_tax_plugins_list",
"summary" : "get_tax_plugins_list - This method allows an API user to get the list of all configured taxation plugins",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTaxPluginsListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTaxPluginsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTaxPluginsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Taxation plugin management"
]
}
},
"/AccessPolicy/get_access_policy_info" : {
"post" : {
"operationId" : "AccessPolicy:get_access_policy_info",
"summary" : "get_access_policy_info - This method enables an API user to get information about access policy",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccessPolicyInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessPolicyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessPolicyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessPolicy | Access policy management"
]
}
},
"/Rate/add_rate" : {
"post" : {
"operationId" : "Rate:add_rate",
"summary" : "add_rate - This method allows an API user (administrator or reseller) to add a new rate for a destination",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddRateResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRateRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Rate management"
]
}
},
"/CodecConverter/add_file" : {
"post" : {
"operationId" : "CodecConverter:add_file",
"summary" : "add_file - This method enables an API user to upload a file",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCodecConverterFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/AddCodecConverterFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CodecConverter | Codec converter file management"
]
}
},
"/NumberPorting/add_netnumber_info" : {
"post" : {
"operationId" : "NumberPorting:add_netnumber_info",
"summary" : "add_netnumber_info - This method enables an API user to save information about created and terminated accounts into the storage in the NetNumber format",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddNetnumberInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddNetnumberInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddNetnumberInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"NumberPorting | Number porting management"
]
}
},
"/Account/get_allowed_addons" : {
"post" : {
"operationId" : "Account:get_allowed_addons",
"summary" : "get_allowed_addons - This method enables an API user to get a list of allowable add-on products for an account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountGetAllowedAddonsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetAllowedAddonsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetAllowedAddonsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/AccessPolicy/get_access_policy_list" : {
"post" : {
"operationId" : "AccessPolicy:get_access_policy_list",
"summary" : "get_access_policy_list - This method enables an API user to get the list of access policy records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccessPolicyListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessPolicyListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessPolicyListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"AccessPolicy | Access policy management"
]
}
},
"/DiscountPlan/add_topup_option" : {
"post" : {
"operationId" : "DiscountPlan:add_topup_option",
"summary" : "add_topup_option - This method enables an API user to add a topup option. Make sure the topup_amount attribute is specified.",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddVDTopupOptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVDTopupOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVDTopupOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Topup option management"
]
}
},
"/Invoice/get_status_info" : {
"post" : {
"operationId" : "Invoice:get_status_info",
"summary" : "get_status_info - This method enables getting the information about the status of an invoice",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetInvoiceStatusInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetInvoiceStatusInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetInvoiceStatusInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/CustomFields/get_custom_field_list" : {
"post" : {
"operationId" : "CustomFields:get_custom_field_list",
"summary" : "get_custom_field_list - This method enables an API user to get the list of custom fields with information about their types and possible values",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomFieldListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomFieldListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomFieldListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomFields | Custom field management"
]
}
},
"/Notification/get_notification_preset_list" : {
"post" : {
"operationId" : "Notification:get_notification_preset_list",
"summary" : "get_notification_preset_list - This method enables an API user to get the list of notification presets",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNotificationPresetListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNotificationPresetListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNotificationPresetListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Notification | Notification management"
]
}
},
"/Destination/get_cset_group_list" : {
"post" : {
"operationId" : "Destination:get_cset_group_list",
"summary" : "get_cset_group_list - This method enables an API user to get the list of complete destination group sets",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationGetCSetGroupListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationGetCSetGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationGetCSetGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/Brandpane/get_brandpane_archive" : {
"post" : {
"operationId" : "Brandpane:get_brandpane_archive",
"summary" : "get_brandpane_archive - This method enables an API user to get the brandpane template and css files. The brandpane-related files are returned in a MIME attachment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetBrandpaneArchiveResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetBrandpaneArchiveRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetBrandpaneArchiveRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Brandpane | Brandpane management"
]
}
},
"/Customer/get_payment_method_info" : {
"post" : {
"operationId" : "Customer:get_payment_method_info",
"summary" : "get_payment_method_info - This method allows an API user to retrieve information about the payment method (e.g. payment card info) assigned to a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerPaymentMethodInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerPaymentMethodInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerPaymentMethodInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Payments, taxation and invoice management"
]
}
},
"/RoutingPlan/get_routing_plan_info" : {
"post" : {
"operationId" : "RoutingPlan:get_routing_plan_info",
"summary" : "get_routing_plan_info - This method allows an API user to get a routing plan record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRoutingPlanInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoutingPlanInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoutingPlanInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingPlan | Routing plan management"
]
}
},
"/Customer/get_custom_fields_values" : {
"post" : {
"operationId" : "Customer:get_custom_fields_values",
"summary" : "get_custom_fields_values - This method allows an API user to get the list of customer's custom fields",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerCustomFieldsValuesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerCustomFieldsValuesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerCustomFieldsValuesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Custom field management"
]
}
},
"/CallBarring/get_default_cb_option_info" : {
"post" : {
"operationId" : "CallBarring:get_default_cb_option_info",
"summary" : "get_default_cb_option_info - This method enables an API user to get a default call barring option record from the DB",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDefaultCallBarringOptionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddGetDefaultCallBarringOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddGetDefaultCallBarringOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CallBarring | Call barring options management"
]
}
},
"/Tariff/test_tariff_rating" : {
"post" : {
"operationId" : "Tariff:test_tariff_rating",
"summary" : "test_tariff_rating - This method enables an API user to test the rating formula of the tariff",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestTariffRatingResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TestTariffRatingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TestTariffRatingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Tariff management"
]
}
},
"/Destination/delete_dest_group" : {
"post" : {
"operationId" : "Destination:delete_dest_group",
"summary" : "delete_dest_group - This method allows an API user to delete a destination group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteDestGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group management"
]
}
},
"/Customer/validate_customer_info" : {
"post" : {
"operationId" : "Customer:validate_customer_info",
"summary" : "validate_customer_info - This method allows an API user to check if the supplied data can be used to create a new customer record or update an existing one",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ValidateCustomerInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ValidateCustomerInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ValidateCustomerInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/TaxationPlugin/get_suretax_exemption_code_list" : {
"post" : {
"operationId" : "TaxationPlugin:get_suretax_exemption_code_list",
"summary" : "get_suretax_exemption_code_list - This method allows an API user to get the list of SureTax exemption codes",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSuretaxExemptionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSuretaxExemptionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSuretaxExemptionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Taxation plugin management"
]
}
},
"/TaxationPlugin/update_tax_transaction_code" : {
"post" : {
"operationId" : "TaxationPlugin:update_tax_transaction_code",
"summary" : "update_tax_transaction_code - This method allows an API user to update a taxation code",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTaxTransactionCodeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTaxTransactionCodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTaxTransactionCodeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Code management"
]
}
},
"/RoamingProfile/clone_roaming_profile" : {
"post" : {
"operationId" : "RoamingProfile:clone_roaming_profile",
"summary" : "clone_roaming_profile - This method enables an API user to clone a roaming profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CloneRoamingProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneRoamingProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CloneRoamingProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoamingProfile | Roaming profile management"
]
}
},
"/Account/update_booth" : {
"post" : {
"operationId" : "Account:update_booth",
"summary" : "update_booth - This method enables an API user to update a booth's state",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountUpdateBoothResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountUpdateBoothRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountUpdateBoothRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/Report/get_cost_revenue_file" : {
"post" : {
"operationId" : "Report:get_cost_revenue_file",
"summary" : "get_cost_revenue_file - This method enables an API user to download the Cost/Revenue report file",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCostRevenueFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCostRevenueFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCostRevenueFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Report | Cost/Revenue report management"
]
}
},
"/Customer/get_my_info" : {
"post" : {
"operationId" : "Customer:get_my_info",
"summary" : "get_my_info - This method allows a reseller to get information about his own customer info record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMyInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/Account/get_phonebook_list" : {
"post" : {
"operationId" : "Account:get_phonebook_list",
"summary" : "get_phonebook_list - This method allows an API user to obtain the list of the account's Phonebook records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetPhoneBookListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPhoneBookListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetPhoneBookListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Phonebook management"
]
}
},
"/TrafficProfile/add_traffic_profile" : {
"post" : {
"operationId" : "TrafficProfile:add_traffic_profile",
"summary" : "add_traffic_profile - This method enables an API user to create a traffic profile",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddTrafficProfileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddTrafficProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddTrafficProfileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TrafficProfile | Profile management"
]
}
},
"/Customer/get_customer_xdrs" : {
"post" : {
"operationId" : "Customer:get_customer_xdrs",
"summary" : "get_customer_xdrs - The cdr_entity attribute allows the use of this method in three modes. In the customer mode, this method only returns CDRs that directly belong to a given customer. In the account mode, this method only returns CDRs that belong to the accounts under a given customer. Supply this attribute with empty value to retrieve CDRs that belong to a given customer and his accounts",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRetailCustomerXDRListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRetailCustomerXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRetailCustomerXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/Customer/get_payment_transaction_list" : {
"post" : {
"operationId" : "Customer:get_payment_transaction_list",
"summary" : "get_payment_transaction_list - This method allows an API user to get a list of customer's payment transactions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerPaymentTransactionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerPaymentTransactionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerPaymentTransactionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Payments, taxation and invoice management"
]
}
},
"/CommissionPlan/get_commission_plan_base_list" : {
"post" : {
"operationId" : "CommissionPlan:get_commission_plan_base_list",
"summary" : "get_commission_plan_base_list - This method enables an API user to get the list of the commission plan base records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCommissionPlanBaseListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommissionPlanBaseListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCommissionPlanBaseListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CommissionPlan | Commission plan management"
]
}
},
"/Representative/add_representative_advanced" : {
"post" : {
"operationId" : "Representative:add_representative_advanced",
"summary" : "add_representative_advanced - This method allows an API user to add representatives to the system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRepresentativeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRepresentativeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddRepresentativeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Representative | Representative management"
]
}
},
"/Destination/get_dest_group_set_list" : {
"post" : {
"operationId" : "Destination:get_dest_group_set_list",
"summary" : "get_dest_group_set_list - This method allows an API user to get a list of destination group sets",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDestGroupSetListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestGroupSetListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestGroupSetListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group set management"
]
}
},
"/Customer/get_vd_counter_history_list" : {
"post" : {
"operationId" : "Customer:get_vd_counter_history_list",
"summary" : "get_vd_counter_history_list - The method enables an API user to retrieve a list of the counter updates",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerVdCounterHistoryListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerVdCounterHistoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerVdCounterHistoryListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/Subscription/update_subscription" : {
"post" : {
"operationId" : "Subscription:update_subscription",
"summary" : "update_subscription - This method enables an API user to update a subscription",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Subscription | Subscription management"
]
}
},
"/Representative/update_representative" : {
"post" : {
"operationId" : "Representative:update_representative",
"summary" : "update_representative - This method allows an API user to update representatives in the system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateRepresentativeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRepresentativeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRepresentativeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Representative | Representative management"
]
}
},
"/Vendor/get_connection_destination_group_list" : {
"post" : {
"operationId" : "Vendor:get_connection_destination_group_list",
"summary" : "get_connection_destination_group_list - This method enables an API user to get the list of connection destination groups",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetConnectionDestinationGroupListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConnectionDestinationGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetConnectionDestinationGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Connection management"
]
}
},
"/Env/update_custom_tax_option" : {
"post" : {
"operationId" : "Env:update_custom_tax_option",
"summary" : "update_custom_tax_option - This method allows an API user to update the existing custom tax",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomTaxOptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomTaxOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomTaxOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Custom tax management"
]
}
},
"/Customer/get_dial_rule_samples" : {
"post" : {
"operationId" : "Customer:get_dial_rule_samples",
"summary" : "get_dial_rule_samples - This method allows a retail customer to get the sample dialing rules",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDialRuleSamplesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDialRuleSamplesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDialRuleSamplesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/DiscountPlan/add_vd_threshold" : {
"post" : {
"operationId" : "DiscountPlan:add_vd_threshold",
"summary" : "add_vd_threshold - This method allows an API user to add a threshold to a discount record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddVDThresholdResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVDThresholdRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVDThresholdRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Threshold management"
]
}
},
"/DiscountPlan/update_vd_threshold" : {
"post" : {
"operationId" : "DiscountPlan:update_vd_threshold",
"summary" : "update_vd_threshold - This method allows an API user to update a threshold in a discount record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateVDThresholdResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVDThresholdRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateVDThresholdRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Threshold management"
]
}
},
"/Account/add_auto_payment" : {
"post" : {
"operationId" : "Account:add_auto_payment",
"summary" : "add_auto_payment - This method enables an API user to set up automated periodic payments",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateAutoPaymentInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Auto-payment management"
]
}
},
"/Subscription/estimate_subscription_price_for_first_billing_period" : {
"post" : {
"operationId" : "Subscription:estimate_subscription_price_for_first_billing_period",
"summary" : "estimate_subscription_price_for_first_billing_period - The method enables an API user to estimate the cost of the subscription in the first billing period",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EstimateSubscriptionPriceForFirstBillingPeriodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EstimateSubscriptionPriceForFirstBillingPeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EstimateSubscriptionPriceForFirstBillingPeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Subscription | Subscription management"
]
}
},
"/Account/find_recipient" : {
"post" : {
"operationId" : "Account:find_recipient",
"summary" : "find_recipient - This method enables an API user to find the recipient for a transfer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountFindRecipientResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountFindRecipientRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountFindRecipientRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/DiscountPlan/get_discount_plan_info" : {
"post" : {
"operationId" : "DiscountPlan:get_discount_plan_info",
"summary" : "get_discount_plan_info - This method allows an API user to get detailed information about a volume discount plan by using its ID",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDiscountPlanInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDiscountPlanInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDiscountPlanInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount plan management"
]
}
},
"/Customer/get_custom_xdr_report_types" : {
"post" : {
"operationId" : "Customer:get_custom_xdr_report_types",
"summary" : "get_custom_xdr_report_types - This method allows to obtain a list of available custom xDR report types",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomXdrReportTypesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomXdrReportTypesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomXdrReportTypesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/Invoice/get_invoice_list" : {
"post" : {
"operationId" : "Invoice:get_invoice_list",
"summary" : "get_invoice_list - This method allows an API user to get the list of invoice records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetInvoiceListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetInvoiceListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetInvoiceListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Customer/get_customer_invoices" : {
"post" : {
"operationId" : "Customer:get_customer_invoices",
"summary" : "get_customer_invoices - This method allows a customer to get the list of customer's invoices",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerInvoicesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerInvoicesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerInvoicesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Payments, taxation and invoice management"
]
}
},
"/Rate/get_rate_list" : {
"post" : {
"operationId" : "Rate:get_rate_list",
"summary" : "get_rate_list - This method allows an API user to retrieve the list of rates",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRateListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Rate | Rate management"
]
}
},
"/Representative/get_representative_info" : {
"post" : {
"operationId" : "Representative:get_representative_info",
"summary" : "get_representative_info - This method allows an API user (administrator or reseller) to get a representative record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRepresentativeInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRepresentativeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRepresentativeInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Representative | Representative management"
]
}
},
"/UA/get_ua_type_list" : {
"post" : {
"operationId" : "UA:get_ua_type_list",
"summary" : "get_ua_type_list - This method enables an API user (administrator or reseller) to get the list of UA device (IP phone) types",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUATypeListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUATypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUATypeListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | UA device type management"
]
}
},
"/Destination/upload_dest_group_set" : {
"post" : {
"operationId" : "Destination:upload_dest_group_set",
"summary" : "upload_dest_group_set - This method allows an API user to upload a destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UploadDGSetResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"upload_file" : {
"format" : "binary",
"type" : "string"
},
"params" : {
"$ref" : "#/components/schemas/UploadDGSetRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group set management"
]
}
},
"/Tariff/update_tariff" : {
"post" : {
"operationId" : "Tariff:update_tariff",
"summary" : "update_tariff - This method allows an API user to update an existing tariff",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateTariffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateTariffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Tariff management"
]
}
},
"/Account/add_followme_number" : {
"post" : {
"operationId" : "Account:add_followme_number",
"summary" : "add_followme_number - This method allows an API user to add a new follow-me entry (number) associated with an account. If successful, a new ID number is returned. Note: the newly added number becomes the last entry in the list of the account’s follow-me numbers",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateFollowMeNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddFollowMeNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddFollowMeNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Follow-me settings management"
]
}
},
"/Session/reset_password" : {
"post" : {
"operationId" : "Session:reset_password",
"summary" : "reset_password - This method enables an API user to reset the password (when the user forgets it, for example) and create a new one",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ResetPasswordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ResetPasswordRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ResetPasswordRequest"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Session | Authenticated session management"
]
}
},
"/RoutingCriteria/get_routing_criteria_dest_group_info" : {
"post" : {
"operationId" : "RoutingCriteria:get_routing_criteria_dest_group_info",
"summary" : "get_routing_criteria_dest_group_info - This method enables an API user to get information about a destination group for a routing criteria record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetRoutingCriteriaDestGroupInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoutingCriteriaDestGroupInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetRoutingCriteriaDestGroupInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingCriteria | Destination group management"
]
}
},
"/IVRApplications/update_ivr_application" : {
"post" : {
"operationId" : "IVRApplications:update_ivr_application",
"summary" : "update_ivr_application - This method enables an API user to update the IVR application",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateIvrApplicationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateIvrApplicationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateIvrApplicationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Application management"
]
}
},
"/Invoice/regenerate_invoice_list" : {
"post" : {
"operationId" : "Invoice:regenerate_invoice_list",
"summary" : "regenerate_invoice_list - This method enables an API user to regenerate a list of invoice PDF files",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/RegenerateInvoicePDFListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RegenerateInvoicePDFListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/RegenerateInvoicePDFListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/DID_Provider/get_numbers_list" : {
"post" : {
"operationId" : "DID_Provider:get_numbers_list",
"summary" : "get_numbers_list - This method allows an API user to retrieve the list of DID numbers for a specified country and area available for allocating from the DID provider. Note that not all DID providers may provide the list of numbers, so you may find out whether the DID provider supports this from the is_numbers_list_available field of the get_provider_info method. If DID provider ident is passed for the customer, either i_customer or customer_batch must be specified; if it is passed for the sub-customer, either i_customer or both customer_batch and reseller_batch must be specified",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDIDNumbersListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDNumbersListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDIDNumbersListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID_Provider | DID auto-provisioning management"
]
}
},
"/MeasuredServices/update_measured_metric" : {
"post" : {
"operationId" : "MeasuredServices:update_measured_metric",
"summary" : "update_measured_metric - This method enables an API user to update a measured metric",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateMeasuredMetricResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateMeasuredMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateMeasuredMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Measured metric management"
]
}
},
"/IVRApplications/get_access_number_list" : {
"post" : {
"operationId" : "IVRApplications:get_access_number_list",
"summary" : "get_access_number_list - This method enables an API user to get the list of IVR access numbers",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccessNumberListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccessNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"IVRApplications | Access number management"
]
}
},
"/BundlePromotion/get_criteria_list" : {
"post" : {
"operationId" : "BundlePromotion:get_criteria_list",
"summary" : "get_criteria_list - This method allows an API user to get the list of the bundle promotion criteria",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCriteriaListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCriteriaListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCriteriaListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BundlePromotion | Criterium management"
]
}
},
"/VoiceQualityProfile/get_profile_info" : {
"post" : {
"operationId" : "VoiceQualityProfile:get_profile_info",
"summary" : "get_profile_info - This method enables an API user to get the voice quality profile information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVoiceQualityProfileInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVoiceQualityProfileInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVoiceQualityProfileInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"VoiceQualityProfile | Voice quality profile management"
]
}
},
"/Destination/get_dest_group_list" : {
"post" : {
"operationId" : "Destination:get_dest_group_list",
"summary" : "get_dest_group_list - This method allows an API user to get a list of destination groups",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDestGroupListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDestGroupListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination group management"
]
}
},
"/UA/get_ua_inventory_usage_statistics" : {
"post" : {
"operationId" : "UA:get_ua_inventory_usage_statistics",
"summary" : "get_ua_inventory_usage_statistics - This method enables an API user to get the UA device (IP phone) usage statistics summary",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUAInventoryUsageStatisticsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUAInventoryUsageStatisticsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUAInventoryUsageStatisticsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"UA | Inventory management"
]
}
},
"/CustomerClass/update_notification_list" : {
"post" : {
"operationId" : "CustomerClass:update_notification_list",
"summary" : "update_notification_list - This method enables an API user to update the list of notifications of the customer class",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomerClassNotificationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerClassNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerClassNotificationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Notification template management"
]
}
},
"/Customer/add_migration" : {
"post" : {
"operationId" : "Customer:add_migration",
"summary" : "add_migration - This method enables an API user to add a customer migration",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddCustomerMigrationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCustomerMigrationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddCustomerMigrationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/SIMCard/update_sim_card_list" : {
"post" : {
"operationId" : "SIMCard:update_sim_card_list",
"summary" : "update_sim_card_list - This method enables an API user to update a list of sim card records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateSIMCardListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateSIMCardListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateSIMCardListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"SIMCard | SIM card management"
]
}
},
"/CCStaff/update_cc_staff" : {
"post" : {
"operationId" : "CCStaff:update_cc_staff",
"summary" : "update_cc_staff - This method enables an API user to update a CC staff record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCCStaffResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCCStaffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCCStaffRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CCStaff | CC staff management"
]
}
},
"/Customer/get_rt_tickets_list" : {
"post" : {
"operationId" : "Customer:get_rt_tickets_list",
"summary" : "get_rt_tickets_list - This method allows to obtain tickets for a customer from the RT server",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomRTTicketsListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomRTTicketsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomRTTicketsListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/BillingSession/add_disconnect_queue_record" : {
"post" : {
"operationId" : "BillingSession:add_disconnect_queue_record",
"summary" : "add_disconnect_queue_record - This method allows an administrator to disconnect an Internet session (by adding a record to the disconnect queue)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddDisconnectQueueRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDisconnectQueueRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDisconnectQueueRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BillingSession | Internet session management"
]
}
},
"/Customer/get_customer_list" : {
"post" : {
"operationId" : "Customer:get_customer_list",
"summary" : "get_customer_list - This method allows an API user to get a list of customer records. The customer must be viewable (or owned) by the user making the request",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/Product/add_service_and_rating" : {
"post" : {
"operationId" : "Product:add_service_and_rating",
"summary" : "add_service_and_rating - This method allows an API user to add a rating entry into a product to define where users of this product can use the service, and how they will be charged for it",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddServiceAndRatingResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddServiceAndRatingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddServiceAndRatingRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Service and rating management"
]
}
},
"/Invoice/void_invoice" : {
"post" : {
"operationId" : "Invoice:void_invoice",
"summary" : "void_invoice - This method allows an API user to void an invoice. It sometimes happens that an error is detected after an invoice has been generated and delivered to the customer. A new invoice must be produced, but the old one must be kept for audit purposes. The void invoice operation marks the invoice as canceled (this will also be visible in the PDF file), and then a new invoice is automatically produced",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VoidInvoiceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/VoidInvoiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/VoidInvoiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Account/get_transactions_total_info" : {
"post" : {
"operationId" : "Account:get_transactions_total_info",
"summary" : "get_transactions_total_info - This method allows an API user to get the list of account's transactions",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountTransactionsTotalInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountTransactionsTotalInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountTransactionsTotalInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Transaction management"
]
}
},
"/Commitment/delete_commitment" : {
"post" : {
"operationId" : "Commitment:delete_commitment",
"summary" : "delete_commitment - The method enables an API user to delete a commitment record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCommitmentResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCommitmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCommitmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/Account/vd_topup" : {
"post" : {
"operationId" : "Account:vd_topup",
"summary" : "vd_topup - This method allows an administrator to top-up the volume of a service (e.g. free minutes or gigabytes) provided to an end-user (account) with the discount",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VDTopupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountVDTopupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountVDTopupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Volume discount management"
]
}
},
"/BundlePromotion/add_bundle_promotion" : {
"post" : {
"operationId" : "BundlePromotion:add_bundle_promotion",
"summary" : "add_bundle_promotion - This method allows an API user to add a new bundle promotion",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateBundlePromotionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddBundlePromotionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddBundlePromotionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BundlePromotion | Bundle promotion management"
]
}
},
"/Account/get_vd_counter_info" : {
"post" : {
"operationId" : "Account:get_vd_counter_info",
"summary" : "get_vd_counter_info - This method enables an API user to retrieve the information about an account-level counter",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountVdCounterInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountVdCounterInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountVdCounterInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Volume discount management"
]
}
},
"/ContentBasedCharging/delete_marketing_group" : {
"post" : {
"operationId" : "ContentBasedCharging:delete_marketing_group",
"summary" : "delete_marketing_group - This method enables an API user to delete a marketing group record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteMarketingGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteMarketingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteMarketingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ContentBasedCharging | Marketing group management"
]
}
},
"/Customer/get_account_aliases_list" : {
"post" : {
"operationId" : "Customer:get_account_aliases_list",
"summary" : "get_account_aliases_list - This method allows a retail customer to get the list of his account aliases",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAllAccAliasesListInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAllAccAliasesListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAllAccAliasesListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Information and statistics management"
]
}
},
"/Customer/delete_customer_site" : {
"post" : {
"operationId" : "Customer:delete_customer_site",
"summary" : "delete_customer_site - This method allows an API user to delete a cutomer site",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerSiteResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerSiteRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerSiteRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Site management"
]
}
},
"/BundlePromotion/get_criterion" : {
"post" : {
"operationId" : "BundlePromotion:get_criterion",
"summary" : "get_criterion - This method allows an API user to get the information about the bundle promotion criterion",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCriterionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCriterionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCriterionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BundlePromotion | Criterium management"
]
}
},
"/DID/assign_did_to_customer" : {
"post" : {
"operationId" : "DID:assign_did_to_customer",
"summary" : "assign_did_to_customer - This method allows an API user to assign a DID number to a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AssignDIDToCustomerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignDIDToCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AssignDIDToCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/Vendor/get_vendor_info" : {
"post" : {
"operationId" : "Vendor:get_vendor_info",
"summary" : "get_vendor_info - This method allows an API user to get a vendor record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVendorInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVendorInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor management"
]
}
},
"/Generic/get_session_data" : {
"post" : {
"operationId" : "Generic:get_session_data",
"summary" : "get_session_data - This method enables an API user to get session information",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GenericGetSessionDataResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetCommonInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GenericGetCommonInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Internal"
]
}
},
"/Customer/get_full_vd_counter_info" : {
"post" : {
"operationId" : "Customer:get_full_vd_counter_info",
"summary" : "get_full_vd_counter_info - This method allows an API user to get full information about volume discount counters (e.g. used discount amount, remaining discount amount, current and next discount values) for the specified customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetFullVDCounterListInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerFullVDCounterListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerFullVDCounterListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Volume discount management"
]
}
},
"/BrandPane/get_brand_pane_zip" : {
"post" : {
"operationId" : "BrandPane:get_brand_pane_zip",
"summary" : "get_brand_pane_zip - This method allows an API user to get the brandpane template and css files. The brandpane-related files are returned in a MIME attachment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetBrandPaneResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetBrandPaneRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetBrandPaneRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"BrandPane | Brand pane management"
]
}
},
"/ContentBasedCharging/delete_rating_group" : {
"post" : {
"operationId" : "ContentBasedCharging:delete_rating_group",
"summary" : "delete_rating_group - This method enables an API user to delete a rating group record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteRatingGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRatingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteRatingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ContentBasedCharging | Rating group management"
]
}
},
"/Account/get_service_wallet_xdr_list" : {
"post" : {
"operationId" : "Account:get_service_wallet_xdr_list",
"summary" : "get_service_wallet_xdr_list - This method enables the user to fetch the Account Service Wallet XDRs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountSWXDRListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountSWXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountSWXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/Customer/get_abbreviated_dialing_number_list" : {
"post" : {
"operationId" : "Customer:get_abbreviated_dialing_number_list",
"summary" : "get_abbreviated_dialing_number_list - This method allows an API user to retrieve an abbreviated number list for a customer",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCustomerAbbreviatedDialingNumberListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerAbbreviatedDialingNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCustomerAbbreviatedDialingNumberListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Abbreviated dialing number management"
]
}
},
"/VoiceQualityProfile/get_profile_list" : {
"post" : {
"operationId" : "VoiceQualityProfile:get_profile_list",
"summary" : "get_profile_list - This method enables an API user to get the list of voice quality profiles",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetVoiceQualityProfileListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVoiceQualityProfileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetVoiceQualityProfileListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"VoiceQualityProfile | Voice quality profile management"
]
}
},
"/TimePeriod/test_time_period" : {
"post" : {
"operationId" : "TimePeriod:test_time_period",
"summary" : "test_time_period - This method enables an API user to test the time period",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/TestTimePeriodResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TestTimePeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/TestTimePeriodRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TimePeriod | Time period management"
]
}
},
"/Subscription/get_subscription_info" : {
"post" : {
"operationId" : "Subscription:get_subscription_info",
"summary" : "get_subscription_info - This method allows an API user (administrator or reseller) to get information about a subscription",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSubscriptionInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSubscriptionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSubscriptionInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Subscription | Subscription management"
]
}
},
"/Invoice/apply_invoice_adjustment" : {
"post" : {
"operationId" : "Invoice:apply_invoice_adjustment",
"summary" : "apply_invoice_adjustment - This method allows an API user to waive an amount from a customer invoice. The amount is deducted from the customer outstanding balance, so that he/she should pay only the reduced amount to cover the adjusted invoice in full. Used if a service provider needs to adjust old invoices issued for their customers (for example, if a customer has disputed his invoice and the service provider agreed to waive a disputable amount)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ApplyInvoiceAdjustmentResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ApplyInvoiceAdjustmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ApplyInvoiceAdjustmentRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/MeasuredServices/delete_customer_metric" : {
"post" : {
"operationId" : "MeasuredServices:delete_customer_metric",
"summary" : "delete_customer_metric - This method allows an API user to delete a customer's measured service",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomerMetricResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomerMetricRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"MeasuredServices | Customer metric management"
]
}
},
"/Account/get_call_barring_options" : {
"post" : {
"operationId" : "Account:get_call_barring_options",
"summary" : "get_call_barring_options - This method allows an API user to retrieve all available options for account call barring and check their status",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCallBarringOptionsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCallBarringOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCallBarringOptionsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Call barring rules management"
]
}
},
"/Product/add_product_detailed" : {
"post" : {
"operationId" : "Product:add_product_detailed",
"summary" : "add_product_detailed - This method enables an API user to add a product with additional properties specified",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductAddProductDetailedResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductAddProductDetailedRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductAddProductDetailedRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Internal"
]
}
},
"/ContentBasedCharging/update_rating_group" : {
"post" : {
"operationId" : "ContentBasedCharging:update_rating_group",
"summary" : "update_rating_group - This method enables an API user to update the information about a rating group",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateRatingGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRatingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRatingGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ContentBasedCharging | Rating group management"
]
}
},
"/DID/release_number" : {
"post" : {
"operationId" : "DID:release_number",
"summary" : "release_number - This method allows an API user to release a previously reserved DID number",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReleaseDIDNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReleaseDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/Vendor/add_vendor_account" : {
"post" : {
"operationId" : "Vendor:add_vendor_account",
"summary" : "add_vendor_account - A vendor account can be used for digest authentication to secure the connection so that no one else can send traffic to the vendor, as this would then be billed to your account. Using this API method you can enter information about such accounts, so that they can be provided automatically by PortaBilling to the SIP server",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddVendorAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVendorAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddVendorAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor account management"
]
}
},
"/Account/get_booths" : {
"post" : {
"operationId" : "Account:get_booths",
"summary" : "get_booths - This method enables an API user to get booths' states",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountGetBoothsResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetBoothsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetBoothsRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/RoutingCriteria/update_routing_criteria_dest_group" : {
"post" : {
"operationId" : "RoutingCriteria:update_routing_criteria_dest_group",
"summary" : "update_routing_criteria_dest_group - This method enables an API user to update a routing criteria destination group record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateRoutingCriteriaDestGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRoutingCriteriaDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateRoutingCriteriaDestGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"RoutingCriteria | Destination group management"
]
}
},
"/Destination/add_destination" : {
"post" : {
"operationId" : "Destination:add_destination",
"summary" : "add_destination - This method allows an API user to add a destination",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddDestinationPrefixResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDestinationPrefixRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddDestinationPrefixRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Destination management"
]
}
},
"/TaxationPlugin/get_tax_plugin" : {
"post" : {
"operationId" : "TaxationPlugin:get_tax_plugin",
"summary" : "get_tax_plugin - This method allows an API user to obtain the taxation plugin record from the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetTaxPluginResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTaxPluginRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetTaxPluginRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"TaxationPlugin | Taxation plugin management"
]
}
},
"/Tariff/get_resale_map_record" : {
"post" : {
"operationId" : "Tariff:get_resale_map_record",
"summary" : "get_resale_map_record - This method allows an API user (reseller) to retrieve mapping between a reseller's wholesale and resale tariffs",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetResaleMapRecordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetResaleMapRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetResaleMapRecordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Tariff | Reseller tariff management"
]
}
},
"/Account/change_password" : {
"post" : {
"operationId" : "Account:change_password",
"summary" : "change_password - This method enables an API user to change their password. The old_password is mandatory only when the method is executed under the account realm",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ChangePasswordResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ChangeAccountPasswordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ChangeAccountPasswordRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account management"
]
}
},
"/Report/get_asr_file" : {
"post" : {
"operationId" : "Report:get_asr_file",
"summary" : "get_asr_file - This method enables an API user to download the ASR file",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetASRFileResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetASRFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetASRFileRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Report | ASR report management"
]
}
},
"/Customer/unsuspend_customer" : {
"post" : {
"operationId" : "Customer:unsuspend_customer",
"summary" : "unsuspend_customer - This method allows to unsuspend all services to a retail customer, reseller or distributor",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UnsuspendCustomerResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UnsuspendCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UnsuspendCustomerRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Customer management"
]
}
},
"/XDRMediator/get_xdr_info" : {
"post" : {
"operationId" : "XDRMediator:get_xdr_info",
"summary" : "get_xdr_info - This method enables an API user to get the information about the xDR in the collection",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMediatorXDRInfoDetailedResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMediatorXDRInfoDetailedRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMediatorXDRInfoDetailedRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"XDRMediator | XDR Mediator management"
]
}
},
"/DialingRule/add_dialing_rule" : {
"post" : {
"operationId" : "DialingRule:add_dialing_rule",
"summary" : "add_dialing_rule - This method allows an API user to add a dialing rule",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateDialingRuleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateDialingRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateDialingRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DialingRule | Dialing rule management"
]
}
},
"/Destination/get_cset_groups_tree" : {
"post" : {
"operationId" : "Destination:get_cset_groups_tree",
"summary" : "get_cset_groups_tree - This method enables an API user to get the tree of groups of the complete destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationGetCSetGroupTreeResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationGetCSetGroupTreeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationGetCSetGroupTreeRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/DID/get_owner_batch_list" : {
"post" : {
"operationId" : "DID:get_owner_batch_list",
"summary" : "get_owner_batch_list - This method allows an API user (administrator or reseller) to get the list of DID pricing batches filtered by various parameters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetOwnerBatchListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOwnerBatchListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetOwnerBatchListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | Pricing batch management"
]
}
},
"/Invoice/review_invoice" : {
"post" : {
"operationId" : "Invoice:review_invoice",
"summary" : "review_invoice - This method allows an API user to either approve or regenerate under review invoices",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReviewInvoiceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReviewInvoiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReviewInvoiceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Invoice | Invoice management"
]
}
},
"/Customer/update_custom_fields_values" : {
"post" : {
"operationId" : "Customer:update_custom_fields_values",
"summary" : "update_custom_fields_values - This method allows an API user to modify a customer's custom fields",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateCustomerCustomFieldsValuesResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerCustomFieldsValuesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateCustomerCustomFieldsValuesRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Custom field management"
]
}
},
"/NumberPorting/cancel_request" : {
"post" : {
"operationId" : "NumberPorting:cancel_request",
"summary" : "cancel_request - This method allows an API user to cancel the number porting request",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CancelRequestResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CancelRequestRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CancelRequestRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"NumberPorting | Number porting management"
]
}
},
"/NegotiatedFeatures/get_negotiated_feature_list" : {
"post" : {
"operationId" : "NegotiatedFeatures:get_negotiated_feature_list",
"summary" : "get_negotiated_feature_list - This method enables an API user to fetch the list of the negotiated features applied to a routing plan or connection",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetNegotiatedFeatureListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNegotiatedFeatureListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetNegotiatedFeatureListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"NegotiatedFeatures | Negotiated feature management"
]
}
},
"/ContentBasedCharging/get_marketing_group_info" : {
"post" : {
"operationId" : "ContentBasedCharging:get_marketing_group_info",
"summary" : "get_marketing_group_info - This method enables an API user to retrieve the information about a marketing group – a certain type of network traffic (e.g. Messengers, Social Networks, etc.)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetMarketingGroupInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMarketingGroupInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetMarketingGroupInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"ContentBasedCharging | Marketing group management"
]
}
},
"/Currency/get_exchange_rate_list" : {
"post" : {
"operationId" : "Currency:get_exchange_rate_list",
"summary" : "get_exchange_rate_list - This method allows an API user to get a list of all exchange rates used within the system",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetXrateListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetXrateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetXrateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Currency | Currencies exchange management"
]
}
},
"/Calendar/get_date_list" : {
"post" : {
"operationId" : "Calendar:get_date_list",
"summary" : "get_date_list - This method enables an API user to get the list of calendar date records (e.g. the list of non-working days for this year)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDateListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDateListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Calendar | Calendar management"
]
}
},
"/Account/get_xdr_list" : {
"post" : {
"operationId" : "Account:get_xdr_list",
"summary" : "get_xdr_list - This method retrieves Account XDR records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountXDRListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountXDRListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
},
"/Subscription/delete_subscription" : {
"post" : {
"operationId" : "Subscription:delete_subscription",
"summary" : "delete_subscription - This method enables an API user to delete a subscription",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteSubscriptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteSubscriptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Subscription | Subscription management"
]
}
},
"/CustomerClass/add_customer_class" : {
"post" : {
"operationId" : "CustomerClass:add_customer_class",
"summary" : "add_customer_class - This method allows an API user to add a customer class record",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AddUpdateCustomerClassRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CustomerClass | Customer class management"
]
}
},
"/Customer/vd_topup" : {
"post" : {
"operationId" : "Customer:vd_topup",
"summary" : "vd_topup - This method allows an administrator to top-up the volume of a service (e.g. free minutes or gigabytes) provided to a customer with the discount",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/VDTopupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerVDTopupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerVDTopupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Volume discount management"
]
}
},
"/Account/estimate_assigned_commitment_penalty_list" : {
"post" : {
"operationId" : "Account:estimate_assigned_commitment_penalty_list",
"summary" : "estimate_assigned_commitment_penalty_list - The method enables an API user to estimate the penalty for a commitment termination",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/EstimateAssignedCommitmentPenaltyListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EstimateAssignedCommitmentPenaltyListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/EstimateAssignedCommitmentPenaltyListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Commitment management"
]
}
},
"/DID_Provider/obtain_number" : {
"post" : {
"operationId" : "DID_Provider:obtain_number",
"summary" : "obtain_number - This method enables an API user to allocate a DID number from the pool",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ObtainDIDNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ObtainDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ObtainDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID_Provider | DID auto-provisioning management"
]
}
},
"/Account/get_service_feature_metainfo" : {
"post" : {
"operationId" : "Account:get_service_feature_metainfo",
"summary" : "get_service_feature_metainfo - This method enables getting the value of the service feature of the account",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountGetServiceFeatureMetaInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetServiceFeatureMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetServiceFeatureMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/Commitment/delete_commitment_recurring_term" : {
"post" : {
"operationId" : "Commitment:delete_commitment_recurring_term",
"summary" : "delete_commitment_recurring_term - The method enables an API user to delete a recurring term record associated with a commitment",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCommitmentRecurringTermResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCommitmentRecurringTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCommitmentRecurringTermRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Commitment | Commitment management"
]
}
},
"/DiscountPlan/get_discount_plan_list" : {
"post" : {
"operationId" : "DiscountPlan:get_discount_plan_list",
"summary" : "get_discount_plan_list - This method allows an API user to retrieve detailed information about volume discount plans by their name patterns or owner ID",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDiscountPlanListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDiscountPlanListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDiscountPlanListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount plan management"
]
}
},
"/DiscountPlan/update_discount" : {
"post" : {
"operationId" : "DiscountPlan:update_discount",
"summary" : "update_discount - This method allows an API user to update a discount (for a destination group)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateDiscountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDiscountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateDiscountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount management"
]
}
},
"/Env/update_env" : {
"post" : {
"operationId" : "Env:update_env",
"summary" : "update_env - This method allows an API user to update an Environment record in the database",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateEnvInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateEnvInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateEnvInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Environment management"
]
}
},
"/Env/delete_custom_tax_option" : {
"post" : {
"operationId" : "Env:delete_custom_tax_option",
"summary" : "delete_custom_tax_option - This method allows an API user to delete the existing custom tax",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCustomTaxOptionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomTaxOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCustomTaxOptionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Env | Custom tax management"
]
}
},
"/Account/get_traced_xdr_list" : {
"post" : {
"operationId" : "Account:get_traced_xdr_list",
"summary" : "get_traced_xdr_list - This method enables an API user to get the list of traced calls",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/AccountGetTracedXdrListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetTracedXdrListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/AccountGetTracedXdrListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Internal"
]
}
},
"/XDRMediator/get_xdr_collection_list" : {
"post" : {
"operationId" : "XDRMediator:get_xdr_collection_list",
"summary" : "get_xdr_collection_list - This method enables an API user to get the list of xDR collections",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetXDRCollectionListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetXDRCollectionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetXDRCollectionListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"XDRMediator | XDR Mediator management"
]
}
},
"/Currency/delete_currency" : {
"post" : {
"operationId" : "Currency:delete_currency",
"summary" : "delete_currency - This method allows an API user to delete a currency",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteCurrencyResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCurrencyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteCurrencyRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Currency | Currency management"
]
}
},
"/Destination/update_cset_group" : {
"post" : {
"operationId" : "Destination:update_cset_group",
"summary" : "update_cset_group - This method enables an API user to update a group of a complete destination group set",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DestinationUpdateCSetGroupResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationAddUpdateCSetGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DestinationAddUpdateCSetGroupRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Destination | Internal"
]
}
},
"/Customer/update_number_sequence" : {
"post" : {
"operationId" : "Customer:update_number_sequence",
"summary" : "update_number_sequence - This method enables an API user to update the customer invoice number sequence",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CustomerUpdateNumberSequenceResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerUpdateNumberSequenceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/CustomerUpdateNumberSequenceRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Internal"
]
}
},
"/Vendor/make_transaction" : {
"post" : {
"operationId" : "Vendor:make_transaction",
"summary" : "make_transaction - This method allows an administrator to correct a vendor's balance",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MakeVendorTransactionResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeVendorTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MakeVendorTransactionRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Vendor | Vendor management"
]
}
},
"/DID/reserve_number" : {
"post" : {
"operationId" : "DID:reserve_number",
"summary" : "reserve_number - This method allows an API user to reserve a DID number for future use. The reserved field will be filled with the current date and time. Note: before the reservation, this method checks that the number was not already reserved during the specified interval",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ReserveDIDNumberResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReserveDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ReserveDIDNumberRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DID | DID number management"
]
}
},
"/Account/delete_allowed_location" : {
"post" : {
"operationId" : "Account:delete_allowed_location",
"summary" : "delete_allowed_location - This method enables an API user to delete an allowed location",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteAllowedLocationResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAllowedLocationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteAllowedLocationRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Location management"
]
}
},
"/SIMCard/get_card_list" : {
"post" : {
"operationId" : "SIMCard:get_card_list",
"summary" : "get_card_list - This method enables an API user to get the list of sim card records",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetSIMCardListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSIMCardListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetSIMCardListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"SIMCard | SIM card management"
]
}
},
"/CallBarring/get_call_barring_class_list" : {
"post" : {
"operationId" : "CallBarring:get_call_barring_class_list",
"summary" : "get_call_barring_class_list - This method enables an API user to fetch a list of call barring classes",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCallBarringClassListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCallBarringClassListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCallBarringClassListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"CallBarring | Call barring class management"
]
}
},
"/Account/move_account" : {
"post" : {
"operationId" : "Account:move_account",
"summary" : "move_account - This method enables an administrator to \"move\" an account to a different customer. The \"movement\" is performed in two steps: 1) The clone of the account is created for the appropriate customer; 2) The original account is terminated. If an account has any subscriptions (active and / or not yet active), they \"move\" together with it. The subscription usage data are preserved. For instance, the clone of the original account will be charged according to the promotional period that was applied before the transfer (e.g. $5 for the 9th subscription period). All subscriptions (both active and not yet active) of the original account are closed. The end date will be the day before the transfer is performed. No fees are applied to the original account (e.g. a cancellation fee). If the account is \"moved\" when the subscription charges in advance have already been applied, then a refund is issued for the \"unused\" subscription time (e.g. 15 days)",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/MoveAccountResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MoveAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/MoveAccountRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account management"
]
}
},
"/DialingRule/delete_dialing_rule" : {
"post" : {
"operationId" : "DialingRule:delete_dialing_rule",
"summary" : "delete_dialing_rule - This method allows an API user to delete a dialing rule",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/DeleteDialingRuleResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDialingRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/DeleteDialingRuleRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DialingRule | Dialing rule management"
]
}
},
"/Customer/get_callqueue_list" : {
"post" : {
"operationId" : "Customer:get_callqueue_list",
"summary" : "get_callqueue_list - This method allows an API user to get the list of a customer's call queues",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetCQListInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCQListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetCQListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Customer | Call queue management"
]
}
},
"/Product/get_service_features_metainfo" : {
"post" : {
"operationId" : "Product:get_service_features_metainfo",
"summary" : "get_service_features_metainfo - This method enables an API user to get the service features values of the product",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/ProductGetServiceFeaturesMetaInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductGetServiceFeaturesMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/ProductGetServiceFeaturesMetaInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Product | Internal"
]
}
},
"/Account/get_used_location_list" : {
"post" : {
"operationId" : "Account:get_used_location_list",
"summary" : "get_used_location_list - This method enables an API user to get the list of used locations",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetUsedLocationListResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUsedLocationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetUsedLocationListRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Location management"
]
}
},
"/Account/get_account_info" : {
"post" : {
"operationId" : "Account:get_account_info",
"summary" : "get_account_info - This method allows an API user to get an account record from the database. The account must be viewable (owned) by the user making the request",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Account management"
]
}
},
"/Generic/get_global_currency_info" : {
"post" : {
"operationId" : "Generic:get_global_currency_info",
"summary" : "get_global_currency_info - This method allows an API user to get information about a specific global currency",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetGlobalCurrencyInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetGlobalCurrencyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetGlobalCurrencyInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Generic | Currency management"
]
}
},
"/Account/update_accounts_batch" : {
"post" : {
"operationId" : "Account:update_accounts_batch",
"summary" : "update_accounts_batch - This method allows an API user to update accounts of a particular batch",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UpdateAccountsBatchResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountsBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/UpdateAccountsBatchRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Batch management"
]
}
},
"/DiscountPlan/get_discount_info" : {
"post" : {
"operationId" : "DiscountPlan:get_discount_info",
"summary" : "get_discount_info - This method allows an API user to get the information about a discount (for a destination group) in the specified volume discount plan",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetDiscountInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDiscountInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetDiscountInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"DiscountPlan | Discount management"
]
}
},
"/Account/get_moh_list_info" : {
"post" : {
"operationId" : "Account:get_moh_list_info",
"summary" : "get_moh_list_info - This method allows an API user to get the list of account's music on hold entries",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/GetAccountMOHListInfoResponse"
}
}
},
"description" : "Successful response of the API method"
},
"500" : {
"content" : {
"application/json" : {
"schema" : {
"type" : "object",
"properties" : {
"faultcode" : {
"type" : "string",
"description" : "The error code"
},
"faultstring" : {
"type" : "string",
"description" : "Text description of the error"
}
}
}
}
},
"description" : "Failed response of the API method"
}
},
"requestBody" : {
"content" : {
"multipart/form-data" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountMOHListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
},
"application/x-www-form-urlencoded" : {
"schema" : {
"type" : "object",
"properties" : {
"params" : {
"$ref" : "#/components/schemas/GetAccountMOHListInfoRequest"
},
"auth_info" : {
"$ref" : "#/components/schemas/AuthInfoStructure"
}
}
},
"encoding" : {
"params" : {
"contentType" : "application/json"
},
"auth_info" : {
"contentType" : "application/json"
}
}
}
}
},
"tags" : [
"Account | Information and statistics management"
]
}
}
}
}