phonebooks_phonebook_contacts

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

Overview

Name	phonebooks_phonebook_contacts
Type	Resource
Id	ovh.sms.phonebooks_phonebook_contacts

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Contact identifier
name	string	Contact name
group	string	Group name of the phonebook
home_mobile	string (phone-number)	Home mobile phone number of the contact (wire: homeMobile)
home_phone	string (phone-number)	Home landline phone number of the contact (wire: homePhone)
surname	string	Contact surname
work_mobile	string (phone-number)	Mobile phone office number of the contact (wire: workMobile)
work_phone	string (phone-number)	Landline phone office number of the contact (wire: workPhone)

list

Phone book contact

Name	Datatype	Description
id	integer	Contact identifier
name	string	Contact name
group	string	Group name of the phonebook
home_mobile	string (phone-number)	Home mobile phone number of the contact (wire: homeMobile)
home_phone	string (phone-number)	Home landline phone number of the contact (wire: homePhone)
surname	string	Contact surname
work_mobile	string (phone-number)	Mobile phone office number of the contact (wire: workMobile)
work_phone	string (phone-number)	Landline phone office number of the contact (wire: workPhone)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	book_key, id, service_name		Get a contact. Returns the contact: name, surname, group, and office and home phone numbers, landline and mobile.
list	select	book_key, service_name	x_pagination_mode	List contacts. Returns the identifiers of the contacts of the phonebook. Get a contact for its name, group and phone numbers.
create	insert	book_key, service_name, group, name, surname		Create a contact. Creates a contact in the phonebook with a name, surname, group and phone numbers. Returns its identifier.
update	update	book_key, id, service_name		Update a contact. Updates the contact: name, surname, group, and office and home phone numbers, landline and mobile.
delete	delete	book_key, id, service_name		Delete a contact. Deletes the contact from the phonebook, with its name, group and office and home phone numbers.

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"}})
book_key	string	Identifier of the phonebook (wire: bookKey)
id	integer	Contact identifier
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 contact. Returns the contact: name, surname, group, and office and home phone numbers, landline and mobile.

SELECT
id,
name,
group,
home_mobile,
home_phone,
surname,
work_mobile,
work_phone
FROM ovh.sms.phonebooks_phonebook_contacts
WHERE book_key = '{{ book_key }}' -- required
AND id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List contacts. Returns the identifiers of the contacts of the phonebook. Get a contact for its name, group and phone numbers.

SELECT
id,
name,
group,
home_mobile,
home_phone,
surname,
work_mobile,
work_phone
FROM ovh.sms.phonebooks_phonebook_contacts
WHERE book_key = '{{ book_key }}' -- required
AND service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Create a contact. Creates a contact in the phonebook with a name, surname, group and phone numbers. Returns its identifier.

INSERT INTO ovh.sms.phonebooks_phonebook_contacts (
group,
home_mobile,
home_phone,
name,
surname,
work_mobile,
work_phone,
book_key,
service_name
)
SELECT 
'{{ group }}' /* required */,
'{{ home_mobile }}',
'{{ home_phone }}',
'{{ name }}' /* required */,
'{{ surname }}' /* required */,
'{{ work_mobile }}',
'{{ work_phone }}',
'{{ book_key }}',
'{{ service_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: phonebooks_phonebook_contacts
props:
  - name: book_key
    value: "{{ book_key }}"
    description: Required parameter for the phonebooks_phonebook_contacts resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the phonebooks_phonebook_contacts resource.
  - name: group
    value: "{{ group }}"
    description: |
      Group name of the phonebook
  - name: home_mobile
    value: "{{ home_mobile }}"
    description: |
      Home mobile phone number of the contact
  - name: home_phone
    value: "{{ home_phone }}"
    description: |
      Home landline phone number of the contact
  - name: name
    value: "{{ name }}"
    description: |
      Name of the contact
  - name: surname
    value: "{{ surname }}"
    description: |
      Contact surname
  - name: work_mobile
    value: "{{ work_mobile }}"
    description: |
      Mobile phone office number of the contact
  - name: work_phone
    value: "{{ work_phone }}"
    description: |
      Landline phone office number of the contact

UPDATE examples

update

Update a contact. Updates the contact: name, surname, group, and office and home phone numbers, landline and mobile.

UPDATE ovh.sms.phonebooks_phonebook_contacts
SET 
group = '{{ group }}',
home_mobile = '{{ home_mobile }}',
home_phone = '{{ home_phone }}',
name = '{{ name }}',
surname = '{{ surname }}',
work_mobile = '{{ work_mobile }}',
work_phone = '{{ work_phone }}'
WHERE 
book_key = '{{ book_key }}' --required
AND id = '{{ id }}' --required
AND service_name = '{{ service_name }}' --required;

DELETE examples

delete

Delete a contact. Deletes the contact from the phonebook, with its name, group and office and home phone numbers.

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