TelephonyProvider

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

This type extends the Metadata 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

Field Name Field Type Description
country ByocCountryCode( enumeration of type string) Required. Specifies the country of the telephony provider.
externalIdentifier string Specifies the ID of the telephony provider.
fullName string Required. The unique name of the TelephonyProvider component. Inherited from the Metadata metadata type.
id string Specifies the ID of the TelephonyProvider record.
masterLabel string Required. Specifies the label for the telephony provider.
providerName string Required. Specifies the name of the telephony provider.
trunkType TrunkType( enumeration of type string) Required. Specifies the trunk type of the telephony provider. Valid values are:
  • Trusted
  • Secondary

Declarative Metadata Sample Definition

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

1<telephonyProvider>
2    <fullName>MyTelephonyProvider</fullName>
3    <country>US</country>
4    <externalIdentifier>sampleValue</externalIdentifier>
5    <id>sampleValue</id>
6    <masterLabel>sampleValue</masterLabel>
7    <providerName>sampleValue</providerName>
8    <trunkType>Trusted</trunkType>
9</telephonyProvider>

The following package.xml manifest retrieves the TelephonyProvider component.

1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3   ~ Copyright 2020 Salesforce, Inc.
4   ~ All Rights Reserved
5   ~ Company Confidential
6-->
7<Package xmlns="http://soap.sforce.com/2006/04/metadata">
8   <types>
9      <members>*</members>
10      <name>TelephonyProvider</name>
11   </types>
12   <version>XX.0</version>
13</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.