users_receivers_csvs
Creates, updates, deletes, gets or lists a users_receivers_csvs resource.
Overview​
| Name | users_receivers_csvs |
| Type | Resource |
| Id | ovh.sms.users_receivers_csvs |
Fields​
The following fields are returned by SELECT queries:
- get
| Name | Datatype | Description |
|---|---|---|
value | string |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | login, service_name, slot_id | Get the receiver list CSV. Returns the content of the receiver list in CSV format. The number of records is given when getting the receiver list. |
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"}}) |
login | string | The sms user login |
service_name | string | The internal name of your SMS offer (wire: serviceName) |
slot_id | integer | Slot number id (wire: slotId) |
SELECT examples​
- get
Get the receiver list CSV. Returns the content of the receiver list in CSV format. The number of records is given when getting the receiver list.
SELECT
value
FROM ovh.sms.users_receivers_csvs
WHERE login = '{{ login }}' -- required
AND service_name = '{{ service_name }}' -- required
AND slot_id = '{{ slot_id }}' -- required
;