Skip to main content

carrier_sip_settings

Creates, updates, deletes, gets or lists a carrier_sip_settings resource.

Overview​

Namecarrier_sip_settings
TypeResource
Idovh.telephony.carrier_sip_settings

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
descriptionstringThe carrier SIP trunk description
max_calls_per_secondintegerThe maximum call establishments per second on your carrier sip service (wire: maxCallsPerSecond)
max_concurrent_callsintegerThe maximum concurrent calls on your carrier sip service (wire: maxConcurrentCalls)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectbilling_account, service_nameGet the settings
updateupdatebilling_account, service_nameUpdate the settings

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
billing_accountstringThe name of your billingAccount (wire: billingAccount)
service_namestring (wire: serviceName)

SELECT examples​

Get the settings

SELECT
description,
max_calls_per_second,
max_concurrent_calls
FROM ovh.telephony.carrier_sip_settings
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;

UPDATE examples​

Update the settings

UPDATE ovh.telephony.carrier_sip_settings
SET
description = '{{ description }}'
WHERE
billing_account = '{{ billing_account }}' --required
AND service_name = '{{ service_name }}' --required;