outgoings

Creates, updates, deletes, gets or lists an outgoings resource.

Overview

Name	outgoings
Type	Resource
Id	ovh.sms.outgoings

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Identifier
batch_id	string (uuid)	ID of batch linked to the SMS (wire: batchID)
message_id	string (uuid)	SMPP messageID (wire: messageID)
creation_datetime	string (date-time)	Creation datetime (wire: creationDatetime)
credits	number	Spent credits
delivered_at	string (date-time)	Delivering datetime (wire: deliveredAt)
delivery_receipt	integer	Delivery receipt from operator (wire: deliveryReceipt)
differed_delivery	integer	Delay before SMS sending (wire: differedDelivery)
message	string	SMS message
message_length	integer	SMS message length (wire: messageLength)
number_of_sms	integer	SMS message's number of parts (wire: numberOfSms)
ptt	integer	Code representing SMS state
receiver	string	SMS receiver
sender	string	SMS sender
sent_at	string (date-time)	Sending datetime (wire: sentAt)
tag	string	Customer label to categorize SMSs
tariff_code	string	Tariff code applied on the sms (wire: tariffCode)

list

Sent SMS

Name	Datatype	Description
id	integer	Identifier
batch_id	string (uuid)	ID of batch linked to the SMS (wire: batchID)
message_id	string (uuid)	SMPP messageID (wire: messageID)
creation_datetime	string (date-time)	Creation datetime (wire: creationDatetime)
credits	number	Spent credits
delivered_at	string (date-time)	Delivering datetime (wire: deliveredAt)
delivery_receipt	integer	Delivery receipt from operator (wire: deliveryReceipt)
differed_delivery	integer	Delay before SMS sending (wire: differedDelivery)
message	string	SMS message
message_length	integer	SMS message length (wire: messageLength)
number_of_sms	integer	SMS message's number of parts (wire: numberOfSms)
ptt	integer	Code representing SMS state
receiver	string	SMS receiver
sender	string	SMS sender
sent_at	string (date-time)	Sending datetime (wire: sentAt)
tag	string	Customer label to categorize SMSs
tariff_code	string	Tariff code applied on the sms (wire: tariffCode)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Returns the sent SMS: receiver, message, delivery status, number of SMS parts and credits used.
list	select	service_name	batch_id, creation_datetime.from, creation_datetime.to, delivery_receipt, differed_delivery, message_id, ptt, receiver, sender, tag, x_pagination_mode	Returns the identifiers of the SMS sent from the account.
delete	delete	id, service_name		Deletes the sent SMS from the 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
service_name	string	The internal name of your SMS offer (wire: serviceName)
batch_id	string (uuid)	Filter on batch id property (=) (wire: batchID)
creation_datetime.from	string (date-time)	Filter on creationDatetime property (>=) (wire: creationDatetime.from)
creation_datetime.to	string (date-time)	Filter on creationDatetime property (<=) (wire: creationDatetime.to)
delivery_receipt	integer	Filter on deliveryReceipt property (=) (wire: deliveryReceipt)
differed_delivery	integer	Filter on differedDelivery property (=) (wire: differedDelivery)
message_id	string (uuid)	Filter on message id property (=) (wire: messageID)
ptt	integer	Filter on ptt property (=)
receiver	string	Filter on receiver property (=)
sender	string	Filter on sender property (=)
tag	string	Filter on tag property (=)
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

Returns the sent SMS: receiver, message, delivery status, number of SMS parts and credits used.

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

list

Returns the identifiers of the SMS sent from the account.

SELECT
id,
batch_id,
message_id,
creation_datetime,
credits,
delivered_at,
delivery_receipt,
differed_delivery,
message,
message_length,
number_of_sms,
ptt,
receiver,
sender,
sent_at,
tag,
tariff_code
FROM ovh.sms.outgoings
WHERE service_name = '{{ service_name }}' -- required
AND batch_id = '{{ batch_id }}'
AND creation_datetime.from = '{{ creation_datetime.from }}'
AND creation_datetime.to = '{{ creation_datetime.to }}'
AND delivery_receipt = '{{ delivery_receipt }}'
AND differed_delivery = '{{ differed_delivery }}'
AND message_id = '{{ message_id }}'
AND ptt = '{{ ptt }}'
AND receiver = '{{ receiver }}'
AND sender = '{{ sender }}'
AND tag = '{{ tag }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

DELETE examples

delete

Deletes the sent SMS from the history.

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