Create a phone

To create a new phone, build a phone object that contains the following objects:

Phone base settings
Site
Line

The following sections describe how to retrieve the information you need to create a new phone object.

Phone Base Settings

Phone base settings are the default settings for a phone model. To create a new phone instance, retrieve the metabase for your phone model and modify it for your configuration. You can use these calls to identify the correct metabase for your phone:

<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases" />
<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/phonebasesettings" />
<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId}" />

Note: Required settings vary by phone model.

Site

The site is the physical location of the phone and requires a direct inward dialing (DID) phone number. Use these calls to identify your site:

<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/sites" />
<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/sites/{siteId}" />
<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/dids" />
<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/dids/{didId}" />

Lines

Lines connect Genesys Cloud Edge devices. New phones create one line by default.

To add more lines, retrieve an existing line base setting (default settings), modify it, and add it to your phone configuration. You can use these calls to identify the correct metabase for your phone:

<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/lines/template" />
<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/linebasesettings" />
<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/linebasesettings/{lineBaseId}" />
<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/lines" />
<dxui:OpenAPIExplorer verb="GET" path="/api/v2/telephony/providers/edges/lines/{lineId}" />

Save the new phone

Save the Genesys Cloud phone using:

<dxui:OpenAPIExplorer verb="POST" path="/api/v2/telephony/providers/edges/phones" />
<dxui:OpenAPIExplorer verb="PUT" path="/api/v2/telephony/providers/edges/phones/{phoneId}" />

Example post

Example request body for POST /api/v2/telephony/providers/edges/phones:

{
  "name": "Test Phone",
  "site": {
    "id": "fbefa3ae-1e4b-4b4b-912d-f0a9852a6b9a"
  },
  "phoneBaseSettings": {
    "id": "71f8c7c2-c019-4290-a3d5-87613e338c10"
  },
  "lines": [
    {
      "name": "TestLine",
      "lineBaseSettings": {
        "id": "716329a7-9113-4f08-ba73-04e4e48f8c9c"
      },
      "properties": {
        "station_label": {
          "value": {
            "instance": null
          }
        },
        "station_remote_address": {
          "value": {
            "instance": "15555551212"
          }
        },
        "station_lineLabel": {
          "value": {
            "instance": "TestLine"
          }
        },
        "station_lineKeyPosition": {
          "value": {
            "instance": 0
          }
        }
      }
    }
  ],
  "properties": {
    "phone_hardwareId": {
      "value": {
        "instance": "FF:FF:FF:FF:FF:FF"
      }
    }
  }
}

Standalone phones

When creating or updating a standalone phone, there are a couple of additional requirements:

In the properties for each line, either station_identity_address or station_identity_emergencyAddress must be set to an existing DID phone number; and
This DID must be in an existing DID Pool.