Trunk Settings
All operations require authentication.
List trunksProduction
Query parameters
Filter resources on IAM tags
Response
Reads your token from $OVH_TOKEN
$ curl https:/[ "string"]
Get a line or trunkProduction
Path parameters
Your trunk number
Response
IAM resource metadata
Example uses serviceName = string
$ curl https:/{ "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 trunk 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:/[ 0]
Get service informationProduction
Get service information. Returns the status, creation and expiration dates, contacts and renewal settings of the service.
Path parameters
Your trunk 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:/{ "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 trunk 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:/Get the maximum simultaneous linesProduction
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/0
Remove extra simultaneous linesProduction
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:/Get simultaneous channels detailsProduction
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:/{ "basic": 0, "current": 0, "extra": 0, "maximum": 0, "toBeDeleted": 0}
List trunksProduction
Path parameters
The name of your billingAccount
Response
Example uses billingAccount = string
$ curl https:/[ "string"]
Get a trunkProduction
Path parameters
The name of your billingAccount
Name of the service
Response
Description of the service
Name of the service
Type of the service
aliaslineExample uses billingAccount = string, serviceName = string
$ curl https:/{ "description": "string", "serviceName": "string", "serviceType": "alias"}
Get the best channel packsProduction
Path parameters
The name of your billingAccount
Name of the service
Query parameters
Channels quantity to get the best repartition on
Response
The optimized quantity of channels to order
The repartition of the packs
The total price of the channels packs combination
Example uses billingAccount = string, serviceName = string
$ curl https:/{ "optimizedChannelsQuantity": 0, "packsRepartition": [ { "channels": 0, "quantity": 0, "unitPrice": { "currencyCode": "AUD", "text": "string", "value": 0 } } ], "totalPrice": { "currencyCode": "AUD", "text": "string", "value": 0 }}
List external displayed numbersProduction
Path parameters
The name of your billingAccount
Name of the service
Response
Example uses billingAccount = string, serviceName = string
$ curl https:/[ "string"]
Get an external displayed numberProduction
Path parameters
The name of your billingAccount
External displayed number linked to a trunk
Name of the service
Response
Creation date
External displayed number linked to a trunk
Validation status
enabledrefusedtoDeletewaitingValidationValidation date
Example uses billingAccount = string, number = string, serviceName = string
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "number": "string", "status": "enabled", "validatedAt": "2024-01-01T12:00:00Z"}
Create an external displayed numberProduction
Path parameters
The name of your billingAccount
Name of the service
Request body (required)
External displayed number auto-validation. Only available for partner. Must be owner of the number.
External displayed number to create, in international format
Response
Creation date
External displayed number linked to a trunk
Validation status
enabledrefusedtoDeletewaitingValidationValidation date
Example uses billingAccount = string, serviceName = string
$ curl https:/{ "createdAt": "2024-01-01T12:00:00Z", "number": "string", "status": "enabled", "validatedAt": "2024-01-01T12:00:00Z"}
Delete an external displayed numberProduction
Path parameters
The name of your billingAccount
External displayed number linked to a trunk
Name of the service
Response
Example uses billingAccount = string, number = string, serviceName = string
$ curl https:/Validate an external displayed numberProduction
Path parameters
The name of your billingAccount
External displayed number linked to a trunk
Name of the service
Response
telephony.Task id of the validation phone call
Validation code to type during phone call
Example uses billingAccount = string, number = string, serviceName = string
$ curl https:/{ "phoneCallTaskId": 0, "validationCode": "string"}