{"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/v1"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"complexType.Range_long":{"type":"object","description":"Start and end points (inclusive) of a range","properties":{"from":{"type":"integer"},"to":{"type":"integer"}}},"complexType.SafeKeyValue_string":{"type":"object","description":"Key and value, with proper key strings","properties":{"key":{"type":"string"},"value":{"type":"string"}}},"coreTypes.CountryEnum":{"type":"string","description":"ISO country codes","enum":["ac","ad","ae","af","ag","ai","al","am","an","ao","aq","ar","as","at","au","aw","ax","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bl","bm","bn","bo","bq","br","bs","bt","bv","bw","by","bz","ca","cc","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cs","cu","cv","cw","cx","cy","cz","de","dj","dk","dm","do","dz","ec","ee","eg","eh","er","es","et","fc","fd","fi","fj","fk","fm","fo","fr","fx","ga","gb","gd","ge","gf","gg","gh","gi","gl","gm","gn","gp","gq","gr","gs","gt","gu","gw","gy","hk","hm","hn","hr","ht","hu","id","ie","il","im","in","io","iq","ir","is","it","je","jm","jo","jp","ke","kg","kh","ki","km","kn","kp","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","mc","md","me","mf","mg","mh","mk","ml","mm","mn","mo","mp","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","nf","ng","ni","nl","no","np","nr","nu","nz","om","pa","pe","pf","pg","ph","pk","pl","pm","pn","pr","ps","pt","pw","py","qa","qc","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","sh","si","sj","sk","sl","sm","sn","so","sr","ss","st","sv","sx","sy","sz","tc","td","tf","tg","th","tj","tk","tl","tm","tn","to","tp","tr","tt","tv","tw","tz","ua","ug","uk","um","us","uy","uz","va","vc","ve","vg","vi","vn","vu","we","wf","ws","ye","yt","yu","za","zm","zw"]},"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"},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value (defaults to 'EQ')","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"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"},"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"},"service.RenewType":{"type":"object","description":"Map a possible renew for a specific service","properties":{"automatic":{"type":"boolean","description":"The service is automatically renewed"},"deleteAtExpiration":{"type":"boolean","description":"The service will be deleted at expiration"},"forced":{"type":"boolean","description":"The service forced to be renewed"},"manualPayment":{"type":"boolean","description":"The service needs to be manually renewed and paid","nullable":true},"period":{"type":"integer","description":"period of renew in month","nullable":true}}},"service.RenewalTypeEnum":{"type":"string","description":"Detailed renewal type of a service","enum":["automaticForcedProduct","automaticV2012","automaticV2014","automaticV2016","automaticV2024","manual","oneShot","option"]},"service.StateEnum":{"type":"string","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"]},"services.Service":{"type":"object","description":"Details about a Service","properties":{"canDeleteAtExpiration":{"type":"boolean","description":"Indicates that the service can be set up to be deleted at expiration","readOnly":true},"contactAdmin":{"type":"string","readOnly":true},"contactBilling":{"type":"string","readOnly":true},"contactTech":{"type":"string","readOnly":true},"creation":{"type":"string","format":"date","readOnly":true},"domain":{"type":"string","readOnly":true},"engagedUpTo":{"type":"string","nullable":true,"format":"date","readOnly":true},"expiration":{"type":"string","format":"date","readOnly":true},"possibleRenewPeriod":{"type":"array","description":"All the possible renew period of your service in month","nullable":true,"items":{"type":"integer"},"readOnly":true},"renew":{"allOf":[{"$ref":"#/components/schemas/service.RenewType"}],"description":"Way of handling the renew","nullable":true},"renewalType":{"allOf":[{"$ref":"#/components/schemas/service.RenewalTypeEnum"}],"readOnly":true},"serviceId":{"type":"integer","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/service.StateEnum"}],"readOnly":true}}},"spare.telephony.TelephonySpareWithIAM":{"type":"object","description":"Spare properties","properties":{"brand":{"type":"string","description":"Phone brand model","readOnly":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"macAddress":{"type":"string","description":"Mac address","readOnly":true},"protocol":{"allOf":[{"$ref":"#/components/schemas/telephony.ProtocolEnum"}],"description":"Phone protocol","readOnly":true}}},"telephony.AccessoryOffer":{"type":"object","description":"Informations related to a line offer","properties":{"description":{"type":"string","description":"The accessory description","nullable":true},"name":{"type":"string","description":"The accessory name"},"price":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Accessory price"},"url":{"type":"string","description":"An URL to accessory details","nullable":true}}},"telephony.AvailableDevice":{"type":"object","description":"A phone device belonging to this billing account, with its currently assigned lines","properties":{"availableSlots":{"type":"integer","description":"Number of line slots still available on this device"},"brand":{"type":"string","description":"Brand of the device"},"description":{"type":"string","description":"Public description of the device"},"lines":{"type":"array","description":"Lines currently assigned to this device","items":{"$ref":"#/components/schemas/telephony.AvailableDeviceLine"}},"linesCount":{"type":"integer","description":"Number of lines currently assigned to this device"},"macAddress":{"type":"string","description":"MAC address of the device"},"maxLines":{"type":"integer","description":"Maximum number of lines the device can handle"}}},"telephony.AvailableDeviceLine":{"type":"object","description":"A line assigned to an available device","properties":{"billingAccount":{"type":"string","description":"Name of the billing account the line belongs to"},"description":{"type":"string","description":"Description of the line"},"isRoot":{"type":"boolean","description":"Whether this line is the root line of the device"},"numberInternational":{"type":"string","description":"The international phone number of the line"}}},"telephony.Contact":{"type":"object","description":"Contact informations structure","properties":{"address":{"type":"string","description":"Contact address","nullable":true},"city":{"type":"string","description":"Contact city","nullable":true},"country":{"allOf":[{"$ref":"#/components/schemas/coreTypes.CountryEnum"}],"description":"Contact country","nullable":true},"email":{"type":"string","nullable":true},"firstname":{"type":"string","description":"Contact firstname","nullable":true},"name":{"type":"string","description":"Contact name","nullable":true},"organisation":{"type":"string","description":"Contact organisation","nullable":true},"phone":{"type":"string","description":"Contact phone","nullable":true},"zip":{"type":"string","description":"Contact zip","nullable":true}}},"telephony.ContactsExportFormatsEnum":{"type":"string","description":"Export file format","enum":["csv"]},"telephony.FunctionKey":{"type":"object","description":"Plug & Phone function key","properties":{"default":{"type":"string","description":"The default function used by the key","nullable":true,"readOnly":true},"function":{"type":"string","description":"The function active on the key","nullable":true},"keyNum":{"type":"integer","description":"The number of the function key","readOnly":true},"label":{"type":"string","description":"The key label","readOnly":true},"parameter":{"type":"string","description":"The function parameter","nullable":true},"type":{"type":"string","description":"The key type","readOnly":true}}},"telephony.HardwareOffer":{"type":"object","description":"Informations related to a telephone offer","properties":{"description":{"type":"string","description":"The telephony description","nullable":true},"name":{"type":"string","description":"The telephony name"},"price":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Telephony price"},"url":{"type":"string","description":"An URL to telephony details","nullable":true}}},"telephony.LinePhone":{"type":"object","description":"Informations related to phone capabilities","properties":{"brand":{"type":"string","description":"Brand name of the phone"},"description":{"type":"string","description":"The phone description"},"fees":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Setup fees","nullable":true},"maxline":{"type":"integer","description":"Maximum number of lines managed by a phone"},"offerType":{"allOf":[{"$ref":"#/components/schemas/telephony.RmaOfferTypeEnum"}],"description":"Type of purchase"},"price":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Telephony price"},"protocol":{"allOf":[{"$ref":"#/components/schemas/telephony.ProtocolEnum"}],"description":"Phone protocol"}}},"telephony.LinePhoneAssociable":{"type":"object","description":"Informations related to associable phone capabilities","properties":{"associatedLines":{"type":"array","description":"Current lines configured on the phone","items":{"$ref":"#/components/schemas/telephony.LinePhoneAssociableConfiguredLines"}},"brand":{"type":"string","description":"Brand name of the phone"},"maxLines":{"type":"integer","description":"Maximum quantity of lines managed by the phone"},"protocol":{"allOf":[{"$ref":"#/components/schemas/telephony.ProtocolEnum"}],"description":"Phone protocol"}}},"telephony.LinePhoneAssociableConfiguredLines":{"type":"object","description":"Current lines configured on the phone","properties":{"description":{"type":"string","description":"The line description"},"serviceName":{"type":"string","description":"Service name of the line"}}},"telephony.OldPhone":{"type":"object","description":"Informations related to phone","properties":{"mac":{"type":"string","description":"Mac address of the phone"},"model":{"type":"string","description":"Model of the phone"}}},"telephony.PcsFile":{"type":"object","description":"Telephony API related file hosted","properties":{"filename":{"type":"string","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/telephony.PcsFileStatusEnum"}],"readOnly":true},"url":{"type":"string","readOnly":true},"urlExpirationDatetime":{"type":"string","format":"date-time","readOnly":true}}},"telephony.PcsFileStatusEnum":{"type":"string","description":"File providing task status","enum":["doing","done","error","todo"]},"telephony.Phone":{"type":"object","description":"Plug & Phone","properties":{"brand":{"type":"string","description":"Brand name","readOnly":true},"description":{"type":"string","description":"The phone description","readOnly":true},"macAddress":{"type":"string","description":"Mac Address","readOnly":true},"maxSimultaneousCalls":{"type":"integer","description":"Maximum simultaneous calls managed by the phone","readOnly":true},"maxline":{"type":"integer","description":"Maximum number of lines managed by a phone","readOnly":true},"mgcpIpRestriction":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"The ip restriction of your MGCP phone","nullable":true},"phoneConfiguration":{"type":"array","description":"Current phone properties","items":{"$ref":"#/components/schemas/telephony.PhoneConfigurationProperty"},"readOnly":true},"protocol":{"allOf":[{"$ref":"#/components/schemas/telephony.ProtocolEnum"}],"description":"Phone protocol","readOnly":true},"userPassword":{"type":"string","description":"The phone user password","nullable":true,"format":"password","readOnly":true}}},"telephony.PhoneConfigurationLevelEnum":{"type":"string","description":"Phone Configuration level enum","enum":["admin","expert"]},"telephony.PhoneConfigurationProperty":{"type":"object","description":"Phone configuration property","properties":{"default":{"type":"string","description":"Default property value","nullable":true},"description":{"type":"string","description":"Property description","nullable":true},"enum":{"type":"array","description":"Property value possibilities","nullable":true,"items":{"type":"string"}},"group":{"type":"string","description":"The property group","nullable":true},"level":{"allOf":[{"$ref":"#/components/schemas/telephony.PhoneConfigurationLevelEnum"}],"description":"Provisioning level","nullable":true},"maxlength":{"type":"integer","description":"Max string chars","nullable":true},"name":{"type":"string","description":"The property name","nullable":true},"rangeValue":{"allOf":[{"$ref":"#/components/schemas/complexType.Range_long"}],"description":"Range property value","nullable":true},"type":{"allOf":[{"$ref":"#/components/schemas/telephony.PhoneConfigurationTypeEnum"}],"description":"Provisioning type","nullable":true},"value":{"type":"string","description":"Current property value","nullable":true}}},"telephony.PhoneConfigurationTypeEnum":{"type":"string","description":"Phone configuration type enum","enum":["boolean","enum","hidden","ipv4","numeric","string"]},"telephony.PhoneCredentials":{"type":"object","description":"Credentials to access the web interface of the phone","properties":{"login":{"type":"string","description":"Username to access the web interface of the phone","nullable":true},"password":{"type":"string","description":"Password to access the web interface of the phone","format":"password"}}},"telephony.Phonebook":{"type":"object","description":"Phone book","properties":{"bookKey":{"type":"string","description":"Identifier of the phonebook","readOnly":true},"isReadonly":{"type":"boolean","description":"Set if phonebook is readonly"},"name":{"type":"string","description":"Phonebook name"},"phoneKey":{"type":"string","description":"Phone key identifier between the phone and phonebooks","readOnly":true}}},"telephony.PhonebookContact":{"type":"object","description":"Phone book contact","properties":{"group":{"type":"string","description":"Group name of the phonebook"},"homeMobile":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Home mobile phone number of the contact","nullable":true},"homePhone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Home landline phone number of the contact","nullable":true},"id":{"type":"integer","description":"Contact identifier","readOnly":true},"name":{"type":"string","description":"Contact name"},"surname":{"type":"string","description":"Contact surname"},"workMobile":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Mobile phone office number of the contact","nullable":true},"workPhone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Landline phone office number of the contact","nullable":true}}},"telephony.PhonebookMaster":{"type":"object","description":"Phone book on group","properties":{"bookKey":{"type":"string","description":"Identifier of the phonebook","readOnly":true},"name":{"type":"string","description":"Phone book name"}}},"telephony.ProtocolEnum":{"type":"string","description":"Phone protocol","enum":["mgcp","sip"]},"telephony.ResetPhoneCodeInfo":{"type":"object","description":"Relevant informations about reset code","properties":{"activationCode":{"type":"string","description":"Activation code","nullable":true},"keyBook":{"type":"string","description":"Key book url","nullable":true},"serverURL":{"type":"string","description":"Server url","nullable":true}}},"telephony.ResetPhoneInfo":{"type":"object","description":"Relevant informations of the phone reset","properties":{"resetCodeInfo":{"allOf":[{"$ref":"#/components/schemas/telephony.ResetPhoneCodeInfo"}],"description":"Reset code informations","nullable":true},"resetPhoneMethod":{"allOf":[{"$ref":"#/components/schemas/telephony.ResetPhoneMethodEnum"}],"description":"Which way had been used to reset the phone"}}},"telephony.ResetPhoneMethodEnum":{"type":"string","description":"How the phone had been reset","enum":["code","http"]},"telephony.Rma":{"type":"object","description":"Current Return Merchandise Authorisation","properties":{"cancellable":{"type":"boolean","description":"Is the RMA cancellable?","readOnly":true},"creationDatetime":{"type":"string","description":"Creation datetime of the return merchandise authorisation ticket","format":"date-time","readOnly":true},"equipmentReference":{"type":"string","description":"Merchandise reference","readOnly":true},"id":{"type":"string","description":"Return merchandise authorisation identifier","readOnly":true},"newMerchandise":{"type":"string","description":"New merchandise brand in case of exchange","nullable":true,"readOnly":true},"offerTypeNew":{"allOf":[{"$ref":"#/components/schemas/telephony.RmaOfferTypeEnum"}],"description":"Offer type of the new merchandise in case of exchange","nullable":true,"readOnly":true},"offerTypeOld":{"allOf":[{"$ref":"#/components/schemas/telephony.RmaOfferTypeEnum"}],"description":"Offer type of the return merchandise","readOnly":true},"process":{"allOf":[{"$ref":"#/components/schemas/telephony.RmaReplaceTypeEnum"}],"description":"Process determined for merchandise returned"},"receptionDatetime":{"type":"string","description":"Reception datetime of the return merchandise authorisation ticket","nullable":true,"format":"date-time","readOnly":true},"shippingContact":{"allOf":[{"$ref":"#/components/schemas/telephony.Contact"}],"description":"Contact information related to the delivery shipping in case of exchange"},"status":{"allOf":[{"$ref":"#/components/schemas/telephony.RmaStatusEnum"}],"description":"Return merchandise authorisation step","readOnly":true},"steps":{"type":"array","description":"Indicates the current status of the RMA with a list of steps","items":{"$ref":"#/components/schemas/telephony.RmaStep"},"readOnly":true},"terminationDatetime":{"type":"string","description":"Termination datetime of the return merchandise authorisation ticket","nullable":true,"format":"date-time","readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/telephony.RmaTypeEnum"}],"description":"Typology process of merchandise return","readOnly":true}}},"telephony.RmaChangeTypeEnum":{"type":"string","description":"Types of return merchandise authorisation you can change to","enum":["resiliate","toSip"]},"telephony.RmaOfferTypeEnum":{"type":"string","description":"Return merchandise authorisation offer type","enum":["deposit","loan","purchase"]},"telephony.RmaPublicTypeEnum":{"type":"string","description":"Return merchandise authorisation type","enum":["change to another phone/equipment (restitution first and shipping then)","restitution but keep the service enable"]},"telephony.RmaReplaceTypeEnum":{"type":"string","description":"Return merchandise authorisation type","enum":["changePhone","phoneRestitution","undefined"]},"telephony.RmaReturn":{"type":"object","description":"Post-creation return information structure","properties":{"id":{"type":"string","description":"Voucher reference identifier of the return merchandise authorisation"}}},"telephony.RmaStatusEnum":{"type":"string","description":"Return merchandise authorisation step","enum":["closed","open","received"]},"telephony.RmaStep":{"type":"object","description":"Informations related to the current RMA step status","properties":{"description":{"type":"string","description":"A brief description of the step"},"doneDate":{"type":"string","description":"The date when this step was done","nullable":true,"format":"date-time"},"infos":{"type":"string","description":"Additional informations about the step","nullable":true},"name":{"allOf":[{"$ref":"#/components/schemas/telephony.RmaStepNameEnum"}],"description":"The name of the RMA step"},"status":{"allOf":[{"$ref":"#/components/schemas/telephony.RmaStepStatusEnum"}],"description":"Status of the step"}}},"telephony.RmaStepNameEnum":{"type":"string","description":"RMA step names","enum":["dispatchJustification","equipmentSending","equipmentTesting","opening","parcelReception","parcelValidation","validation"]},"telephony.RmaStepStatusEnum":{"type":"string","description":"Status of the RMA step","enum":["done","todo"]},"telephony.RmaTypeEnum":{"type":"string","description":"Return merchandise authorisation type","enum":["after sale equipment service exchange","after sale phone service exchange","equipment restitution","fast exchange","old merchandise reception before exchange","phone restitution","resends due to shipping lost by the carrier","resends due to shipping not withdraw","specific return merchandise authorisation","termination","unknown"]},"telephony.ServiceNumberCountryEnum":{"type":"string","description":"Number country","enum":["be","ch","de","es","fr","gb","uk"]},"telephony.SoftphoneBetaStatus":{"type":"object","description":"Beta status of softphone","properties":{"enabled":{"type":"boolean","description":"Whether Softphone beta is enabled or disabled"}},"required":["enabled"]},"telephony.SoftphoneDevices":{"type":"object","description":"List of softphone devices","properties":{"id":{"type":"string","description":"Device ID","readOnly":true},"name":{"type":"string","description":"Device name","readOnly":true},"os":{"type":"string","description":"Device operating system","readOnly":true},"updateTime":{"type":"string","description":"Last device register date","format":"date-time","readOnly":true},"userAgent":{"type":"string","description":"Device user agent","readOnly":true}}},"telephony.SoftphoneInfrastructureEnum":{"type":"string","description":"Softphone infrastructure","enum":["LEGACY","NOWI"]},"telephony.SoftphoneLogo":{"type":"object","description":"Softphone logo information","properties":{"filename":{"type":"string","description":"Logo filename"},"url":{"type":"string","description":"URL used to download logo"}},"required":["filename","url"]},"telephony.SoftphoneStatus":{"type":"object","description":"Softphone status","properties":{"activation":{"type":"boolean","description":"Line beta softphone activation status","readOnly":true},"eligibility":{"type":"boolean","description":"Line eligibility to softphone","readOnly":true},"infrastructure":{"allOf":[{"$ref":"#/components/schemas/telephony.SoftphoneInfrastructureEnum"}],"description":"Line infrastructure","readOnly":true}}},"telephony.SoftphoneStoreLinks":{"type":"object","description":"Softphone application stores links","properties":{"android":{"type":"string","description":"Android application store link","readOnly":true},"ios":{"type":"string","description":"iOS application store link","readOnly":true},"macos":{"type":"string","description":"MacOS application store link","readOnly":true},"windows":{"type":"string","description":"Windows application store link","readOnly":true}}},"telephony.SoftphoneTheme":{"type":"object","description":"Softphone theme information","properties":{"color":{"type":"string","description":"Theme main color code","readOnly":true},"themeId":{"type":"integer","description":"Theme ID","readOnly":true}}},"telephony.SoftphoneThemeInput":{"type":"object","description":"Softphone theme update inputs","properties":{"themeId":{"type":"integer","description":"Theme ID"}},"required":["themeId"]},"telephony.SoftphoneToken":{"type":"object","description":"Softphone provisioning token","properties":{"token":{"type":"string","description":"Provisioning token used to register device","format":"password","readOnly":true}}},"telephony.SoftphoneTokenInput":{"type":"object","description":"Softphone token input","properties":{"email":{"type":"string","description":"Email to receive the generated provisioning token"}}},"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"]},"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/accessories":{"get":{"summary":"Get all available accessories","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"brand","description":"Phone brand","schema":{"type":"string"}},{"in":"query","name":"country","description":"The country","required":true,"schema":{"$ref":"#/components/schemas/telephony.ServiceNumberCountryEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/telephony.AccessoryOffer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Billing Accounts","Orders"],["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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/accessories\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/accessories\");\n\nprint_r($result);\n?>"}]}},"/telephony/softphone/storeLinks":{"get":{"operationId":"getTelephonySoftphoneStoreLinks","summary":"Get the softphone store links","description":"Returns the links to download the softphone application for Android, iOS, macOS and Windows.","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.SoftphoneStoreLinks"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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/softphone/storeLinks\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/softphone/storeLinks\");\n\nprint_r($result);\n?>"}]}},"/telephony/softphone/themes":{"get":{"operationId":"getAllTelephonySoftphoneThemes","summary":"List softphone themes","description":"Returns the identifiers of the available softphone themes.","security":[{"oAuth2AuthCode":[]}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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/softphone/themes\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/softphone/themes\");\n\nprint_r($result);\n?>"}],"x-expanded-response":"TelephonySoftphoneTheme"}},"/telephony/softphone/themes/{themeId}":{"get":{"operationId":"getTelephonySoftphoneTheme","summary":"Get a softphone theme","description":"Returns the softphone theme and its main color code.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"themeId","description":"Theme ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.SoftphoneTheme"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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/softphone/themes/{themeId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/softphone/themes/{themeId}\");\n\nprint_r($result);\n?>"}],"x-response-identifier":"themeId"}},"/telephony/spare":{"get":{"summary":"List spare phones","description":"List spare phones. Returns the spare phones of the customer. A spare phone can replace a phone of a line, with the same protocol.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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/spare\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/spare\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:spare/get","required":true}],"x-expanded-response":"SpareTelephonyTelephonySpareWithIAM"}},"/telephony/spare/brands":{"get":{"summary":"Get all available spare brands","responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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/spare/brands\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/spare/brands\");\n\nprint_r($result);\n?>"}]}},"/telephony/spare/{spare}":{"delete":{"summary":"Delete a spare phone","description":"Delete a spare phone. Removes the spare phone from the customer account, as if it no longer belonged to OVHcloud.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"spare","description":"The internal name of your spare","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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/spare/{spare}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/telephony/spare/{spare}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:spare/delete","required":true}]},"get":{"summary":"Get a spare phone","description":"Get a spare phone. Returns the spare phone: MAC address, brand and model, and its telephony protocol.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"spare","description":"The internal name of your spare","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/spare.telephony.TelephonySpareWithIAM"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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/spare/{spare}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/spare/{spare}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:spare/get","required":true}]}},"/telephony/spare/{spare}/compatibleReplacement":{"get":{"summary":"List phones replaceable by the spare","description":"List phones replaceable by the spare. Returns the phones that the spare can replace. Use one of them to replace a phone with the spare.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"spare","description":"The internal name of your spare","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","SIP Lines","Phones & Softphones@@@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\nresult = client.get(\"/telephony/spare/{spare}/compatibleReplacement\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/spare/{spare}/compatibleReplacement\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:spare/compatibleReplacement/get","required":true}]}},"/telephony/spare/{spare}/replace":{"post":{"summary":"Replace a phone with the spare","description":"Replace a phone with the spare. Replaces the phone of a line, given by its domain and public IP address, with the spare. The replaced phone becomes a spare if it was bought.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"spare","description":"The internal name of your spare","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"The phone to replace by the spare"},"ip":{"description":"Public ip of the phone","$ref":"#/components/schemas/ipv4"}},"required":["domain","ip"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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/spare/{spare}/replace\",\n\tdomain = None, # The phone to replace by the spare (type: string)\n\tip = None, # Public ip of the phone (type: ipv4)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/telephony/spare/{spare}/replace\", array(\n\tdomain => null, // The phone to replace by the spare (type: string)\n\tip => null, // Public ip of the phone (type: ipv4)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:spare/replace","required":true}]}},"/telephony/spare/{spare}/serviceInfos":{"get":{"summary":"Get service information","description":"Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"spare","description":"The internal name of your spare","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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\nresult = client.get(\"/telephony/spare/{spare}/serviceInfos\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/spare/{spare}/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:spare/serviceInfos/get","required":true}]},"put":{"summary":"Update service information","description":"Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"spare","description":"The internal name of your spare","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@70"]],"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: services.Service\nresult = client.put(\"/telephony/spare/{spare}/serviceInfos\",\n\trenew = None, # Way of handling the renew (type: service.RenewType, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: services.Service\n$result = $ovh->put(\"/telephony/spare/{spare}/serviceInfos\", array(\n\trenew => null, // Way of handling the renew (type: service.RenewType, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:spare/serviceInfos/edit","required":true}]}},"/telephony/{billingAccount}/availableDevices":{"get":{"summary":"List phone devices","description":"List phone devices. Returns the phone devices of the billing account: brand, MAC address, maximum and available lines, and the lines assigned to each one.","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":{"$ref":"#/components/schemas/telephony.AvailableDevice"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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}/availableDevices\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/availableDevices\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:availableDevices/get","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/activateNewPhone":{"get":{"summary":"Check for a new phone to activate","description":"Check for a new phone to activate. Checks whether a new phone is waiting to be activated on the line, after a phone switch.","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","SIP Lines","Phones & Softphones@@@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\nresult = client.get(\"/telephony/{billingAccount}/line/{serviceName}/activateNewPhone\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/activateNewPhone\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/activateNewPhone/get","required":true}]},"post":{"summary":"Activate a new phone","description":"Activate a new phone. Activates the new phone on the line, after a phone switch. Check first that a new phone is waiting to be activated.","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","SIP Lines","Phones & Softphones@@@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\nresult = client.post(\"/telephony/{billingAccount}/line/{serviceName}/activateNewPhone\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/activateNewPhone\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/activateNewPhone/create","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/associateDevice":{"post":{"summary":"Associate a device","description":"Associate a device. Associates a phone with the line, using the phone MAC address (AABBCCDDEEFF), its public IP address and the slot of the line on the phone.","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":{"ipAddress":{"description":"The public phone IP address allowed to get phone's configuration","$ref":"#/components/schemas/ipv4"},"macAddress":{"type":"string","description":"The mac address of the device you want to associate to the line (format: AABBCCDDEEFF)"},"slot":{"type":"integer","description":"The slot or line position on the device (from 1 to N. N is the maximum number of lines/slots available on the device)"}},"required":["macAddress"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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\n# Request body type: long\nresult = client.post(\"/telephony/{billingAccount}/line/{serviceName}/associateDevice\",\n\tipAddress = None, # The public phone IP address allowed to get phone's configuration (type: ipv4, nullable)\n\tmacAddress = None, # The mac address of the device you want to associate to the line (format: AABBCCDDEEFF) (type: string)\n\tslot = None, # The slot or line position on the device (from 1 to N. N is the maximum number of lines/slots available on the device) (type: long, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: long\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/associateDevice\", array(\n\tipAddress => null, // The public phone IP address allowed to get phone's configuration (type: ipv4, nullable)\n\tmacAddress => null, // The mac address of the device you want to associate to the line (format: AABBCCDDEEFF) (type: string)\n\tslot => null, // The slot or line position on the device (from 1 to N. N is the maximum number of lines/slots available on the device) (type: long, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/associateDevice/create","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/dissociateDevice":{"post":{"summary":"Dissociate a device","description":"Dissociate a device. Dissociates a phone from the line, using the phone MAC address (AABBCCDDEEFF) and its public IP address.","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":{"ipAddress":{"description":"The public phone IP address allowed to get phone's configuration","$ref":"#/components/schemas/ipv4"},"macAddress":{"type":"string","description":"The mac address of the device you want to dissociate from the line (format: AABBCCDDEEFF)"}},"required":["macAddress"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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.post(\"/telephony/{billingAccount}/line/{serviceName}/dissociateDevice\",\n\tipAddress = None, # The public phone IP address allowed to get phone's configuration (type: ipv4, nullable)\n\tmacAddress = None, # The mac address of the device you want to dissociate from the line (format: AABBCCDDEEFF) (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/dissociateDevice\", array(\n\tipAddress => null, // The public phone IP address allowed to get phone's configuration (type: ipv4, nullable)\n\tmacAddress => null, // The mac address of the device you want to dissociate from the line (format: AABBCCDDEEFF) (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/dissociateDevice/create","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/listAssociablePhones":{"get":{"summary":"List associable phones","description":"List associable phones. Returns the phones with a free slot that the line can be attached to, with their brand, protocol, attached lines and maximum number of lines.","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.LinePhoneAssociable"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@130"]],"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}/line/{serviceName}/listAssociablePhones\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/listAssociablePhones\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/listAssociablePhones/get","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone":{"get":{"summary":"Get the phone","description":"Get the phone. Returns the phone attached to the line: brand, MAC address, protocol, description, maximum lines and simultaneous calls, and configuration.","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.Phone"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@140"]],"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}/line/{serviceName}/phone\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/get","required":true}]},"put":{"summary":"Update the phone","description":"Update the phone. Updates the phone attached to the line: the IP address restriction of an MGCP phone.","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.Phone"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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\n# Request body type: telephony.Phone\nresult = client.put(\"/telephony/{billingAccount}/line/{serviceName}/phone\",\n\tmgcpIpRestriction = None, # The ip restriction of your MGCP phone (type: ip, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.Phone\n$result = $ovh->put(\"/telephony/{billingAccount}/line/{serviceName}/phone\", array(\n\tmgcpIpRestriction => null, // The ip restriction of your MGCP phone (type: ip, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/edit","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/adminCredentials":{"get":{"summary":"Get the phone admin credentials","description":"Get the phone admin credentials. Returns the administration login and password of the phone. Available to VIP customers only.","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.PhoneCredentials"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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\nresult = client.get(\"/telephony/{billingAccount}/line/{serviceName}/phone/adminCredentials\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/adminCredentials\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/adminCredentials/get","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/changePhoneConfiguration":{"post":{"summary":"Change the phone configuration","description":"Change the phone configuration. Changes the phone configuration remotely with name value pairs of provisioning options, and can reboot the phone to apply them.","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":{"autoReboot":{"type":"boolean","description":"Automatically reboot phone when applying the configuration"},"newConfigurations":{"type":"array","description":"Name value pairs of provisioning options","items":{"$ref":"#/components/schemas/complexType.SafeKeyValue_string"}}}}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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.post(\"/telephony/{billingAccount}/line/{serviceName}/phone/changePhoneConfiguration\",\n\tautoReboot = None, # Automatically reboot phone when applying the configuration (type: boolean, nullable)\n\tnewConfigurations = None, # Name value pairs of provisioning options (type: complexType.SafeKeyValue<string>[], nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/phone/changePhoneConfiguration\", array(\n\tautoReboot => null, // Automatically reboot phone when applying the configuration (type: boolean, nullable)\n\tnewConfigurations => null, // Name value pairs of provisioning options (type: complexType.SafeKeyValue<string>[], nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/changePhoneConfiguration","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/functionKey":{"get":{"summary":"List function keys","description":"List function keys. Returns the numbers (keyNum) of the function keys of the phone. Get a function key for its label, type and active function.","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":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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}/line/{serviceName}/phone/functionKey\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/functionKey\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/functionKey/get","required":true}],"x-expanded-response":"TelephonyFunctionKey"}},"/telephony/{billingAccount}/line/{serviceName}/phone/functionKey/{keyNum}":{"get":{"summary":"Get a function key","description":"Get a function key. Returns the function key of the phone: number, label, type, default function, active function and its parameter.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"keyNum","description":"The number of the function key","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.FunctionKey"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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}/line/{serviceName}/phone/functionKey/{keyNum}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/functionKey/{keyNum}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/functionKey/get","required":true}]},"put":{"summary":"Update a function key","description":"Update a function key. Updates the function active on the key and its parameter. The available functions are listed for each key.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"keyNum","description":"The number of the function key","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.FunctionKey"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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\n# Request body type: telephony.FunctionKey\nresult = client.put(\"/telephony/{billingAccount}/line/{serviceName}/phone/functionKey/{keyNum}\",\n\tfunction = None, # The function active on the key (type: string, nullable)\n\tparameter = None, # The function parameter (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.FunctionKey\n$result = $ovh->put(\"/telephony/{billingAccount}/line/{serviceName}/phone/functionKey/{keyNum}\", array(\n\tfunction => null, // The function active on the key (type: string, nullable)\n\tparameter => null, // The function parameter (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/functionKey/edit","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/functionKey/{keyNum}/availableFunction":{"get":{"summary":"List available functions","description":"List available functions. Returns the functions that can be set on the function key. Set one with the function and parameter of the key.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"keyNum","description":"The number of the function key","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","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","SIP Lines","Phones & Softphones@@@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}/line/{serviceName}/phone/functionKey/{keyNum}/availableFunction\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/functionKey/{keyNum}/availableFunction\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/functionKey/availableFunction/get","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/merchandiseAvailable":{"get":{"summary":"List exchange phones","description":"List exchange phones. Returns the phones available to exchange the current phone, with their name, description, URL and price.","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.HardwareOffer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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}/line/{serviceName}/phone/merchandiseAvailable\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/merchandiseAvailable\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/merchandiseAvailable/get","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook":{"get":{"summary":"List phonebooks","description":"List phonebooks. Returns the identifiers (bookKey) of the phonebooks of the phone. Check first that the phone supports phonebooks.","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":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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}/line/{serviceName}/phone/phonebook\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/get","required":true}],"x-expanded-response":"TelephonyPhonebook"},"post":{"summary":"Create a phonebook","description":"Create a phonebook. Creates a phonebook on the phone of the line, if the phone supports phonebooks. Returns its identifier (bookKey).","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":{"name":{"type":"string","description":"Name of the wanted phonebook"}},"required":["name"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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\n# Request body type: string\nresult = client.post(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook\",\n\tname = None, # Name of the wanted phonebook (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook\", array(\n\tname => null, // Name of the wanted phonebook (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/create","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}":{"delete":{"summary":"Delete a phonebook","description":"Delete a phonebook. Deletes the phonebook of the phone and its contacts. Export the contacts first to keep a copy.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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","SIP Lines","Phones & Softphones@@@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.delete(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/delete","required":true}]},"get":{"summary":"Get a phonebook","description":"Get a phonebook. Returns the phonebook of the phone: name, identifier (bookKey), phone key and whether it is read-only.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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.Phonebook"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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\nresult = client.get(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/get","required":true}]},"put":{"summary":"Update a phonebook","description":"Update a phonebook. Updates the name of the phonebook of the phone. Contacts are updated one by one with the phonebookContact route.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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.Phonebook"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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\n# Request body type: telephony.Phonebook\nresult = client.put(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}\",\n\tisReadonly = None, # Set if phonebook is readonly (type: boolean)\n\tname = None, # Phonebook name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.Phonebook\n$result = $ovh->put(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}\", array(\n\tisReadonly => null, // Set if phonebook is readonly (type: boolean)\n\tname => null, // Phonebook name (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/edit","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/export":{"get":{"summary":"Export contacts","description":"Export contacts. Exports the contacts of the phonebook to a file in CSV format. Returns the file to download.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"query","name":"format","description":"Format of the file","required":true,"schema":{"$ref":"#/components/schemas/telephony.ContactsExportFormatsEnum"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PcsFile"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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}/line/{serviceName}/phone/phonebook/{bookKey}/export\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/export\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/export/get","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/import":{"post":{"summary":"Import contacts","description":"Import contacts. Imports contacts into the phonebook from an Excel (.xls, .xlsx) or CSV file in /me/document. Returns the task that performs the import.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","description":"ID of the /me/document file you want to import"}},"required":["documentId"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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\n# Request body type: string\nresult = client.post(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/import\",\n\tdocumentId = None, # ID of the /me/document file you want to import (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/import\", array(\n\tdocumentId => null, // ID of the /me/document file you want to import (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/import","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact":{"get":{"summary":"List contacts","description":"List contacts. Returns the identifiers of the contacts of the phonebook. Get a contact for its name, group and phone numbers.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@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}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/phonebookContact/get","required":true}],"x-expanded-response":"TelephonyPhonebookContact"},"post":{"summary":"Create a contact","description":"Create a contact. Creates a contact in the phonebook with a name, surname, group and phone numbers. Returns its identifier.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"group":{"type":"string","description":"Group name of the phonebook"},"homeMobile":{"description":"Home mobile phone number of the contact","$ref":"#/components/schemas/phoneNumber"},"homePhone":{"description":"Home landline phone number of the contact","$ref":"#/components/schemas/phoneNumber"},"name":{"type":"string","description":"Name of the contact"},"surname":{"type":"string","description":"Contact surname"},"workMobile":{"description":"Mobile phone office number of the contact","$ref":"#/components/schemas/phoneNumber"},"workPhone":{"description":"Landline phone office number of the contact","$ref":"#/components/schemas/phoneNumber"}},"required":["group","name","surname"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"integer"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@320"]],"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: phoneNumber\nresult = client.post(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact\",\n\tgroup = None, # Group name of the phonebook (type: string)\n\thomeMobile = None, # Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone = None, # Home landline phone number of the contact (type: phoneNumber, nullable)\n\tname = None, # Name of the contact (type: string)\n\tsurname = None, # Contact surname (type: string)\n\tworkMobile = None, # Mobile phone office number of the contact (type: phoneNumber, nullable)\n\tworkPhone = None, # Landline phone office number of the contact (type: phoneNumber, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: phoneNumber\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact\", array(\n\tgroup => null, // Group name of the phonebook (type: string)\n\thomeMobile => null, // Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone => null, // Home landline phone number of the contact (type: phoneNumber, nullable)\n\tname => null, // Name of the contact (type: string)\n\tsurname => null, // Contact surname (type: string)\n\tworkMobile => null, // Mobile phone office number of the contact (type: phoneNumber, nullable)\n\tworkPhone => null, // Landline phone office number of the contact (type: phoneNumber, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/phonebookContact/create","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact/{id}":{"delete":{"summary":"Delete a contact","description":"Delete a contact. Deletes the contact from the phonebook, with its name, group and office and home phone numbers.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Contact identifier","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@330"]],"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}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/phonebookContact/delete","required":true}]},"get":{"summary":"Get a contact","description":"Get a contact. Returns the contact of the phonebook: name, surname, group, and office and home phone numbers, landline and mobile.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Contact identifier","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.PhonebookContact"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@310"]],"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}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/phonebookContact/get","required":true}]},"put":{"summary":"Update a contact","description":"Update a contact. Updates the contact of the phonebook: name, surname, group, and office and home phone numbers, landline and mobile.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Contact identifier","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PhonebookContact"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@340"]],"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.PhonebookContact\nresult = client.put(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact/{id}\",\n\tgroup = None, # Group name of the phonebook (type: string)\n\thomeMobile = None, # Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone = None, # Home landline phone number of the contact (type: phoneNumber, nullable)\n\tname = None, # Contact name (type: string)\n\tsurname = None, # Contact surname (type: string)\n\tworkMobile = None, # Mobile phone office number of the contact (type: phoneNumber, nullable)\n\tworkPhone = None, # Landline phone office number of the contact (type: phoneNumber, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.PhonebookContact\n$result = $ovh->put(\"/telephony/{billingAccount}/line/{serviceName}/phone/phonebook/{bookKey}/phonebookContact/{id}\", array(\n\tgroup => null, // Group name of the phonebook (type: string)\n\thomeMobile => null, // Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone => null, // Home landline phone number of the contact (type: phoneNumber, nullable)\n\tname => null, // Contact name (type: string)\n\tsurname => null, // Contact surname (type: string)\n\tworkMobile => null, // Mobile phone office number of the contact (type: phoneNumber, nullable)\n\tworkPhone => null, // Landline phone office number of the contact (type: phoneNumber, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/phonebook/phonebookContact/edit","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/reboot":{"post":{"summary":"Reboot the phone","description":"Reboot the phone. Reboots the phone attached to the line. Returns the task that tracks the reboot, to follow its status.","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.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@350"]],"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}/line/{serviceName}/phone/reboot\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/phone/reboot\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/reboot","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/refreshScreen":{"post":{"summary":"Refresh the phone screen","description":"Refresh the phone screen. Refreshes the screen of the MGCP phone. Returns the task that tracks the refresh.","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.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@360"]],"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}/line/{serviceName}/phone/refreshScreen\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/phone/refreshScreen\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/refreshScreen","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/resetConfig":{"post":{"summary":"Reset the phone configuration","description":"Reset the phone configuration. Resets the phone configuration to its default values, for the given public IP address. Returns the reset code and the reset method.","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":{"ip":{"description":"The public ip phone allowed for reset","$ref":"#/components/schemas/ipv4"}},"required":["ip"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.ResetPhoneInfo"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@370"]],"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: ipv4\nresult = client.post(\"/telephony/{billingAccount}/line/{serviceName}/phone/resetConfig\",\n\tip = None, # The public ip phone allowed for reset (type: ipv4)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: ipv4\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/phone/resetConfig\", array(\n\tip => null, // The public ip phone allowed for reset (type: ipv4)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/resetConfig","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/rma":{"get":{"summary":"List RMAs","description":"List RMAs. Returns the identifiers of the RMAs of the phone. An RMA is a request to return or exchange a phone.","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":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@380"]],"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}/line/{serviceName}/phone/rma\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/rma\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/rma/get","required":true}],"x-expanded-response":"TelephonyRma"},"post":{"summary":"Create an RMA","description":"Create an RMA. Creates an RMA to return the phone and keep the service, or to exchange it for another phone. Returns the RMA identifier.","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":{"mondialRelayId":{"type":"string","description":"Use /supply/mondialRelay entry point to specify a relay point and ignore shipping contact address information entry."},"newMerchandise":{"type":"string","description":"New merchandise brand in case of exchange"},"shippingContactId":{"type":"integer","description":"Shipping contact information id from /me entry point"},"type":{"description":"Typology process of merchandise return","$ref":"#/components/schemas/telephony.RmaPublicTypeEnum"}},"required":["type"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.RmaReturn"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@400"]],"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}/line/{serviceName}/phone/rma\",\n\tmondialRelayId = None, # Use /supply/mondialRelay entry point to specify a relay point and ignore shipping contact address information entry. (type: string, nullable)\n\tnewMerchandise = None, # New merchandise brand in case of exchange (type: string, nullable)\n\tshippingContactId = None, # Shipping contact information id from /me entry point (type: long, nullable)\n\ttype = None, # Typology process of merchandise return (type: telephony.RmaPublicTypeEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/phone/rma\", array(\n\tmondialRelayId => null, // Use /supply/mondialRelay entry point to specify a relay point and ignore shipping contact address information entry. (type: string, nullable)\n\tnewMerchandise => null, // New merchandise brand in case of exchange (type: string, nullable)\n\tshippingContactId => null, // Shipping contact information id from /me entry point (type: long, nullable)\n\ttype => null, // Typology process of merchandise return (type: telephony.RmaPublicTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/rma/create","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/rma/{id}":{"delete":{"summary":"Cancel an RMA","description":"Cancel an RMA. Cancels the RMA of the phone. Only an RMA marked as cancellable, as returned when getting the RMA, can be cancelled.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Return merchandise authorisation identifier","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","SIP Lines","Phones & Softphones@@@410"]],"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}/line/{serviceName}/phone/rma/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/telephony/{billingAccount}/line/{serviceName}/phone/rma/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/rma/delete","required":true}]},"get":{"summary":"Get an RMA","description":"Get an RMA. Returns the RMA: type, process, status and steps, creation, reception and termination dates, equipment reference and shipping contact.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Return merchandise authorisation identifier","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.Rma"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@390"]],"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}/line/{serviceName}/phone/rma/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/rma/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/rma/get","required":true}]},"put":{"summary":"Update an RMA","description":"Update an RMA. Updates the shipping contact used for an exchange and the process determined for the returned phone.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Return merchandise authorisation identifier","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.Rma"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@420"]],"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.Rma\nresult = client.put(\"/telephony/{billingAccount}/line/{serviceName}/phone/rma/{id}\",\n\tprocess = None, # Process determined for merchandise returned (type: telephony.RmaReplaceTypeEnum)\n\tshippingContact = None, # Contact information related to the delivery shipping in case of exchange (type: telephony.Contact)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.Rma\n$result = $ovh->put(\"/telephony/{billingAccount}/line/{serviceName}/phone/rma/{id}\", array(\n\tprocess => null, // Process determined for merchandise returned (type: telephony.RmaReplaceTypeEnum)\n\tshippingContact => null, // Contact information related to the delivery shipping in case of exchange (type: telephony.Contact)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/rma/edit","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/rma/{id}/changeType":{"post":{"summary":"Change the RMA type","description":"Change the RMA type. Changes the type of the RMA to a termination (resiliate) or a phone restitution (toSip).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Return merchandise authorisation identifier","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"description":"new RMA type","$ref":"#/components/schemas/telephony.RmaChangeTypeEnum"}},"required":["type"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@430"]],"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.RmaChangeTypeEnum\nresult = client.post(\"/telephony/{billingAccount}/line/{serviceName}/phone/rma/{id}/changeType\",\n\ttype = None, # new RMA type (type: telephony.RmaChangeTypeEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.RmaChangeTypeEnum\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/phone/rma/{id}/changeType\", array(\n\ttype => null, // new RMA type (type: telephony.RmaChangeTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/rma/changeType","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phone/supportsPhonebook":{"get":{"summary":"Check phonebook support","description":"Check phonebook support. Returns whether the phone supports phonebooks. Phonebooks can be created on the phone only when it does.","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":"boolean"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@440"]],"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}/line/{serviceName}/phone/supportsPhonebook\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phone/supportsPhonebook\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phone/supportsPhonebook/get","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/phoneCanBeAssociable":{"get":{"summary":"List phones with a free SIP slot","description":"List phones with a free SIP slot. Returns the phones with a free SIP slot for the line: brand, protocol, maximum number of lines, price and fees.","deprecated":true,"x-deprecation-date":"2017-05-09T10:00:00+01:00","x-deletion-date":"2016-11-09T10:00:00+01:00","x-replacement-route":"/telephony/{billingAccount}/line/{serviceName}/listAssociablePhones","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.LinePhone"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@450"]],"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}/line/{serviceName}/phoneCanBeAssociable\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/phoneCanBeAssociable\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/phoneCanBeAssociable/get","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/softphone/beta":{"get":{"operationId":"getTelephonyLineSoftphoneBeta","summary":"Get the softphone beta status","description":"Returns whether the softphone beta is enabled on the line.","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.SoftphoneBetaStatus"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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}/line/{serviceName}/softphone/beta\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/softphone/beta\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/beta/get","required":true}]},"put":{"operationId":"editTelephonyLineSoftphoneBeta","summary":"Update the softphone beta status","description":"Enables or disables the softphone beta on the line.","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.SoftphoneBetaStatus"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.SoftphoneBetaStatus"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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.SoftphoneBetaStatus\nresult = client.put(\"/telephony/{billingAccount}/line/{serviceName}/softphone/beta\",\n\tenabled = None, # Whether Softphone beta is enabled or disabled (type: boolean)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.SoftphoneBetaStatus\n$result = $ovh->put(\"/telephony/{billingAccount}/line/{serviceName}/softphone/beta\", array(\n\tenabled => null, // Whether Softphone beta is enabled or disabled (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/beta/edit","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/softphone/devices":{"get":{"operationId":"getTelephonyLineSoftphoneDevices","summary":"List softphone devices","description":"Returns the softphone devices registered on the line: name, operating system, user agent and last registration date.","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.SoftphoneDevices"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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}/line/{serviceName}/softphone/devices\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/softphone/devices\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/devices/get","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/softphone/devices/disconnect":{"post":{"operationId":"disconnectTelephonyLineSoftphoneDevices","summary":"Disconnect all softphone devices","description":"Disconnects every softphone device registered on the line.","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","SIP Lines","Phones & Softphones"]],"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}/line/{serviceName}/softphone/devices/disconnect\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/softphone/devices/disconnect\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/devices/disconnect","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/softphone/devices/{deviceId}":{"delete":{"operationId":"deleteTelephonyLineSoftphoneDevice","summary":"Delete a softphone device","description":"Deletes a softphone device registered on the line.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"deviceId","description":"Device ID","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","SIP Lines","Phones & Softphones"]],"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}/line/{serviceName}/softphone/devices/{deviceId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/telephony/{billingAccount}/line/{serviceName}/softphone/devices/{deviceId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/devices/delete","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/softphone/logo":{"delete":{"operationId":"deleteTelephonyLineSoftphoneLogo","summary":"Delete the line softphone logo","description":"Deletes the softphone logo of the line.","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","SIP Lines","Phones & Softphones"]],"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}/line/{serviceName}/softphone/logo\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/telephony/{billingAccount}/line/{serviceName}/softphone/logo\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/logo/delete","required":true}]},"get":{"operationId":"getTelephonyLineSoftphoneLogo","summary":"Get the line softphone logo","description":"Returns the softphone logo of the line: file name and download URL.","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.SoftphoneLogo"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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}/line/{serviceName}/softphone/logo\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/softphone/logo\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/logo/get","required":true}]},"put":{"operationId":"editTelephonyLineSoftphoneLogo","summary":"Update the line softphone logo","description":"Sets the softphone logo of the line from a file name and a URL.","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.SoftphoneLogo"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.SoftphoneLogo"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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.SoftphoneLogo\nresult = client.put(\"/telephony/{billingAccount}/line/{serviceName}/softphone/logo\",\n\tfilename = None, # Logo filename (type: string)\n\turl = None, # URL used to download logo (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.SoftphoneLogo\n$result = $ovh->put(\"/telephony/{billingAccount}/line/{serviceName}/softphone/logo\", array(\n\tfilename => null, // Logo filename (type: string)\n\turl => null, // URL used to download logo (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/logo/edit","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/softphone/status":{"get":{"operationId":"getTelephonyLineSoftphoneStatus","summary":"Get the line softphone status","description":"Returns the softphone status of the line: eligibility, beta activation and infrastructure.","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.SoftphoneStatus"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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}/line/{serviceName}/softphone/status\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/softphone/status\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/status/get","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/softphone/theme":{"delete":{"operationId":"deleteTelephonyLineSoftphoneTheme","summary":"Delete the line softphone theme","description":"Deletes the softphone theme of the line.","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","SIP Lines","Phones & Softphones"]],"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}/line/{serviceName}/softphone/theme\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/telephony/{billingAccount}/line/{serviceName}/softphone/theme\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/theme/delete","required":true}]},"get":{"operationId":"getTelephonyLineSoftphoneTheme","summary":"Get the line softphone theme","description":"Returns the softphone theme of the line and its main color code.","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.SoftphoneTheme"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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}/line/{serviceName}/softphone/theme\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/line/{serviceName}/softphone/theme\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/theme/get","required":true}],"x-response-identifier":"themeId"},"put":{"operationId":"editTelephonyLineSoftphoneTheme","summary":"Update the line softphone theme","description":"Sets the softphone theme of the line from a theme identifier.","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.SoftphoneThemeInput"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.SoftphoneTheme"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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.SoftphoneThemeInput\nresult = client.put(\"/telephony/{billingAccount}/line/{serviceName}/softphone/theme\",\n\tthemeId = None, # Theme ID (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.SoftphoneThemeInput\n$result = $ovh->put(\"/telephony/{billingAccount}/line/{serviceName}/softphone/theme\", array(\n\tthemeId => null, // Theme ID (type: integer)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/theme/edit","required":true}]}},"/telephony/{billingAccount}/line/{serviceName}/softphone/token":{"post":{"operationId":"createTelephonyLineSoftphoneToken","summary":"Generate a provisioning token","description":"Generates a token to register a softphone device on the line, and sends it to the given email address.","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.SoftphoneTokenInput"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.SoftphoneToken"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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.SoftphoneTokenInput\nresult = client.post(\"/telephony/{billingAccount}/line/{serviceName}/softphone/token\",\n\temail = None, # Email to receive the generated provisioning token (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.SoftphoneTokenInput\n$result = $ovh->post(\"/telephony/{billingAccount}/line/{serviceName}/softphone/token\", array(\n\temail => null, // Email to receive the generated provisioning token (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:line/softphone/token/create","required":true}]}},"/telephony/{billingAccount}/oldPhone":{"get":{"summary":"List unreturned old phones","description":"List unreturned old phones. Returns the old phones not returned after an RMA, with their model and MAC address.","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":{"$ref":"#/components/schemas/telephony.OldPhone"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@460"]],"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}/oldPhone\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/oldPhone\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:oldPhone/get","required":true}]}},"/telephony/{billingAccount}/phonebook":{"get":{"summary":"List phonebooks","description":"List phonebooks. Returns the identifiers (bookKey) of the phonebooks shared by the billing account. A phonebook stores contacts with their phone numbers.","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","SIP Lines","Phones & Softphones@@@470"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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}/phonebook\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/phonebook\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/get","required":true}],"x-expanded-response":"TelephonyPhonebookMaster"},"post":{"summary":"Create a phonebook","description":"Create a phonebook. Creates a phonebook shared by the billing account. Returns its identifier (bookKey).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the wanted phonebook"}},"required":["name"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@490"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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\n# Request body type: string\nresult = client.post(\"/telephony/{billingAccount}/phonebook\",\n\tname = None, # Name of the wanted phonebook (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/telephony/{billingAccount}/phonebook\", array(\n\tname => null, // Name of the wanted phonebook (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/create","required":true}]}},"/telephony/{billingAccount}/phonebook/{bookKey}":{"delete":{"summary":"Delete a phonebook","description":"Delete a phonebook. Deletes the phonebook shared by the billing account and its contacts. Export the contacts first to keep a copy.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@500"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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\nresult = client.delete(\"/telephony/{billingAccount}/phonebook/{bookKey}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/telephony/{billingAccount}/phonebook/{bookKey}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/delete","required":true}]},"get":{"summary":"Get a phonebook","description":"Get a phonebook. Returns the name and the identifier (bookKey) of the phonebook shared by the billing account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PhonebookMaster"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@480"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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}/phonebook/{bookKey}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/phonebook/{bookKey}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/get","required":true}]},"put":{"summary":"Update a phonebook","description":"Update a phonebook. Updates the name of the phonebook shared by the billing account. Contacts are updated one by one.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PhonebookMaster"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@510"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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\n# Request body type: telephony.PhonebookMaster\nresult = client.put(\"/telephony/{billingAccount}/phonebook/{bookKey}\",\n\tname = None, # Phone book name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.PhonebookMaster\n$result = $ovh->put(\"/telephony/{billingAccount}/phonebook/{bookKey}\", array(\n\tname => null, // Phone book name (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/edit","required":true}]}},"/telephony/{billingAccount}/phonebook/{bookKey}/export":{"get":{"summary":"Export contacts","description":"Export contacts. Exports the contacts of the phonebook to a file in CSV format. Returns the file to download.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"query","name":"format","description":"Format of the file","required":true,"schema":{"$ref":"#/components/schemas/telephony.ContactsExportFormatsEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PcsFile"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@520"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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\nresult = client.get(\"/telephony/{billingAccount}/phonebook/{bookKey}/export\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/phonebook/{bookKey}/export\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/export/get","required":true}]}},"/telephony/{billingAccount}/phonebook/{bookKey}/import":{"post":{"summary":"Import contacts","description":"Import contacts. Imports contacts into the phonebook from an Excel (.xls, .xlsx) or CSV file in /me/document. Returns the task that performs the import.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","description":"ID of the /me/document file you want to import"}},"required":["documentId"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@530"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@70"]],"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}/phonebook/{bookKey}/import\",\n\tdocumentId = None, # ID of the /me/document file you want to import (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/telephony/{billingAccount}/phonebook/{bookKey}/import\", array(\n\tdocumentId => null, // ID of the /me/document file you want to import (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/import","required":true}]}},"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact":{"get":{"summary":"List contacts","description":"List contacts. Returns the identifiers of the contacts of the phonebook. Get a contact for its name, group and phone numbers.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@540"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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}/phonebook/{bookKey}/phonebookContact\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/phonebookContact/get","required":true}],"x-expanded-response":"TelephonyPhonebookContact"},"post":{"summary":"Create a contact","description":"Create a contact. Creates a contact in the phonebook with a name, surname, group and phone numbers. Returns its identifier.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"group":{"type":"string","description":"Group name of the phonebook"},"homeMobile":{"description":"Home mobile phone number of the contact","$ref":"#/components/schemas/phoneNumber"},"homePhone":{"description":"Home landline phone number of the contact","$ref":"#/components/schemas/phoneNumber"},"name":{"type":"string","description":"Name of the contact"},"surname":{"type":"string","description":"Contact surname"},"workMobile":{"description":"Mobile phone office number of the contact","$ref":"#/components/schemas/phoneNumber"},"workPhone":{"description":"Landline phone office number of the contact","$ref":"#/components/schemas/phoneNumber"}},"required":["group","name","surname"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"integer"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@560"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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: phoneNumber\nresult = client.post(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact\",\n\tgroup = None, # Group name of the phonebook (type: string)\n\thomeMobile = None, # Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone = None, # Home landline phone number of the contact (type: phoneNumber, nullable)\n\tname = None, # Name of the contact (type: string)\n\tsurname = None, # Contact surname (type: string)\n\tworkMobile = None, # Mobile phone office number of the contact (type: phoneNumber, nullable)\n\tworkPhone = None, # Landline phone office number of the contact (type: phoneNumber, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: phoneNumber\n$result = $ovh->post(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact\", array(\n\tgroup => null, // Group name of the phonebook (type: string)\n\thomeMobile => null, // Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone => null, // Home landline phone number of the contact (type: phoneNumber, nullable)\n\tname => null, // Name of the contact (type: string)\n\tsurname => null, // Contact surname (type: string)\n\tworkMobile => null, // Mobile phone office number of the contact (type: phoneNumber, nullable)\n\tworkPhone => null, // Landline phone office number of the contact (type: phoneNumber, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/phonebookContact/create","required":true}]}},"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}":{"delete":{"summary":"Delete a contact","description":"Delete a contact. Deletes the contact from the phonebook, with its name, group and office and home phone numbers.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Contact identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@570"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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.delete(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/phonebookContact/delete","required":true}]},"get":{"summary":"Get a contact","description":"Get a contact. Returns the contact of the phonebook: name, surname, group, and office and home phone numbers, landline and mobile.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Contact identifier","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PhonebookContact"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@550"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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\nresult = client.get(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/phonebookContact/get","required":true}]},"put":{"summary":"Update a contact","description":"Update a contact. Updates the contact of the phonebook: name, surname, group, and office and home phone numbers, landline and mobile.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Contact identifier","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PhonebookContact"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@580"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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\n# Request body type: telephony.PhonebookContact\nresult = client.put(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}\",\n\tgroup = None, # Group name of the phonebook (type: string)\n\thomeMobile = None, # Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone = None, # Home landline phone number of the contact (type: phoneNumber, nullable)\n\tname = None, # Contact name (type: string)\n\tsurname = None, # Contact surname (type: string)\n\tworkMobile = None, # Mobile phone office number of the contact (type: phoneNumber, nullable)\n\tworkPhone = None, # Landline phone office number of the contact (type: phoneNumber, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.PhonebookContact\n$result = $ovh->put(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}\", array(\n\tgroup => null, // Group name of the phonebook (type: string)\n\thomeMobile => null, // Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone => null, // Home landline phone number of the contact (type: phoneNumber, nullable)\n\tname => null, // Contact name (type: string)\n\tsurname => null, // Contact surname (type: string)\n\tworkMobile => null, // Mobile phone office number of the contact (type: phoneNumber, nullable)\n\tworkPhone => null, // Landline phone office number of the contact (type: phoneNumber, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/phonebookContact/edit","required":true}]}},"/telephony/{billingAccount}/softphone/logo":{"delete":{"operationId":"deleteTelephonyBillingAccountSoftphoneLogo","summary":"Delete the billing account softphone logo","description":"Deletes the softphone logo of the billing account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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}/softphone/logo\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/telephony/{billingAccount}/softphone/logo\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:softphone/logo/delete","required":true}]},"get":{"operationId":"getTelephonyBillingAccountSoftphoneLogo","summary":"Get the billing account softphone logo","description":"Returns the softphone logo of the billing account: file name and download URL.","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":{"$ref":"#/components/schemas/telephony.SoftphoneLogo"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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}/softphone/logo\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/softphone/logo\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:softphone/logo/get","required":true}]},"put":{"operationId":"editTelephonyBillingAccountSoftphoneLogo","summary":"Update the billing account softphone logo","description":"Sets the softphone logo of the billing account from a file name and a URL.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.SoftphoneLogo"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.SoftphoneLogo"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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.SoftphoneLogo\nresult = client.put(\"/telephony/{billingAccount}/softphone/logo\",\n\tfilename = None, # Logo filename (type: string)\n\turl = None, # URL used to download logo (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.SoftphoneLogo\n$result = $ovh->put(\"/telephony/{billingAccount}/softphone/logo\", array(\n\tfilename => null, // Logo filename (type: string)\n\turl => null, // URL used to download logo (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:softphone/logo/edit","required":true}]}},"/telephony/{billingAccount}/softphone/theme":{"get":{"operationId":"getTelephonyBillingAccountSoftphoneTheme","summary":"Get the billing account softphone theme","description":"Returns the softphone theme of the billing account and its main color code.","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":{"$ref":"#/components/schemas/telephony.SoftphoneTheme"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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}/softphone/theme\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/telephony/{billingAccount}/softphone/theme\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:softphone/theme/get","required":true}],"x-response-identifier":"themeId"},"put":{"operationId":"editTelephonyBillingAccountSoftphoneTheme","summary":"Update the billing account softphone theme","description":"Sets the softphone theme of the billing account from a theme identifier.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.SoftphoneThemeInput"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.SoftphoneTheme"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones"]],"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.SoftphoneThemeInput\nresult = client.put(\"/telephony/{billingAccount}/softphone/theme\",\n\tthemeId = None, # Theme ID (type: integer)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\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=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: telephony.SoftphoneThemeInput\n$result = $ovh->put(\"/telephony/{billingAccount}/softphone/theme\", array(\n\tthemeId => null, // Theme ID (type: integer)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:softphone/theme/edit","required":true}]}}}}
