virtual_numbers_chat_accesses

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

Overview

Name	virtual_numbers_chat_accesses
Type	Resource
Id	ovh.sms.virtual_numbers_chat_accesses

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer
creation_date	string (date-time)	The creation date of this access (wire: creationDate)
url	string	The url of the web access

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	number, service_name		Get the web access. Returns the web access to the chat application of the virtual number: its URL and creation date.
create	insert	number, service_name		Create the web access. Creates a web access to the chat application of the virtual number. Returns its URL.
delete	delete	number, service_name		Delete the web access. Deletes the web access to the chat application of the virtual number. Its URL no longer gives access to the chat.

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

SELECT examples

get

Get the web access. Returns the web access to the chat application of the virtual number: its URL and creation date.

SELECT
id,
creation_date,
url
FROM ovh.sms.virtual_numbers_chat_accesses
WHERE number = '{{ number }}' -- required
AND service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Create the web access. Creates a web access to the chat application of the virtual number. Returns its URL.

INSERT INTO ovh.sms.virtual_numbers_chat_accesses (
number,
service_name
)
SELECT 
'{{ number }}',
'{{ service_name }}'
RETURNING
id,
creation_date,
url
;

Manifest

# Description fields are for documentation purposes
- name: virtual_numbers_chat_accesses
props:
  - name: number
    value: "{{ number }}"
    description: Required parameter for the virtual_numbers_chat_accesses resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the virtual_numbers_chat_accesses resource.

DELETE examples

delete

Delete the web access. Deletes the web access to the chat application of the virtual number. Its URL no longer gives access to the chat.

DELETE FROM ovh.sms.virtual_numbers_chat_accesses
WHERE number = '{{ number }}' --required
AND service_name = '{{ service_name }}' --required
;