{"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"},"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}}},"sms.CharsetEnum":{"type":"string","description":"The charset format","enum":["UTF-8"]},"sms.ChatAccess":{"type":"object","description":"The web access for your virtual number chat application","properties":{"creationDate":{"type":"string","description":"The creation date of this access","format":"date-time","readOnly":true},"id":{"type":"integer","readOnly":true},"url":{"type":"string","description":"The url of the web access","readOnly":true}}},"sms.ClassEnum":{"type":"string","description":"Deprecated: The sms class of sms sending job","enum":["flash","phoneDisplay","sim","toolkit"]},"sms.CodingEnum":{"type":"string","description":"The sms coding","enum":["7bit","8bit"]},"sms.Hlr":{"type":"object","description":"Sms operator informations","properties":{"country":{"type":"string","description":"The country","readOnly":true},"countryCode":{"type":"string","description":"The countryCode prefix number","readOnly":true},"network":{"type":"string","description":"The network name","readOnly":true},"operator":{"type":"string","description":"The operator name","readOnly":true},"region":{"type":"string","description":"The region","readOnly":true}}},"sms.Incoming":{"type":"object","description":"Sms history of sms incoming received","properties":{"creationDatetime":{"type":"string","format":"date-time","readOnly":true},"credits":{"type":"number","readOnly":true},"id":{"type":"integer","readOnly":true},"message":{"type":"string","readOnly":true},"sender":{"type":"string","readOnly":true},"tag":{"type":"string","readOnly":true}}},"sms.Outgoing":{"type":"object","description":"Sms history of sms outgoing sent","properties":{"creationDatetime":{"type":"string","format":"date-time","readOnly":true},"credits":{"type":"number","readOnly":true},"deliveredAt":{"type":"string","nullable":true,"format":"date-time","readOnly":true},"deliveryReceipt":{"type":"integer","readOnly":true},"differedDelivery":{"type":"integer","readOnly":true},"id":{"type":"integer","readOnly":true},"message":{"type":"string","readOnly":true},"messageLength":{"type":"integer","readOnly":true},"numberOfSms":{"type":"integer","readOnly":true},"ptt":{"type":"integer","readOnly":true},"receiver":{"type":"string","readOnly":true},"sender":{"type":"string","readOnly":true},"sentAt":{"type":"string","nullable":true,"format":"date-time","readOnly":true},"tag":{"type":"string","readOnly":true},"tariffCode":{"type":"string","description":"Tariff code applied on the sms","readOnly":true}}},"sms.PriorityEnum":{"type":"string","description":"The priority of an sms sending","enum":["high","low","medium","veryLow"]},"sms.SmsSendingReport":{"type":"object","description":"A structure describing all information about quota information","properties":{"ids":{"type":"array","items":{"type":"integer"}},"invalidReceivers":{"type":"array","items":{"type":"string"}},"tag":{"type":"string"},"totalCreditsRemoved":{"type":"number"},"validReceivers":{"type":"array","items":{"type":"string"}}}},"sms.VirtualNumber":{"type":"object","description":"Virtual numbers","properties":{"countryCode":{"allOf":[{"$ref":"#/components/schemas/sms.VirtualNumberIsoCountryCodeEnum"}],"description":"The ISO formated country code of the number","readOnly":true},"number":{"type":"string","description":"The virtual number","readOnly":true}}},"sms.VirtualNumberGenericServiceWithIAM":{"type":"object","description":"Virtual numbers","properties":{"countryCode":{"allOf":[{"$ref":"#/components/schemas/sms.VirtualNumberIsoCountryCodeEnum"}],"description":"The ISO formated country code of the number","readOnly":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"number":{"type":"string","description":"The virtual number","readOnly":true}}},"sms.VirtualNumberIsoCountryCodeEnum":{"type":"string","description":"The ISO formated country code of the number","enum":["be","ch","de","es","fr","uk"]},"sms.VirtualNumberJob":{"type":"object","description":"Sms job","properties":{"creationDatetime":{"type":"string","format":"date-time","readOnly":true},"credits":{"type":"number","readOnly":true},"deliveryReceipt":{"type":"integer","readOnly":true},"differedDelivery":{"type":"integer","readOnly":true},"id":{"type":"integer","readOnly":true},"message":{"type":"string","readOnly":true},"messageLength":{"type":"integer","readOnly":true},"numberOfSms":{"type":"integer","readOnly":true},"ptt":{"type":"integer","readOnly":true},"receiver":{"type":"string","readOnly":true}}},"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/virtualNumbers":{"get":{"summary":"List virtual numbers","description":"List virtual numbers. Returns the virtual numbers of the customer, as services. A virtual number receives SMS and lets receivers reply to the messages sent.","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","SMS Virtual Numbers@@@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/virtualNumbers\")\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/virtualNumbers\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"smsVirtualNumbers:apiovh:get","required":true}],"x-expanded-response":"SmsVirtualNumberGenericServiceWithIAM"}},"/sms/virtualNumbers/{number}":{"get":{"summary":"Get a virtual number service","description":"Get a virtual number service. Returns the virtual number service, with the number and the ISO code of its country.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"Your virtual number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.VirtualNumberGenericServiceWithIAM"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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/virtualNumbers/{number}\")\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/virtualNumbers/{number}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"smsVirtualNumbers:apiovh:get","required":true}]}},"/sms/virtualNumbers/{number}/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":"number","description":"Your virtual number","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","SMS Virtual Numbers@@@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.get(\"/sms/virtualNumbers/{number}/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/virtualNumbers/{number}/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"smsVirtualNumbers: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":"number","description":"Your virtual number","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","SMS Virtual Numbers@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: services.Service\nresult = client.put(\"/sms/virtualNumbers/{number}/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/virtualNumbers/{number}/serviceInfos\", array(\n\trenew => null, // Way of handling the renew (type: service.RenewType, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"smsVirtualNumbers:apiovh:serviceInfos/edit","required":true}]}},"/sms/{serviceName}/virtualNumbers":{"get":{"summary":"List virtual numbers","description":"List virtual numbers. Returns the virtual numbers of the account. A virtual number receives SMS and lets receivers reply.","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":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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}/virtualNumbers\")\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}/virtualNumbers\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/get","required":true}],"x-expanded-response":"SmsVirtualNumber"}},"/sms/{serviceName}/virtualNumbers/{number}":{"get":{"summary":"Get a virtual number","description":"Get a virtual number. Returns the virtual number attached to the SMS account and the ISO code of its country.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"The virtual number","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":{"$ref":"#/components/schemas/sms.VirtualNumber"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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}/virtualNumbers/{number}\")\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}/virtualNumbers/{number}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/get","required":true}]}},"/sms/{serviceName}/virtualNumbers/{number}/chatAccess":{"delete":{"summary":"Delete the web access","description":"Delete the web access. Deletes the web access to the chat application of the virtual number. Its URL no longer gives access to the chat.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"The virtual number","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"}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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.delete(\"/sms/{serviceName}/virtualNumbers/{number}/chatAccess\")\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(\"/sms/{serviceName}/virtualNumbers/{number}/chatAccess\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/chatAccess/delete","required":true}]},"get":{"summary":"Get the web access","description":"Get the web access. Returns the web access to the chat application of the virtual number: its URL and creation date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"The virtual number","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":{"$ref":"#/components/schemas/sms.ChatAccess"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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}/virtualNumbers/{number}/chatAccess\")\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}/virtualNumbers/{number}/chatAccess\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/chatAccess/get","required":true}]},"post":{"summary":"Create the web access","description":"Create the web access. Creates a web access to the chat application of the virtual number. Returns its URL.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"The virtual number","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":{"$ref":"#/components/schemas/sms.ChatAccess"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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.post(\"/sms/{serviceName}/virtualNumbers/{number}/chatAccess\")\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}/virtualNumbers/{number}/chatAccess\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/chatAccess/create","required":true}]}},"/sms/{serviceName}/virtualNumbers/{number}/incoming":{"get":{"summary":"List received SMS","description":"List received SMS. Returns the identifiers of the received SMS. Get a received SMS for its sender, message, date and credits used.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"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":"number","description":"The virtual number","required":true,"schema":{"type":"string"}},{"in":"query","name":"sender","description":"Filter the value of sender property (=)","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"query","name":"tag","description":"Filter the value of tag property (=)","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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}/virtualNumbers/{number}/incoming\")\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}/virtualNumbers/{number}/incoming\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/incoming/get","required":true}],"x-expanded-response":"SmsIncoming"}},"/sms/{serviceName}/virtualNumbers/{number}/incoming/{id}":{"delete":{"summary":"Delete a received SMS","description":"Delete a received SMS. Deletes the received SMS from the history. It no longer appears in the list of received SMS.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"number","description":"The virtual number","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"}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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.delete(\"/sms/{serviceName}/virtualNumbers/{number}/incoming/{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(\"/sms/{serviceName}/virtualNumbers/{number}/incoming/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/incoming/delete","required":true}]},"get":{"summary":"Get a received SMS","description":"Get a received SMS. Returns the received SMS: sender, message, reception date, credits used and tag. The tag groups SMS for filtering and export.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"number","description":"The virtual number","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":{"$ref":"#/components/schemas/sms.Incoming"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@110"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/virtualNumbers/{number}/incoming/{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(\"/sms/{serviceName}/virtualNumbers/{number}/incoming/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/incoming/get","required":true}]}},"/sms/{serviceName}/virtualNumbers/{number}/jobs":{"get":{"summary":"List pending jobs","description":"List pending jobs. Returns the identifiers of the SMS waiting to be sent. Get a pending job for its receiver, message, number of SMS parts and credits.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"The virtual number","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":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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(\"/sms/{serviceName}/virtualNumbers/{number}/jobs\")\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}/virtualNumbers/{number}/jobs\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/jobs/get","required":true}],"x-expanded-response":"SmsVirtualNumberJob"},"post":{"summary":"Send SMS","description":"Send SMS. Sends an SMS to one or several receivers, given as a list, a CSV document URL or a receiver list. Sending can be delayed, and a validity period drops the message if it is not delivered in time.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"number","description":"The virtual number","required":true,"schema":{"type":"string"}},{"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":{"charset":{"description":"The sms coding","$ref":"#/components/schemas/sms.CharsetEnum"},"class":{"description":"Deprecated: The sms class","$ref":"#/components/schemas/sms.ClassEnum"},"coding":{"description":"Deprecated: the coding is deduced from the message and its charset","$ref":"#/components/schemas/sms.CodingEnum"},"differedPeriod":{"type":"integer","description":"The time -in minute(s)- to wait before sending the message"},"message":{"type":"string","description":"The sms message"},"priority":{"description":"The priority of the message","$ref":"#/components/schemas/sms.PriorityEnum"},"receivers":{"type":"array","description":"The receivers list","items":{"type":"string"}},"receiversDocumentUrl":{"type":"string","description":"The receivers document url link in csv format"},"receiversSlotId":{"type":"string","description":"The receivers document slot id"},"tag":{"type":"string","description":"The identifier group tag"},"validityPeriod":{"type":"integer","description":"The maximum time -in minute(s)- before the message is dropped"}},"required":["message"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.SmsSendingReport"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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: long\nresult = client.post(\"/sms/{serviceName}/virtualNumbers/{number}/jobs\",\n\tcharset = None, # The sms coding (type: sms.CharsetEnum, nullable)\n\tclass = None, # Deprecated: The sms class (type: sms.ClassEnum, nullable)\n\tcoding = None, # Deprecated: the coding is deduced from the message and its charset (type: sms.CodingEnum, nullable)\n\tdifferedPeriod = None, # The time -in minute(s)- to wait before sending the message (type: long, nullable)\n\tmessage = None, # The sms message (type: string)\n\tpriority = None, # The priority of the message (type: sms.PriorityEnum, nullable)\n\treceivers = None, # The receivers list (type: string[], nullable)\n\treceiversDocumentUrl = None, # The receivers document url link in csv format (type: string, nullable)\n\treceiversSlotId = None, # The receivers document slot id (type: string, nullable)\n\ttag = None, # The identifier group tag (type: string, nullable)\n\tvalidityPeriod = None, # The maximum time -in minute(s)- before the message is dropped (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(\"/sms/{serviceName}/virtualNumbers/{number}/jobs\", array(\n\tcharset => null, // The sms coding (type: sms.CharsetEnum, nullable)\n\tclass => null, // Deprecated: The sms class (type: sms.ClassEnum, nullable)\n\tcoding => null, // Deprecated: the coding is deduced from the message and its charset (type: sms.CodingEnum, nullable)\n\tdifferedPeriod => null, // The time -in minute(s)- to wait before sending the message (type: long, nullable)\n\tmessage => null, // The sms message (type: string)\n\tpriority => null, // The priority of the message (type: sms.PriorityEnum, nullable)\n\treceivers => null, // The receivers list (type: string[], nullable)\n\treceiversDocumentUrl => null, // The receivers document url link in csv format (type: string, nullable)\n\treceiversSlotId => null, // The receivers document slot id (type: string, nullable)\n\ttag => null, // The identifier group tag (type: string, nullable)\n\tvalidityPeriod => null, // The maximum time -in minute(s)- before the message is dropped (type: long, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/jobs/create","required":true}]}},"/sms/{serviceName}/virtualNumbers/{number}/jobs/{id}":{"delete":{"summary":"Delete a pending job","description":"Delete a pending job. Cancels the sending of an SMS that is still waiting to be sent, such as a delayed SMS. Sent SMS are in the sent SMS history.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"number","description":"The virtual number","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"}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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.delete(\"/sms/{serviceName}/virtualNumbers/{number}/jobs/{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(\"/sms/{serviceName}/virtualNumbers/{number}/jobs/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/jobs/delete","required":true}]},"get":{"summary":"Get a pending job","description":"Get a pending job. Returns the SMS waiting to be sent: receiver, message, number of SMS parts and credits.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"number","description":"The virtual number","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":{"$ref":"#/components/schemas/sms.VirtualNumberJob"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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(\"/sms/{serviceName}/virtualNumbers/{number}/jobs/{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(\"/sms/{serviceName}/virtualNumbers/{number}/jobs/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/jobs/get","required":true}]}},"/sms/{serviceName}/virtualNumbers/{number}/outgoing":{"get":{"summary":"List sent SMS","description":"List sent SMS. Returns the identifiers of the sent SMS. Get a sent SMS for its receiver, message, delivery status, number of SMS parts and credits used.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"creationDatetime.from","description":"Filter the value of creationDatetime property (>=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"creationDatetime.to","description":"Filter the value of creationDatetime property (<=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"deliveryReceipt","description":"Filter the value of deliveryReceipt property (=)","schema":{"type":"integer"}},{"in":"query","name":"differedDelivery","description":"Filter the value of differedDelivery property (=)","schema":{"type":"integer"}},{"in":"path","name":"number","description":"The virtual number","required":true,"schema":{"type":"string"}},{"in":"query","name":"ptt","description":"Filter the value of ptt property (=)","schema":{"type":"integer"}},{"in":"query","name":"receiver","description":"Filter the value of receiver property (=)","schema":{"type":"string"}},{"in":"query","name":"sender","description":"Filter the value of sender property (=)","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"query","name":"tag","description":"Filter the value of tag property (=)","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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.get(\"/sms/{serviceName}/virtualNumbers/{number}/outgoing\")\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}/virtualNumbers/{number}/outgoing\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/outgoing/get","required":true}],"x-expanded-response":"SmsOutgoing"}},"/sms/{serviceName}/virtualNumbers/{number}/outgoing/{id}":{"delete":{"summary":"Delete a sent SMS","description":"Delete a sent SMS. Deletes the sent SMS from the history. It no longer appears in the list of sent SMS of the user or number.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"number","description":"The virtual number","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"}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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.delete(\"/sms/{serviceName}/virtualNumbers/{number}/outgoing/{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(\"/sms/{serviceName}/virtualNumbers/{number}/outgoing/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/outgoing/delete","required":true}]},"get":{"summary":"Get a sent SMS","description":"Get a sent SMS. Returns the sent SMS: receiver, message, delivery status, number of SMS parts and credits used.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"number","description":"The virtual number","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":{"$ref":"#/components/schemas/sms.Outgoing"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@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(\"/sms/{serviceName}/virtualNumbers/{number}/outgoing/{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(\"/sms/{serviceName}/virtualNumbers/{number}/outgoing/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/outgoing/get","required":true}]}},"/sms/{serviceName}/virtualNumbers/{number}/outgoing/{id}/hlr":{"get":{"summary":"Get the receiver operator","description":"Get the receiver operator. Returns the operator of the phone number, from the network query trace: country, country code, region, operator and network.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"number","description":"The virtual number","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":{"$ref":"#/components/schemas/sms.Hlr"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","SMS Virtual Numbers@@@200"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/virtualNumbers/{number}/outgoing/{id}/hlr\")\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}/virtualNumbers/{number}/outgoing/{id}/hlr\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:virtualNumbers/outgoing/hlr/get","required":true}]}}}}