sms_news

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

Overview

Name	sms_news
Type	Resource
Id	ovh.order.sms_news

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
order_id	integer	Identifier of the order (wire: orderId)
contracts	array	List of contracts related to the order
details	array	Details of the order
prices	object	Prices of the order including with and without taxes
url	string	URL to download the order

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	quantity	channel, smpp	Get prices and contracts information
create	insert	quantity		Create order

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"}})
quantity	integer	Sms credit quantity
channel	string	For what purpose this account can be used for
smpp	boolean	Whether the account can be used for smpp or not

SELECT examples

get

Get prices and contracts information

SELECT
order_id,
contracts,
details,
prices,
url
FROM ovh.order.sms_news
WHERE quantity = '{{ quantity }}' -- required
AND channel = '{{ channel }}'
AND smpp = '{{ smpp }}'
;

INSERT examples

create

Create order

INSERT INTO ovh.order.sms_news (
channel,
quantity,
smpp
)
SELECT 
'{{ channel }}',
{{ quantity }} /* required */,
{{ smpp }}
RETURNING
order_id,
contracts,
details,
prices,
url
;

Manifest

# Description fields are for documentation purposes
- name: sms_news
props:
  - name: channel
    value: "{{ channel }}"
    description: |
      In case of smpp the channel can not be "both"
    valid_values: ['both', 'marketing', 'transactional']
  - name: quantity
    value: {{ quantity }}
    description: |
      Sms credit quantity
  - name: smpp
    value: {{ smpp }}
    description: |
      Whether the account can be used for smpp or not