---
schema_version: "1"
id: 06c4341d049c0860f23040e61328aa63f8c31e03c2c7d10f107120cb09d8c192
title: TelephonyProvider
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_telephonyprovider.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_telephonyprovider.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 40dcc651506b493cd2175b8f9ecf12eb1a46334a49d39b6ff062e0533bf93d3e
description: Represents a telephony provider configuration that an org uses with Bring Your Own Carrier (BYOC).
---
# TelephonyProvider

Represents a telephony provider configuration that an org uses with Bring Your Own Carrier (BYOC).

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

TelephonyProvider components have the suffix .telephonyProvider and are stored in the telephonyProviders folder.

## Version

TelephonyProvider components are available in API version 68.0 and later.

## Special Access Rules

To access TelephonyProvider, you must have the Agentforce Contact Center Admin (Salesforce Voice) permission set assigned.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d894139e103">Field Name</th>

              <th class="featureTableHeader  " id="d894139e106">Field Type</th>

              <th class="featureTableHeader  " id="d894139e109">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">country</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">ByocCountryCode(
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a>
                of type string)
              </td>

              <td class="entry" headers="d894139e109" data-title="Description">Required. Specifies the country of the telephony provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">externalIdentifier</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">string</td>

              <td class="entry" headers="d894139e109" data-title="Description">Specifies the ID of the telephony provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">fullName</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">string</td>

              <td class="entry" headers="d894139e109" data-title="Description">Required. The unique name of the TelephonyProvider component.
                Inherited from the <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm" title="The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.">Metadata</a> metadata type.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">id</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">string</td>

              <td class="entry" headers="d894139e109" data-title="Description">Specifies the ID of the TelephonyProvider record.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">masterLabel</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">string</td>

              <td class="entry" headers="d894139e109" data-title="Description">Required. Specifies the label for the telephony provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">providerName</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">string</td>

              <td class="entry" headers="d894139e109" data-title="Description">Required. Specifies the name of the telephony provider.</td>

            </tr>

            <tr>
              <td class="entry" headers="d894139e103" data-title="Field Name"><span class="keyword parmname">trunkType</span></td>

              <td class="entry" headers="d894139e106" data-title="Field Type">TrunkType(
                <a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_objects_intro.htm#enumeration_title">enumeration</a>
                of type string)
              </td>

              <td class="entry" headers="d894139e109" data-title="Description">Required. Specifies the trunk type of the telephony provider. Valid
                values are: <ul class="ul bulletList">
                  <li class="li"><samp class="codeph nolang">Trusted</samp></li>

                  <li class="li"><samp class="codeph nolang">Secondary</samp></li>

                </ul>

              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

A sample XML definition of a TelephonyProvider component is shown here.

<telephonyProvider>
    <fullName>MyTelephonyProvider</fullName>
    <country>US</country>
    <externalIdentifier>sampleValue</externalIdentifier>
    <id>sampleValue</id>
    <masterLabel>sampleValue</masterLabel>
    <providerName>sampleValue</providerName>
    <trunkType>Trusted</trunkType>
</telephonyProvider>

The following package.xml manifest retrieves the TelephonyProvider component.

<?xml version="1.0" encoding="UTF-8"?>
<!--
   ~ Copyright 2020 Salesforce, Inc.
   ~ All Rights Reserved
   ~ Company Confidential
-->
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
   <types>
      <members>\*</members>
      <name>TelephonyProvider</name>
   </types>
   <version>XX.0</version>
</Package>

## Wildcard Support in the Manifest File

This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm "HTML (New Window)").