Skip to content

Carrier Settings

All operations require authentication.

13 operationsv1/telephony/{billingAccount}
View as Markdown (opens in a new tab)
Agent setup

List Carrier SIP servicesProduction

GET
/v1/telephony/{billingAccount}/carrierSip

List Carrier SIP services. Returns the Carrier SIP services of the billing account. Carrier SIP connects an operator network to OVHcloud over SIP.

Path parameters

billingAccount
required
string

The name of your billingAccount

Response

200string[]successful operation

Example uses billingAccount = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "string"]

Get a Carrier SIP serviceProduction

GET
/v1/telephony/{billingAccount}/carrierSip/{serviceName}

Get a Carrier SIP service. Returns the Carrier SIP service and its description. Settings, SIP endpoints and VNO mandates have their own routes.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200CarrierSipsuccessful operation
description
read-only
string
—
serviceName
read-only
string
—
serviceType
read-only
TypeServiceEnum

All existing types

Valuesaliasline

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "description": "string", "serviceName": "string", "serviceType": "alias"}

Get call detail recordsProduction

GET
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/cdrs

Get call detail records. Returns the call detail records (CDR) of the Carrier SIP service for a month (YYYY-MM), the current month by default, as a document.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Query parameters

month
string

The month you want to extract (format: YYYY-MM). Current month if not specified.

Response

200Documentsuccessful operation
description
string

Description of the document

id
read-only
stringuuid

Identifier of the document

name
string

Name of the document

size
read-only
integer

Document size (in bytes)

url
read-only
string

URL to get document

validationDate
read-only
stringdate-time

Document validation date

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/cdrs \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "description": "string", "id": "00000000-0000-0000-0000-000000000000", "name": "string", "size": 0, "url": "string", "validationDate": "2024-01-01T12:00:00Z"}

Get the cluster detailsProduction

GET
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/clusterDetails

Get the cluster details. Returns the details of the Carrier SIP cluster the service runs on: its name and its zones.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200CarrierSipClusterInfosuccessful operation
name
string

The name of the cluster

zones
CarrierSipClusterZone[]

The availability zones of the cluster

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/clusterDetails \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "name": "string", "zones": [ { "mediaIps": [ "192.0.2.0" ], "region": "rbx" } ]}

List SIP endpointsProduction

GET
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/endpoints

List SIP endpoints. Returns the identifiers of the remote SIP endpoints of the service. Get an endpoint for its IP address, port, protocol and priority.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200integer[]successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/endpoints \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ 0]

Get a SIP endpointProduction

GET
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/endpoints/{id}

Get a SIP endpoint. Returns the remote SIP endpoint: IP address, port, protocol (udp, tcp or tls), DNS SRV priority and weight, and whether it receives incoming calls.

Path parameters

billingAccount
required
string

The name of your billingAccount

id
required
integer

Id of the object

serviceName
required
string
—

Response

200CarrierSipCustomerEndpointsuccessful operation
enableIncomingCalls
read-only
boolean

Should we send incoming calls to this endpoint

id
read-only
integer

SIP Endpoint id

ip
read-only
ipv4

SIP Endpoint IP

port
read-only
integer

SIP Endpoint port

priority
read-only
integer

SIP Endpoint priority (DNS SRV)

protocol
read-only
CarrierSipEndpointProtocolEnum

The protocol of the endpoint (udp/tcp/tls)

Valuestcptlsudp
weight
read-only
integer

SIP Endpoint weight (DNS SRV)

Example uses billingAccount = string, id = 0, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/endpoints/{id} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "enableIncomingCalls": true, "id": 0, "ip": "192.0.2.0", "port": 0, "priority": 0, "protocol": "tcp", "weight": 0}

Get the settingsProduction

GET
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/settings

Get the settings. Returns the Carrier SIP settings: description, maximum call establishments per second and maximum concurrent calls.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200CarrierSipDetailssuccessful operation
description
string

The carrier SIP trunk description

maxCallsPerSecond
read-only
integer

The maximum call establishments per second on your carrier sip service

maxConcurrentCalls
read-only
integer

The maximum concurrent calls on your carrier sip service

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/settings \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "description": "string", "maxCallsPerSecond": 0, "maxConcurrentCalls": 0}

Update the settingsProduction

PUT
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/settings

Update the settings. Updates the Carrier SIP settings. Only the description can be changed; the call limits are read only.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Request body (required)

description
string

The carrier SIP trunk description

maxCallsPerSecond
read-only
integer

The maximum call establishments per second on your carrier sip service

maxConcurrentCalls
read-only
integer

The maximum concurrent calls on your carrier sip service

Response

200—successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/settings \
  -H "authorization: Bearer $OVH_TOKEN"

List VNO mandatesProduction

GET
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/vno

List VNO mandates. Returns the references of the VNO mandates of the service. A mandate covers number ranges routed from its application date.

Path parameters

billingAccount
required
string

The name of your billingAccount

serviceName
required
string
—

Response

200string[]successful operation

Example uses billingAccount = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/vno \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "string"]

Get a VNO mandateProduction

GET
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}

Get a VNO mandate. Returns the VNO mandate: the reference written on the VNO contract and the date from which its ranges are routed.

Path parameters

billingAccount
required
string

The name of your billingAccount

contractReference
required
string

The reference written on your VNO contract.

serviceName
required
string
—

Response

200CarrierSipVnoMandatesuccessful operation
applicationDate
read-only
stringdate-time

Date at which the associated ranges will be routed.

contractReference
read-only
string

The reference written on your VNO contract.

Example uses billingAccount = string, contractReference = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "applicationDate": "2024-01-01T12:00:00Z", "contractReference": "string"}

List mandate number rangesProduction

GET
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges

List mandate number ranges. Returns the prefixes of the number ranges covered by the VNO mandate. Get a range for its description.

Path parameters

billingAccount
required
string

The name of your billingAccount

contractReference
required
string

The reference written on your VNO contract.

serviceName
required
string
—

Response

200string[]successful operation

Example uses billingAccount = string, contractReference = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ "string"]

Get a number rangeProduction

GET
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges/{prefix}

Get a number range. Returns the number range of the mandate: its phone range prefix and its description, which can be updated.

Path parameters

billingAccount
required
string

The name of your billingAccount

contractReference
required
string

The reference written on your VNO contract.

prefix
required
string

The phone range prefix.

serviceName
required
string
—

Response

200CarrierSipVnoRangesuccessful operation
description
string

The carrier SIP trunk description.

prefix
read-only
string

The phone range prefix.

Example uses billingAccount = string, contractReference = string, prefix = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges/{prefix} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "description": "string", "prefix": "string"}

Update a number rangeProduction

PUT
/v1/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges/{prefix}

Update a number range. Updates the description of the number range of the mandate. The prefix cannot be changed.

Path parameters

billingAccount
required
string

The name of your billingAccount

contractReference
required
string

The reference written on your VNO contract.

prefix
required
string

The phone range prefix.

serviceName
required
string
—

Request body (required)

description
string

The carrier SIP trunk description.

prefix
read-only
string

The phone range prefix.

Response

200—successful operation

Example uses billingAccount = string, contractReference = string, prefix = string, serviceName = string

$ curl https://api.eu.ovhcloud.com/v1/telephony/{billingAccount}/carrierSip/{serviceName}/vno/{contractReference}/ranges/{prefix} \
  -H "authorization: Bearer $OVH_TOKEN"