users_jobs

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

Overview

Name	users_jobs
Type	Resource
Id	ovh.sms.users_jobs

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
creation_datetime	string (date-time)	(wire: creationDatetime)
credits	number
delivered_at	string (date-time)	(wire: deliveredAt)
delivery_receipt	integer	(wire: deliveryReceipt)
differed_delivery	integer	(wire: differedDelivery)
message	string
message_length	integer	(wire: messageLength)
number_of_sms	integer	(wire: numberOfSms)
ptt	integer
receiver	string
sender	string
sent_at	string (date-time)	(wire: sentAt)

list

Sms job

Name	Datatype	Description
id	integer
creation_datetime	string (date-time)	(wire: creationDatetime)
credits	number
delivered_at	string (date-time)	(wire: deliveredAt)
delivery_receipt	integer	(wire: deliveryReceipt)
differed_delivery	integer	(wire: differedDelivery)
message	string
message_length	integer	(wire: messageLength)
number_of_sms	integer	(wire: numberOfSms)
ptt	integer
receiver	string
sender	string
sent_at	string (date-time)	(wire: sentAt)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, login, service_name		Get a pending job. Returns the SMS waiting to be sent: receiver, message, number of SMS parts and credits.
list	select	login, service_name	x_pagination_mode	List pending jobs. Returns the identifiers of the SMS waiting to be sent. Get a pending job for its receiver, message, number of SMS parts and credits.
create	insert	login, service_name, message		Send SMS. Sends an SMS to one or several receivers, given as a list, a CSV document URL or a receiver list. Sending can be delayed, and a validity period drops the message if it is not delivered in time.
delete	delete	id, login, service_name		Delete a pending job. Cancels the sending of an SMS that is still waiting to be sent, such as a delayed SMS. Sent SMS are in the sent SMS history.

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"}})
id	integer	Id of the object
login	string	The sms user login
service_name	string	The internal name of your SMS offer (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

Get a pending job. Returns the SMS waiting to be sent: receiver, message, number of SMS parts and credits.

SELECT
id,
creation_datetime,
credits,
delivered_at,
delivery_receipt,
differed_delivery,
message,
message_length,
number_of_sms,
ptt,
receiver,
sender,
sent_at
FROM ovh.sms.users_jobs
WHERE id = '{{ id }}' -- required
AND login = '{{ login }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List pending jobs. Returns the identifiers of the SMS waiting to be sent. Get a pending job for its receiver, message, number of SMS parts and credits.

SELECT
id,
creation_datetime,
credits,
delivered_at,
delivery_receipt,
differed_delivery,
message,
message_length,
number_of_sms,
ptt,
receiver,
sender,
sent_at
FROM ovh.sms.users_jobs
WHERE login = '{{ login }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Send SMS. Sends an SMS to one or several receivers, given as a list, a CSV document URL or a receiver list. Sending can be delayed, and a validity period drops the message if it is not delivered in time.

INSERT INTO ovh.sms.users_jobs (
charset,
class,
coding,
differed_period,
message,
no_stop_clause,
priority,
receivers,
receivers_document_url,
receivers_slot_id,
sender,
sender_for_response,
tag,
validity_period,
login,
service_name
)
SELECT 
'{{ charset }}',
'{{ class }}',
'{{ coding }}',
{{ differed_period }},
'{{ message }}' /* required */,
{{ no_stop_clause }},
'{{ priority }}',
'{{ receivers }}',
'{{ receivers_document_url }}',
'{{ receivers_slot_id }}',
'{{ sender }}',
{{ sender_for_response }},
'{{ tag }}',
{{ validity_period }},
'{{ login }}',
'{{ service_name }}'
RETURNING
credits_left,
ids,
invalid_receivers,
tag,
total_credits_removed,
valid_receivers
;

Manifest

# Description fields are for documentation purposes
- name: users_jobs
props:
  - name: login
    value: "{{ login }}"
    description: Required parameter for the users_jobs resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the users_jobs resource.
  - name: charset
    value: "{{ charset }}"
    description: |
      The sms coding
    valid_values: ['UTF-8']
  - name: class
    value: "{{ class }}"
    description: |
      Deprecated: The sms class
    valid_values: ['flash', 'phoneDisplay', 'sim', 'toolkit']
  - name: coding
    value: "{{ coding }}"
    description: |
      Deprecated: the coding is deduced from the message and its charset
    valid_values: ['7bit', '8bit']
  - name: differed_period
    value: {{ differed_period }}
    description: |
      The time -in minute(s)- to wait before sending the message
  - name: message
    value: "{{ message }}"
    description: |
      The sms message
  - name: no_stop_clause
    value: {{ no_stop_clause }}
    description: |
      Do not display STOP clause in the message, this requires that this is not an advertising message
  - name: priority
    value: "{{ priority }}"
    description: |
      The priority of the message
    valid_values: ['high', 'low', 'medium', 'veryLow']
  - name: receivers
    value:
      - "{{ receivers }}"
    description: |
      The receivers list
  - name: receivers_document_url
    value: "{{ receivers_document_url }}"
    description: |
      The receivers document url link in csv format
  - name: receivers_slot_id
    value: "{{ receivers_slot_id }}"
    description: |
      The receivers document slot id
  - name: sender
    value: "{{ sender }}"
    description: |
      The sender
  - name: sender_for_response
    value: {{ sender_for_response }}
    description: |
      Set the flag to send a special sms which can be reply by the receiver (smsResponse).
  - name: tag
    value: "{{ tag }}"
    description: |
      The identifier group tag
  - name: validity_period
    value: {{ validity_period }}
    description: |
      The maximum time -in minute(s)- before the message is dropped

DELETE examples

delete

Delete a pending job. Cancels the sending of an SMS that is still waiting to be sent, such as a delayed SMS. Sent SMS are in the sent SMS history.

DELETE FROM ovh.sms.users_jobs
WHERE id = '{{ id }}' --required
AND login = '{{ login }}' --required
AND service_name = '{{ service_name }}' --required
;