{"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.CarrierSip":{"type":"object","description":"CarrierSip","properties":{"description":{"type":"string","readOnly":true},"serviceName":{"type":"string","readOnly":true},"serviceType":{"allOf":[{"$ref":"#/components/schemas/telephony.TypeServiceEnum"}],"readOnly":true}}},"telephony.CarrierSipClusterInfo":{"type":"object","description":"The information about the Carrier SIP cluster attached to your service","properties":{"name":{"type":"string","description":"The name of the cluster"},"zones":{"type":"array","description":"The availability zones of the cluster","items":{"$ref":"#/components/schemas/telephony.CarrierSipClusterZone"}}}},"telephony.CarrierSipClusterZone":{"type":"object","description":"The information about a carrier sip cluster zone","properties":{"mediaIps":{"type":"array","description":"The list of media (RTP) ips of this zone","items":{"$ref":"#/components/schemas/ipv4"}},"region":{"allOf":[{"$ref":"#/components/schemas/telephony.CarrierSipClusterZoneRegionEnum"}],"description":"The region of the cluster (rbx, sbg,...)"}}},"telephony.CarrierSipClusterZoneRegionEnum":{"type":"string","description":"Carrier SIP Zone Regions","enum":["rbx","sbg"]},"telephony.CarrierSipCustomerEndpoint":{"type":"object","description":"Carrier SIP Endpoints","properties":{"enableIncomingCalls":{"type":"boolean","description":"Should we send incoming calls to this endpoint","readOnly":true},"id":{"type":"integer","description":"SIP Endpoint id","readOnly":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"SIP Endpoint IP","readOnly":true},"port":{"type":"integer","description":"SIP Endpoint port","readOnly":true},"priority":{"type":"integer","description":"SIP Endpoint priority (DNS SRV)","readOnly":true},"protocol":{"allOf":[{"$ref":"#/components/schemas/telephony.CarrierSipEndpointProtocolEnum"}],"description":"The protocol of the endpoint (udp/tcp/tls)","readOnly":true},"weight":{"type":"integer","description":"SIP Endpoint weight (DNS SRV)","readOnly":true}}},"telephony.CarrierSipDetails":{"type":"object","description":"Carrier SIP Properties","properties":{"description":{"type":"string","description":"The carrier SIP trunk description"},"maxCallsPerSecond":{"type":"integer","description":"The maximum call establishments per second on your carrier sip service","readOnly":true},"maxConcurrentCalls":{"type":"integer","description":"The maximum concurrent calls on your carrier sip service","readOnly":true}}},"telephony.CarrierSipEndpointProtocolEnum":{"type":"string","description":"Protocol of a carrier sip trunk customer endpoint","enum":["tcp","tls","udp"]},"telephony.CarrierSipVnoMandate":{"type":"object","description":"Carrier SIP VNO mandate","properties":{"applicationDate":{"type":"string","description":"Date at which the associated ranges will be routed.","format":"date-time","readOnly":true},"contractReference":{"type":"string","description":"The reference written on your VNO contract.","readOnly":true}}},"telephony.CarrierSipVnoRange":{"type":"object","description":"Carrier SIP VNO range","properties":{"description":{"type":"string","description":"The carrier SIP trunk description."},"prefix":{"type":"string","description":"The phone range prefix.","readOnly":true}}},"telephony.Document":{"type":"object","description":"Document linked to a telephony service","properties":{"description":{"type":"string","description":"Description of the document","nullable":true},"id":{"type":"string","description":"Identifier of the document","format":"uuid","readOnly":true},"name":{"type":"string","description":"Name of the document"},"size":{"type":"integer","description":"Document size (in bytes)","readOnly":true},"url":{"type":"string","description":"URL to get document","readOnly":true},"validationDate":{"type":"string","description":"Document validation date","nullable":true,"format":"date-time","readOnly":true}}},"telephony.TypeServiceEnum":{"type":"string","description":"All existing types","enum":["alias","line"]},"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}/carrierSip":{"get":{"summary":"List Carrier SIP services","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","Carrier SIP","Carrier Settings@@@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}/carrierSip\")\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}/carrierSip\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/get","required":true}],"x-expanded-response":"TelephonyCarrierSip"}},"/telephony/{billingAccount}/carrierSip/{serviceName}":{"get":{"summary":"Get a Carrier SIP service","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.CarrierSip"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Carrier SIP","Carrier Settings@@@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}/carrierSip/{serviceName}\")\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}/carrierSip/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/get","required":true}]}},"/telephony/{billingAccount}/carrierSip/{serviceName}/cdrs":{"get":{"summary":"Get call detail records","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"query","name":"month","description":"The month you want to extract (format: YYYY-MM). Current month if not specified.","schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.Document"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Carrier SIP","Carrier Settings@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/carrierSip/{serviceName}/cdrs\")\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}/carrierSip/{serviceName}/cdrs\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/cdrs/get","required":true}]}},"/telephony/{billingAccount}/carrierSip/{serviceName}/clusterDetails":{"get":{"summary":"Get the cluster details","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.CarrierSipClusterInfo"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Carrier SIP","Carrier Settings@@@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.get(\"/telephony/{billingAccount}/carrierSip/{serviceName}/clusterDetails\")\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}/carrierSip/{serviceName}/clusterDetails\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/clusterDetails/get","required":true}]}},"/telephony/{billingAccount}/carrierSip/{serviceName}/endpoints":{"get":{"summary":"List SIP endpoints","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","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","Carrier SIP","Carrier Settings@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/carrierSip/{serviceName}/endpoints\")\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}/carrierSip/{serviceName}/endpoints\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/endpoints/get","required":true}],"x-expanded-response":"TelephonyCarrierSipCustomerEndpoint"}},"/telephony/{billingAccount}/carrierSip/{serviceName}/endpoints/{id}":{"get":{"summary":"Get a SIP endpoint","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"id","description":"Id of the object","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.CarrierSipCustomerEndpoint"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Carrier SIP","Carrier Settings@@@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}/carrierSip/{serviceName}/endpoints/{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}/carrierSip/{serviceName}/endpoints/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/endpoints/get","required":true}]}},"/telephony/{billingAccount}/carrierSip/{serviceName}/settings":{"get":{"summary":"Get the settings","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.CarrierSipDetails"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Carrier SIP","Carrier Settings@@@70"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/carrierSip/{serviceName}/settings\")\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}/carrierSip/{serviceName}/settings\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/settings/get","required":true}]},"put":{"summary":"Update the settings","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.CarrierSipDetails"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Carrier SIP","Carrier Settings@@@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\n# Request body type: telephony.CarrierSipDetails\nresult = client.put(\"/telephony/{billingAccount}/carrierSip/{serviceName}/settings\",\n\tdescription = None, # The carrier SIP trunk description (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.CarrierSipDetails\n$result = $ovh->put(\"/telephony/{billingAccount}/carrierSip/{serviceName}/settings\", array(\n\tdescription => null, // The carrier SIP trunk description (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/settings/edit","required":true}]}},"/telephony/{billingAccount}/carrierSip/{serviceName}/vno":{"get":{"summary":"List VNO mandates","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","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","Carrier SIP","Carrier Settings@@@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}/carrierSip/{serviceName}/vno\")\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}/carrierSip/{serviceName}/vno\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/vno/mandates/get","required":true}],"x-expanded-response":"TelephonyCarrierSipVnoMandate"}},"/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}":{"get":{"summary":"Get a VNO mandate","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"contractReference","description":"The reference written on your VNO contract.","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.CarrierSipVnoMandate"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Carrier SIP","Carrier Settings@@@100"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}\")\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}/carrierSip/{serviceName}/vno/{contractReference}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/vno/mandates/get","required":true}]}},"/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges":{"get":{"summary":"List mandate number ranges","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"contractReference","description":"The reference written on your VNO contract.","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","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","Carrier SIP","Carrier Settings@@@110"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges\")\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}/carrierSip/{serviceName}/vno/{contractReference}/ranges\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/vno/ranges/get","required":true}],"x-expanded-response":"TelephonyCarrierSipVnoRange"}},"/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges/{prefix}":{"get":{"summary":"Get a number range","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"contractReference","description":"The reference written on your VNO contract.","required":true,"schema":{"type":"string"}},{"in":"path","name":"prefix","description":"The phone range prefix.","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.CarrierSipVnoRange"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Carrier SIP","Carrier Settings@@@120"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges/{prefix}\")\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}/carrierSip/{serviceName}/vno/{contractReference}/ranges/{prefix}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/vno/ranges/get","required":true}]},"put":{"summary":"Update a number range","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"billingAccount","description":"The name of your billingAccount","required":true,"schema":{"type":"string"}},{"in":"path","name":"contractReference","description":"The reference written on your VNO contract.","required":true,"schema":{"type":"string"}},{"in":"path","name":"prefix","description":"The phone range prefix.","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.CarrierSipVnoRange"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Carrier SIP","Carrier Settings@@@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\n# Request body type: telephony.CarrierSipVnoRange\nresult = client.put(\"/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges/{prefix}\",\n\tdescription = None, # The carrier SIP trunk description. (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.CarrierSipVnoRange\n$result = $ovh->put(\"/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges/{prefix}\", array(\n\tdescription => null, // The carrier SIP trunk description. (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:carrierSip/vno/ranges/edit","required":true}]}}}}