Line Settings
All operations require authentication.
List linesProduction
List lines. Returns the lines of the customer, across all billing accounts. Get a line or trunk for the service without its billing account.
Query parameters
Filter resources on IAM tags
Response
Reads your token from $OVH_TOKEN
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ lines \
-H "authorization: Bearer $OVH_TOKEN"[ "string"]
Get a line or trunkProduction
Get a line or trunk. Returns the line or trunk service, without its billing account. Use it to find a service across all billing accounts.
Path parameters
Your line number
Response
IAM resource metadata
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ lines/ {serviceName} \
-H "authorization: Bearer $OVH_TOKEN"{ "iam": { "displayName": "string", "id": "00000000-0000-0000-0000-000000000000", "state": "EXPIRED", "tags": { "key": "string" }, "urn": "string" }, "serviceName": "string"}
Change service contactsProduction
Change service contacts. Starts a procedure to change the admin, tech or billing contact of the service.
Path parameters
Your line number
Request body (required)
The contact to set as admin contact
The contact to set as billing contact
The contact to set as tech contact
Response
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ lines/ {serviceName}/ changeContact \
-H "authorization: Bearer $OVH_TOKEN"[ 0]
Get service informationProduction
Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.
Path parameters
Your line number
Response
Indicates that the service can be set up to be deleted at expiration
All the possible renew period of your service in month
Way of handling the renew
Detailed renewal type of a service
automaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoptionautorenewInProgressexpiredinCreationokpendingDebtunPaidExample uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ lines/ {serviceName}/ serviceInfos \
-H "authorization: Bearer $OVH_TOKEN"{ "canDeleteAtExpiration": true, "contactAdmin": "string", "contactBilling": "string", "contactTech": "string", "creation": "2024-01-01", "domain": "string", "engagedUpTo": "2024-01-01", "expiration": "2024-01-01", "possibleRenewPeriod": [ 0 ], "renew": { "automatic": true, "deleteAtExpiration": true, "forced": true, "manualPayment": true, "period": 0 }, "renewalType": "automaticForcedProduct", "serviceId": 0, "status": "autorenewInProgress"}
Update service informationProduction
Update service information. Updates the renewal settings of the service: automatic renewal, period, or deletion at expiration.
Path parameters
Your line number
Request body (required)
Indicates that the service can be set up to be deleted at expiration
All the possible renew period of your service in month
Way of handling the renew
Detailed renewal type of a service
automaticForcedProductautomaticV2012automaticV2014automaticV2016automaticV2024manualoneShotoptionautorenewInProgressexpiredinCreationokpendingDebtunPaidResponse
Example uses serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ lines/ {serviceName}/ serviceInfos \
-H "authorization: Bearer $OVH_TOKEN"List linesProduction
List lines. Returns the lines of the billing account. Get a line for its settings, phone, options and simultaneous calls.
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line \
-H "authorization: Bearer $OVH_TOKEN"[ "string"]
Get a lineProduction
Get a line. Returns the line: description, offer, number of simultaneous lines, infrastructure, diagnostic notification settings and position on its phone.
Path parameters
The name of your billingAccount
Response
Ability to manage SIP password on this service
The position of the line when attached to a device (0 if the line is not attached to a device)
The line offers
The infrastructure where is configured the line
Is this line attached to a phone that belongs to another line?
Send notifications about Line's diagnosticReports
The line offers (Deprecated, prefer "name" in getPublicOffer)
All existing types
aliaslineExample uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName} \
-H "authorization: Bearer $OVH_TOKEN"{ "canChangePassword": true, "description": "string", "deviceSlot": 0, "getPublicOffer": { "description": "string", "name": "string", "price": { "currencyCode": "AUD", "text": "string", "value": 0 } }, "infrastructure": "string", "isAttachedToOtherLinesPhone": true, "notifications": { "logs": { "email": "string", "frequency": "Never", "sendIfNull": true } }, "offers": [ "string" ], "serviceName": "string", "serviceType": "alias", "simultaneousLines": 0}
Update a lineProduction
Update a line. Updates the description of the line and the notifications sent about its diagnostic reports.
Path parameters
The name of your billingAccount
Request body (required)
Ability to manage SIP password on this service
The position of the line when attached to a device (0 if the line is not attached to a device)
The line offers
The infrastructure where is configured the line
Is this line attached to a phone that belongs to another line?
Send notifications about Line's diagnosticReports
The line offers (Deprecated, prefer "name" in getPublicOffer)
All existing types
aliaslineResponse
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName} \
-H "authorization: Bearer $OVH_TOKEN"List numbers blocked by antihackProduction
List numbers blocked by antihack. Returns the numbers and short codes blocked by the automatic antihack protection of the line.
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ antihack \
-H "authorization: Bearer $OVH_TOKEN"[ "string"]
Clean antihack restrictionsProduction
Clean antihack restrictions. Authorizes or blocks one number, or all the numbers, restricted by the antihack protection of the line.
Path parameters
The name of your billingAccount
Request body (required)
Type of action
AUTHORIZE_ALLAUTHORIZE_ONE_NUMBERBLOCK_ALLBLOCK_ONE_NUMBERNumber or short number restricted
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ antihack \
-H "authorization: Bearer $OVH_TOKEN"List available SIP domainsProduction
List available SIP domains. Returns the SIP domains the line can use, for the SIP configuration of its phone or softphone.
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ availableSipDomains \
-H "authorization: Bearer $OVH_TOKEN"[ "string"]
Block the lineProduction
Block the line. Blocks the incoming calls, the outgoing calls or both, depending on the mode. Without a mode, both directions are blocked.
Path parameters
The name of your billingAccount
Request body (required)
The block mode : outgoing, incoming, both (default: both)
bothincomingoutgoingResponse
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ block \
-H "authorization: Bearer $OVH_TOKEN"Check if the SIP password can changeDeprecated
Deprecated since Mar 1, 2018, will be removed on Apr 1, 2018 — use /telephony/{billingAccount}/line/{serviceName}/ instead.
Check if the SIP password can change. Returns whether the SIP password of the line can be changed. Change it with the changePassword call.
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ canChangePassword \
-H "authorization: Bearer $OVH_TOKEN"true
Cancel a scheduled conversion to numberProduction
Cancel a scheduled conversion to number. Cancels the scheduled conversion of the line to a number without a phone.
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ cancelConvertToNumber \
-H "authorization: Bearer $OVH_TOKEN"Change the SIP passwordProduction
Change the SIP password. Changes the SIP password of the line, used by the phone or softphone to register. The new password is given in the password parameter.
Path parameters
The name of your billingAccount
Request body (required)
The password
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ changePassword \
-H "authorization: Bearer $OVH_TOKEN"Schedule a conversion to numberProduction
Schedule a conversion to number. Schedules the conversion of the line to a number without a phone. Returns the offer task.
Path parameters
The name of your billingAccount
Response
Actual action that will be executed
convertToAliasconvertToSipmigrateToNewVoicemailremoveSimltaneousLinesswitchServerterminationupdateFirmwareupgradePlanned execution date
Current status of the task
doingdoneerrorpausetodoType of operation that will be executed
lineofferoptionphoneExample uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ convertToNumber \
-H "authorization: Bearer $OVH_TOKEN"{ "action": "convertToAlias", "executionDate": "2024-01-01T12:00:00Z", "status": "doing", "taskId": 0, "type": "line"}
List last registered IPsProduction
List last registered IPs. Returns the last IP addresses the line registered from, with the date of each registration.
Path parameters
The name of your billingAccount
Response
IP address (e.g., 192.0.2.0)
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ ips \
-H "authorization: Bearer $OVH_TOKEN"[ { "datetime": "2024-01-01T12:00:00Z", "ip": "192.0.2.0" }]
List last registrationsProduction
List last registrations. Returns the last registrations of the line: date, public and local IP addresses and ports, user agent and SIP domain.
Path parameters
The name of your billingAccount
Response
SIP registration's date
SIP registration's domain
SIP registration's IP
SIP registration's local device IP
SIP registration's local device port
SIP registration's port
SIP registration's User-Agent
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ lastRegistrations \
-H "authorization: Bearer $OVH_TOKEN"[ { "datetime": "2024-01-01T12:00:00Z", "domain": "string", "ip": "192.0.2.0", "localIp": "192.0.2.0", "localPort": 0, "port": 0, "userAgent": "string" }]
Get the maximum simultaneous linesProduction
Get the maximum simultaneous lines. Returns the maximum number of simultaneous calls available for the line. The current, basic and extra channels are in the simultaneous channels details.
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ maximumAvailableSimultaneousLines \
-H "authorization: Bearer $OVH_TOKEN"0
Get the line offerProduction
Get the line offer. Returns the public offer of the line: its name, its description and its price. It replaces the deprecated offers property of the line.
Path parameters
The name of your billingAccount
Response
The offer description
The offer name
Offer price per month
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ offer \
-H "authorization: Bearer $OVH_TOKEN"{ "description": "string", "name": "string", "price": { "currencyCode": "AUD", "text": "string", "value": 0 }}
Get the line optionsProduction
Get the line options. Returns the line options: codecs, caller identification, forwarding, do not disturb and other call options.
Path parameters
The name of your billingAccount
Response
Reject anonymous calls
Whether or not the line has restriction on incoming calls
Whether or not the line has restriction on outgoing calls
If the line receives a new call and the line is already in communication, this new call is dispatched once the current call is completed
Codecs preferences
The default voicemail of the line. It can be the voicemail of any line of your account.
Phone number
The domain to configure in your SIP client.
Enable calls forward when the line is unavailable
Nature of the forward when the line is unavailable
faxnumbervoicemailDestination of the forward when the line is unavailable
Enable calls forward when the line is busy
Nature of the forward when the line is busy
faxnumbervoicemailDestination of the forward when the line is busy
Enable calls forward on no-reply
Delay before forward on no-reply
Nature of the forward on no-reply
faxnumbervoicemailDestination of the forward on no-reply
Enable unconditional calls forward
Nature of the unconditional forward
faxnumbervoicemailDestination of the unconditional forward
Do not display your number
Intercom mode: takes automatically the call with the loudspeaker
noprefixedyesThe ip restrictions of your line
Language of the line
DutchEnglish (UK)FrenchFrench (BE)GermanItalianSpanishDisallow outgoing calls
Disallow outgoing calls password
The outbound proxy to configure in your SIP client.
Enable or disable record of outgoing calls
Sound ID of on-call-waiting tone
Sound ID of on-hold tone
Sound ID of ringback tone
Voicemail number to dial from any other line
Voicemail short number to dial from the line
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ options \
-H "authorization: Bearer $OVH_TOKEN"{ "absentSubscriber": true, "anonymousCallRejection": true, "callRestrictionIncoming": true, "callRestrictionOutgoing": true, "callWaiting": true, "codecs": "string", "defaultVoicemail": "string", "displayNumber": "string", "doNotDisturb": true, "domain": "string", "forwardBackup": true, "forwardBackupNature": "fax", "forwardBackupNumber": "string", "forwardBusy": true, "forwardBusyNature": "fax", "forwardBusyNumber": "string", "forwardNoReply": true, "forwardNoReplyDelay": 0, "forwardNoReplyNature": "fax", "forwardNoReplyNumber": "string", "forwardUnconditional": true, "forwardUnconditionalNature": "fax", "forwardUnconditionalNumber": "string", "identificationRestriction": true, "intercom": "no", "ipRestrictions": [ "192.0.2.0/24" ], "language": "Dutch", "lockOutCall": true, "lockOutCallPassword": "string", "proxy": "string", "recordOutgoingCallsBeta": true, "toneOnCallWaitingSoundId": 0, "toneOnHoldSoundId": 0, "toneRingbackSoundId": 0, "voicemailExternalNumber": "string", "voicemailInternalNumber": "string"}
Update the line optionsProduction
Update the line options. Updates the line options: forwarding rules, do not disturb, caller identification, call waiting, codecs, IP restrictions and call restrictions.
Path parameters
The name of your billingAccount
Request body (required)
Reject anonymous calls
Whether or not the line has restriction on incoming calls
Whether or not the line has restriction on outgoing calls
If the line receives a new call and the line is already in communication, this new call is dispatched once the current call is completed
Codecs preferences
The default voicemail of the line. It can be the voicemail of any line of your account.
Phone number
The domain to configure in your SIP client.
Enable calls forward when the line is unavailable
Nature of the forward when the line is unavailable
faxnumbervoicemailDestination of the forward when the line is unavailable
Enable calls forward when the line is busy
Nature of the forward when the line is busy
faxnumbervoicemailDestination of the forward when the line is busy
Enable calls forward on no-reply
Delay before forward on no-reply
Nature of the forward on no-reply
faxnumbervoicemailDestination of the forward on no-reply
Enable unconditional calls forward
Nature of the unconditional forward
faxnumbervoicemailDestination of the unconditional forward
Do not display your number
Intercom mode: takes automatically the call with the loudspeaker
noprefixedyesThe ip restrictions of your line
Language of the line
DutchEnglish (UK)FrenchFrench (BE)GermanItalianSpanishDisallow outgoing calls
Disallow outgoing calls password
The outbound proxy to configure in your SIP client.
Enable or disable record of outgoing calls
Sound ID of on-call-waiting tone
Sound ID of on-hold tone
Sound ID of ringback tone
Voicemail number to dial from any other line
Voicemail short number to dial from the line
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ options \
-H "authorization: Bearer $OVH_TOKEN"List available codecsProduction
List available codecs. Returns the codec combinations available for the line. One of them can be set as the codecs preferences in the line options.
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ options/ availableCodecs \
-H "authorization: Bearer $OVH_TOKEN"[ "string"]
Get the default codecsProduction
Get the default codecs. Returns the codecs used when none are set on the line. Set the codecs preferences in the line options.
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ options/ defaultCodecs \
-H "authorization: Bearer $OVH_TOKEN""string"
Remove extra simultaneous linesProduction
Remove extra simultaneous lines. Removes the given quantity of extra simultaneous lines from the line. The extra channels are listed in the simultaneous channels details.
Path parameters
The name of your billingAccount
Request body (required)
The quantity of extra simultaneous lines to remove
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ removeSimultaneousLines \
-H "authorization: Bearer $OVH_TOKEN"Get simultaneous channels detailsProduction
Get simultaneous channels details. Returns the simultaneous call channels of the line: current, basic, extra, to be deleted and maximum.
Path parameters
The name of your billingAccount
Response
Basic quantity of simultaneous channels included in the line.
Current quantity of simultaneous channels.
Extra quantity of simultaneous channels added to the line.
Maximum quantity of simultaneous channels the line can have.
Quantity of simultaneous channels going to be deleted at the end of the billing cycle.
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ simultaneousChannelsDetails \
-H "authorization: Bearer $OVH_TOKEN"{ "basic": 0, "current": 0, "extra": 0, "maximum": 0, "toBeDeleted": 0}
Get the tonesProduction
Get the tones. Returns the tones of the line: ringback, on hold, call waiting and end of call. Each tone is a default sound, none or a custom sound.
Path parameters
The name of your billingAccount
Response
Tone played when caller is waiting in queue
Custom soundNoneTone played when callee is ending call
Custom soundNoneTone played when caller is put on hold
Custom soundNonePredefined 1Predefined 2Ringback tone
Custom soundNoneExample uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ tones \
-H "authorization: Bearer $OVH_TOKEN"{ "callWaiting": "Custom sound", "endCall": "Custom sound", "onHold": "Custom sound", "ringback": "Custom sound"}
Update the tonesProduction
Update the tones. Updates the tones of the line: ringback, on hold, call waiting and end of call. Custom sounds are uploaded with the tone upload call.
Path parameters
The name of your billingAccount
Request body (required)
Tone played when caller is waiting in queue
Custom soundNoneTone played when callee is ending call
Custom soundNoneTone played when caller is put on hold
Custom soundNonePredefined 1Predefined 2Ringback tone
Custom soundNoneResponse
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ tones \
-H "authorization: Bearer $OVH_TOKEN"Upload a toneProduction
Upload a tone. Uploads a sound file to use as a tone: ringback, on hold, call waiting or closure. The file is given by a /me/document ID or a URL. Returns the task that tracks the upload.
Path parameters
The name of your billingAccount
Request body (required)
ID of the /me/document file you want to import
Tones type
callWaitingendCallonHoldringbackURL of the file you want to import (instead of /me/document ID)
Response
Action associated with the task
Potential failure reason of the task
Object potentially created at the end of the task
Status of the task
doingdoneerrorpausetodoExample uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ tones/ toneUpload \
-H "authorization: Bearer $OVH_TOKEN"{ "action": "string", "message": "string", "objectCreated": "string", "serviceType": "string", "status": "doing", "taskId": 0}
Unblock the lineProduction
Unblock the line. Unblocks the line and removes every incoming and outgoing block set with the block call.
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/ / api.eu.ovhcloud.com/ v1/ telephony/ {billingAccount}/ line/ {serviceName}/ unblock \
-H "authorization: Bearer $OVH_TOKEN"