exceptions

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

Overview

Name	exceptions
Type	Resource
Id	ovh.sms.exceptions

Fields

The following fields are returned by SELECT queries:

list

Sms reach list

Name	Datatype	Description
country_suffixe	string	The abreviated country code. (wire: countrySuffixe)
messages	array	The exception message
operators	string	The list of operators impacted.
restriction_code	string	The type of routing restriction imposed by the operator (ALPHA, BAD_DLR, BLOCKED, CODING, DLR, FLASHONLY, MSISDN) (wire: restrictionCode)
substitution	string	The substitution sender used to bypass operator filter

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	receiver, service_name		List sending restrictions for a number. Returns the operator restrictions and substitutions that apply when sending SMS to the given number.

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"}})
receiver	string	The receiver number to check
service_name	string	The internal name of your SMS offer (wire: serviceName)

SELECT examples

list

List sending restrictions for a number. Returns the operator restrictions and substitutions that apply when sending SMS to the given number.

SELECT
country_suffixe,
messages,
operators,
restriction_code,
substitution
FROM ovh.sms.exceptions
WHERE receiver = '{{ receiver }}' -- required
AND service_name = '{{ service_name }}' -- required
;