{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"sms.AlertThreshold":{"type":"object","description":"A structure describing all information about alert threshold informations","properties":{"alertEmail":{"type":"string"},"alertNumber":{"type":"string"},"alertThreshold":{"type":"integer"},"support":{"$ref":"#/components/schemas/sms.SupportEnum"}}},"sms.CharsetEnum":{"type":"string","description":"The charset format","enum":["UTF-8"]},"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.DocumentWayTypeEnum":{"type":"string","description":"Way type","enum":["incoming","outgoing"]},"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.Job":{"type":"object","description":"Sms job","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}}},"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.Quota":{"type":"object","description":"A structure describing all information about quota informations","properties":{"quotaLeft":{"type":"number"},"quotaStatus":{"$ref":"#/components/schemas/sms.QuotaStatusUserEnum"}}},"sms.QuotaStatusUserEnum":{"type":"string","description":"Current quota status","enum":["active","inactive"]},"sms.Receiver":{"type":"object","description":"Sms receivers preloaded","properties":{"autoUpdate":{"type":"boolean","description":"Download file from URL before sending to contacts (works only with csvUrl and not document ID)"},"canAutoUpdate":{"type":"boolean","description":"Is the object compatible with autoUpdate","readOnly":true},"datetime":{"type":"string","description":"Creation date of the document","format":"date-time","readOnly":true},"description":{"type":"string","description":"Description name of the document"},"records":{"type":"integer","description":"Number of receiver records in the document","readOnly":true},"slotId":{"type":"integer","description":"Slot number id","readOnly":true}}},"sms.ReceiversAsynchronousCleanReport":{"type":"object","description":"A structure giving operation price and asynchronous task ID","properties":{"taskId":{"type":"integer"},"totalCreditsRemoved":{"type":"number"}}},"sms.SmsSendingReportUser":{"type":"object","description":"A structure describing all information about quota information","properties":{"creditsLeft":{"type":"number"},"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.SupportEnum":{"type":"string","description":"The media support used to be contacted in case of alert","enum":["both","mail","sms"]},"sms.User":{"type":"object","description":"SMS users","properties":{"alertThresholdInformations":{"$ref":"#/components/schemas/sms.AlertThreshold"},"callBack":{"type":"string","description":"URL called when state of a sent SMS changes","nullable":true},"ipRestrictions":{"type":"array","items":{"type":"string"}},"login":{"type":"string","description":"The sms user login","readOnly":true},"password":{"type":"string"},"quotaInformations":{"$ref":"#/components/schemas/sms.Quota"},"stopCallBack":{"type":"string","description":"URL called when a STOP is received after a receiver replied stop to a SMS","nullable":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/{serviceName}/users":{"get":{"summary":"List users","description":"List users. Returns the logins of the API users of the SMS account. Each user sends SMS with its own login, callback URLs, quota and IP restrictions.","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","API Users@@@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/{serviceName}/users\")\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}/users\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/get","required":true}],"x-expanded-response":"SmsUser"},"post":{"summary":"Create a user","description":"Create a user. Creates an API user with a login and a password, to send SMS with its own callback URLs, quota and IP restrictions.","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":{"login":{"type":"string","description":"The sms login"},"password":{"type":"string","description":"The sms password"}},"required":["login","password"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@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.post(\"/sms/{serviceName}/users\",\n\tlogin = None, # The sms login (type: string)\n\tpassword = None, # The sms password (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}/users\", array(\n\tlogin => null, // The sms login (type: string)\n\tpassword => null, // The sms password (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/create","required":true}]}},"/sms/{serviceName}/users/{login}":{"delete":{"summary":"Delete a user","description":"Delete a user. Deletes the API user of the SMS account. Its login and password can no longer be used to send SMS.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"login","description":"The sms user login","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","API Users@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/sms/{serviceName}/users/{login}\")\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}/users/{login}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/delete","required":true}]},"get":{"summary":"Get a user","description":"Get a user. Returns the API user: login, callback URLs, quota left and status, alert threshold and the IP addresses allowed to send SMS.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"login","description":"The sms user login","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.User"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@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}/users/{login}\")\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}/users/{login}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/get","required":true}]},"put":{"summary":"Update a user","description":"Update a user. Updates the API user: password, callback URLs, quota, alert threshold and the IP addresses allowed to send SMS.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"login","description":"The sms user login","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":{"$ref":"#/components/schemas/sms.User"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: sms.User\nresult = client.put(\"/sms/{serviceName}/users/{login}\",\n\talertThresholdInformations = None, #  (type: )\n\tcallBack = None, # URL called when state of a sent SMS changes (type: string, nullable)\n\tipRestrictions = None, #  (type: array)\n\tpassword = None, #  (type: string)\n\tquotaInformations = None, #  (type: )\n\tstopCallBack = None, # URL called when a STOP is received after a receiver replied stop to a SMS (type: string, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: sms.User\n$result = $ovh->put(\"/sms/{serviceName}/users/{login}\", array(\n\talertThresholdInformations => null, //  (type: )\n\tcallBack => null, // URL called when state of a sent SMS changes (type: string, nullable)\n\tipRestrictions => null, //  (type: array)\n\tpassword => null, //  (type: string)\n\tquotaInformations => null, //  (type: )\n\tstopCallBack => null, // URL called when a STOP is received after a receiver replied stop to a SMS (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/edit","required":true}]}},"/sms/{serviceName}/users/{login}/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":"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":"login","description":"The sms user login","required":true,"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":"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","API Users@@@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}/users/{login}/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}/users/{login}/document\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/document/get","required":true}]}},"/sms/{serviceName}/users/{login}/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":"path","name":"login","description":"The sms user login","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","API Users@@@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}/users/{login}/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}/users/{login}/incoming\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/incoming/get","required":true}],"x-expanded-response":"SmsIncoming"}},"/sms/{serviceName}/users/{login}/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":"login","description":"The sms user login","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","API Users@@@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}/users/{login}/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}/users/{login}/incoming/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/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":"login","description":"The sms user login","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","API Users@@@80"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/users/{login}/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}/users/{login}/incoming/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/incoming/get","required":true}]}},"/sms/{serviceName}/users/{login}/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":"login","description":"The sms user login","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","API Users@@@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}/users/{login}/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}/users/{login}/jobs\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/jobs/get","required":true}],"x-expanded-response":"SmsJob"},"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":"login","description":"The sms user login","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"},"noStopClause":{"type":"boolean","description":"Do not display STOP clause in the message, this requires that this is not an advertising 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"},"sender":{"type":"string","description":"The sender"},"senderForResponse":{"type":"boolean","description":"Set the flag to send a special sms which can be reply by the receiver (smsResponse)."},"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.SmsSendingReportUser"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@120"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/sms/{serviceName}/users/{login}/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\tnoStopClause = None, # Do not display STOP clause in the message, this requires that this is not an advertising message (type: boolean, nullable)\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\tsender = None, # The sender (type: string, nullable)\n\tsenderForResponse = None, # Set the flag to send a special sms which can be reply by the receiver (smsResponse). (type: boolean, 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$result = $ovh->post(\"/sms/{serviceName}/users/{login}/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\tnoStopClause => null, // Do not display STOP clause in the message, this requires that this is not an advertising message (type: boolean, nullable)\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\tsender => null, // The sender (type: string, nullable)\n\tsenderForResponse => null, // Set the flag to send a special sms which can be reply by the receiver (smsResponse). (type: boolean, 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:users/jobs/create","required":true}]}},"/sms/{serviceName}/users/{login}/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":"login","description":"The sms user login","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","API Users@@@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.delete(\"/sms/{serviceName}/users/{login}/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}/users/{login}/jobs/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/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":"login","description":"The sms user login","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.Job"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@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}/users/{login}/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}/users/{login}/jobs/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/jobs/get","required":true}]}},"/sms/{serviceName}/users/{login}/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":"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":"login","description":"The sms user login","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","API Users@@@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}/users/{login}/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}/users/{login}/outgoing\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/outgoing/get","required":true}],"x-expanded-response":"SmsOutgoing"}},"/sms/{serviceName}/users/{login}/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":"login","description":"The sms user login","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","API Users@@@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}/users/{login}/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}/users/{login}/outgoing/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/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":"login","description":"The sms user login","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","API Users@@@150"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/users/{login}/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}/users/{login}/outgoing/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/outgoing/get","required":true}]}},"/sms/{serviceName}/users/{login}/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":"login","description":"The sms user login","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","API Users@@@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}/users/{login}/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}/users/{login}/outgoing/{id}/hlr\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/outgoing/hlr/get","required":true}]}},"/sms/{serviceName}/users/{login}/receivers":{"get":{"summary":"List receiver lists","description":"List receiver lists. Returns the identifiers (slotId) of the receiver lists. A receiver list is a CSV or text document of numbers, used to send SMS in bulk.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"login","description":"The sms user login","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","API Users@@@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}/users/{login}/receivers\")\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}/users/{login}/receivers\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/receivers/get","required":true}],"x-expanded-response":"SmsReceiver"},"post":{"summary":"Create a receiver list","description":"Create a receiver list. Creates a receiver list from a CSV file, given as a /me/document identifier or a URL. With a URL, the file can be downloaded again before each sending.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"login","description":"The sms user login","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":{"autoUpdate":{"type":"boolean","description":"Download file from URL before sending to contacts (works only with csvUrl and not document ID)"},"csvUrl":{"type":"string","description":"URL of the file you want to import"},"description":{"type":"string","description":"Description name of the document"},"documentId":{"type":"string","description":"ID of the /me/document file you want to import"},"slotId":{"type":"integer","description":"Slot number id used to handle the document"}},"required":["autoUpdate","description","slotId"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.Receiver"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@200"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: long\nresult = client.post(\"/sms/{serviceName}/users/{login}/receivers\",\n\tautoUpdate = None, # Download file from URL before sending to contacts (works only with csvUrl and not document ID) (type: boolean)\n\tcsvUrl = None, # URL of the file you want to import (type: string, nullable)\n\tdescription = None, # Description name of the document (type: string)\n\tdocumentId = None, # ID of the /me/document file you want to import (type: string, nullable)\n\tslotId = None, # Slot number id used to handle the document (type: long)\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}/users/{login}/receivers\", array(\n\tautoUpdate => null, // Download file from URL before sending to contacts (works only with csvUrl and not document ID) (type: boolean)\n\tcsvUrl => null, // URL of the file you want to import (type: string, nullable)\n\tdescription => null, // Description name of the document (type: string)\n\tdocumentId => null, // ID of the /me/document file you want to import (type: string, nullable)\n\tslotId => null, // Slot number id used to handle the document (type: long)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/receivers/create","required":true}]}},"/sms/{serviceName}/users/{login}/receivers/{slotId}":{"delete":{"summary":"Delete a receiver list","description":"Delete a receiver list. Deletes the receiver list. It can no longer be used as the receivers of an SMS sending (receiversSlotId).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"login","description":"The sms user login","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"slotId","description":"Slot number id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@210"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/sms/{serviceName}/users/{login}/receivers/{slotId}\")\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}/users/{login}/receivers/{slotId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/receivers/delete","required":true}]},"get":{"summary":"Get a receiver list","description":"Get a receiver list. Returns the receiver list: description, number of records and automatic update settings.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"login","description":"The sms user login","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"slotId","description":"Slot number id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.Receiver"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@190"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/users/{login}/receivers/{slotId}\")\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}/users/{login}/receivers/{slotId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/receivers/get","required":true}]},"put":{"summary":"Update a receiver list","description":"Update a receiver list. Updates the description of the receiver list and its automatic update, which downloads the file from its URL before each sending.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"login","description":"The sms user login","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"slotId","description":"Slot number id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.Receiver"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@220"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: sms.Receiver\nresult = client.put(\"/sms/{serviceName}/users/{login}/receivers/{slotId}\",\n\tautoUpdate = None, # Download file from URL before sending to contacts (works only with csvUrl and not document ID) (type: boolean)\n\tdescription = None, # Description name of the document (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: sms.Receiver\n$result = $ovh->put(\"/sms/{serviceName}/users/{login}/receivers/{slotId}\", array(\n\tautoUpdate => null, // Download file from URL before sending to contacts (works only with csvUrl and not document ID) (type: boolean)\n\tdescription => null, // Description name of the document (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/receivers/edit","required":true}]}},"/sms/{serviceName}/users/{login}/receivers/{slotId}/clean":{"post":{"summary":"Clean a receiver list","description":"Clean a receiver list. Removes the invalid and inactive numbers from the receiver list, with an HLR lookup on each number. A report is sent by email at the end.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"login","description":"The sms user login","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"slotId","description":"Slot number id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"freemium":{"type":"boolean","description":"Limit checks to syntaxical validation"},"priceOnly":{"type":"boolean","description":"Only get action's price in credits without executing it"}},"required":["freemium","priceOnly"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.ReceiversAsynchronousCleanReport"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@230"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/sms/{serviceName}/users/{login}/receivers/{slotId}/clean\",\n\tfreemium = None, # Limit checks to syntaxical validation (type: boolean)\n\tpriceOnly = None, # Only get action's price in credits without executing it (type: boolean)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/sms/{serviceName}/users/{login}/receivers/{slotId}/clean\", array(\n\tfreemium => null, // Limit checks to syntaxical validation (type: boolean)\n\tpriceOnly => null, // Only get action's price in credits without executing it (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/receivers/clean","required":true}]}},"/sms/{serviceName}/users/{login}/receivers/{slotId}/csv":{"get":{"summary":"Get the receiver list CSV","description":"Get the receiver list CSV. Returns the content of the receiver list in CSV format. The number of records is given when getting the receiver list.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"login","description":"The sms user login","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"slotId","description":"Slot number id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","API Users@@@240"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/users/{login}/receivers/{slotId}/csv\")\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}/users/{login}/receivers/{slotId}/csv\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:users/receivers/csv/get","required":true}]}}}}