{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"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"},"reference.CountryEnum":{"type":"string","description":"All country prices accessible from a reference","enum":["all","ca","cz","de","en","es","fi","fr","gb","ie","it","lt","ma","nl","pl","pp","pt","qc","ru","sk","sn","tn","we"]},"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}}},"sms.Account":{"type":"object","description":"SMS details","properties":{"automaticRecreditAmount":{"allOf":[{"$ref":"#/components/schemas/sms.PackQuantityAutomaticRecreditEnum"}],"nullable":true},"callBack":{"type":"string","description":"URL called when state of a sent SMS changes","nullable":true},"channel":{"allOf":[{"$ref":"#/components/schemas/sms.ChannelEnum"}],"description":"For what purpose this account can be used for","readOnly":true},"creditThresholdForAutomaticRecredit":{"type":"number","description":"Credit threshold after which an automatic recredit is launched"},"creditsHoldByQuota":{"type":"number","readOnly":true},"creditsLeft":{"type":"number","readOnly":true},"description":{"type":"string"},"name":{"type":"string","readOnly":true},"smpp":{"type":"boolean","description":"Whether the account can be used for smpp or not","readOnly":true},"smsResponse":{"$ref":"#/components/schemas/sms.Response"},"status":{"allOf":[{"$ref":"#/components/schemas/sms.StatusAccountEnum"}],"readOnly":true},"stopCallBack":{"type":"string","description":"URL called when a STOP is received after a receiver replied stop to a SMS","nullable":true},"templates":{"$ref":"#/components/schemas/sms.Templates"},"userQuantityWithQuota":{"type":"integer","readOnly":true}}},"sms.AccountWithIAM":{"type":"object","description":"SMS details","properties":{"automaticRecreditAmount":{"allOf":[{"$ref":"#/components/schemas/sms.PackQuantityAutomaticRecreditEnum"}],"nullable":true},"callBack":{"type":"string","description":"URL called when state of a sent SMS changes","nullable":true},"channel":{"allOf":[{"$ref":"#/components/schemas/sms.ChannelEnum"}],"description":"For what purpose this account can be used for","readOnly":true},"creditThresholdForAutomaticRecredit":{"type":"number","description":"Credit threshold after which an automatic recredit is launched"},"creditsHoldByQuota":{"type":"number","readOnly":true},"creditsLeft":{"type":"number","readOnly":true},"description":{"type":"string"},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"name":{"type":"string","readOnly":true},"smpp":{"type":"boolean","description":"Whether the account can be used for smpp or not","readOnly":true},"smsResponse":{"$ref":"#/components/schemas/sms.Response"},"status":{"allOf":[{"$ref":"#/components/schemas/sms.StatusAccountEnum"}],"readOnly":true},"stopCallBack":{"type":"string","description":"URL called when a STOP is received after a receiver replied stop to a SMS","nullable":true},"templates":{"$ref":"#/components/schemas/sms.Templates"},"userQuantityWithQuota":{"type":"integer","readOnly":true}}},"sms.BillingCountryEnum":{"type":"string","description":"Countries where we sell SMS credits","enum":["es","fr","gb","ie","it","pl"]},"sms.ChannelEnum":{"type":"string","description":"In case of smpp the channel can not be \"both\"","enum":["both","marketing","transactional"]},"sms.CountryEnum":{"type":"string","description":"All country suffixes accessible for sms services and \"all\" available","enum":["ad","ae","af","ag","ai","al","all","am","an","ao","ar","at","au","aw","az","ba","bb","bd","be","bf","bg","bh","bi","bj","bm","bn","bo","br","bs","bt","bw","by","bz","ca","cd","cf","cg","ch","ci","ck","cl","cm","cn","co","cr","cu","cv","cy","cz","de","dk","dm","dz","ec","ee","eg","es","et","fi","fj","fk","fo","fr","ga","gb","gd","ge","gf","gh","gi","gl","gm","gn","gp","gq","gr","gt","gu","gw","gy","hk","hn","hr","ht","hu","id","ie","il","in","io","iq","ir","is","it","jm","jo","jp","ke","kg","kh","km","kn","kr","kw","ky","kz","la","lb","lc","li","lk","lr","ls","lt","lu","lv","ly","ma","md","me","mg","mk","ml","mn","mo","mq","mr","ms","mt","mu","mv","mw","mx","my","mz","na","nc","ne","ng","ni","nl","no","np","nz","om","pa","pe","pf","pg","ph","pk","pl","ps","pt","py","qa","re","ro","rs","ru","rw","sa","sb","sc","sd","se","sg","si","sk","sl","sm","sn","so","sr","st","sv","sy","sz","tc","td","tg","th","tj","tl","tm","tn","to","tr","tt","tw","tz","ua","ug","us","uy","uz","vc","ve","vg","vi","vn","vu","ws","ye","yt","za","zm","zw"]},"sms.DestinationRates":{"type":"object","description":"Rates of a given destination","properties":{"country":{"type":"string","description":"The country full name"},"countryCode":{"allOf":[{"$ref":"#/components/schemas/sms.CountryEnum"}],"description":"The country 2-letters code"},"credit":{"type":"number","description":"Credits consumed by sending one SMS towards the given destination"},"price":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Price of one SMS sent towards the given destination"},"vatRate":{"type":"number","description":"The VAT rate applied from the provided billing country."}}},"sms.DocumentWayTypeEnum":{"type":"string","description":"Way type","enum":["incoming","outgoing"]},"sms.Exception":{"type":"object","description":"Sms reach list","properties":{"countrySuffixe":{"type":"string","description":"The abreviated country code.","readOnly":true},"messages":{"type":"array","description":"The exception message","items":{"type":"string"},"readOnly":true},"operators":{"type":"string","description":"The list of operators impacted.","readOnly":true},"restrictionCode":{"allOf":[{"$ref":"#/components/schemas/sms.RestrictionCodeEnum"}],"description":"The type of routing restriction imposed by the operator","readOnly":true},"substitution":{"type":"string","description":"The substitution sender used to bypass operator filter","nullable":true,"readOnly":true}}},"sms.PackDetails":{"type":"object","description":"Details about a SMS pack","properties":{"countryCode":{"allOf":[{"$ref":"#/components/schemas/sms.CountryEnum"}],"description":"Destination country code"},"credit":{"type":"number","description":"Credits consumed by sending one SMS towards the given destination"},"creditPrice":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Price of one credit, including pack's promotion"},"creditQuantityMax":{"type":"integer","description":"Maximum quantity (excluded) of credit to order to have this price","nullable":true},"creditQuantityMin":{"type":"integer","description":"Minimum quantity (included) of credit to order to have this price"},"discountCreditPrice":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Price of one credit, during a promotional event","nullable":true},"discountPercentage":{"type":"integer","description":"Percentage applied as part of a promotional event","nullable":true},"discountSmsPrice":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Price of one SMS, during a promotional event","nullable":true},"smsPrice":{"allOf":[{"$ref":"#/components/schemas/order.Price"}],"description":"Price of one SMS sent towards the given destination, including pack's promotion"},"smsQuantityMax":{"type":"integer","description":"Maximum quantity (excluded) of SMS you can obtain with this pack","nullable":true},"smsQuantityMin":{"type":"integer","description":"Minimum quantity (included) of SMS you can obtain with this pack"},"vatRate":{"type":"number","description":"The VAT rate applied from the provided billing country."}}},"sms.PackOffer":{"type":"object","description":"A structure describing all information about an sms pack offer","properties":{"countryDestination":{"type":"string"},"giftPrice":{"type":"number","nullable":true},"giftQuantity":{"type":"number","nullable":true},"language":{"type":"string"},"price":{"type":"number"},"quantity":{"type":"integer"},"smsQuantity":{"type":"number"},"totalPrice":{"type":"number","nullable":true}}},"sms.PackQuantityAutomaticRecreditEnum":{"type":"integer","description":"Pack quantity automatic recredit possibilities","enum":[100,200,250,500,1000,5000,10000]},"sms.PackQuantityEnum":{"type":"integer","description":"Pack quantity levels","enum":[100,200,250,500,1000,2500,5000,10000,25000,50000,100000,1000000]},"sms.Response":{"type":"object","description":"A structure describing how to manage an sms Response","properties":{"cgiUrl":{"type":"string","description":"Default url callback used for a given response.","nullable":true},"responseType":{"$ref":"#/components/schemas/sms.ResponseTypeEnum"},"text":{"type":"string","description":"Automatic notification sent by text in case of customer reply.","nullable":true},"trackingDefaultSmsSender":{"type":"string","nullable":true},"trackingOptions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/sms.ResponseTrackingOptions"}}}},"sms.ResponseTrackingMediaEnum":{"type":"string","description":"The tracking media response","enum":["email","sms","voice"]},"sms.ResponseTrackingOptions":{"type":"object","description":"The tracking media response","properties":{"media":{"$ref":"#/components/schemas/sms.ResponseTrackingMediaEnum"},"sender":{"type":"string"},"target":{"type":"string"}}},"sms.ResponseTypeEnum":{"type":"string","description":"Response type","enum":["cgi","none","text"]},"sms.RestrictionCodeEnum":{"type":"string","description":"Restriction type used by the operator to filter sms.","enum":["ALPHA","BAD_DLR","BLOCKED","CODING","DLR","FLASHONLY","MSISDN"]},"sms.StatusAccountEnum":{"type":"string","description":"Account status","enum":["disable","enable"]},"sms.Task":{"type":"object","description":"Operation on a SMS service","properties":{"function":{"allOf":[{"$ref":"#/components/schemas/sms.TodoGeneralPublicFunctionsEnum"}],"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/telephony.TaskStatusEnum"}],"readOnly":true},"step":{"allOf":[{"$ref":"#/components/schemas/sms.TodoGeneralPublicStepsEnum"}],"readOnly":true},"taskId":{"type":"integer","readOnly":true}}},"sms.Templates":{"type":"object","description":"A structure describing all information about templates informations","properties":{"customizedEmailMode":{"type":"boolean"},"customizedSmsMode":{"type":"boolean"},"emailBody":{"type":"string","nullable":true},"emailFrom":{"type":"string","nullable":true},"emailSubject":{"type":"string","nullable":true},"smsBody":{"type":"string","nullable":true}}},"sms.TodoGeneralPublicFunctionsEnum":{"type":"string","description":"The task function","enum":["cleanSmsReceivers"]},"sms.TodoGeneralPublicStepsEnum":{"type":"string","description":"The task step","enum":["checkOrder","createHlrs","finishing","sendMailReport","starting","waitForHlrs"]},"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":{"/sms":{"get":{"summary":"List SMS accounts","description":"List SMS accounts. Returns the service names of the SMS accounts of the customer. Get an SMS account for its status, credits left and settings.","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","SMS","Account@@@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(\"/sms\")\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(\"/sms\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:get","required":true}],"x-expanded-response":"SmsAccountWithIAM"}},"/sms/rates/destinations":{"get":{"summary":"Get rates for a country","description":"Get rates for a country. Returns the credits consumed and the price of one SMS sent to a country, for credits bought in the billing country, with the VAT rate.","parameters":[{"in":"query","name":"billingCountry","description":"Country where you buy credits","schema":{"$ref":"#/components/schemas/sms.BillingCountryEnum"}},{"in":"query","name":"country","description":"Country where you send SMS","required":true,"schema":{"$ref":"#/components/schemas/sms.CountryEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.DestinationRates"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Account@@@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(\"/sms/rates/destinations\")\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(\"/sms/rates/destinations\");\n\nprint_r($result);\n?>"}]}},"/sms/rates/packs":{"get":{"summary":"List SMS pack prices","description":"List SMS pack prices. Returns the SMS packs that can be bought for a destination country: credit and SMS quantities, prices, discount and VAT rate.","parameters":[{"in":"query","name":"billingCountry","description":"Country where you buy credits","schema":{"$ref":"#/components/schemas/sms.BillingCountryEnum"}},{"in":"query","name":"country","description":"Country where you send SMS","required":true,"schema":{"$ref":"#/components/schemas/sms.CountryEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/sms.PackDetails"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Account@@@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(\"/sms/rates/packs\")\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(\"/sms/rates/packs\");\n\nprint_r($result);\n?>"}]}},"/sms/{serviceName}":{"get":{"summary":"Get an SMS account","description":"Get an SMS account. Returns the SMS account: status, credits left, callback URLs, automatic recredit settings and channel.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.AccountWithIAM"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Account@@@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(\"/sms/{serviceName}\")\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(\"/sms/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:get","required":true}]},"put":{"summary":"Update an SMS account","description":"Update an SMS account. Updates the SMS account settings, such as the callback URLs, the templates and the automatic recredit.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.Account"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","Account@@@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: sms.Account\nresult = client.put(\"/sms/{serviceName}\",\n\tautomaticRecreditAmount = None, #  (type: sms.PackQuantityAutomaticRecreditEnum, nullable)\n\tcallBack = None, # URL called when state of a sent SMS changes (type: string, nullable)\n\tcreditThresholdForAutomaticRecredit = None, # Credit threshold after which an automatic recredit is launched (type: number)\n\tdescription = None, #  (type: string)\n\tsmsResponse = None, #  (type: )\n\tstopCallBack = None, # URL called when a STOP is received after a receiver replied stop to a SMS (type: string, nullable)\n\ttemplates = None, #  (type: )\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: sms.Account\n$result = $ovh->put(\"/sms/{serviceName}\", array(\n\tautomaticRecreditAmount => null, //  (type: sms.PackQuantityAutomaticRecreditEnum, nullable)\n\tcallBack => null, // URL called when state of a sent SMS changes (type: string, nullable)\n\tcreditThresholdForAutomaticRecredit => null, // Credit threshold after which an automatic recredit is launched (type: number)\n\tdescription => null, //  (type: string)\n\tsmsResponse => null, //  (type: )\n\tstopCallBack => null, // URL called when a STOP is received after a receiver replied stop to a SMS (type: string, nullable)\n\ttemplates => null, //  (type: )\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:put","required":true}]}},"/sms/{serviceName}/document":{"get":{"summary":"Export SMS to a document","description":"Export SMS to a document. Generates a document with the SMS of the account, filtered by tag, date, direction or batch. Returns the identifier of the document in /me/document.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"batchID","description":"Filter SMSs with their batch ID (outgoing SMSs only)","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"creationDatetime.from","description":"Filter the value of creationDatetime property (>=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"creationDatetime.to","description":"Filter the value of creationDatetime property (<=)","schema":{"type":"string","format":"date-time"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"query","name":"tag","description":"Select sms with a specific identifier group tag","schema":{"type":"string"}},{"in":"query","name":"wayType","description":"specify outgoing or incoming sms","required":true,"schema":{"$ref":"#/components/schemas/sms.DocumentWayTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Account@@@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(\"/sms/{serviceName}/document\")\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(\"/sms/{serviceName}/document\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:document/get","required":true}]}},"/sms/{serviceName}/exceptions":{"get":{"summary":"List sending restrictions for a number","description":"List sending restrictions for a number. Returns the operator restrictions and substitutions that apply when sending SMS to the given number.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"receiver","description":"The receiver number to check","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/sms.Exception"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Account@@@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.get(\"/sms/{serviceName}/exceptions\")\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(\"/sms/{serviceName}/exceptions\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:exceptions/get","required":true}]}},"/sms/{serviceName}/seeOffers":{"get":{"summary":"List SMS offers","description":"List SMS offers. Returns the SMS pack offers available for the account, by quantity and destination country.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"countryCurrencyPrice","description":"Filter to have the currency country prices","required":true,"schema":{"$ref":"#/components/schemas/reference.CountryEnum"}},{"in":"query","name":"countryDestination","description":"Filter to have the country destination","required":true,"schema":{"$ref":"#/components/schemas/sms.CountryEnum"}},{"in":"query","name":"quantity","description":"Sms pack offer quantity","required":true,"schema":{"$ref":"#/components/schemas/sms.PackQuantityEnum"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/sms.PackOffer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Account@@@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(\"/sms/{serviceName}/seeOffers\")\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(\"/sms/{serviceName}/seeOffers\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:seeOffers/get","required":true}]}},"/sms/{serviceName}/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":"serviceName","description":"The internal name of your SMS offer","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","SMS","Account@@@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\nresult = client.get(\"/sms/{serviceName}/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(\"/sms/{serviceName}/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh: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":"serviceName","description":"The internal name of your SMS offer","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","SMS","Account@@@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\n# Request body type: services.Service\nresult = client.put(\"/sms/{serviceName}/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(\"/sms/{serviceName}/serviceInfos\", array(\n\trenew => null, // Way of handling the renew (type: service.RenewType, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:serviceInfos/edit","required":true}]}},"/sms/{serviceName}/task":{"get":{"summary":"List tasks","description":"List tasks. Returns the identifiers of the operations run on the SMS account. Get a task for its function, current step and status.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"query","name":"status","description":"Filter the value of status property (=)","schema":{"$ref":"#/components/schemas/telephony.TaskStatusEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Account@@@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(\"/sms/{serviceName}/task\")\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(\"/sms/{serviceName}/task\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:task/get","required":true}],"x-expanded-response":"SmsTask"}},"/sms/{serviceName}/task/{taskId}":{"get":{"summary":"Get a task","description":"Get a task. Returns an operation run on the SMS account, with the function performed, its current step and its status.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"taskId","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Account@@@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.get(\"/sms/{serviceName}/task/{taskId}\")\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(\"/sms/{serviceName}/task/{taskId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:task/get","required":true}]}},"/sms/{serviceName}/transferCredits":{"post":{"summary":"Transfer credits","description":"Transfer credits. Transfers an amount of credits from this SMS account to another SMS account, given by its service name.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"credits":{"type":"number","description":"Amount of credits to transfer."},"smsAccountTarget":{"type":"string","description":"Sms account destination."}},"required":["credits","smsAccountTarget"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","Account@@@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.post(\"/sms/{serviceName}/transferCredits\",\n\tcredits = None, # Amount of credits to transfer. (type: double)\n\tsmsAccountTarget = None, # Sms account destination. (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(\"/sms/{serviceName}/transferCredits\", array(\n\tcredits => null, // Amount of credits to transfer. (type: double)\n\tsmsAccountTarget => null, // Sms account destination. (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:transferCredits","required":true}]}}}}