AlexaForBusiness / Client / create_contact

create_contact#

AlexaForBusiness.Client.create_contact(**kwargs)#

Creates a contact with the specified details.

See also: AWS API Documentation

Request Syntax

response = client.create_contact(
    DisplayName='string',
    FirstName='string',
    LastName='string',
    PhoneNumber='string',
    PhoneNumbers=[
        {
            'Number': 'string',
            'Type': 'MOBILE'|'WORK'|'HOME'
        },
    ],
    SipAddresses=[
        {
            'Uri': 'string',
            'Type': 'WORK'
        },
    ],
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:

  • DisplayName (string) – The name of the contact to display on the console.

  • FirstName (string) –

    [REQUIRED]

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

  • LastName (string) – The last name of the contact that is used to call the contact on the device.

  • PhoneNumber (string) – 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.

  • 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) – [REQUIRED]

        The raw value of the phone number.

      • Type (string) – [REQUIRED]

        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) – [REQUIRED]

        The URI for the SIP address.

      • Type (string) – [REQUIRED]

        The type of the SIP address.

  • ClientRequestToken (string) –

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

    This field is autopopulated if not provided.

  • Tags (list) –

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

    • (dict) –

      A key-value pair that can be associated with a resource.

      • Key (string) – [REQUIRED]

        The key of a tag. Tag keys are case-sensitive.

      • Value (string) – [REQUIRED]

        The value of a tag. Tag values are case sensitive and can be null.

Return type:

dict

Returns:

Response Syntax

{
    'ContactArn': 'string'
}

Response Structure

  • (dict) –

    • ContactArn (string) –

      The ARN of the newly created address book.

Exceptions

  • AlexaForBusiness.Client.exceptions.AlreadyExistsException

  • AlexaForBusiness.Client.exceptions.LimitExceededException