{"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.Batch":{"type":"object","description":"Batch of SMS to send","properties":{"accountID":{"type":"integer","description":"SMS account ID","readOnly":true},"createdAt":{"type":"string","description":"Creation datetime","format":"date-time","readOnly":true},"errors":{"type":"array","description":"Details on error(s) on the batch, if any","items":{"$ref":"#/components/schemas/sms.BatchError"},"readOnly":true},"estimatedCredits":{"type":"number","description":"The estimated cost of the batch in credits","readOnly":true},"finishedAt":{"type":"string","description":"Datetime when the batch finished processing SMSs","nullable":true,"format":"date-time","readOnly":true},"from":{"type":"string","description":"SMS sender","nullable":true,"readOnly":true},"id":{"type":"string","description":"Batch ID","format":"uuid","readOnly":true},"message":{"type":"string","description":"SMS message","readOnly":true},"name":{"type":"string","description":"Batch name","readOnly":true},"processedRecords":{"type":"integer","description":"Number of processed records in this batch","readOnly":true},"receivers":{"type":"array","description":"SMS receivers list","nullable":true,"items":{"$ref":"#/components/schemas/phoneNumber"},"readOnly":true},"sentAt":{"type":"string","description":"Datetime when the SMSs of the batch are sent (based on deferred time if exists)","nullable":true,"format":"date-time","readOnly":true},"slotID":{"type":"string","description":"Slot ID","nullable":true,"readOnly":true},"startedAt":{"type":"string","description":"Datetime when the batch started processing SMSs","nullable":true,"format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/sms.BatchStatusEnum"}],"description":"Batch status","readOnly":true},"totalRecords":{"type":"integer","description":"Total number of records in this batch","readOnly":true},"updatedAt":{"type":"string","description":"Last update datetime","format":"date-time","readOnly":true}}},"sms.BatchClassEnum":{"type":"string","description":"SMS classes","enum":["FLASH","PHONE","SIM"]},"sms.BatchError":{"type":"object","description":"Batch error details","properties":{"message":{"type":"string","description":"Error message","readOnly":true},"receiver":{"type":"string","description":"Receiver that triggered the error","readOnly":true}}},"sms.BatchParams":{"type":"object","description":"Params to create a batch","properties":{"class":{"allOf":[{"$ref":"#/components/schemas/sms.BatchClassEnum"}],"description":"Deprecated: SMS class"},"deferred":{"type":"string","description":"SMS deferred sending date","format":"date-time"},"from":{"type":"string","description":"SMS sender. Either \"from\" or \"senderForResponse\" must be passed"},"message":{"type":"string","description":"SMS message"},"name":{"type":"string","description":"Batch name"},"noStop":{"type":"boolean","description":"STOP clause not needed"},"senderForResponse":{"type":"boolean","description":"Ask to compute a sender that allows response. Either \"from\" or \"senderForResponse\" must be passed"},"slotID":{"type":"string","description":"SMS receivers slot ID. Either \"to\" or \"slotID\" must be passed"},"tag":{"type":"string","description":"SMS tag"},"to":{"type":"array","description":"SMS receivers list. Either \"to\" or \"slotID\" must be passed","items":{"$ref":"#/components/schemas/phoneNumber"}}},"required":["message"]},"sms.BatchStatistics":{"type":"object","description":"Batch's statistics","properties":{"credits":{"type":"number","description":"The cost of the batch in credits, computed during batch processing","readOnly":true},"delivered":{"type":"integer","description":"Number of SMS that are delivered","readOnly":true},"estimatedCredits":{"type":"number","description":"The estimated cost of the batch in credits, computed before batch processing","readOnly":true},"failed":{"type":"integer","description":"Number of SMS in error","readOnly":true},"id":{"type":"string","description":"Batch ID","format":"uuid","readOnly":true},"pending":{"type":"integer","description":"Number of SMS that are in pending status","readOnly":true},"sent":{"type":"integer","description":"Number of SMS that are sent to the broker","readOnly":true},"stoplisted":{"type":"integer","description":"Number of SMS that received a STOP by the receiver","readOnly":true}}},"sms.BatchStatusEnum":{"type":"string","description":"Batch statuses","enum":["CANCELED","CANCELING","COMPLETED","FAILED","INSERTED","INSERTING","PENDING","TO_CANCEL"]},"sms.BatchUpdateParams":{"type":"object","description":"Params to update a batch","properties":{"name":{"type":"string","description":"Batch name"}},"required":["name"]},"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.EncodingEnum":{"type":"string","description":"The SMS available characters class","enum":["7bits","unicode"]},"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.HlrLookupNumber":{"type":"object","description":"Home Location Register informations. Give informations about a given cellular phone.","properties":{"datetime":{"type":"string","description":"HLR creation datetime","format":"date-time","readOnly":true},"id":{"type":"integer","description":"HLR id","readOnly":true},"msisdn":{"type":"string","description":"MSISDN","readOnly":true},"operatorCode":{"type":"string","description":"The {Mobile Country Code, Mobile Network Code} unique identifier","readOnly":true},"ported":{"type":"boolean","description":"Has the MSISDN been ported from its original network","readOnly":true},"reachable":{"type":"boolean","description":"Is the MSISDN currently reachable","readOnly":true},"roaming":{"type":"boolean","description":"Is the MSISDN currently roaming outside its natinal network","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/sms.HlrStatuses"}],"description":"Status of the HLR request","readOnly":true},"valid":{"type":"boolean","description":"Is the MSISDN valid","readOnly":true}}},"sms.HlrStatuses":{"type":"string","description":"The sms coding","enum":["doing","done","error","todo"]},"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.JobEstimate":{"type":"object","description":"A structure describing the encoding, length and number of SMS parts of a text message","properties":{"characters":{"type":"integer","description":"The number of characters the message contains, including invisible escaped characters"},"charactersClass":{"allOf":[{"$ref":"#/components/schemas/sms.EncodingEnum"}],"description":"The characters class that will be used to send the SMS, depending on characters in message"},"maxCharactersPerPart":{"type":"integer","description":"The number of characters every SMS part can contain, depending on characters class and quantity of parts"},"parts":{"type":"integer","description":"The quantity of SMS parts the message will be split in"}}},"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.PttDetails":{"type":"object","description":"A structure describing ptt details","properties":{"comment":{"type":"string","description":"Ptt informations"},"description":{"type":"string","description":"Ptt short description"},"duration":{"allOf":[{"$ref":"#/components/schemas/sms.PttDurationTypeEnum"}],"description":"Ptt volatility type"}}},"sms.PttDurationTypeEnum":{"type":"string","description":"All typology of ptt duration","enum":["indeterminated","permanent","temporary"]},"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.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.StatusSenderEnum":{"type":"string","description":"All existing status for a given referer","enum":["disable","enable","refused","waitingValidation"]},"sms.TemplateControl":{"type":"object","description":"Sms template for moderation (Needed to send in US country)","properties":{"activity":{"allOf":[{"$ref":"#/components/schemas/sms.TypeTemplateEnum"}],"description":"Specify the kind of template"},"comment":{"type":"string","description":"Message sent by the moderator","readOnly":true},"datetime":{"type":"string","description":"Template creation datetime","format":"date-time","readOnly":true},"description":{"type":"string","description":"Template description"},"message":{"type":"string","description":"Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area."},"name":{"type":"string","description":"Name of the template"},"status":{"allOf":[{"$ref":"#/components/schemas/sms.StatusSenderEnum"}],"description":"Template status"}}},"sms.TypeSenderEnum":{"type":"string","description":"All existing types for a given sender","enum":["alpha","numeric","shortcode","time2chat","virtual"]},"sms.TypeTemplateEnum":{"type":"string","description":"All existing types for a given template","enum":["alerting","authentification","transactional"]},"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/estimate":{"post":{"summary":"Estimate a message","description":"Estimate a message. Returns the encoding, the length and the number of SMS parts needed to send a text message.","security":[{"oAuth2AuthCode":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"The message to send"},"noStopClause":{"type":"boolean","description":"Do not display STOP clause in the message, this requires that this is not an advertising message"},"senderType":{"description":"Sender type that will be used to send the message","$ref":"#/components/schemas/sms.TypeSenderEnum"}},"required":["message","noStopClause","senderType"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.JobEstimate"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive@@@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\n# Request body type: sms.TypeSenderEnum\nresult = client.post(\"/sms/estimate\",\n\tmessage = None, # The message to send (type: text)\n\tnoStopClause = None, # Do not display STOP clause in the message, this requires that this is not an advertising message (type: boolean)\n\tsenderType = None, # Sender type that will be used to send the message (type: sms.TypeSenderEnum)\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.TypeSenderEnum\n$result = $ovh->post(\"/sms/estimate\", array(\n\tmessage => null, // The message to send (type: text)\n\tnoStopClause => null, // Do not display STOP clause in the message, this requires that this is not an advertising message (type: boolean)\n\tsenderType => null, // Sender type that will be used to send the message (type: sms.TypeSenderEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:sms/estimate","required":true}]}},"/sms/ptts":{"get":{"summary":"Get a PTT code","description":"Get a PTT code. Returns the meaning of a PTT code. The PTT code is the delivery status code of an SMS, given in the ptt field of sent SMS and pending jobs.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"ptt","description":"The premium transaction tracking code","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.PttDetails"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive"]],"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/ptts\")\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/ptts\");\n\nprint_r($result);\n?>"}]}},"/sms/{serviceName}/batches":{"get":{"summary":"List batches","description":"Returns the batches of the SMS account.","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":{"$ref":"#/components/schemas/sms.Batch"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive"]],"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}/batches\")\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}/batches\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:batches/get","required":true}],"x-response-identifier":"id","x-expanded-response":"SmsBatch"},"post":{"summary":"Create a batch","description":"Creates a batch that sends one message to a list of receivers or to a receiver list. Set a sender, or ask for one that allows replies. Sending can be deferred to a later date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.BatchParams"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.Batch"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive"]],"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.BatchParams\nresult = client.post(\"/sms/{serviceName}/batches\",\n\tclass = None, # Deprecated: SMS class (type: sms.BatchClassEnum)\n\tdeferred = None, # SMS deferred sending date (type: string)\n\tfrom = None, # SMS sender. Either \"from\" or \"senderForResponse\" must be passed (type: string)\n\tmessage = None, # SMS message (type: string)\n\tname = None, # Batch name (type: string)\n\tnoStop = None, # STOP clause not needed (type: boolean)\n\tsenderForResponse = None, # Ask to compute a sender that allows response. Either \"from\" or \"senderForResponse\" must be passed (type: boolean)\n\tslotID = None, # SMS receivers slot ID. Either \"to\" or \"slotID\" must be passed (type: string)\n\ttag = None, # SMS tag (type: string)\n\tto = None, # SMS receivers list. Either \"to\" or \"slotID\" must be passed (type: array)\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.BatchParams\n$result = $ovh->post(\"/sms/{serviceName}/batches\", array(\n\tclass => null, // Deprecated: SMS class (type: sms.BatchClassEnum)\n\tdeferred => null, // SMS deferred sending date (type: string)\n\tfrom => null, // SMS sender. Either \"from\" or \"senderForResponse\" must be passed (type: string)\n\tmessage => null, // SMS message (type: string)\n\tname => null, // Batch name (type: string)\n\tnoStop => null, // STOP clause not needed (type: boolean)\n\tsenderForResponse => null, // Ask to compute a sender that allows response. Either \"from\" or \"senderForResponse\" must be passed (type: boolean)\n\tslotID => null, // SMS receivers slot ID. Either \"to\" or \"slotID\" must be passed (type: string)\n\ttag => null, // SMS tag (type: string)\n\tto => null, // SMS receivers list. Either \"to\" or \"slotID\" must be passed (type: array)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:batches/create","required":true}]}},"/sms/{serviceName}/batches/{id}":{"delete":{"summary":"Delete a batch","description":"Deletes the batch.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"string","format":"uuid"}},{"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","Send & Receive"]],"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}/batches/{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}/batches/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:batches/delete","required":true}]},"get":{"summary":"Get a batch","description":"Returns the batch: message, sender, receivers, status, estimated credits and errors.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"string","format":"uuid"}},{"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.Batch"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive"]],"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}/batches/{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}/batches/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:batches/get","required":true}],"x-response-identifier":"id"},"put":{"summary":"Update a batch","description":"Updates the batch name.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"string","format":"uuid"}},{"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.BatchUpdateParams"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.Batch"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive"]],"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.BatchUpdateParams\nresult = client.put(\"/sms/{serviceName}/batches/{id}\",\n\tname = None, # Batch name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: sms.BatchUpdateParams\n$result = $ovh->put(\"/sms/{serviceName}/batches/{id}\", array(\n\tname => null, // Batch name (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:batches/edit","required":true}]}},"/sms/{serviceName}/batches/{id}/cancel":{"post":{"summary":"Cancel a deferred batch","description":"Cancels a batch scheduled for later. Only possible if no SMS of the batch has been sent yet.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"string","format":"uuid"}},{"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.Batch"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive"]],"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}/batches/{id}/cancel\")\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}/batches/{id}/cancel\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:batches/cancel","required":true}]}},"/sms/{serviceName}/batches/{id}/statistics":{"get":{"summary":"Get batch statistics","description":"Returns the batch statistics: delivered, sent, pending, failed and stoplisted SMS, and the credits used.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"string","format":"uuid"}},{"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.BatchStatistics"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive"]],"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}/batches/{id}/statistics\")\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}/batches/{id}/statistics\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:batches/statistics/get","required":true}]}},"/sms/{serviceName}/hlr":{"get":{"summary":"List HLR lookups","description":"List HLR lookups. Returns the identifiers of the HLR lookups. An HLR lookup checks whether a mobile number is valid, reachable, ported or roaming.","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":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive@@@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}/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}/hlr\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:hlr/get","required":true}],"x-expanded-response":"SmsHlrLookupNumber"},"post":{"summary":"Request HLR lookups","description":"Request HLR lookups. Requests an HLR lookup for one or several mobile numbers, given as a list or a CSV document URL. Returns the lookup identifiers and the credits used.","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":{"receivers":{"type":"array","description":"The receivers","items":{"type":"string"}},"receiversDocumentUrl":{"type":"string","description":"The receivers document url link in csv format"}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.SmsSendingReport"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive@@@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.post(\"/sms/{serviceName}/hlr\",\n\treceivers = None, # The receivers (type: string[], nullable)\n\treceiversDocumentUrl = None, # The receivers document url link in csv format (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$result = $ovh->post(\"/sms/{serviceName}/hlr\", array(\n\treceivers => null, // The receivers (type: string[], nullable)\n\treceiversDocumentUrl => null, // The receivers document url link in csv format (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:hlr/create","required":true}]}},"/sms/{serviceName}/hlr/{id}":{"get":{"summary":"Get an HLR lookup","description":"Get an HLR lookup. Returns the result of the HLR lookup: validity, reachability, portability and roaming of the number.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"HLR id","required":true,"schema":{"type":"integer"}},{"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.HlrLookupNumber"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive@@@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/{serviceName}/hlr/{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}/hlr/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:hlr/get","required":true}]}},"/sms/{serviceName}/hlr/{id}/operator":{"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":"HLR id","required":true,"schema":{"type":"integer"}},{"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","Send & Receive@@@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}/hlr/{id}/operator\")\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}/hlr/{id}/operator\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:hlr/operator/get","required":true}]}},"/sms/{serviceName}/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":"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","Send & Receive@@@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}/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}/incoming\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:incoming/get","required":true}],"x-expanded-response":"SmsIncoming"}},"/sms/{serviceName}/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":"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","Send & Receive@@@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.delete(\"/sms/{serviceName}/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}/incoming/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh: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":"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","Send & Receive@@@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}/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}/incoming/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:incoming/get","required":true}]}},"/sms/{serviceName}/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":"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","Send & Receive@@@90"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/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}/jobs\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh: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":"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","Send & Receive@@@110"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/sms/{serviceName}/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}/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:jobs/create","required":true}]}},"/sms/{serviceName}/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":"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","Send & Receive@@@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}/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}/jobs/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh: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":"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","Send & Receive@@@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}/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}/jobs/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:jobs/get","required":true}]}},"/sms/{serviceName}/outgoing":{"get":{"summary":"List sent SMS","description":"Returns the identifiers of the SMS sent from the account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"batchID","description":"Filter on batch id property (=)","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"creationDatetime.from","description":"Filter on creationDatetime property (>=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"creationDatetime.to","description":"Filter on creationDatetime property (<=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"deliveryReceipt","description":"Filter on deliveryReceipt property (=)","schema":{"type":"integer"}},{"in":"query","name":"differedDelivery","description":"Filter on differedDelivery property (=)","schema":{"type":"integer"}},{"in":"query","name":"messageID","description":"Filter on message id property (=)","schema":{"type":"string","format":"uuid"}},{"in":"query","name":"ptt","description":"Filter on ptt property (=)","schema":{"type":"integer"}},{"in":"query","name":"receiver","description":"Filter on receiver property (=)","schema":{"type":"string"}},{"in":"query","name":"sender","description":"Filter on 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 on 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","Send & Receive"]],"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}/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}/outgoing\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:outgoing/get","required":true}],"x-expanded-response":"SmsOutgoing"}},"/sms/{serviceName}/outgoing/{id}":{"delete":{"summary":"Delete a sent SMS","description":"Deletes the sent SMS from the history.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}},{"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","Send & Receive"]],"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}/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}/outgoing/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:outgoing/delete","required":true}]},"get":{"summary":"Get a sent SMS","description":"Returns the sent SMS: receiver, message, delivery status, number of SMS parts and credits used.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Id","required":true,"schema":{"type":"integer"}},{"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","Send & Receive"]],"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}/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}/outgoing/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:outgoing/get","required":true}]}},"/sms/{serviceName}/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":"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","Send & Receive@@@160"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/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}/outgoing/{id}/hlr\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:outgoing/hlr/get","required":true}]}},"/sms/{serviceName}/templatesControl":{"get":{"summary":"List message templates","description":"List message templates. Returns the message templates. Sending SMS to the United States requires a template validated by a moderator.","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","Send & Receive@@@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}/templatesControl\")\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}/templatesControl\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:templatesControl/get","required":true}],"x-expanded-response":"SmsTemplateControl"},"post":{"summary":"Create a message template","description":"Create a message template. Creates a message template and submits it to moderation. Sending SMS to the United States requires a validated template.","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":{"activity":{"description":"Specify the kind of template","$ref":"#/components/schemas/sms.TypeTemplateEnum"},"description":{"type":"string","description":"Template description"},"message":{"type":"string","description":"Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area."},"name":{"type":"string","description":"Name of the template"},"reason":{"type":"string","description":"Message seen by the moderator"}},"required":["activity","message","name"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive@@@190"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/sms/{serviceName}/templatesControl\",\n\tactivity = None, # Specify the kind of template (type: sms.TypeTemplateEnum)\n\tdescription = None, # Template description (type: string, nullable)\n\tmessage = None, # Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area. (type: string)\n\tname = None, # Name of the template (type: string)\n\treason = None, # Message seen by the moderator (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: string\n$result = $ovh->post(\"/sms/{serviceName}/templatesControl\", array(\n\tactivity => null, // Specify the kind of template (type: sms.TypeTemplateEnum)\n\tdescription => null, // Template description (type: string, nullable)\n\tmessage => null, // Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area. (type: string)\n\tname => null, // Name of the template (type: string)\n\treason => null, // Message seen by the moderator (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:templatesControl/create","required":true}]}},"/sms/{serviceName}/templatesControl/{name}":{"delete":{"summary":"Delete a message template","description":"Delete a message template. Deletes the message template from the SMS account, whatever its moderation status.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Name of the template","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","Send & Receive@@@200"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/sms/{serviceName}/templatesControl/{name}\")\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}/templatesControl/{name}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:templatesControl/delete","required":true}]},"get":{"summary":"Get a message template","description":"Get a message template. Returns the message template: pattern, activity, status and moderator comment.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Name of the template","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.TemplateControl"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive@@@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}/templatesControl/{name}\")\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}/templatesControl/{name}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:templatesControl/get","required":true}]},"put":{"summary":"Update a message template","description":"Update a message template. Updates the message template: description, message pattern with #VALUE# dynamic areas, and kind (alerting, authentification or transactional).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Name of the template","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.TemplateControl"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive@@@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\n# Request body type: sms.TemplateControl\nresult = client.put(\"/sms/{serviceName}/templatesControl/{name}\",\n\tactivity = None, # Specify the kind of template (type: sms.TypeTemplateEnum)\n\tdescription = None, # Template description (type: string)\n\tmessage = None, # Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area. (type: string)\n\tname = None, # Name of the template (type: string)\n\tstatus = None, # Template status (type: sms.StatusSenderEnum)\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.TemplateControl\n$result = $ovh->put(\"/sms/{serviceName}/templatesControl/{name}\", array(\n\tactivity => null, // Specify the kind of template (type: sms.TypeTemplateEnum)\n\tdescription => null, // Template description (type: string)\n\tmessage => null, // Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area. (type: string)\n\tname => null, // Name of the template (type: string)\n\tstatus => null, // Template status (type: sms.StatusSenderEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:templatesControl/edit","required":true}]}},"/sms/{serviceName}/templatesControl/{name}/relaunchValidation":{"post":{"summary":"Relaunch template validation","description":"Relaunch template validation. Submits the message template to moderation again after a refusal, with an updated message pattern and description.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Name of the template","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":{"description":{"type":"string","description":"Template description"},"message":{"type":"string","description":"Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area"}},"required":["description","message"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","Send & Receive@@@220"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/sms/{serviceName}/templatesControl/{name}/relaunchValidation\",\n\tdescription = None, # Template description (type: string)\n\tmessage = None, # Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area (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}/templatesControl/{name}/relaunchValidation\", array(\n\tdescription => null, // Template description (type: string)\n\tmessage => null, // Message pattern to be moderated. Use \"#VALUE#\" format for dynamic text area (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:templatesControl/relaunchValidation","required":true}]}}}}