carrier_sips
Creates, updates, deletes, gets or lists a carrier_sips resource.
Overview​
| Name | carrier_sips |
| Type | Resource |
| Id | ovh.telephony.carrier_sips |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
service_name | string | (wire: serviceName) |
description | string | |
service_type | string | All existing types (alias, line) (wire: serviceType) |
CarrierSip
| Name | Datatype | Description |
|---|---|---|
service_name | string | (wire: serviceName) |
description | string | |
service_type | string | All existing types (alias, line) (wire: serviceType) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | billing_account, service_name | Get a Carrier SIP service | |
list | select | billing_account | x_pagination_mode | List Carrier SIP services |
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.
| Name | Datatype | Description |
|---|---|---|
api_host | string | The 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_account | string | The name of your billingAccount (wire: billingAccount) |
service_name | string | (wire: serviceName) |
x_pagination_mode | string | Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode) |
SELECT examples​
- get
- list
Get a Carrier SIP service
SELECT
service_name,
description,
service_type
FROM ovh.telephony.carrier_sips
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
;
List Carrier SIP services
SELECT
service_name,
description,
service_type
FROM ovh.telephony.carrier_sips
WHERE billing_account = '{{ billing_account }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;