{"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.Phonebook":{"type":"object","description":"Phone book","properties":{"bookKey":{"type":"string","description":"Identifier of the phonebook","readOnly":true},"name":{"type":"string","description":"Phonebook name"},"phoneKey":{"type":"string","description":"Phone key identifier between the phone and phonebooks","readOnly":true}}},"sms.PhonebookContact":{"type":"object","description":"Phone book contact","properties":{"group":{"type":"string","description":"Group name of the phonebook"},"homeMobile":{"allOf":[{"$ref":"#/components/schemas/internationalPhoneNumber"}],"description":"Home mobile phone number of the contact","nullable":true},"homePhone":{"allOf":[{"$ref":"#/components/schemas/internationalPhoneNumber"}],"description":"Home landline phone number of the contact","nullable":true},"id":{"type":"integer","description":"Contact identifier","readOnly":true},"name":{"type":"string","description":"Contact name"},"surname":{"type":"string","description":"Contact surname"},"workMobile":{"allOf":[{"$ref":"#/components/schemas/internationalPhoneNumber"}],"description":"Mobile phone office number of the contact","nullable":true},"workPhone":{"allOf":[{"$ref":"#/components/schemas/internationalPhoneNumber"}],"description":"Landline phone office number of the contact","nullable":true}}},"sms.Receiver":{"type":"object","description":"Sms receivers preloaded","properties":{"autoUpdate":{"type":"boolean","description":"Download file from URL before sending to contacts (works only with csvUrl and not document ID)"},"canAutoUpdate":{"type":"boolean","description":"Is the object compatible with autoUpdate","readOnly":true},"datetime":{"type":"string","description":"Creation date of the document","format":"date-time","readOnly":true},"description":{"type":"string","description":"Description name of the document"},"records":{"type":"integer","description":"Number of receiver records in the document","readOnly":true},"slotId":{"type":"integer","description":"Slot number id","readOnly":true}}},"sms.ReceiversAsynchronousCleanReport":{"type":"object","description":"A structure giving operation price and asynchronous task ID","properties":{"taskId":{"type":"integer"},"totalCreditsRemoved":{"type":"number"}}},"telephony.ContactsExportFormatsEnum":{"type":"string","description":"Export file format","enum":["csv"]},"telephony.PcsFile":{"type":"object","description":"Telephony API related file hosted","properties":{"filename":{"type":"string","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/telephony.PcsFileStatusEnum"}],"readOnly":true},"url":{"type":"string","readOnly":true},"urlExpirationDatetime":{"type":"string","format":"date-time","readOnly":true}}},"telephony.PcsFileStatusEnum":{"type":"string","description":"File providing task status","enum":["doing","done","error","todo"]},"telephony.Task":{"type":"object","description":"Operation on a telephony service","properties":{"action":{"type":"string","description":"Action associated with the task","readOnly":true},"message":{"type":"string","description":"Potential failure reason of the task","nullable":true,"readOnly":true},"objectCreated":{"type":"string","description":"Object potentially created at the end of the task","nullable":true,"readOnly":true},"serviceType":{"type":"string","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/telephony.TaskStatusEnum"}],"description":"Status of the task","readOnly":true},"taskId":{"type":"integer","readOnly":true}}},"telephony.TaskStatusEnum":{"type":"string","description":"Task status","enum":["doing","done","error","pause","todo"]},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/sms/{serviceName}/phonebooks":{"get":{"summary":"List phonebooks","description":"List phonebooks. Returns the identifiers (bookKey) of the phonebooks of the SMS account. A phonebook stores contacts with their phone numbers.","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","Contacts@@@10"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/phonebooks\")\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}/phonebooks\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/get","required":true}],"x-expanded-response":"SmsPhonebook"},"post":{"summary":"Create a phonebook","description":"Create a phonebook. Creates a phonebook with a name. Returns its identifier (bookKey), used to add or import contacts.","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":{"name":{"type":"string","description":"Name of the wanted phonebook"}},"required":["name"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/sms/{serviceName}/phonebooks\",\n\tname = None, # Name of the wanted phonebook (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/sms/{serviceName}/phonebooks\", array(\n\tname => null, // Name of the wanted phonebook (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/create","required":true}]}},"/sms/{serviceName}/phonebooks/{bookKey}":{"delete":{"summary":"Delete a phonebook","description":"Delete a phonebook. Deletes the phonebook and its contacts. Export the contacts first to keep a copy of them.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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","Contacts@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/sms/{serviceName}/phonebooks/{bookKey}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/sms/{serviceName}/phonebooks/{bookKey}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/delete","required":true}]},"get":{"summary":"Get a phonebook","description":"Get a phonebook. Returns the name and the identifier (bookKey) of the phonebook. Its contacts are listed with the phonebookContact route.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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.Phonebook"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@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}/phonebooks/{bookKey}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/sms/{serviceName}/phonebooks/{bookKey}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/get","required":true}]},"put":{"summary":"Update a phonebook","description":"Update a phonebook. Updates the name of the phonebook. The contacts are updated one by one with the phonebookContact route.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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.Phonebook"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: sms.Phonebook\nresult = client.put(\"/sms/{serviceName}/phonebooks/{bookKey}\",\n\tname = None, # Phonebook name (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: sms.Phonebook\n$result = $ovh->put(\"/sms/{serviceName}/phonebooks/{bookKey}\", array(\n\tname => null, // Phonebook name (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/edit","required":true}]}},"/sms/{serviceName}/phonebooks/{bookKey}/export":{"get":{"summary":"Export contacts","description":"Export contacts. Exports the contacts of the phonebook to a file in CSV format. Returns the file to download.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"query","name":"format","description":"Format of the file","required":true,"schema":{"$ref":"#/components/schemas/telephony.ContactsExportFormatsEnum"}},{"in":"path","name":"serviceName","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/telephony.PcsFile"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@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}/phonebooks/{bookKey}/export\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/sms/{serviceName}/phonebooks/{bookKey}/export\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/export/get","required":true}]}},"/sms/{serviceName}/phonebooks/{bookKey}/import":{"post":{"summary":"Import contacts","description":"Import contacts. Imports contacts into the phonebook from an Excel (.xls, .xlsx) or CSV file in /me/document. Returns the task that performs the import.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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":{"documentId":{"type":"string","description":"ID of the /me/document file you want to import"}},"required":["documentId"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@70"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: string\nresult = client.post(\"/sms/{serviceName}/phonebooks/{bookKey}/import\",\n\tdocumentId = None, # ID of the /me/document file you want to import (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string\n$result = $ovh->post(\"/sms/{serviceName}/phonebooks/{bookKey}/import\", array(\n\tdocumentId => null, // ID of the /me/document file you want to import (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/import","required":true}]}},"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact":{"get":{"summary":"List contacts","description":"List contacts. Returns the identifiers of the contacts of the phonebook. Get a contact for its name, group and phone numbers.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@80"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/phonebookContact/get","required":true}],"x-expanded-response":"SmsPhonebookContact"},"post":{"summary":"Create a contact","description":"Create a contact. Creates a contact in the phonebook with a name, surname, group and phone numbers. Returns its identifier.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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":{"group":{"type":"string","description":"Group name of the phonebook"},"homeMobile":{"description":"Home mobile phone number of the contact","$ref":"#/components/schemas/internationalPhoneNumber"},"homePhone":{"description":"Home landline phone number of the contact","$ref":"#/components/schemas/internationalPhoneNumber"},"name":{"type":"string","description":"Name of the contact"},"surname":{"type":"string","description":"Contact surname"},"workMobile":{"description":"Mobile phone office number of the contact","$ref":"#/components/schemas/internationalPhoneNumber"},"workPhone":{"description":"Landline phone office number of the contact","$ref":"#/components/schemas/internationalPhoneNumber"}},"required":["group","name","surname"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"integer"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@100"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: internationalPhoneNumber\nresult = client.post(\"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact\",\n\tgroup = None, # Group name of the phonebook (type: string)\n\thomeMobile = None, # Home mobile phone number of the contact (type: internationalPhoneNumber, nullable)\n\thomePhone = None, # Home landline phone number of the contact (type: internationalPhoneNumber, nullable)\n\tname = None, # Name of the contact (type: string)\n\tsurname = None, # Contact surname (type: string)\n\tworkMobile = None, # Mobile phone office number of the contact (type: internationalPhoneNumber, nullable)\n\tworkPhone = None, # Landline phone office number of the contact (type: internationalPhoneNumber, 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: internationalPhoneNumber\n$result = $ovh->post(\"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact\", array(\n\tgroup => null, // Group name of the phonebook (type: string)\n\thomeMobile => null, // Home mobile phone number of the contact (type: internationalPhoneNumber, nullable)\n\thomePhone => null, // Home landline phone number of the contact (type: internationalPhoneNumber, nullable)\n\tname => null, // Name of the contact (type: string)\n\tsurname => null, // Contact surname (type: string)\n\tworkMobile => null, // Mobile phone office number of the contact (type: internationalPhoneNumber, nullable)\n\tworkPhone => null, // Landline phone office number of the contact (type: internationalPhoneNumber, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/phonebookContact/create","required":true}]}},"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact/{id}":{"delete":{"summary":"Delete a contact","description":"Delete a contact. Deletes the contact from the phonebook, with its name, group and office and home phone numbers.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Contact identifier","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","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","Contacts@@@110"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/phonebookContact/delete","required":true}]},"get":{"summary":"Get a contact","description":"Get a contact. Returns the contact: name, surname, group, and office and home phone numbers, landline and mobile.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Contact identifier","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","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.PhonebookContact"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@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}/phonebooks/{bookKey}/phonebookContact/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/phonebookContact/get","required":true}]},"put":{"summary":"Update a contact","description":"Update a contact. Updates the contact: name, surname, group, and office and home phone numbers, landline and mobile.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Contact identifier","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.PhonebookContact"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@120"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: sms.PhonebookContact\nresult = client.put(\"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact/{id}\",\n\tgroup = None, # Group name of the phonebook (type: string)\n\thomeMobile = None, # Home mobile phone number of the contact (type: internationalPhoneNumber, nullable)\n\thomePhone = None, # Home landline phone number of the contact (type: internationalPhoneNumber, nullable)\n\tname = None, # Contact name (type: string)\n\tsurname = None, # Contact surname (type: string)\n\tworkMobile = None, # Mobile phone office number of the contact (type: internationalPhoneNumber, nullable)\n\tworkPhone = None, # Landline phone office number of the contact (type: internationalPhoneNumber, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: sms.PhonebookContact\n$result = $ovh->put(\"/sms/{serviceName}/phonebooks/{bookKey}/phonebookContact/{id}\", array(\n\tgroup => null, // Group name of the phonebook (type: string)\n\thomeMobile => null, // Home mobile phone number of the contact (type: internationalPhoneNumber, nullable)\n\thomePhone => null, // Home landline phone number of the contact (type: internationalPhoneNumber, nullable)\n\tname => null, // Contact name (type: string)\n\tsurname => null, // Contact surname (type: string)\n\tworkMobile => null, // Mobile phone office number of the contact (type: internationalPhoneNumber, nullable)\n\tworkPhone => null, // Landline phone office number of the contact (type: internationalPhoneNumber, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:phonebooks/phonebookContact/edit","required":true}]}},"/sms/{serviceName}/receivers":{"get":{"summary":"List receiver lists","description":"List receiver lists. Returns the identifiers (slotId) of the receiver lists. A receiver list is a CSV or text document of numbers, used to send SMS in bulk.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"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","Contacts@@@130"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/receivers\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/sms/{serviceName}/receivers\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:receivers/get","required":true}],"x-expanded-response":"SmsReceiver"},"post":{"summary":"Create a receiver list","description":"Create a receiver list. Creates a receiver list from a CSV file, given as a /me/document identifier or a URL. With a URL, the file can be downloaded again before each sending.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"autoUpdate":{"type":"boolean","description":"Download file from URL before sending to contacts (works only with csvUrl and not document ID)"},"csvUrl":{"type":"string","description":"URL of the file you want to import"},"description":{"type":"string","description":"Description name of the document"},"documentId":{"type":"string","description":"ID of the /me/document file you want to import"},"slotId":{"type":"integer","description":"Slot number id used to handle the document"}},"required":["autoUpdate","description","slotId"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.Receiver"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@150"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: long\nresult = client.post(\"/sms/{serviceName}/receivers\",\n\tautoUpdate = None, # Download file from URL before sending to contacts (works only with csvUrl and not document ID) (type: boolean)\n\tcsvUrl = None, # URL of the file you want to import (type: string, nullable)\n\tdescription = None, # Description name of the document (type: string)\n\tdocumentId = None, # ID of the /me/document file you want to import (type: string, nullable)\n\tslotId = None, # Slot number id used to handle the document (type: long)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: long\n$result = $ovh->post(\"/sms/{serviceName}/receivers\", array(\n\tautoUpdate => null, // Download file from URL before sending to contacts (works only with csvUrl and not document ID) (type: boolean)\n\tcsvUrl => null, // URL of the file you want to import (type: string, nullable)\n\tdescription => null, // Description name of the document (type: string)\n\tdocumentId => null, // ID of the /me/document file you want to import (type: string, nullable)\n\tslotId => null, // Slot number id used to handle the document (type: long)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:receivers/create","required":true}]}},"/sms/{serviceName}/receivers/{slotId}":{"delete":{"summary":"Delete a receiver list","description":"Delete a receiver list. Deletes the receiver list. It can no longer be used as the receivers of an SMS sending (receiversSlotId).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"slotId","description":"Slot number id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@160"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/sms/{serviceName}/receivers/{slotId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/sms/{serviceName}/receivers/{slotId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:receivers/delete","required":true}]},"get":{"summary":"Get a receiver list","description":"Get a receiver list. Returns the receiver list: description, number of records and automatic update settings.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"slotId","description":"Slot number id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.Receiver"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@140"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/receivers/{slotId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/sms/{serviceName}/receivers/{slotId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:receivers/get","required":true}]},"put":{"summary":"Update a receiver list","description":"Update a receiver list. Updates the description of the receiver list and its automatic update, which downloads the file from its URL before each sending.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"slotId","description":"Slot number id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.Receiver"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@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\n# Request body type: sms.Receiver\nresult = client.put(\"/sms/{serviceName}/receivers/{slotId}\",\n\tautoUpdate = None, # Download file from URL before sending to contacts (works only with csvUrl and not document ID) (type: boolean)\n\tdescription = None, # Description name of the document (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: sms.Receiver\n$result = $ovh->put(\"/sms/{serviceName}/receivers/{slotId}\", array(\n\tautoUpdate => null, // Download file from URL before sending to contacts (works only with csvUrl and not document ID) (type: boolean)\n\tdescription => null, // Description name of the document (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:receivers/edit","required":true}]}},"/sms/{serviceName}/receivers/{slotId}/clean":{"post":{"summary":"Clean a receiver list","description":"Clean a receiver list. Removes the invalid and inactive numbers from the receiver list, with an HLR lookup on each number. A report is sent by email at the end.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"slotId","description":"Slot number id","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"freemium":{"type":"boolean","description":"Limit checks to syntaxical validation"},"priceOnly":{"type":"boolean","description":"Only get action's price in credits without executing it"}},"required":["freemium","priceOnly"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/sms.ReceiversAsynchronousCleanReport"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@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.post(\"/sms/{serviceName}/receivers/{slotId}/clean\",\n\tfreemium = None, # Limit checks to syntaxical validation (type: boolean)\n\tpriceOnly = None, # Only get action's price in credits without executing it (type: boolean)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/sms/{serviceName}/receivers/{slotId}/clean\", array(\n\tfreemium => null, // Limit checks to syntaxical validation (type: boolean)\n\tpriceOnly => null, // Only get action's price in credits without executing it (type: boolean)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:receivers/clean","required":true}]}},"/sms/{serviceName}/receivers/{slotId}/csv":{"get":{"summary":"Get the receiver list CSV","description":"Get the receiver list CSV. Returns the content of the receiver list in CSV format. The number of records is given when getting the receiver list.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your SMS offer","required":true,"schema":{"type":"string"}},{"in":"path","name":"slotId","description":"Slot number id","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","SMS","Contacts@@@190"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/sms/{serviceName}/receivers/{slotId}/csv\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/sms/{serviceName}/receivers/{slotId}/csv\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"sms:apiovh:receivers/csv/get","required":true}]}}}}