{"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.Fax":{"type":"object","description":"Fax service","properties":{"description":{"type":"string"},"notifications":{"allOf":[{"$ref":"#/components/schemas/telephony.LineNotificationsOptions"}],"description":"Send notifications about Line's diagnosticReports","nullable":true},"offers":{"type":"array","items":{"type":"string"},"readOnly":true},"serviceName":{"type":"string","readOnly":true},"serviceType":{"allOf":[{"$ref":"#/components/schemas/telephony.TypeServiceEnum"}],"readOnly":true}}},"telephony.FaxCampaign":{"type":"object","description":"Fax campaigns","properties":{"countFailed":{"type":"integer","description":"The count of failed faxes in the campaign","readOnly":true},"countSuccess":{"type":"integer","description":"The count of success faxes in the campaign","readOnly":true},"countTotal":{"type":"integer","description":"The total count of faxes in the campaign","readOnly":true},"dateEnd":{"type":"string","description":"The end date of the fax campaign","nullable":true,"format":"date-time","readOnly":true},"dateStart":{"type":"string","description":"The start date of the fax campaign","nullable":true,"format":"date-time","readOnly":true},"id":{"type":"integer","description":"The id of the fax campaign","readOnly":true},"name":{"type":"string","description":"The name of the fax campaign","readOnly":true},"reference":{"type":"string","description":"The reference of the fax campaign","readOnly":true},"status":{"type":"string","description":"The status of the fax campaign","readOnly":true}}},"telephony.FaxCampaignDetail":{"type":"object","description":"Detail of a fax campaign","properties":{"failed":{"type":"array","items":{"$ref":"#/components/schemas/phoneNumber"}},"success":{"type":"array","items":{"$ref":"#/components/schemas/phoneNumber"}},"todo":{"type":"array","items":{"$ref":"#/components/schemas/phoneNumber"}}}},"telephony.FaxCampaignRecipientsTypeEnum":{"type":"string","description":"Available recipients method for fax campaign","enum":["document","list"]},"telephony.FaxCampaignSendTypeEnum":{"type":"string","description":"Available sending method for fax campaign","enum":["automatic","manual","scheduled"]},"telephony.FaxMailFormatEnum":{"type":"string","description":"Format of the notification mail. \"html\" will include a preview image of the fax","enum":["html","text"]},"telephony.FaxProperties":{"type":"object","description":"Fax properties","properties":{"callNumber":{"type":"string","readOnly":true},"countryCode":{"type":"string","readOnly":true},"faxMaxCall":{"$ref":"#/components/schemas/telephony.FaxSendingTries"},"faxQuality":{"$ref":"#/components/schemas/telephony.FaxQualityEnum"},"faxTagLine":{"type":"string"},"fromEmail":{"type":"string"},"fromName":{"type":"string"},"mailFormat":{"$ref":"#/components/schemas/telephony.FaxMailFormatEnum"},"receiver":{"type":"string"},"redirectionEmail":{"type":"array","items":{"type":"string"}},"rejectAnonymous":{"type":"boolean"},"sender":{"type":"string"}}},"telephony.FaxQualityEnum":{"type":"string","description":"Available quality for fax documents","enum":["best","high","normal"]},"telephony.FaxScreen":{"type":"object","description":"Fax ScreenLists","properties":{"blacklistedNumbers":{"type":"array","description":"List of numbers not allowed to send a fax","nullable":true,"items":{"type":"string"}},"blacklistedTSI":{"type":"array","description":"List of logins (TSI or ID) not allowed to send a fax","nullable":true,"items":{"type":"string"}},"callNumber":{"type":"string","description":"Number of the fax service","readOnly":true},"countryCode":{"type":"string","description":"Country code of the fax service","readOnly":true},"filteringList":{"allOf":[{"$ref":"#/components/schemas/telephony.FaxScreenListTypeEnum"}],"description":"Which list is active (blackist, whitelist or none)","nullable":true,"readOnly":true},"serviceName":{"type":"string","readOnly":true},"whitelistedNumbers":{"type":"array","description":"List of numbers allowed to send a fax","nullable":true,"items":{"type":"string"}},"whitelistedTSI":{"type":"array","description":"List of logins (TSI or ID) allowed to send a fax","nullable":true,"items":{"type":"string"}}}},"telephony.FaxScreenListTypeEnum":{"type":"string","description":"Type of screen list","enum":["","blacklist","no","whitelist"]},"telephony.FaxSendingTries":{"type":"integer","description":"Number of tries when sending a fax","enum":[1,2,3,4,5,6,7,8,9]},"telephony.LineNotificationsLogsFrequencyEnum":{"type":"string","description":"Types of statistics available for a line.","enum":["Never","Once a day","Twice a day"]},"telephony.LineNotificationsLogsOptions":{"type":"object","description":"Error logging notifications options","properties":{"email":{"type":"string","description":"Email address where to send notifications","nullable":true},"frequency":{"allOf":[{"$ref":"#/components/schemas/telephony.LineNotificationsLogsFrequencyEnum"}],"description":"Frequency at which the notifications will be send","nullable":true},"sendIfNull":{"type":"boolean","description":"Send a blank notification if there is no diagnosticReports entries for the period","nullable":true}}},"telephony.LineNotificationsOptions":{"type":"object","properties":{"logs":{"allOf":[{"$ref":"#/components/schemas/telephony.LineNotificationsLogsOptions"}],"description":"Error logging notifications options","nullable":true}}},"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"]},"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}/fax":{"get":{"summary":"List fax services","description":"List fax services. Returns the service names of the fax services of the billing account. Get a fax service for its type, offers and notification settings.","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","Virtual Fax","Fax 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}/fax\")\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}/fax\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/get","required":true}],"x-expanded-response":"TelephonyFax"}},"/telephony/{billingAccount}/fax/{serviceName}":{"get":{"summary":"Get a fax service","description":"Get a fax service. Returns the fax service: type, offers, description and diagnostic notification 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.Fax"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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}/fax/{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}/fax/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/get","required":true}]},"put":{"summary":"Update a fax service","description":"Update a fax service. Updates the description and the diagnostic notification settings of the fax 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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.Fax"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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\n# Request body type: telephony.Fax\nresult = client.put(\"/telephony/{billingAccount}/fax/{serviceName}\",\n\tdescription = None, #  (type: string)\n\tnotifications = None, # Send notifications about Line's diagnosticReports (type: telephony.LineNotificationsOptions, 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.Fax\n$result = $ovh->put(\"/telephony/{billingAccount}/fax/{serviceName}\", array(\n\tdescription => null, //  (type: string)\n\tnotifications => null, // Send notifications about Line's diagnosticReports (type: telephony.LineNotificationsOptions, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/edit","required":true}]}},"/telephony/{billingAccount}/fax/{serviceName}/campaigns":{"get":{"summary":"List campaigns","description":"List campaigns. Returns the identifiers of the fax campaigns of the service. Get a campaign for its status, dates and counters.","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","Virtual Fax","Fax 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}/fax/{serviceName}/campaigns\")\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}/fax/{serviceName}/campaigns\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/campaigns/get","required":true}],"x-expanded-response":"TelephonyFaxCampaign"},"post":{"summary":"Create a campaign","description":"Create a campaign. Creates a campaign that sends a PDF document to a list of numbers or to the numbers of a document. The campaign is sent manually, automatically or at a scheduled date.","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":{"type":"object","properties":{"documentId":{"type":"string","description":"The id of the /me/document pdf you want to send"},"faxQuality":{"description":"The quality of the fax you want to send","$ref":"#/components/schemas/telephony.FaxQualityEnum"},"name":{"type":"string","description":"The name of the fax campaign"},"recipientsDocId":{"type":"string","description":"If recipientsType is set to document, the id of the document containing the recipients phone numbers"},"recipientsList":{"type":"array","description":"If recipientsType is set to list, the list of recipients phone numbers","items":{"$ref":"#/components/schemas/phoneNumber"}},"recipientsType":{"description":"Method to set the campaign recipient","$ref":"#/components/schemas/telephony.FaxCampaignRecipientsTypeEnum"},"sendDate":{"type":"string","description":"Sending date of the campaign (when sendType is scheduled)","format":"date-time"},"sendType":{"description":"Sending type of the campaign","$ref":"#/components/schemas/telephony.FaxCampaignSendTypeEnum"}},"required":["documentId","name","recipientsType","sendType"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.FaxCampaign"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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.post(\"/telephony/{billingAccount}/fax/{serviceName}/campaigns\",\n\tdocumentId = None, # The id of the /me/document pdf you want to send (type: string)\n\tfaxQuality = None, # The quality of the fax you want to send (type: telephony.FaxQualityEnum, nullable)\n\tname = None, # The name of the fax campaign (type: string)\n\trecipientsDocId = None, # If recipientsType is set to document, the id of the document containing the recipients phone numbers (type: string, nullable)\n\trecipientsList = None, # If recipientsType is set to list, the list of recipients phone numbers (type: phoneNumber[], nullable)\n\trecipientsType = None, # Method to set the campaign recipient (type: telephony.FaxCampaignRecipientsTypeEnum)\n\tsendDate = None, # Sending date of the campaign (when sendType is scheduled) (type: datetime, nullable)\n\tsendType = None, # Sending type of the campaign (type: telephony.FaxCampaignSendTypeEnum)\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(\"/telephony/{billingAccount}/fax/{serviceName}/campaigns\", array(\n\tdocumentId => null, // The id of the /me/document pdf you want to send (type: string)\n\tfaxQuality => null, // The quality of the fax you want to send (type: telephony.FaxQualityEnum, nullable)\n\tname => null, // The name of the fax campaign (type: string)\n\trecipientsDocId => null, // If recipientsType is set to document, the id of the document containing the recipients phone numbers (type: string, nullable)\n\trecipientsList => null, // If recipientsType is set to list, the list of recipients phone numbers (type: phoneNumber[], nullable)\n\trecipientsType => null, // Method to set the campaign recipient (type: telephony.FaxCampaignRecipientsTypeEnum)\n\tsendDate => null, // Sending date of the campaign (when sendType is scheduled) (type: datetime, nullable)\n\tsendType => null, // Sending type of the campaign (type: telephony.FaxCampaignSendTypeEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/campaigns/create","required":true}]}},"/telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}":{"delete":{"summary":"Delete a campaign","description":"Delete a campaign. Deletes the fax campaign from the fax service. The campaign no longer appears in the list of campaigns.","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"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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.delete(\"/telephony/{billingAccount}/fax/{serviceName}/campaigns/{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}/fax/{serviceName}/campaigns/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/campaigns/delete","required":true}]},"get":{"summary":"Get a campaign","description":"Get a campaign. Returns the campaign: name, reference, status, dates, and the number of faxes sent, successful and failed.","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.FaxCampaign"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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}/fax/{serviceName}/campaigns/{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}/fax/{serviceName}/campaigns/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/campaigns/get","required":true}]}},"/telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}/detail":{"get":{"summary":"Get campaign recipients by status","description":"Get campaign recipients by status. Returns the recipient numbers of the campaign, grouped by status: to do, successful and failed.","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.FaxCampaignDetail"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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\nresult = client.get(\"/telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}/detail\")\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}/fax/{serviceName}/campaigns/{id}/detail\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/campaigns/detail/get","required":true}]}},"/telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}/start":{"post":{"summary":"Start a campaign","description":"Start a campaign. Starts sending the campaign to its recipients. Follow the progress with the success and failure counters of the campaign.","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"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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.post(\"/telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}/start\")\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(\"/telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}/start\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/campaigns/start","required":true}]}},"/telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}/stop":{"post":{"summary":"Stop a campaign","description":"Stop a campaign. Stops sending the campaign to its recipients. The success and failure counters of the campaign show the faxes sent before the stop.","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"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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.post(\"/telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}/stop\")\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(\"/telephony/{billingAccount}/fax/{serviceName}/campaigns/{id}/stop\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/campaigns/stop","required":true}]}},"/telephony/{billingAccount}/fax/{serviceName}/screenLists":{"delete":{"summary":"Delete the screen lists","description":"Delete the screen lists. Deletes all screen lists of the fax service: allowed and blocked numbers and logins (TSI).","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"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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\nresult = client.delete(\"/telephony/{billingAccount}/fax/{serviceName}/screenLists\")\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}/fax/{serviceName}/screenLists\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/screenLists/delete","required":true}]},"get":{"summary":"Get the screen lists","description":"Get the screen lists. Returns the numbers and logins (TSI) allowed or blocked from sending faxes to the service, and which list is active.","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.FaxScreen"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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}/fax/{serviceName}/screenLists\")\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}/fax/{serviceName}/screenLists\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/screenLists/get","required":true}]},"post":{"summary":"Create the screen lists","description":"Create the screen lists. Creates the screen lists of the fax service. The active list is whitelist, blacklist or none.","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":{"type":"object","properties":{"blacklistedNumbers":{"type":"array","description":"List of numbers not allowed to send a fax","items":{"type":"string"}},"blacklistedTSI":{"type":"array","description":"List of logins (TSI or ID) not allowed to send a fax","items":{"type":"string"}},"filteringList":{"description":"Which list is active (blackist, whitelist or none)","$ref":"#/components/schemas/telephony.FaxScreenListTypeEnum"},"whitelistedNumbers":{"type":"array","description":"List of numbers allowed to send a fax","items":{"type":"string"}},"whitelistedTSI":{"type":"array","description":"List of logins (TSI or ID) allowed to send a fax","items":{"type":"string"}}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.FaxScreen"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax 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\n# Request body type: string[]\nresult = client.post(\"/telephony/{billingAccount}/fax/{serviceName}/screenLists\",\n\tblacklistedNumbers = None, # List of numbers not allowed to send a fax (type: string[], nullable)\n\tblacklistedTSI = None, # List of logins (TSI or ID) not allowed to send a fax (type: string[], nullable)\n\tfilteringList = None, # Which list is active (blackist, whitelist or none) (type: telephony.FaxScreenListTypeEnum, nullable)\n\twhitelistedNumbers = None, # List of numbers allowed to send a fax (type: string[], nullable)\n\twhitelistedTSI = None, # List of logins (TSI or ID) allowed to send a fax (type: string[], nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: string[]\n$result = $ovh->post(\"/telephony/{billingAccount}/fax/{serviceName}/screenLists\", array(\n\tblacklistedNumbers => null, // List of numbers not allowed to send a fax (type: string[], nullable)\n\tblacklistedTSI => null, // List of logins (TSI or ID) not allowed to send a fax (type: string[], nullable)\n\tfilteringList => null, // Which list is active (blackist, whitelist or none) (type: telephony.FaxScreenListTypeEnum, nullable)\n\twhitelistedNumbers => null, // List of numbers allowed to send a fax (type: string[], nullable)\n\twhitelistedTSI => null, // List of logins (TSI or ID) allowed to send a fax (type: string[], nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/screenLists/create","required":true}]},"put":{"summary":"Update the screen lists","description":"Update the screen lists. Updates the allowed and blocked numbers and logins (TSI). The active list is chosen when the screen lists are created.","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.FaxScreen"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax Settings@@@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\n# Request body type: telephony.FaxScreen\nresult = client.put(\"/telephony/{billingAccount}/fax/{serviceName}/screenLists\",\n\tblacklistedNumbers = None, # List of numbers not allowed to send a fax (type: array, nullable)\n\tblacklistedTSI = None, # List of logins (TSI or ID) not allowed to send a fax (type: array, nullable)\n\twhitelistedNumbers = None, # List of numbers allowed to send a fax (type: array, nullable)\n\twhitelistedTSI = None, # List of logins (TSI or ID) allowed to send a fax (type: array, 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.FaxScreen\n$result = $ovh->put(\"/telephony/{billingAccount}/fax/{serviceName}/screenLists\", array(\n\tblacklistedNumbers => null, // List of numbers not allowed to send a fax (type: array, nullable)\n\tblacklistedTSI => null, // List of logins (TSI or ID) not allowed to send a fax (type: array, nullable)\n\twhitelistedNumbers => null, // List of numbers allowed to send a fax (type: array, nullable)\n\twhitelistedTSI => null, // List of logins (TSI or ID) allowed to send a fax (type: array, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/screenLists/edit","required":true}]}},"/telephony/{billingAccount}/fax/{serviceName}/screenLists/reset":{"post":{"summary":"Reset the screen lists","description":"Reset the screen lists. Empties the selected screen lists: allowed or blocked numbers, allowed or blocked logins.","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":{"type":"object","properties":{"blacklistedNumbers":{"type":"boolean","description":"List of black numbers"},"blacklistedTSI":{"type":"boolean","description":"List of black login (TSI or ID)"},"whitelistedNumbers":{"type":"boolean","description":"List of white numbers"},"whitelistedTSI":{"type":"boolean","description":"List of white login (TSI or ID)"}}}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax Settings@@@150"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.post(\"/telephony/{billingAccount}/fax/{serviceName}/screenLists/reset\",\n\tblacklistedNumbers = None, # List of black numbers (type: boolean, nullable)\n\tblacklistedTSI = None, # List of black login (TSI or ID) (type: boolean, nullable)\n\twhitelistedNumbers = None, # List of white numbers (type: boolean, nullable)\n\twhitelistedTSI = None, # List of white login (TSI or ID) (type: boolean, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->post(\"/telephony/{billingAccount}/fax/{serviceName}/screenLists/reset\", array(\n\tblacklistedNumbers => null, // List of black numbers (type: boolean, nullable)\n\tblacklistedTSI => null, // List of black login (TSI or ID) (type: boolean, nullable)\n\twhitelistedNumbers => null, // List of white numbers (type: boolean, nullable)\n\twhitelistedTSI => null, // List of white login (TSI or ID) (type: boolean, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/screenLists/reset","required":true}]}},"/telephony/{billingAccount}/fax/{serviceName}/settings":{"get":{"summary":"Get the settings","description":"Get the settings. Returns the fax settings: sender, quality, number of sending tries, email delivery and rejection of anonymous faxes.","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.FaxProperties"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax Settings@@@160"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/telephony/{billingAccount}/fax/{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}/fax/{serviceName}/settings\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/settings/get","required":true}]},"put":{"summary":"Update the settings","description":"Update the settings. Updates the fax settings: sender, receiver, quality, number of sending tries (1 to 9), tag line, email delivery and rejection of anonymous faxes.","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.FaxProperties"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax Settings@@@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: telephony.FaxProperties\nresult = client.put(\"/telephony/{billingAccount}/fax/{serviceName}/settings\",\n\tfaxMaxCall = None, #  (type: )\n\tfaxQuality = None, #  (type: )\n\tfaxTagLine = None, #  (type: string)\n\tfromEmail = None, #  (type: string)\n\tfromName = None, #  (type: string)\n\tmailFormat = None, #  (type: )\n\treceiver = None, #  (type: string)\n\tredirectionEmail = None, #  (type: array)\n\trejectAnonymous = None, #  (type: boolean)\n\tsender = None, #  (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.FaxProperties\n$result = $ovh->put(\"/telephony/{billingAccount}/fax/{serviceName}/settings\", array(\n\tfaxMaxCall => null, //  (type: )\n\tfaxQuality => null, //  (type: )\n\tfaxTagLine => null, //  (type: string)\n\tfromEmail => null, //  (type: string)\n\tfromName => null, //  (type: string)\n\tmailFormat => null, //  (type: )\n\treceiver => null, //  (type: string)\n\tredirectionEmail => null, //  (type: array)\n\trejectAnonymous => null, //  (type: boolean)\n\tsender => null, //  (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/settings/edit","required":true}]}},"/telephony/{billingAccount}/fax/{serviceName}/settings/changePassword":{"post":{"summary":"Change the password","description":"Change the password. Sets a new password for the fax account. Without a password, a random one is generated and returned.","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":{"type":"object","properties":{"password":{"type":"string","description":"The password, if not specified, a random password will be generated","format":"password"}}}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string","format":"password"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax Settings@@@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\n# Request body type: password\nresult = client.post(\"/telephony/{billingAccount}/fax/{serviceName}/settings/changePassword\",\n\tpassword = None, # The password, if not specified, a random password will be generated (type: password, 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: password\n$result = $ovh->post(\"/telephony/{billingAccount}/fax/{serviceName}/settings/changePassword\", array(\n\tpassword => null, // The password, if not specified, a random password will be generated (type: password, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/settings/changePassword","required":true}]}},"/telephony/{billingAccount}/fax/{serviceName}/settings/sendFax":{"post":{"summary":"Send a fax","description":"Send a fax. Sends a PDF document from a URL to one or more recipients, now or at a scheduled date. Returns the task that tracks the sending.","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":{"type":"object","properties":{"dateSchedule":{"type":"string","description":"If you want to schedule your fax later, you can specify a date","format":"date-time"},"pdfUrl":{"type":"string","description":"Url of the pdf document you want to send"},"recipients":{"type":"array","description":"List of recipients of your fax","items":{"$ref":"#/components/schemas/phoneNumber"}}},"required":["pdfUrl","recipients"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/telephony.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Telephony","Virtual Fax","Fax Settings@@@190"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: phoneNumber[]\nresult = client.post(\"/telephony/{billingAccount}/fax/{serviceName}/settings/sendFax\",\n\tdateSchedule = None, # If you want to schedule your fax later, you can specify a date (type: datetime, nullable)\n\tpdfUrl = None, # Url of the pdf document you want to send (type: string)\n\trecipients = None, # List of recipients of your fax (type: phoneNumber[])\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}/fax/{serviceName}/settings/sendFax\", array(\n\tdateSchedule => null, // If you want to schedule your fax later, you can specify a date (type: datetime, nullable)\n\tpdfUrl => null, // Url of the pdf document you want to send (type: string)\n\trecipients => null, // List of recipients of your fax (type: phoneNumber[])\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"voip:apiovh:fax/settings/sendFax","required":true}]}}}}