File: browse_and_reserve_phone_numbers_sample.py

package info (click to toggle)
python-azure 20251014%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 766,472 kB
  • sloc: python: 6,314,744; ansic: 804; javascript: 287; makefile: 198; sh: 198; xml: 109
file content (68 lines) | stat: -rw-r--r-- 2,752 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# coding: utf-8

# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------

"""
FILE:browse_and_reserve_phone_numbers_sample.py
DESCRIPTION:
    This sample demonstrates how to browse and reserve phone numbers using your connection string and
    the Reservations API in the Azure Communication Phone Numbers SDK.
USAGE:
    python browse_and_reserve_phone_numbers_sample.py
    Set the environment variables with your own values before running the sample:
    1) COMMUNICATION_SAMPLES_CONNECTION_STRING - The connection string including your endpoint and 
        access key of your Azure Communication Service
"""

import os
import uuid
from azure.communication.phonenumbers import PhoneNumbersClient

connection_str = os.environ["COMMUNICATION_SAMPLES_CONNECTION_STRING"]
phone_numbers_client = PhoneNumbersClient.from_connection_string(
    connection_str)


def browse_and_reserve_phone_numbers():
    browse_result = phone_numbers_client.browse_available_phone_numbers(
        country_code="US",
        phone_number_type="tollFree"
    )
    number_to_reserve = browse_result.phone_numbers[0]
    print(f"Reserving phone number: {number_to_reserve.phone_number}")

    # The reservation ID needs to be a valid UUID.
    reservation_id = str(uuid.uuid4())
    print(f"Using reservation ID: {reservation_id}")

    reservation = phone_numbers_client.create_or_update_reservation(
        reservation_id=reservation_id,
        numbers_to_add=[number_to_reserve]
    )

    # Check if any errors occurred during reservation
    if reservation.phone_numbers:
        numbers_with_error = [
            n for n in reservation.phone_numbers.values() if n.status == "error"]
    if any(numbers_with_error):
        print("Errors occurred during reservation:")
        for number in numbers_with_error:
            error_code = number.error.code if number.error and number.error.code else "Unknown"
            error_message = number.error.message if number.error and number.error.message else "Unknown error"
            print(
                f"Phone number: {number.phone_number}, Error: {error_code}, Message: {error_message}")
    else:
        print("Reservation operation completed without errors.")

    # Clean up the reservation after use
    print(f"Deleting reservation with ID: {reservation_id}")
    phone_numbers_client.delete_reservation(reservation_id=reservation_id)
    print("Reservation deleted successfully.")


if __name__ == "__main__":
    browse_and_reserve_phone_numbers()