{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"nichandle.GenderEnum":{"type":"string","description":"All genders a person can choose","enum":["female","male"]},"order.CurrencyCodeEnum":{"type":"string","enum":["AUD","CAD","CZK","EUR","GBP","INR","LTL","MAD","N/A","PLN","SGD","TND","USD","XOF","points"]},"order.Price":{"type":"object","description":"Price with it's currency and textual representation","properties":{"currencyCode":{"$ref":"#/components/schemas/order.CurrencyCodeEnum"},"text":{"type":"string"},"value":{"type":"number"}}},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"telephony.DiagnosticReport":{"type":"object","description":"Relevant informations of the service detected from the MOS or the signal leg in SIP/MGCP protocol.","properties":{"callId":{"type":"string","description":"Identifier of the concerned leg"},"category":{"allOf":[{"$ref":"#/components/schemas/telephony.DiagnosticReportCategoryEnum"}],"description":"Typology where the diagnostic arriving from"},"datetime":{"type":"string","description":"Datetime of the diagnostic","format":"date-time"},"description":{"type":"string","description":"Explanation of the diagnostic"},"level":{"allOf":[{"$ref":"#/components/schemas/telephony.DiagnosticReportLevelEnum"}],"description":"The level of the diagnostic"},"name":{"type":"string","description":"Name of the rule detected"},"report":{"type":"string","description":"Report of the diagnostic"}}},"telephony.DiagnosticReportCategoryEnum":{"type":"string","description":"Source of the diagnostic report","enum":["dpi","signal"]},"telephony.DiagnosticReportIndexEnum":{"type":"string","description":"The index interval","enum":["2 days ago","3 days ago","today","yesterday"]},"telephony.DiagnosticReportLevelEnum":{"type":"string","description":"Level of the diagnostic report","enum":["debug","error","info","warn"]},"telephony.DirectoryHeadingPJ":{"type":"object","description":"Directory Informations","properties":{"apeCode":{"type":"string","readOnly":true},"apeDescription":{"type":"string","readOnly":true},"directoryServiceCode":{"type":"integer","readOnly":true},"directoryServiceDescription":{"type":"string","readOnly":true},"notification":{"type":"string","readOnly":true}}},"telephony.DirectoryInfo":{"type":"object","description":"Directory Informations","properties":{"address":{"type":"string"},"addressExtra":{"type":"string"},"ape":{"type":"string"},"areaCode":{"type":"integer","readOnly":true},"birthDate":{"type":"string","nullable":true,"format":"date"},"cedex":{"type":"string"},"city":{"type":"string"},"country":{"type":"string"},"directoryServiceCode":{"type":"string"},"displayFirstName":{"type":"boolean"},"displayMarketingDirectory":{"type":"boolean"},"displayOnlyCity":{"type":"boolean"},"displaySearchReverse":{"type":"boolean"},"displayUniversalDirectory":{"type":"boolean"},"email":{"type":"string"},"firstName":{"type":"string"},"gender":{"allOf":[{"$ref":"#/components/schemas/nichandle.GenderEnum"}],"nullable":true},"inseeCode":{"type":"integer","readOnly":true},"legalForm":{"type":"string"},"lineDescription":{"type":"string"},"modificationDate":{"type":"string","readOnly":true},"modificationType":{"type":"string","readOnly":true},"name":{"type":"string"},"number":{"type":"string","readOnly":true},"occupation":{"type":"string"},"postBox":{"type":"string"},"postCode":{"type":"string"},"siret":{"type":"string"},"socialNomination":{"type":"string"},"socialNominationExtra":{"type":"string"},"status":{"type":"string","readOnly":true},"urbanDistrict":{"type":"string"},"wayName":{"type":"string"},"wayNumber":{"type":"string"},"wayNumberExtra":{"type":"string"},"wayType":{"type":"string"}}},"telephony.DirectoryWayType":{"type":"object","description":"Directory way type","properties":{"abbreviatedName":{"type":"string","readOnly":true},"wayName":{"type":"string","readOnly":true}}},"telephony.EntrepriseNumberInformations":{"type":"object","description":"Task informations about an entreprise","properties":{"address":{"type":"string","description":"Address of the entreprise","nullable":true},"ape":{"type":"string","description":"Entreprise's category code for directory services","nullable":true},"brand":{"type":"string","description":"Brand of the entreprise","nullable":true},"entrepriseNumber":{"type":"string","description":"Entreprise number"},"isValid":{"type":"boolean","description":"Is this a valid entreprise number?"},"name":{"type":"string","description":"Name of the entreprise"},"siren":{"type":"string","description":"Short version of the entreprise number (FR only)","nullable":true}}},"telephony.EntrepriseNumberInformationsTask":{"type":"object","description":"Task about getting entreprise informations","properties":{"informations":{"allOf":[{"$ref":"#/components/schemas/telephony.EntrepriseNumberInformations"}],"description":"Informations about the enterprise"},"status":{"allOf":[{"$ref":"#/components/schemas/telephony.TaskStatusEnum"}],"description":"Task status"}}},"telephony.EventToken":{"type":"object","description":"Token associated to the service for live event","properties":{"token":{"type":"string","readOnly":true}}},"telephony.FaxConsumption":{"type":"object","description":"Fax delivery record","properties":{"called":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"nullable":true,"readOnly":true},"calling":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"nullable":true,"readOnly":true},"consumptionId":{"type":"integer","readOnly":true},"creationDatetime":{"type":"string","format":"date-time","readOnly":true},"pages":{"type":"integer","readOnly":true},"priceWithoutTax":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"readOnly":true},"wayType":{"allOf":[{"$ref":"#/components/schemas/telephony.FaxConsumptionWayTypeEnum"}],"readOnly":true}}},"telephony.FaxConsumptionWayTypeEnum":{"type":"string","description":"Consumption way type","enum":["received","sent"]},"telephony.LineOffer":{"type":"object","description":"Informations related to a line offer","properties":{"description":{"type":"string","description":"The offer description"},"name":{"type":"string","description":"The offer name"},"price":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Offer price per month","nullable":true}}},"telephony.NumberCountryCodeEnum":{"type":"integer","description":"Number country code","enum":[32,33,34,41,44,49]},"telephony.OfferChange":{"type":"object","description":"Offer change","properties":{"offer":{"type":"string","description":"The current offer will be replace by this one on the next renew.","readOnly":true}}},"telephony.OfferTask":{"type":"object","description":"Operation on a telephony offer","properties":{"action":{"allOf":[{"$ref":"#/components/schemas/telephony.OfferTaskActionEnum"}],"description":"Actual action that will be executed","readOnly":true},"executionDate":{"type":"string","description":"Planned execution date","format":"date-time"},"status":{"allOf":[{"$ref":"#/components/schemas/telephony.TaskStatusEnum"}],"description":"Current status of the task","readOnly":true},"taskId":{"type":"integer","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/telephony.OfferTaskTypeEnum"}],"description":"Type of operation that will be executed","readOnly":true}}},"telephony.OfferTaskActionEnum":{"type":"string","description":"Offer task actions","enum":["convertToAlias","convertToSip","migrateToNewVoicemail","removeSimltaneousLines","switchServer","termination","updateFirmware","upgrade"]},"telephony.OfferTaskTypeEnum":{"type":"string","description":"Offer task types","enum":["line","offer","option","phone"]},"telephony.PreviousVoiceConsumption":{"type":"object","description":"Call delivery record of the previous month","properties":{"called":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"nullable":true,"readOnly":true},"calling":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"nullable":true,"readOnly":true},"consumptionId":{"type":"integer","readOnly":true},"countrySuffix":{"type":"string","description":"Country suffix destination","readOnly":true},"creationDatetime":{"type":"string","format":"date-time","readOnly":true},"designation":{"type":"string","description":"Description of the destination","readOnly":true},"destinationType":{"allOf":[{"$ref":"#/components/schemas/telephony.VoiceConsumptionDestinationTypeEnum"}],"readOnly":true},"duration":{"type":"integer","readOnly":true},"hangupNature":{"type":"string","description":"Information about hangup cause","nullable":true,"readOnly":true},"planType":{"allOf":[{"$ref":"#/components/schemas/telephony.VoiceConsumptionPlanTypeEnum"}],"readOnly":true},"priceWithoutTax":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"readOnly":true},"wayType":{"allOf":[{"$ref":"#/components/schemas/telephony.VoiceConsumptionWayTypeEnum"}],"readOnly":true}}},"telephony.PropertyEnum":{"type":"string","description":"All existing properties of line or alias offer","enum":["xdsl"]},"telephony.ServiceNumberCountryEnum":{"type":"string","description":"Number country","enum":["be","ch","de","es","fr","gb","uk"]},"telephony.Task":{"type":"object","description":"Operation on a telephony service","properties":{"action":{"type":"string","description":"Action associated with the task","readOnly":true},"message":{"type":"string","description":"Potential failure reason of the task","nullable":true,"readOnly":true},"objectCreated":{"type":"string","description":"Object potentially created at the end of the task","nullable":true,"readOnly":true},"serviceType":{"type":"string","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/telephony.TaskStatusEnum"}],"description":"Status of the task","readOnly":true},"taskId":{"type":"integer","readOnly":true}}},"telephony.TaskStatusEnum":{"type":"string","description":"Task status","enum":["doing","done","error","pause","todo"]},"telephony.TelephonyService":{"type":"object","description":"Telephony service","properties":{"associatedDeviceMac":{"allOf":[{"$ref":"#/components/schemas/macAddress"}],"description":"MAC address of the associated device if there is one.","nullable":true,"readOnly":true},"country":{"allOf":[{"$ref":"#/components/schemas/telephony.ServiceNumberCountryEnum"}],"description":"The country of the number","readOnly":true},"countryCode":{"allOf":[{"$ref":"#/components/schemas/telephony.NumberCountryCodeEnum"}],"description":"The country code of the number","readOnly":true},"currentOutplan":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Current outplan","readOnly":true},"description":{"type":"string"},"featureType":{"allOf":[{"$ref":"#/components/schemas/telephony.TypeEnum"}],"readOnly":true},"getPublicOffer":{"allOf":[{"$ref":"#/components/schemas/telephony.LineOffer"}],"description":"The service offers","readOnly":true},"hasFaxCapabilities":{"type":"boolean","description":"Does this service have fax capabilities?","readOnly":true},"offers":{"type":"array","items":{"type":"string"},"readOnly":true},"properties":{"type":"array","items":{"$ref":"#/components/schemas/telephony.PropertyEnum"},"readOnly":true},"rio":{"type":"string","description":"The identifier to use to port the number","readOnly":true},"serviceName":{"type":"string","readOnly":true},"serviceType":{"allOf":[{"$ref":"#/components/schemas/telephony.TypeServiceEnum"}],"readOnly":true},"simultaneousLines":{"type":"integer","readOnly":true}}},"telephony.TerminationReasonEnum":{"type":"string","description":"Termination reason","enum":["addresseMove","billingDifficulties","cessationOfActivity","missingOptions","moveToCompetitor","other","plugAndPhoneDifficulties","technicalDifficulties"]},"telephony.TokenExpirationEnum":{"type":"string","description":"expiration possibility","enum":["1 day","1 hour","30 days","5 minutes","unlimited"]},"telephony.TypeEnum":{"type":"string","description":"All existing types of line or alias","enum":["aiAgent","carrierSip","cloudHunting","cloudIvr","conference","contactCenterSolution","contactCenterSolutionExpert","ddi","easyHunting","empty","fax","freefax","mgcp","oldConference","plugAndFax","redirect","sip","svi","voicefax","voicemail","vxml"]},"telephony.TypeServiceEnum":{"type":"string","description":"All existing types","enum":["alias","line"]},"telephony.VoiceConsumption":{"type":"object","description":"Call delivery record","properties":{"called":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"nullable":true,"readOnly":true},"calling":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"nullable":true,"readOnly":true},"consumptionId":{"type":"integer","readOnly":true},"countrySuffix":{"type":"string","description":"Country suffix destination","readOnly":true},"creationDatetime":{"type":"string","format":"date-time","readOnly":true},"designation":{"type":"string","description":"Description of the destination","readOnly":true},"destinationType":{"allOf":[{"$ref":"#/components/schemas/telephony.VoiceConsumptionDestinationTypeEnum"}],"readOnly":true},"dialed":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"nullable":true,"readOnly":true},"duration":{"type":"integer","readOnly":true},"hangupNature":{"type":"string","description":"Information about hangup cause","nullable":true,"readOnly":true},"planType":{"allOf":[{"$ref":"#/components/schemas/telephony.VoiceConsumptionPlanTypeEnum"}],"readOnly":true},"priceWithoutTax":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"readOnly":true},"wayType":{"allOf":[{"$ref":"#/components/schemas/telephony.VoiceConsumptionWayTypeEnum"}],"readOnly":true}}},"telephony.VoiceConsumptionDestinationTypeEnum":{"type":"string","description":"Consumption destination type","enum":["landline","mobile","special"]},"telephony.VoiceConsumptionPlanTypeEnum":{"type":"string","description":"Consumption plan type","enum":["outplan","priceplan"]},"telephony.VoiceConsumptionWayTypeEnum":{"type":"string","description":"Consumption way type","enum":["incoming","outgoing","transfer"]},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/telephony/{billingAccount}/service":{"get":{"summary":"List services","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@10"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@10"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@10"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@10"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@10"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@10"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/get","required":true}],"x-expanded-response":"TelephonyTelephonyService"}},"/telephony/{billingAccount}/service/{serviceName}":{"delete":{"summary":"Terminate a service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"query","name":"details","description":"Termination reason details","schema":{"type":"string"}},{"in":"query","name":"reason","description":"Termination reason","required":true,"schema":{"$ref":"#/components/schemas/telephony.TerminationReasonEnum"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@30"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@30"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@30"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@30"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@30"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/telephony/{billingAccount}/service/{serviceName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"delete(\"/telephony/{billingAccount}/service/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/delete","required":true}]},"get":{"summary":"Get a service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.TelephonyService"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@20"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@20"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@20"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@20"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@20"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@20"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/get","required":true}]},"put":{"summary":"Update a service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.TelephonyService"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@40"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@40"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@40"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@40"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@40"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: telephony.TelephonyService\nresult = client.put(\"/telephony/{billingAccount}/service/{serviceName}\",\n\tdescription = None, # (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"put(\"/telephony/{billingAccount}/service/{serviceName}\", array(\n\tdescription => null, // (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/edit","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/cancelTermination":{"post":{"summary":"Cancel the service termination","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@50"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@50"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@50"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@50"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@50"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.post(\"/telephony/{billingAccount}/service/{serviceName}/cancelTermination\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/telephony/{billingAccount}/service/{serviceName}/cancelTermination\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/cancelTermination","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/changeOfBillingAccount":{"post":{"summary":"Move a service to another billing account","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"billingAccountDestination":{"type":"string","description":"Billing account destination target"}},"required":["billingAccountDestination"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@60"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@60"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@60"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@60"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@60"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@60"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/telephony/{billingAccount}/service/{serviceName}/changeOfBillingAccount\",\n\tbillingAccountDestination = None, # Billing account destination target (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/telephony/{billingAccount}/service/{serviceName}/changeOfBillingAccount\", array(\n\tbillingAccountDestination => null, // Billing account destination target (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/changeOfBillingAccount","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/diagnosticReports":{"get":{"summary":"Get diagnostic reports","deprecated":true,"x-deprecation-date":"2024-01-01T00:00:00+01:00","x-deletion-date":"2024-02-01T00:00:00+01:00","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"query","name":"dayInterval","description":"The date index interval","required":true,"schema":{"$ref":"#/components/schemas/telephony.DiagnosticReportIndexEnum"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/telephony.DiagnosticReport"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@70"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@70"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@70"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@70"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@70"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@70"]],"x-badges":[{"color":"red","label":"Deprecated, will be removed"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/diagnosticReports\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/diagnosticReports\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/diagnosticReports/get","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/directory":{"get":{"summary":"Get the directory listing","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.DirectoryInfo"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@80"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@80"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@80"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@80"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@80"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@80"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/directory\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/directory\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/directory/get","required":true}]},"put":{"summary":"Update the directory listing","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.DirectoryInfo"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@90"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@90"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@90"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@90"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@90"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@90"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: telephony.DirectoryInfo\nresult = client.put(\"/telephony/{billingAccount}/service/{serviceName}/directory\",\n\taddress = None, # (type: string)\n\taddressExtra = None, # (type: string)\n\tape = None, # (type: string)\n\tbirthDate = None, # (type: string, nullable)\n\tcedex = None, # (type: string)\n\tcity = None, # (type: string)\n\tcountry = None, # (type: string)\n\tdirectoryServiceCode = None, # (type: string)\n\tdisplayFirstName = None, # (type: boolean)\n\tdisplayMarketingDirectory = None, # (type: boolean)\n\tdisplayOnlyCity = None, # (type: boolean)\n\tdisplaySearchReverse = None, # (type: boolean)\n\tdisplayUniversalDirectory = None, # (type: boolean)\n\temail = None, # (type: string)\n\tfirstName = None, # (type: string)\n\tgender = None, # (type: nichandle.GenderEnum, nullable)\n\tlegalForm = None, # (type: string)\n\tlineDescription = None, # (type: string)\n\tname = None, # (type: string)\n\toccupation = None, # (type: string)\n\tpostBox = None, # (type: string)\n\tpostCode = None, # (type: string)\n\tsiret = None, # (type: string)\n\tsocialNomination = None, # (type: string)\n\tsocialNominationExtra = None, # (type: string)\n\turbanDistrict = None, # (type: string)\n\twayName = None, # (type: string)\n\twayNumber = None, # (type: string)\n\twayNumberExtra = None, # (type: string)\n\twayType = None, # (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"put(\"/telephony/{billingAccount}/service/{serviceName}/directory\", array(\n\taddress => null, // (type: string)\n\taddressExtra => null, // (type: string)\n\tape => null, // (type: string)\n\tbirthDate => null, // (type: string, nullable)\n\tcedex => null, // (type: string)\n\tcity => null, // (type: string)\n\tcountry => null, // (type: string)\n\tdirectoryServiceCode => null, // (type: string)\n\tdisplayFirstName => null, // (type: boolean)\n\tdisplayMarketingDirectory => null, // (type: boolean)\n\tdisplayOnlyCity => null, // (type: boolean)\n\tdisplaySearchReverse => null, // (type: boolean)\n\tdisplayUniversalDirectory => null, // (type: boolean)\n\temail => null, // (type: string)\n\tfirstName => null, // (type: string)\n\tgender => null, // (type: nichandle.GenderEnum, nullable)\n\tlegalForm => null, // (type: string)\n\tlineDescription => null, // (type: string)\n\tname => null, // (type: string)\n\toccupation => null, // (type: string)\n\tpostBox => null, // (type: string)\n\tpostCode => null, // (type: string)\n\tsiret => null, // (type: string)\n\tsocialNomination => null, // (type: string)\n\tsocialNominationExtra => null, // (type: string)\n\turbanDistrict => null, // (type: string)\n\twayName => null, // (type: string)\n\twayNumber => null, // (type: string)\n\twayNumberExtra => null, // (type: string)\n\twayType => null, // (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/directory/edit","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/directory/fetchEntrepriseInformations":{"post":{"summary":"Fetch company information","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entrepriseNumber":{"type":"string","description":"Entreprise number to fetch informations from"}},"required":["entrepriseNumber"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.EntrepriseNumberInformationsTask"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@100"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@100"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@100"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@100"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@100"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@100"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/telephony/{billingAccount}/service/{serviceName}/directory/fetchEntrepriseInformations\",\n\tentrepriseNumber = None, # Entreprise number to fetch informations from (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/telephony/{billingAccount}/service/{serviceName}/directory/fetchEntrepriseInformations\", array(\n\tentrepriseNumber => null, // Entreprise number to fetch informations from (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/directory/fetchEntrepriseInformations","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/directory/getDirectoryServiceCode":{"get":{"summary":"Get the directory service code","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"apeCode","required":true,"schema":{"type":"string"}},{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/telephony.DirectoryHeadingPJ"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@110"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@110"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@110"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@110"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@110"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@110"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/directory/getDirectoryServiceCode\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/directory/getDirectoryServiceCode\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/directory/getDirectoryServiceCode/get","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/directory/getWayTypes":{"get":{"summary":"List street types","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/telephony.DirectoryWayType"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@120"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@120"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@120"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@120"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@120"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@120"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/directory/getWayTypes\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/directory/getWayTypes\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/directory/getWayTypes/get","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/eventToken":{"delete":{"summary":"Delete the event token","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@170"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@170"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@170"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@170"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@170"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@170"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/telephony/{billingAccount}/service/{serviceName}/eventToken\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"delete(\"/telephony/{billingAccount}/service/{serviceName}/eventToken\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/eventToken/delete","required":true}]},"get":{"summary":"Get the event token","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.EventToken"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@150"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@150"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@150"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@150"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@150"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@150"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/eventToken\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/eventToken\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/eventToken/get","required":true}]},"post":{"summary":"Create an event token","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"expiration":{"description":"Time to live in seconds for the token","$ref":"#/components/schemas/telephony.TokenExpirationEnum"}},"required":["expiration"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@160"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@160"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@160"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@160"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@160"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@160"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: telephony.TokenExpirationEnum\nresult = client.post(\"/telephony/{billingAccount}/service/{serviceName}/eventToken\",\n\texpiration = None, # Time to live in seconds for the token (type: telephony.TokenExpirationEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/telephony/{billingAccount}/service/{serviceName}/eventToken\", array(\n\texpiration => null, // Time to live in seconds for the token (type: telephony.TokenExpirationEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/eventToken/create","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/faxConsumption":{"get":{"summary":"List fax records","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"query","name":"creationDatetime.from","description":"Filter the value of creationDatetime property (>=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"creationDatetime.to","description":"Filter the value of creationDatetime property (<=)","schema":{"type":"string","format":"date-time"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}},{"in":"query","name":"wayType","description":"Filter the value of wayType property (=)","schema":{"$ref":"#/components/schemas/telephony.FaxConsumptionWayTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@180"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@180"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@180"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/faxConsumption\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/faxConsumption\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/faxConsumption/get","required":true}],"x-expanded-response":"TelephonyFaxConsumption"}},"/telephony/{billingAccount}/service/{serviceName}/faxConsumption/{consumptionId}":{"get":{"summary":"Get a fax record","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"consumptionId","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.FaxConsumption"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@190"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@190"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@190"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/faxConsumption/{consumptionId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/faxConsumption/{consumptionId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/faxConsumption/get","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/offerChange":{"delete":{"summary":"Cancel the scheduled offer change","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@220"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@220"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@200"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@220"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@200"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@200"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.delete(\"/telephony/{billingAccount}/service/{serviceName}/offerChange\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"delete(\"/telephony/{billingAccount}/service/{serviceName}/offerChange\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/offerChange/delete","required":true}]},"get":{"summary":"Get the scheduled offer change","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.OfferChange"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@200"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@200"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@180"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@200"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@180"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@180"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/offerChange\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/offerChange\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/offerChange/get","required":true}]},"post":{"summary":"Schedule an offer change","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"offer":{"type":"string","description":"The future offer"}},"required":["offer"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@210"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@210"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@190"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@210"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@190"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@190"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/telephony/{billingAccount}/service/{serviceName}/offerChange\",\n\toffer = None, # The future offer (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/telephony/{billingAccount}/service/{serviceName}/offerChange\", array(\n\toffer => null, // The future offer (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/offerChange/create","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/offerChanges":{"get":{"summary":"List available offer changes","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/telephony.LineOffer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@230"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@230"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@210"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@230"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@210"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@210"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/offerChanges\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/offerChanges\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/offerChanges/get","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/offerTask":{"get":{"summary":"List offer tasks","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"action","description":"Filter the value of action property (=)","schema":{"$ref":"#/components/schemas/telephony.OfferTaskActionEnum"}},{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}},{"in":"query","name":"status","description":"Filter the value of status property (=)","schema":{"$ref":"#/components/schemas/telephony.TaskStatusEnum"}},{"in":"query","name":"type","description":"Filter the value of type property (=)","schema":{"$ref":"#/components/schemas/telephony.OfferTaskTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@240"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@240"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@220"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@240"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@220"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@220"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/offerTask\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/offerTask\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/offerTask/get","required":true}],"x-expanded-response":"TelephonyOfferTask"}},"/telephony/{billingAccount}/service/{serviceName}/offerTask/{taskId}":{"get":{"summary":"Get an offer task","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.OfferTask"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@250"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@250"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@230"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@250"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@230"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@230"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/offerTask/{taskId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/offerTask/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/offerTask/get","required":true}]},"put":{"summary":"Update an offer task","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.OfferTask"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@260"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@260"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@240"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@260"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@240"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@240"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\n# Request body type: telephony.OfferTask\nresult = client.put(\"/telephony/{billingAccount}/service/{serviceName}/offerTask/{taskId}\",\n\texecutionDate = None, # Planned execution date (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"put(\"/telephony/{billingAccount}/service/{serviceName}/offerTask/{taskId}\", array(\n\texecutionDate => null, // Planned execution date (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/offerTask/edit","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/previousVoiceConsumption":{"get":{"summary":"List last month call records","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"query","name":"creationDatetime.from","description":"Filter the value of creationDatetime property (>=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"creationDatetime.to","description":"Filter the value of creationDatetime property (<=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"destinationType","description":"Filter the value of destinationType property (=)","schema":{"$ref":"#/components/schemas/telephony.VoiceConsumptionDestinationTypeEnum"}},{"in":"query","name":"planType","description":"Filter the value of planType property (=)","schema":{"$ref":"#/components/schemas/telephony.VoiceConsumptionPlanTypeEnum"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}},{"in":"query","name":"wayType","description":"Filter the value of wayType property (=)","schema":{"$ref":"#/components/schemas/telephony.VoiceConsumptionWayTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@270"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@270"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@250"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@250"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@250"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/previousVoiceConsumption\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/previousVoiceConsumption\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/previousVoiceConsumption/get","required":true}],"x-expanded-response":"TelephonyPreviousVoiceConsumption"}},"/telephony/{billingAccount}/service/{serviceName}/previousVoiceConsumption/{consumptionId}":{"get":{"summary":"Get a last month call record","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"consumptionId","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PreviousVoiceConsumption"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@280"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@280"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@260"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@260"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@260"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/previousVoiceConsumption/{consumptionId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/previousVoiceConsumption/{consumptionId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/previousVoiceConsumption/get","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/task":{"get":{"summary":"List tasks","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"action","description":"Filter the value of action property (=)","schema":{"type":"string"}},{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}},{"in":"query","name":"serviceType","description":"Filter the value of serviceType property (=)","schema":{"type":"string"}},{"in":"query","name":"status","description":"Filter the value of status property (=)","schema":{"$ref":"#/components/schemas/telephony.TaskStatusEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@310"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@290"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@290"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@270"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@270"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@270"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/task\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/task\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/task/get","required":true}],"x-expanded-response":"TelephonyTask"}},"/telephony/{billingAccount}/service/{serviceName}/task/{taskId}":{"get":{"summary":"Get a task","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@320"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@300"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@300"],["Web Cloud","Telephony","Virtual Fax","Subscription & Usage@@@280"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@280"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@280"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/task/{taskId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/task/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/task/get","required":true}]}},"/telephony/{billingAccount}/service/{serviceName}/voiceConsumption":{"get":{"summary":"List call records","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"query","name":"creationDatetime.from","description":"Filter the value of creationDatetime property (>=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"creationDatetime.to","description":"Filter the value of creationDatetime property (<=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"destinationType","description":"Filter the value of destinationType property (=)","schema":{"$ref":"#/components/schemas/telephony.VoiceConsumptionDestinationTypeEnum"}},{"in":"query","name":"planType","description":"Filter the value of planType property (=)","schema":{"$ref":"#/components/schemas/telephony.VoiceConsumptionPlanTypeEnum"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}},{"in":"query","name":"wayType","description":"Filter the value of wayType property (=)","schema":{"$ref":"#/components/schemas/telephony.VoiceConsumptionWayTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@330"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@310"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@310"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@290"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@290"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/voiceConsumption\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/voiceConsumption\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/voiceConsumption/get","required":true}],"x-expanded-response":"TelephonyVoiceConsumption"}},"/telephony/{billingAccount}/service/{serviceName}/voiceConsumption/{consumptionId}":{"get":{"summary":"Get a call record","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"consumptionId","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.VoiceConsumption"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","All Services@@@340"],["Web Cloud","Telephony","SIP Lines","Subscription & Usage@@@320"],["Web Cloud","Telephony","Phone Numbers (alias)","Subscription & Usage@@@320"],["Web Cloud","Telephony","SIP Trunk","Subscription & Usage@@@300"],["Web Cloud","Telephony","Carrier SIP","Subscription & Usage@@@300"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu', # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx', # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx', # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/service/{serviceName}/voiceConsumption/{consumptionId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/telephony/{billingAccount}/service/{serviceName}/voiceConsumption/{consumptionId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:service/voiceConsumption/get","required":true}]}}}}