get_contact

AlexaForBusiness.Client.get_contact(**kwargs)

Gets the contact details by the contact ARN.

See also: AWS API Documentation

Request Syntax

response = client.get_contact(
    ContactArn='string'
)

Parameters

ContactArn (string) --

[REQUIRED]

The ARN of the contact for which to request details.

Return type

dict

Returns

Response Syntax

{
    'Contact': {
        'ContactArn': 'string',
        'DisplayName': 'string',
        'FirstName': 'string',
        'LastName': 'string',
        'PhoneNumber': 'string',
        'PhoneNumbers': [
            {
                'Number': 'string',
                'Type': 'MOBILE'|'WORK'|'HOME'
            },
        ],
        'SipAddresses': [
            {
                'Uri': 'string',
                'Type': 'WORK'
            },
        ]
    }
}

Response Structure

• (dict) --
  • Contact (dict) --

    The details of the requested contact.

    • ContactArn (string) --

      The ARN of the contact.

    • DisplayName (string) --

      The name of the contact to display on the console.

    • FirstName (string) --

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

    • LastName (string) --

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

    • PhoneNumber (string) --

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

    • PhoneNumbers (list) --

      The list of phone numbers for the contact.

      • (dict) --

        The phone number for the contact containing the raw number and phone number type.

        • Number (string) --

          The raw value of the phone number.

        • Type (string) --

          The type of the phone number.

    • SipAddresses (list) --

      The list of SIP addresses for the contact.

      • (dict) --

        The SIP address for the contact containing the URI and SIP address type.

        • Uri (string) --

          The URI for the SIP address.

        • Type (string) --

          The type of the SIP address.

Exceptions

• AlexaForBusiness.Client.exceptions.NotFoundException