Phone Number Configurations

There are a couple of different configurations for phone numbers. This section will explain them in detail.

No configuration

NameDescriptionRequiredSchema
TypeThe type should be none.Yesstring
PhoneNumberThe phone number to configure.Yesnumber

SIP configuration

NameDescriptionRequiredSchema
TypeThe type should be sip.Yesstring
PhoneNumberThe phone number to configure.Yesnumber
DistributionGroupGuidThe distribution group used for the phone number, find the right Guid using the following endpoint: GET https://api.cm.com/voiceroutingapi/v1/{voiceAccountGuid}/distributiongroupsYesstring (uuid)
AlgorithmRoundRobin (shares all incoming calls over the given IPs) or Failover (looks at the first IP and only if that gives an error, the next one will be tried, etc.).Yesstring
AnonymousModeIf 1 is used and a call contains the Privacy:id header, the call will be passed 'as is'. If 2 is used and a call contains the Privacy:id header, all headers containing the callers' phone number will be stripped (P-Asserted-Identity, Remote-Party-ID) and the URI in the From header will be replaced with [email protected].Yesnumber

Notification configuration

NameDescriptionRequiredSchema
TypeThe type should be notification.Yesstring
PhoneNumberThe phone number to configure.Yesnumber
AppAccountGuidFind the Guid using the following endpoint: GET https://api.cm.com/voice-appaccountapi/v1/{voiceAccountGuid}/appaccountsYesstring (uuid)
PromptTypeFile or TTS (Text To Speech.)Yesstring
PromptThe prompt message or the path of the audio file.Yesstring
LanguageLanguage formatted like 'en-GB'For TTS.string
GenderVoice gender (Male or Female)For TTS.string
VoiceNumberSee the voice api docs for all the options https://www.cm.com/en-en/app/docs/voice-api-apps/v2.0 (Text-To-Speech).For TTSnumber
TimeoutInMillisecondsThe time to let the phone ring at the receiver.Nonumber
CallbackUrlThe URL (including http(s)://) for the callback. See https://www.cm.com/en-en/app/docs/voice-api-apps/v2.0 (Notification App callback) for more info.Nostring

Direct forwarding configuration

NameDescriptionRequiredSchema
TypeThe type should be directforwardingYesstring
PhoneNumberThe phone number to configure.Yesnumber
AppAccountGuidFind the Guid using the following endpoint: GET https://api.cm.com/voice-appaccountapi/v1/{voiceAccountGuid}/appaccountsYesstring (uuid)
DestinationNumberThe destination number to forward to.Yesnumber
CustomCallerIdNumber alias.Nostring

Did this page help you?