line_click2_call_users

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

Overview

Name	line_click2_call_users
Type	Resource
Id	ovh.telephony.line_click2_call_users

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Contact identifier
creation_date_time	string (date-time)	Date when user was created (wire: creationDateTime)
login	string	login of the click 2 call user

list

User of the click 2 call

Name	Datatype	Description
id	integer	Contact identifier
creation_date_time	string (date-time)	Date when user was created (wire: creationDateTime)
login	string	login of the click 2 call user

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	billing_account, id, service_name		Get a click2call user
list	select	billing_account, service_name	x_pagination_mode	List click2call users
create	insert	billing_account, service_name, login, password		Create a click2call user
delete	delete	billing_account, id, service_name		Delete a click2call user
change_password	exec	billingAccount, id, serviceName, password		Change the user password
click2_call	exec	billingAccount, id, serviceName, calledNumber		Start a call from the line

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"}})
billingAccount	string	The name of your billingAccount
billing_account	string	The name of your billingAccount (wire: billingAccount)
id	integer	Id of the object
serviceName	string
service_name	string	(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 click2call user

SELECT
id,
creation_date_time,
login
FROM ovh.telephony.line_click2_call_users
WHERE billing_account = '{{ billing_account }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List click2call users

SELECT
id,
creation_date_time,
login
FROM ovh.telephony.line_click2_call_users
WHERE billing_account = '{{ billing_account }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a click2call user

INSERT INTO ovh.telephony.line_click2_call_users (
login,
password,
billing_account,
service_name
)
SELECT 
'{{ login }}' /* required */,
'{{ password }}' /* required */,
'{{ billing_account }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: line_click2_call_users
props:
  - name: billing_account
    value: "{{ billing_account }}"
    description: Required parameter for the line_click2_call_users resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the line_click2_call_users resource.
  - name: login
    value: "{{ login }}"
    description: |
      Name of the contact
  - name: password
    value: "{{ password }}"
    description: |
      The user password

DELETE examples

delete

Delete a click2call user

DELETE FROM ovh.telephony.line_click2_call_users
WHERE billing_account = '{{ billing_account }}' --required
AND id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

change_password

Change the user password

EXEC ovh.telephony.line_click2_call_users.change_password 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;

click2_call

Start a call from the line

EXEC ovh.telephony.line_click2_call_users.click2_call 
@billingAccount='{{ billingAccount }}' --required, 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"calledNumber": "{{ calledNumber }}", 
"callingNumber": "{{ callingNumber }}"
}'
;