smpp_settings
Creates, updates, deletes, gets or lists a smpp_settings resource.
Overview​
| Name | smpp_settings |
| Type | Resource |
| Id | ovh.sms.smpp_settings |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
system_id | string | Username used to connect to OVHcloud SMSC (wire: systemID) |
endpoints | array | Addresses of the TLS and non-TLS endpoints |
status | string | Status of the SMPP account (DELETED, ERROR, SUCCESS, UNKNOWN, UPDATING_IP, WAITING_IP) |
throughput | integer | Number of messages allowed per seconds |
windowing | integer | Number of messages treated simultaneously |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | service_name | Returns the SMPP settings: TLS and non-TLS endpoints, system ID, status, throughput and windowing. |
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"}}) |
service_name | string | The internal name of your SMS offer (wire: serviceName) |
SELECT examples​
- get
Returns the SMPP settings: TLS and non-TLS endpoints, system ID, status, throughput and windowing.
SELECT
system_id,
endpoints,
status,
throughput,
windowing
FROM ovh.sms.smpp_settings
WHERE service_name = '{{ service_name }}' -- required
;