Partner System Attributes

Partner system attributes can be set at the system level and affect all the partners at once. These values are used by default for all the partners.

At the same time, it is possible to set these attributes at the partner level, so that they will affect only the certain partner.

Global Settings

Attribute Data Type Description Default Value
billing.defaults.calldr.lrn_enabled boolean Whether or not the billing is based on the location routing number (LRN) of the dialed number. false
sms.defaults.sms_in_bad_phonenumber_partner_id string The ID of the partner to whom the message with the incorrect phone number will be assigned. QA: 2565943, Prod: 6618
sms.defaults.sms_in_partner_not_found_partner_id string The ID of the partner to whom the message with the incorrect partner will be assigned. QA: 2565942, Prod: 6617
sms.vendor.queue_names string The names of the providers that an SMS passes in queue. beepsend; clx_sc; clx; inteliquent; mitto; tsg; tyntec; legos

Endpoint

Attribute Data Type Description Default Value
account_sid string The account secure ID associated with the created endpoint.  
api_url string The URL to the endpoint API.  
container_sid string The container secure ID associated with the created endpoint.  
default_capacity integer The capacity assigned to the created endpoint. 0
did_group_id string The secure ID of the DID group associated with the created endpoint.  
login string The login for the endpoint access assigned to the user.  
password string The password for the endpoint access assigned to the user.  
system_endpoint_name string The name for the system endpoint (system_gateway). System Gateway
Conference/Conference Playback      
conference_endpoint_sid string The secure ID of the Conference endpoint associated with the Conference Playback endpoint.  
conference.subscriber.event_callback_url string The eventCallbackUrl attribute of the Conference endpoint Subscriber object. QA: http://qa-recserver-carrierx.int/conference/callback, Prod: http://mia-recserver-carrierx.int/conference/callback
FlexML      
flexml_account_sid string The secure ID of the account associated with the FlexML endpoint.  
flexml_api_url string The URL the FlexML endpoint API.  
flexml_login string The login associated with the FlexML endpoint.  
flexml_password string The password associated with the FlexML endpoint.  
Voicemail      
callback_method string The callback method used with the Voicemail endpoint. POST
callback_url string The callback URL used with the Voicemail endpoint.  
greeting string The name of the file used as a greeting for the Voicemail endpoint.  
max_duration integer The maximum length of the recording in seconds used with the Voicemail endpoint.  
SIP Headers      
conference.relay_sip_headers string The relay_sip_headers value used with the trunks associated with the Conference endpoints. Diversion; Diversion,2:Diversion; P-Charging-Vector; WYDE-.*; X-.*;
flexml.relay_sip_headers string The relay_sip_headers value used with the trunks associated with the FlexML endpoints. Diversion; Diversion,2:Diversion; P-Charging-Vector; WYDE-.*; X-.*;
mediator.relay_sip_headers string The relay_sip_headers value used with the trunks associated with the Mediator endpoints. Diversion; Diversion,2:Diversion; P-Charging-Vector;
peering_receiver.relay_sip_headers string The relay_sip_headers value used with the trunks associated with the Peering Receiver endpoints. Diversion;
peering_sender.relay_sip_headers string The relay_sip_headers value used with the trunks associated with the Peering Sender endpoints. Diversion;
third_party.relay_sip_headers string The relay_sip_headers value used with the trunks associated with the Third Party endpoints. Diversion;
External Storage      
aws_access_key string The access key used to access AWS S3. This value is set when Amazon Amazon Simple Storage Service is used as an external storage.  
aws_bucket_name string The bucket name where the container is stored. This value is set when Amazon Amazon Simple Storage Service is used as an external storage.  
aws_secret_key string The secret key used to access AWS S3. This value is set when Amazon Amazon Simple Storage Service is used as an external storage.  
azure_account_key string The account key used to access Microsoft Azure Blob storage. This value is set when Microsoft Azure Blob storage is used as an external storage.  
azure_account_name string The account name used to access Microsoft Azure Blob storage. This value is set when Microsoft Azure Blob storage is used as an external storage.  
azure_container_name string The container name where the container is stored. This value is set when Microsoft Azure Blob storage is used as an external storage.  
azure_sas_token string The SAS token used to access Microsoft Azure Blob storage. This value is set when Microsoft Azure Blob storage is used as an external storage.  
gcp_access_token string The access token used to access Google Cloud Platform. This value is set when Google Cloud Platform is used as an external storage.  
gcp_bucket_name string The bucket name where the container is stored. This value is set when Google Cloud Platform is used as an external storage.  
gcp_client_id string The client ID used to access Google Cloud Platform. This value is set when Google Cloud Platform is used as an external storage.  
gcp_client_secret string The client secret used to access Google Cloud Platform. This value is set when Google Cloud Platform is used as an external storage.  
gcp_project string The project that will be used to store the recording. This value is set when Google Cloud Platform is used as an external storage.  
gcp_refresh_token string The refresh token used to access Google Cloud Platform. This value is set when Google Cloud Platform is used as an external storage.  

Partner

Attribute Data Type Description Default Value
general.defaults.scopes string The IDs of the scopes set for the partner in case the scope attribute is left empty. Refer to the Partner Available Scopes table to find out the correspondence between the scopes and their IDs. 3; 4; 8; 20; 25; 26; 30; 40; 45; 60; 70; 90; 100; 110; 120; 130; 150; 161; 170; 180; 190; 200; 310; 330
general.restriction.transformation.allowed_headers string The regular expressions limiting the use of certain headers for transformations. ^X-.+; ^P-.+
callback.url_names string The possible callback URL types used for the callbacks attribute of the Partner object. sms; app_mediator; app_conference_meeting; app_conference_call
partner.defaults.ivs_token.scopes string The list of default scopes used for the IVS. lookup.ip_addresses.read; lookup.dids.read; lookup.dids.allow_cnam; lookup.dids.allow_lrn; lookup.dids.allow_carrier; billing.skip_lrn_lookup_billing; billing.skip_cnam_lookup_billing; billing.skip_carrier_lookup_billing; billing.skip_carrier_lookup_billing
partner.defaults.suspended.email_notification_period integer The number of days between the email notifications which are sent to remind the partner that they have the suspended status. 14
partner.defaults.suspended.retention_policy integer The number of days the suspended partner account stays in the suspended status before transiting to the canceled status and releasing the partner phone number according to the retention policy. 90
partner.defaults.system_attribute.allow_custom_sid boolean Whether or not to allow the custom caller ID for the partner. false
partner.defaults.system_attribute.allow_pstn_gw boolean Whether or not to allow the outbound traffic from the phone number to go to PSTN. When set to false, the partner will only be allowed to receive calls. false
partner.defaults.system_attribute.billing.low_balance_limits string The semicolon-separated list of the values in US dollars of the low partner balance at which the notifications are sent. 0; 10; 25; 50
partner.defaults.system_attribute.billing.send_low_balance_email boolean Whether or not the billing.partner.send_low_balance_email value of the System Attribute object is set to true or false when creating a new partner. false
partner.defaults.system_attribute.pstn_gw_url string The gateway URL used for the outbound traffic from the phone number to go to PSTN. QA: 3a4c5b51-b4e5-44af-8fd9-d254cda9abdf:efb95d96-ab7f-4600-87f8-bce016a805fe@12.7.192.27, Prod: 63919a35-fb82-41c9-ac74-41a43e0adeb0:acdf0cf1-de9a-4bd3-8854-a2db3c8e2ce4@PUBLIC_PROXY
partner.restrictions.trunk_group.handlers.enabled boolean Whether or not the external handlers feature is enabled for the partner when a new partner is created false
partner.restrictions.trunk_group.handlers.max_cumulative_timeout integer The cumulative period of time for all the external handlers in a single trunk group per direction specified in milliseconds. 250
partner.restrictions.trunk_group.handlers.max_qty integer The maximum number of the external handlers in a single trunk group per direction. 1
Billing      
billing.invoice.review_required boolean Whether or not the invoice review is required.  
billing.limits.daily.max_charge_amount integer The maximum amount which the partner can be charged daily. 500
billing.taxes.include string Specifies the taxes which the system will take into account when billing the partner. Can be overriden by setting the value of the billing.taxes.include field of the System Attribute object. none
Endpoints      
endpoint.conference.ip_addresses string The IP address used for the Conference endpoints. 10.2.114.15:5060:udp
endpoint.conference_legacy.ip_addresses string The IP address used for the Conference legacy endpoints. 10.2.114.15:5060:udp
endpoint.flexml.ip_addresses string The IP address used for the FlexML endpoints. 10.1.10.84:5060:udp
endpoint.mediator.ip_addresses string The IP address used for the Mediator endpoints. 10.222.2.126:5060:udp
endpoint.peering_receiver.ip_addresses string The IP address used for the Peering Receiver endpoints. 12.7.192.27:5060:udp
endpoint.peering_sender.ip_addresses string The IP address used for the Peering Sender endpoints. 12.7.192.27:5060:udp; 162.251.183.11:5060:udp; 162.251.181.136:5060:udp
endpoint.systemgw.ip_addresses string The IP address used for the System Gateway endpoint. 10.1.10.190:5060:udp
endpoints.restriction.protected_address_keywords string The keywords which cannot be used in the endpoints addresses. PRIVATEPROXY; PUBLICPROXY
endpoints.restriction.protected_ranges string The system reserved IP ranges, which cannot be used by the partners for the endpoint IP addresses. 10.0.0.0/8; 172.16.0.0/12; 192.168.0.0/16; 12.7.192.0/23; 162.251.180.0/22
endpoint.use_template_addresses boolean Whether or not the newly created endpoint should use the addresses from the endpoint templates. false
Lookup      
lookup.defaults.dids.cnam.ttl integer The CNAM lookup cache time, specified in seconds. 86400
lookup.defaults.dids.cnam.ttl.l1 integer Level 1 lookup cache time, specified in seconds. It is used in addition to the lookup.defaults.dids.cnam.ttl. 0
lookup.defaults.dids.cnam.ttl.l1_percent integer Level 1 lookup cache time threshold, specified in percentage of the lookup.defaults.dids.cnam.ttl value. 0
lookup.defaults.dids.cnam.ttl.l2 integer Level 2 lookup cache time, specified in seconds. It is used in addition to the lookup.defaults.dids.cnam.ttl. 0
lookup.defaults.dids.cnam.ttl.l2_percent integer Level 2 lookup cache time threshold, specified in percentage of the lookup.defaults.dids.cnam.ttl value. 0
lookup.defaults.dids.cnam.ttl.l3 integer Level 3 lookup cache time, specified in seconds. It is used in addition to the lookup.defaults.dids.cnam.ttl. 0
lookup.defaults.dids.cnam.ttl.l3_percent integer Level 3 lookup cache time threshold, specified in percentage of the lookup.defaults.dids.cnam.ttl value. 0
lookup.defaults.dids.hlr.ttl integer The Home Location Register (HLR) database lookup cache time, specified in seconds. 2592000
OAuth      
oauth.client.defaults.accesstoken.default.ttl integer The default TTL for the access token specified in seconds. 1800
oauth.client.defaults.accesstoken.max.ttl integer The maximum TTL for the access token specified in seconds. 3600
oauth.client.defaults.refreshtoken.default.ttl integer The default TTL for the refresh token specified in seconds. 3600
oauth.client.defaults.refreshtoken.max.ttl integer The maximum TTL for the refresh token specified in seconds. 86400
oauth.client.limits.accesstoken.default.ttl integer The maximum value which can be set for the access token default TTL specified in seconds. 3600
oauth.client.limits.accesstoken.max.ttl integer The maximum value which can be set for the access token maximum TTL specified in seconds. 86400
oauth.client.limits.refreshtoken.default.ttl integer The maximum value which can be set for the refresh token default TTL specified in seconds. 86400
oauth.client.limits.refreshtoken.max.ttl integer The maximum value which can be set for the refresh token maximum TTL specified in seconds. 2592000
Push      
push.limits.total.max_devices integer The maximum number of recipients of push notification messages sent to mobile devices. 100
SMS/MMS      
mms.defaults.message.dlr.timeout_status_wait integer The period of time after which the MMS status will be changed from sent to timed_out if not changed to delivered or undelivered, specified in seconds. 86400
mms.defaults.message.sending.timeout_status_wait integer The period of time after which the MMS status will be changed from queued to sending_timed_out if not changed to sent, specified in seconds. 86400
sms.defaults.message.dlr.timeout_status_wait integer The period of time after which the SMS status will be changed from sent to timed_out if not changed to delivered or undelivered, specified in seconds. 86400
sms.defaults.message.retention_policy integer The period when the messages are kept within the system according to the retention policy, specified in seconds. 7776000
sms.defaults.message.sending.timeout_status_wait integer The period of time after which the SMS status will be changed from queued to sending_timed_out if not changed to sent, specified in seconds. 86400
sms.limits.message.max_segments integer The maximum number of segments of which an SMS can consist. 10
Storage      
storage.defaults.container.quota_bytes integer The total size of the storage available in a single container, specified in bytes. 1073741824
storage.defaults.container.quota_files integer The total number of files which can be stored in a single container. 100
storage.limits.mogfs.allowed_domains string The MogileFS domain used to upload files through CarrierX. carrierx_fcc2; carrierx_startmeeting; carrierx_fcchd; carrierx_tfcc; carrierx_stf; carrierx_huddle; carrierx_bullhorn; carrierx_santa; carrierx_simpleblast; carrierx_nc_storage; carrierx_teltech; carrierx_default
storage.defaults.mogfs.domain string The MogileFS domain name which will be used when creating a new container. QA: carrierx_test, Prod: carrierx_default
storage.limits.total.max_bytes integer The total size of the storage that includes all the containers, specified in bytes. 1073741824
storage.limits.total.max_containers integer The total number of available containers per partner. 2
TTS      
tts.text.defaults.bitrate integer The default bitrate used for text-to-speech conversion, specified in bits per second (bit/s). 16000
tts.text.defaults.format string The default output audio format used for text-to-speech conversion. mp3
tts.text.defaults.language string The default language used for text-to-speech conversion. en-US
tts.text.defaults.voice_sid string The default voice used for text-to-speech conversion when no voice secure ID is specified. man
tts.text.limits.text_size integer The default number of characters allowed for the text used in text-to-speech conversion. 3000
tts.text.supported_bitrates string The available values for the bitrate which can be used to convert text to speech, specified in bits per second (bit/s). 8000; 16000; 24000; 32000; 40000; 48000; 64000; 80000; 96000; 112000; 128000; 160000; 192000; 224000; 256000; 320000
tts.text.supported_formats string The available output audio file formats which can be used to convert text to speech. al; flac; g722; mp3; mp4; ogg; ul; wav
tts.voice.restrictions.allowed_voices string The list of the prefixes for the voices allowed for the current partner. man; woman
tts.voice.supported_languages string The available languages which can be used to convert text to speech. arb; cmn-CN; cy-GB; da-DK; de-DE; en-AU; en-GB; en-GB-WLS; en-IN; en-US; es-ES; es-MX; es-US; fr-CA; fr-FR; is-IS; it-IT; ja-JP; hi-IN; ko-KR; nb-NO; nl-NL; pl-PL; pt-BR; pt-PT; ro-RO; ru-RU; sv-SE; tr-TR
tts.voice.supported_voices string The available voices which can be used to convert text to speech. man; woman; Polly.Aditi; Polly.Amy; Polly.Astrid; Polly.Bianca; Polly.Brian; Polly.Camila; Polly.Carla; Polly.Carmen; Polly.Celine; Polly.Chantal; Polly.Conchita; Polly.Cristiano; Polly.Dora; Polly.Emma; Polly.Enrique; Polly.Ewa; Polly.Filiz; Polly.Geraint; Polly.Giorgio; Polly.Gwyneth; Polly.Hans; Polly.Ines; Polly.Ivy; Polly.Jacek; Polly.Jan; Polly.Joanna; Polly.Joey; Polly.Justin; Polly.Karl; Polly.Kendra; Polly.Kevin; Polly.Kimberly; Polly.Lea; Polly.Liv; Polly.Lotte; Polly.Lucia; Polly.Lupe; Polly.Mads; Polly.Maja; Polly.Marlene; Polly.Mathieu; Polly.Matthew; Polly.Maxim; Polly.Mia; Polly.Miguel; Polly.Mizuki; Polly.Naja; Polly.Nicole; Polly.Olivia; Polly.Penelope; Polly.Raveena; Polly.Ricardo; Polly.Ruben; Polly.Russell; Polly.Salli; Polly.Seoyeon; Polly.Takumi; Polly.Tatyana; Polly.Vicki; Polly.Vitoria; Polly.Zeina; Polly.Zhiyu