{"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"},"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.PhonebookContact":{"type":"object","description":"Phone book contact","properties":{"group":{"type":"string","description":"Group name of the phonebook"},"homeMobile":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Home mobile phone number of the contact","nullable":true},"homePhone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"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/phoneNumber"}],"description":"Mobile phone office number of the contact","nullable":true},"workPhone":{"allOf":[{"$ref":"#/components/schemas/phoneNumber"}],"description":"Landline phone office number of the contact","nullable":true}}},"telephony.PhonebookMaster":{"type":"object","description":"Phone book on group","properties":{"bookKey":{"type":"string","description":"Identifier of the phonebook","readOnly":true},"name":{"type":"string","description":"Phone book name"}}},"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":{"/telephony/{billingAccount}/phonebook":{"get":{"summary":"List phonebooks","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","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","Telephony","SIP Lines","Phones & Softphones@@@470"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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(\"/telephony/{billingAccount}/phonebook\")\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(\"/telephony/{billingAccount}/phonebook\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/get","required":true}],"x-expanded-response":"TelephonyPhonebookMaster"},"post":{"summary":"Create a phonebook","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","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","Telephony","SIP Lines","Phones & Softphones@@@490"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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(\"/telephony/{billingAccount}/phonebook\",\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(\"/telephony/{billingAccount}/phonebook\", array(\n\tname => null, // Name of the wanted phonebook (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/create","required":true}]}},"/telephony/{billingAccount}/phonebook/{bookKey}":{"delete":{"summary":"Delete a phonebook","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@500"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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(\"/telephony/{billingAccount}/phonebook/{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(\"/telephony/{billingAccount}/phonebook/{bookKey}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/delete","required":true}]},"get":{"summary":"Get a phonebook","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PhonebookMaster"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@480"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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(\"/telephony/{billingAccount}/phonebook/{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(\"/telephony/{billingAccount}/phonebook/{bookKey}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/get","required":true}]},"put":{"summary":"Update a phonebook","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PhonebookMaster"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@510"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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: telephony.PhonebookMaster\nresult = client.put(\"/telephony/{billingAccount}/phonebook/{bookKey}\",\n\tname = None, # Phone book 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: telephony.PhonebookMaster\n$result = $ovh->put(\"/telephony/{billingAccount}/phonebook/{bookKey}\", array(\n\tname => null, // Phone book name (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/edit","required":true}]}},"/telephony/{billingAccount}/phonebook/{bookKey}/export":{"get":{"summary":"Export contacts","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"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"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PcsFile"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@520"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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(\"/telephony/{billingAccount}/phonebook/{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(\"/telephony/{billingAccount}/phonebook/{bookKey}/export\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/export/get","required":true}]}},"/telephony/{billingAccount}/phonebook/{bookKey}/import":{"post":{"summary":"Import contacts","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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","Telephony","SIP Lines","Phones & Softphones@@@530"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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(\"/telephony/{billingAccount}/phonebook/{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(\"/telephony/{billingAccount}/phonebook/{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":"voip:apiovh:phonebook/import","required":true}]}},"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact":{"get":{"summary":"List contacts","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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","Telephony","SIP Lines","Phones & Softphones@@@540"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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(\"/telephony/{billingAccount}/phonebook/{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(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/phonebookContact/get","required":true}],"x-expanded-response":"TelephonyPhonebookContact"},"post":{"summary":"Create a contact","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"bookKey","description":"Identifier of the phonebook","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/phoneNumber"},"homePhone":{"description":"Home landline phone number of the contact","$ref":"#/components/schemas/phoneNumber"},"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/phoneNumber"},"workPhone":{"description":"Landline phone office number of the contact","$ref":"#/components/schemas/phoneNumber"}},"required":["group","name","surname"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"integer"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@560"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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: phoneNumber\nresult = client.post(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact\",\n\tgroup = None, # Group name of the phonebook (type: string)\n\thomeMobile = None, # Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone = None, # Home landline phone number of the contact (type: phoneNumber, 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: phoneNumber, nullable)\n\tworkPhone = None, # Landline phone office number of the contact (type: phoneNumber, 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: phoneNumber\n$result = $ovh->post(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact\", array(\n\tgroup => null, // Group name of the phonebook (type: string)\n\thomeMobile => null, // Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone => null, // Home landline phone number of the contact (type: phoneNumber, 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: phoneNumber, nullable)\n\tworkPhone => null, // Landline phone office number of the contact (type: phoneNumber, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/phonebookContact/create","required":true}]}},"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}":{"delete":{"summary":"Delete a contact","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"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"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@570"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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(\"/telephony/{billingAccount}/phonebook/{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(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/phonebookContact/delete","required":true}]},"get":{"summary":"Get a contact","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"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"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PhonebookContact"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@550"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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(\"/telephony/{billingAccount}/phonebook/{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(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/phonebookContact/get","required":true}]},"put":{"summary":"Update a contact","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.PhonebookContact"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","SIP Lines","Phones & Softphones@@@580"],["Web Cloud","Telephony","Billing Accounts","Address Book@@@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: telephony.PhonebookContact\nresult = client.put(\"/telephony/{billingAccount}/phonebook/{bookKey}/phonebookContact/{id}\",\n\tgroup = None, # Group name of the phonebook (type: string)\n\thomeMobile = None, # Home mobile phone number of the contact (type: phoneNumber, nullable)\n\thomePhone = None, # Home landline phone number of the contact (type: phoneNumber, 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: phoneNumber, nullable)\n\tworkPhone = None, # Landline phone office number of the contact (type: phoneNumber, 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: telephony.PhonebookContact\n$result = $ovh->put(\"/telephony/{billingAccount}/phonebook/{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: phoneNumber, nullable)\n\thomePhone => null, // Home landline phone number of the contact (type: phoneNumber, 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: phoneNumber, nullable)\n\tworkPhone => null, // Landline phone office number of the contact (type: phoneNumber, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:phonebook/phonebookContact/edit","required":true}]}}}}