Class: Aws::AlexaForBusiness::Types::CreateContactRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb

Overview

Note:

When making an API call, you may pass CreateContactRequest data as a hash:

{
  display_name: "ContactName",
  first_name: "ContactName", # required
  last_name: "ContactName",
  phone_number: "RawPhoneNumber",
  phone_numbers: [
    {
      number: "RawPhoneNumber", # required
      type: "MOBILE", # required, accepts MOBILE, WORK, HOME
    },
  ],
  sip_addresses: [
    {
      uri: "SipUri", # required
      type: "WORK", # required, accepts WORK
    },
  ],
  client_request_token: "ClientRequestToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[:phone_number]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

A unique, user-specified identifier for this request that ensures idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013

class CreateContactRequest < Struct.new(
  :display_name,
  :first_name,
  :last_name,
  :phone_number,
  :phone_numbers,
  :sip_addresses,
  :client_request_token,
  :tags)
  SENSITIVE = [:phone_number]
  include Aws::Structure
end

#display_nameString

The name of the contact to display on the console.

Returns:

  • (String)


1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013

class CreateContactRequest < Struct.new(
  :display_name,
  :first_name,
  :last_name,
  :phone_number,
  :phone_numbers,
  :sip_addresses,
  :client_request_token,
  :tags)
  SENSITIVE = [:phone_number]
  include Aws::Structure
end

#first_nameString

The first name of the contact that is used to call the contact on the device.

Returns:

  • (String)


1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013

class CreateContactRequest < Struct.new(
  :display_name,
  :first_name,
  :last_name,
  :phone_number,
  :phone_numbers,
  :sip_addresses,
  :client_request_token,
  :tags)
  SENSITIVE = [:phone_number]
  include Aws::Structure
end

#last_nameString

The last name of the contact that is used to call the contact on the device.

Returns:

  • (String)


1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013

class CreateContactRequest < Struct.new(
  :display_name,
  :first_name,
  :last_name,
  :phone_number,
  :phone_numbers,
  :sip_addresses,
  :client_request_token,
  :tags)
  SENSITIVE = [:phone_number]
  include Aws::Structure
end

#phone_numberString

The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

Returns:

  • (String)


1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013

class CreateContactRequest < Struct.new(
  :display_name,
  :first_name,
  :last_name,
  :phone_number,
  :phone_numbers,
  :sip_addresses,
  :client_request_token,
  :tags)
  SENSITIVE = [:phone_number]
  include Aws::Structure
end

#phone_numbersArray<Types::PhoneNumber>

The list of phone numbers for the contact.

Returns:



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013

class CreateContactRequest < Struct.new(
  :display_name,
  :first_name,
  :last_name,
  :phone_number,
  :phone_numbers,
  :sip_addresses,
  :client_request_token,
  :tags)
  SENSITIVE = [:phone_number]
  include Aws::Structure
end

#sip_addressesArray<Types::SipAddress>

The list of SIP addresses for the contact.

Returns:



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013

class CreateContactRequest < Struct.new(
  :display_name,
  :first_name,
  :last_name,
  :phone_number,
  :phone_numbers,
  :sip_addresses,
  :client_request_token,
  :tags)
  SENSITIVE = [:phone_number]
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags to be added to the specified resource. Do not provide system tags.

Returns:



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
# File 'gems/aws-sdk-alexaforbusiness/lib/aws-sdk-alexaforbusiness/types.rb', line 1013

class CreateContactRequest < Struct.new(
  :display_name,
  :first_name,
  :last_name,
  :phone_number,
  :phone_numbers,
  :sip_addresses,
  :client_request_token,
  :tags)
  SENSITIVE = [:phone_number]
  include Aws::Structure
end