carrier_sip_endpoints
Creates, updates, deletes, gets or lists a carrier_sip_endpoints resource.
Overview​
| Name | carrier_sip_endpoints |
| Type | Resource |
| Id | ovh.telephony.carrier_sip_endpoints |
Fields​
The following fields are returned by SELECT queries:
- get
- list
successful operation
| Name | Datatype | Description |
|---|---|---|
id | integer | SIP Endpoint id |
enable_incoming_calls | boolean | Should we send incoming calls to this endpoint (wire: enableIncomingCalls) |
ip | string (ipv4) | SIP Endpoint IP (example: 192.0.2.0) |
port | integer | SIP Endpoint port |
priority | integer | SIP Endpoint priority (DNS SRV) |
protocol | string | The protocol of the endpoint (udp/tcp/tls) (tcp, tls, udp) |
weight | integer | SIP Endpoint weight (DNS SRV) |
Carrier SIP Endpoints
| Name | Datatype | Description |
|---|---|---|
id | integer | SIP Endpoint id |
enable_incoming_calls | boolean | Should we send incoming calls to this endpoint (wire: enableIncomingCalls) |
ip | string (ipv4) | SIP Endpoint IP (example: 192.0.2.0) |
port | integer | SIP Endpoint port |
priority | integer | SIP Endpoint priority (DNS SRV) |
protocol | string | The protocol of the endpoint (udp/tcp/tls) (tcp, tls, udp) |
weight | integer | SIP Endpoint weight (DNS SRV) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | billing_account, id, service_name | Get a SIP endpoint | |
list | select | billing_account, service_name | x_pagination_mode | List SIP endpoints |
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) |
id | integer | Id of the object |
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 SIP endpoint
SELECT
id,
enable_incoming_calls,
ip,
port,
priority,
protocol,
weight
FROM ovh.telephony.carrier_sip_endpoints
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;
List SIP endpoints
SELECT
id,
enable_incoming_calls,
ip,
port,
priority,
protocol,
weight
FROM ovh.telephony.carrier_sip_endpoints
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;