Article ID: 115784, created on Mar 21, 2013, last review on May 9, 2014

  • Applies to:
  • Operations Automation 5.4

This article describes how to add new Lync Phone Numbers Pools and Ranges, how to create a new Lync Phone Numbers Assignment, and how to view the existing Lync phone numbers by using the POA Public API methods.

Table of contents:

1. How to create a new Lync Phone Numbers Pool
2. How to create a new Lync Phone Numbers Range of the "range" type
3. How to create a new Lync Phone Numbers Range of the "list" type
4. How to create a new Lync Phone Numbers Assignment of the "range" type
5. How to create a new Lync Phone Numbers Assignment of the "list" type
6. How to list all Lync Phone Numbers Assignments
7. How to list all phone numbers added to a subscription

How to create a new Lync Phone Numbers Pool

1. First of all, we need the <application id> that can be found on the "Applications->Lync Phone Numbers->Configuration->General" page:

2. In order to obtain the Lync Phone Numbers Configuration service ID, call the method pem.APS.getServiceInstances with the following parameters:

  • "application_instance_id" = <application id>, e.g., "529"
  • "service_id" = "Configuration"

The ID of the Lync Phone Numbers Configuration service is represented by the "service_instance_id" setting in the returned response. Let’s call it <configuration id>.
3. Call the method pem.APS.provideServiceInstance with the following:

  • "parent_service_instance_id" = <configuration id> retrieved by the previous step
  • "service_id" = "Pool"
  • Configure the following service settings:
    • name: "Pool_Name"; value: <name of created pool>, e.g., "TestPool"
    • name: "Pool_Description"; value: <description of the created pool>, e.g., "Test phone number pool"

The returned response contains the ID of the created Pool.

#Back to top

How to create a new Lync Phone Numbers Range of the "range" type

1. The ID of the parent Lync Phone Numbers Pool (<pool id>) can be found on the "Applications->Lync Phone Numbers->Pools-><Pool>" page:


2. Call the method pem.APS.provideServiceInstance with the following:

  • "parent_service_instance_id" = <pool id> retrieved by the previous step. In this example, it is "3520"
  • "service_id" = "Range"
  • Configure the following service settings:
    • name: "Range_Name"; value: <range name>, e.g., "range1"
    • name: "Range_Type"; value: "Range"
    • name: "Range_StartRangeValue"; value: <start range value>, e.g., "1-234-567-8900"
    • name: "Range_EndRangeValue"; value: <end range value>, e.g., "1-234-567-8950"
The returned response contains the ID of the created range.

#Back to top

How to create a new Lync Phone Numbers Range of the "list" type

1. The ID of the parent Lync Phone Numbers Pool (<pool id>) can be found on the "Applications->Lync Phone Numbers->Pools-><Pool>" page:


2. Call the method pem.APS.provideServiceInstance with the following:

  • "parent_service_instance_id" = <pool id>, e.g., "3520"
  • "service_id" = "Range"
  • Configure the following service settings:
    • name: "Range_Name"; value: <range name>, e.g., "range2"
    • name: "Range_Type"; value: "List"
    • name: "Range_PhoneNumberList"; value: <the first phone number>, e.g., "1-234-567-8951"
    • name: "Range_PhoneNumberList"; value: <the second phone number>, e.g., "1-234-567-8953"
    • ....
    • name: "Range_PhoneNumberList"; value: <the last phone number>, e.g., "1-234-567-8955"
The returned response contains the ID of the created range.


#Back to top

How to create a new Lync Phone Numbers Assignment of the "range" type

1. We need the <application id> that can be found on the "Applications->Lync Phone Numbers->Configuration->General" page:

2. In order to obtain the Lync Phone Numbers Configuration service ID, call the method pem.APS.getServiceInstances with the following parameters:

  • "application_instance_id" = <application id>, e.g., "529"
  • "service_id" = "Configuration"

The ID of the Lync Phone Numbers Configuration service is represented by the "service_instance_id" setting in the returned response. Let’s call it <configuration id>.
3. Call the method pem.APS.provideServiceInstance with the following:

  • "parent_service_instance_id" = <configuration id>
  • "service_id" = "Assignment"
  • Configure the following service settings:
    • name: "Assignment_Type"; value: "Range"
    • name: "Assignment_OwnerId"; value: <subscription id to assign phone numbers to>, e.g.,"524"
    • name: "Assignment_StartRangeValue"; value: <start range value>, e.g., "1-917-300-0000"
    • name: "Assignment_EndRangeValue"; value: <end range value>, e.g., "1-917-300-0010"
The returned response contains the ID of the created assignment.

#Back to top

How to create a new Lync Phone Numbers Assignment of the "list" type

1. We need the <application id> that can be found on the "Applications->Lync Phone Numbers->Configuration->General" page:

2. In order to obtain the Lync Phone Numbers Configuration service ID, call the method pem.APS.getServiceInstances with the following parameters:

  • "application_instance_id" = <application id>, e.g., "529"
  • "service_id" = "Configuration"

The ID of the Lync Phone Numbers Configuration service is represented by the "service_instance_id" setting in the returned response. Let’s call it <configuration id>.
3. Call the method pem.APS.provideServiceInstance with the following:

  • "parent_service_instance_id" = <configuration id> 
  • "service_id" = "Assignment"
  • Configure the following service settings:
    • name: "Assignment_Type"; value: "List"
    • name: "Assignment_OwnerId"; value: <subscription id to assign phone numbers to>, e.g., "524"
    • name: "Assignment_PhoneNumberList"; value: <first phone number>, e.g., "1-917-300-0011"
    • ...
    • name: "Assignment_PhoneNumberList"; value: <last phone number>, e.g., "1-917-300-0015"
The returned response contains the ID of the created assignment.

How to list all Lync Phone Numbers Assignments

1. Get the LyncPhoneNumbers <application id>, which can be found on the "Applications->Lync Phone Numbers->Configuration->General" page:

2. Call the method pem.APS.getServiceInstances with the following:

  • "application_instance_id" = <application id> retrieved by previous step; in this example, it is "529"
  • "service_id" = "Assignment"
The response will contain the Lync Phone Numbers Assignment list, which is the same as the one shown on the "Applications->Lync Phone Numbers->Assignments" page.
 

How to list all phone numbers added to a subscription

1. Find the Microsoft Lync 2010 <application id> on the "Microsoft Lync 2010->Configuration->General" page:

2. Call the method pem.APS.getServiceInstances with the following:

  • "application_instance_id" = <application id> retrieved by the previous step; in this example, it is "580"
  • "service_id" = "Generic_Phone_Number"

The response will contain a list of phone numbers that is identical to the one shown on the "Microsoft Lync 2010->Phone Numbers" page.
 

#Back to top

ac82ce33439a9c1feec4ff4f2f638899 caea8340e2d186a540518d08602aa065 5356b422f65bdad1c3e9edca5d74a1ae 2554725ed606193dd9bbce21365bed4e e12cea1d47a3125d335d68e6d4e15e07

Email subscription for changes to this article
Save as PDF