Propriétés de configuration JSON avancées

Vous pouvez utiliser un fichier de configuration JSON pour définir certaines propriétés pour des titulaires individuels au lieu de configurer des variables d'environnement applicables à l'ensemble du déploiement.

Important : Les propriétés de configuration pour plusieurs titulaires sont associées à des variables d'environnement Docker dans la configuration de Voice Gateway. Si aucune valeur n'est définie dans le fichier de configuration JSON, certaines valeurs des variables d'environnement Docker associées sont utilisées, comme documenté dans les sections suivantes.

La configuration pour plusieurs titulaires est prise en charge dans la version 1.0.0.2 et les versions ultérieures.

Exemple de fichier de configuration JSON

Par exemple, le fichier JSON suivant configure un titulaire au numéro 234-555-6789 en tant qu'agent en libre-service publiant des événements de génération de rapport et un autre titulaire au 234-555-7890 sur l'hôte myhost.com dont les détails ne sont pas affichés.

Pour déployer cette configuration, vous devez définir le chemin d'accès à votre fichier de configuration JSON comme la variable d'environnement MULTI_TENANT_CONFIG_FILE du fichier de configuration de votre déploiement Voice Gateway.

  {
    "tenants": [
      {
            "tenantURI": "2345556789",
        "description": "Voice Gateway Demo US",
        "whitelistFromUri" : "8765554321",
        "putCallerOnHoldOnTransfer" : "false",
        "conversation": {
                "url": "https://gateway.watsonplatform.net/conversation/api",
          "workspaceID": "a23de67h-e527-40d5-a867-5c0ce9e72d0d",
          "password": "InWtiUpYhF1Z",
          "username": "9h7f54cb-d9ed-46b3-8492-e9a9bf555021"
            },
        "stt": {
                "credentials": {
                    "url": "https://stream.watsonplatform.net/speech-to-text/api",
                    "username": "9h7f54cb-f28f-4a64-91e1-a0657e1dd3f4",
                    "password": "IAB5jfxls0Zt",
                },
                "config": {
                    "model": "en-US_NarrowbandModel",
                  "profanity_filter": true,
                  "smart_formatting": true
              },
        "broadbandConfig": {
                    "model": "en-US_BroadbandModel",
                    "profanity_filter": true,
                    "smart_formatting": true
                },
                "bandPreference": "broadband",
                "confidenceScoreThreshold": 0.2,
                "echoSuppression": true,
                "bargeInResume": true,
        "trackLatency": false
            },
            "tts": {
                "cacheTimeToLive": 336,
          "credentials": {
                    "url": "https://stream.watsonplatform.net/text-to-speech/api",
                    "username": "9h7f54cb-8b0f-4766-8b15-eaa8f7c3fae7",
                    "password": "HcmzFp1kec1P",
                },
                "config": {
                    "voice": "en-US_MichaelVoice"
          }
            },
        "reporting": {
                "url": "http://10.10.10.10:8080",
                "username": "john.smith",
                "password": "HcmzFp1kec1P",
                "cdrEventInd": "cdr",
                "convEventInd": "conv",
                "transcriptionEventInd": "transcription"
            },
            "smsPipe": {
                "url": "http://host:port/sms.gateway/smsPipe",
                "username": "tR3qNZ12-u53qmz93",
                "password": "Qz34x05e",
                "tenantPhoneNumber": "+18765554321"
            },
      "enableOutboundCalls": true,
      "outboundCalls": {
        "statusWebhook": "http://need.example.webhook.url.com/",
        "tenantURI": "same as tenant URI above?",
        "connectTimeout": 3,
        "readTimeout": 5,
        "maxRetyNo": 2        
      },
      "restAPI": {
        "username": "exampleusername",
        "password": "examplepassword"        
      },
    }
        {
            "tenantURI": "2345557890@example.com"
        }
    ]
}
  1. Ajoutez votre configuration de titulaire à la configuration Voice Gateway puis déployez votre environnement. Pour plus d'informations, voir Déploiement d'une configuration JSON à plusieurs titulaires.

Important : Les propriétés de configuration à plusieurs titulaires sont associées à des variables d'environnement Docker dans la configuration de Voice Gateway. Si aucune valeur n'est définie dans le fichier JSON de configuration, certaines valeurs des variables d'environnement Docker associées sont utilisées, comme documenté dans les sections suivantes.

Retour en haut de page

Propriétés obligatoires des titulaires

Tableau 1. Propriétés JSON obligatoires pour la configuration d'un titulaire
Propriété JSON Description Variable d'environnement associée
tenantURI Identificateur de titulaire unique, tel qu'un numéro de téléphone. Doit correspondre au SIP To URI dans la demande SIP INVITE qui démarre l'appel. Chaque titulaire doit inclure un tenantURI.

Propriétés facultatives des titulaires

Vous pouvez définir les propriétés de configuration suivantes pour chaque titulaire individuellement. Les propriétés sont facultatives mais si vous voulez les définir, cette opération doit être effectuée en tant que propriétés JSON. Les valeurs des variables d'environnement Docker associées ne sont pas utilisées.

Tableau 2. Propriétés JSON facultatives pour la configuration d'un titulaire
Propriété JSON Description Variable d'environnement associée
acceptTransferRejectCodes Liste de codes de réponses séparés par des virgules, indiquant les erreurs qui sont traitées en tant que réponses réussies lorsqu'une demande NOTIFY est traitée durant un transfert d'appel. Par défaut, tous les codes de la plage [200-299] sont des réponses réussies. Si un code de réponse dans une demande NOTIFY ne se trouve pas dans cette plage, le processus de transfert échoue. Vous pouvez étendre la liste des réponses réussies en ajoutant cet attribut. Versions 1.0.0.6 et ultérieures. ACCEPT_TRANSFER_REJECT_CODES
conversationFailedReplyMessage Message transmis à l'appelant quand un appel est transféré/déconnecté suite à une défaillance de l'un des services Watson. Modifiez le message par défaut si aucune cible par défaut n'est configurée. CONVERSATION_FAILED_REPLY_MESSAGE
conversationFailedReplyAudioURL URL pointant vers un fichier audio qui est lu si le service Text to Speech ne peut pas être contacté lorsque Voice Gateway tente de lire le message conversationFailedReplyMessage. CONVERSATION_FAILED_REPLY_AUDIO_URL
customSIPInviteHeader Zone d'en-tête SIP à extraire des demandes SIP INVITE entrantes. Lorsque cette variable est définie, la valeur de l'en-tête SIP spécifié est transmise au service Watson Assistant dans la variable d'état vgwSIPCustomInviteHeader. CUSTOM_SIP_INVITE_HEADER
customSIPInviteHeaders Liste de zones d'en-tête SIP séparées par des virgules, à extraire des demandes SIP INVITE entrantes. Lorsque cette variable est définie, les valeurs des en-têtes SIP spécifiés sont transmises à Watson Assistant dans la variable d'état vgwSIPCustomInviteHeaders. CUSTOM_SIP_INVITE_HEADERS
customSIPRECSessionField Zone de métadonnées SIPREC dont la valeur est utilisée en tant qu'ID de session global. La valeur de la zone de métadonnées SIPREC est utilisée dans tous les messages d'audit et transmise à Watson Assistant dans la variable d'état vgwSessionID. Si la zone configurée ne peut pas être trouvée dans les métadonnées, la propriété JSON customSIPSessionHeader est utilisée pour déterminer l'identificateur de session global. Les valeurs possibles de la zone de session SIPREC personnalisée sont gcid, callid et session_id. Versions 1.0.0.6a et ultérieures. CUSTOM_SIPREC_SESSION_FIELD
customSIPSessionHeader En-tête d'ID session personnalisé extrait de la demande SIP INVITE. La valeur représente l'ID de session global qui est utilisé dans tous les journaux d'audit de Voice Gateway relatifs à la session. CUSTOM_SIP_SESSION_HEADER
description Description du titulaire (façon dont il est utilisé, par exemple). Facultatif, mais recommandé.
disconnectCallOnTransferFailure Détermine si l'appel doit être déconnecté en cas d'échec du transfert d'appel. Lorsque la valeur est false, Voice Gateway initie un échange de conversation en envoyant le texte "vgwCallTransferFailed" à Watson Assistant. Ensuite, Watson Assistant peut déconnecter l'appel ou le transférer à une destination différente, comme configuré dans le dialogue. La valeur par défaut est true. Versions 1.0.0.2 et ultérieures. DISCONNECT_CALL_ON_TRANSFER_FAILURE
finalUtteranceTimeout Durée en millisecondes durant laquelle Voice Gateway attend de recevoir un énoncé final du service Speech to Text. Un dépassement du délai d'attente se produit si Voice Gateway ne reçoit pas d'énoncé final à l'intérieur d'un intervalle défini, même si des hypothèses continuent d'être générées. Lorsqu'un dépassement du délai d'attente se produit, Voice Gateway envoie à Watson Assistant une mise à jour du texte avec le mot "vgwFinalUtteranceTimeout" pour indiquer qu'aucun énoncé final n'a été reçu. Versions 1.0.0.4c et ultérieures. FINAL_UTTERANCE_TIMEOUT
notifyConversationOnFilteredUtterances Si cette propriété est définie sur true, Voice Gateway initie un nouvel échange avec Watson Assistant et le mot "vgwSTTResultFiltered" pour indiquer que l'énoncé a été filtré en raison d'un faible niveau de fiabilité. Version 1.0.2 ou ultérieure. NOTIFY_CONVERSATION_ON_FILTERED_UTTERANCES
notifyConversationOnNetworkEvents Lorsque cette variable a pour valeur true et qu'une erreur réseau est détectée, Voice Gateway initie un échange vers le service Watson Assistant avec le texte "vgwNetworkWarningMessage". La variable d'état vgwNetworkWarnings contient une liste des événements de réseau qui se sont produits lors de l'échange en cours. Si l'indicateur a pour valeur false, une liste des événements de réseau qui se sont produits lors de l'échange en cours est envoyée lors de l'événement d'échange suivant dans la variable d'état vgwNetworkWarnings. Versions 1.0.0.5 et ultérieures. NOTIFY_CONVERSATION_ON_NETWORK_EVENTS
notifyConversationOnMediaChange Les fonctions média peuvent changer au milieu d'un appel lorsqu'un appelant envoie une demande re-INVITE ou UPDATE. Lorsque cette propriété est définie sur true, Voice Gateway initie un nouvel échange vers Watson Assistant avec le mot vgwMediaCapsChanged pour indiquer que les fonctions média ont été mises à jour correctement. NOTIFY_CONVERSATION_ON_MEDIA_CHANGE
postResponseTimeout Temps d'attente, en millisecondes, d'un nouvel énoncé après la lecture d'une réponse à l'appelant. Si cette valeur est dépassée, Watson Assistant reçoit une mise à jour textuelle avec le mot "vgwPostResponseTimeout" afin d'indiquer un dépassement de délai. La valeur par défaut est 7000 ms. POST_RESPONSE_TIMEOUT
putCallerOnHoldOnTransfer Définissez sur false si vous ne voulez pas que l'appelant soit mis en attente pendant que l'appel est transféré. Version 1.0.0.3 et ultérieures. PUT_CALLER_ON_HOLD_ON_TRANSFER
sendOnFirstTurn Contient une liste de paramètres séparés par des virgules, à envoyer au service Watson Assistant dans la première demande d'échange. Tous les paramètres de la liste doivent être configurés dans la section générale. Versions 1.0.0.6 et ultérieures. SEND_ON_FIRST_TURN_TO_CONVERSATION
sendProvisionalResponse Définissez sur false pour le titulaire pour ne pas envoyer une réponse 180 Ringing alors qu'il traite un appel entrant. Version 1.0.0.3 et ultérieures. SEND_PROVISIONAL_RESPONSE
sendSIPCallIDToConversation Lorsque cette variable est définie sur true, l'ID d'appel SIP est transmis à Watson Assistant dans la variable d'état vgwSIPCallID. La valeur par défaut est false. SEND_SIP_CALL_ID_TO_CONVERSATION
sendSIPRequestURIToConversation Lorsque cette variable est définie sur true, l'URI de demande SIP est transmis à Watson Assistant dans la variable d'état vgwSIPRequestURI. La valeur par défaut est false. SEND_SIP_REQUEST_URI_TO_CONVERSATION
sendSIPToUriToConversation Lorsque cette variable est définie sur true, le SIP vers URI est transmis à Watson Assistant dans la variable d'état vgwSIPToURI. La valeur par défaut est false. SEND_SIP_TO_URI_TO_CONVERSATION
sendSIPFromUriToConversation Lorsque cette variable est définie sur true, le SIP depuis URI est transmis à Watson Assistant dans la variable d'état vgwSIPFromURI. La valeur par défaut est false. SEND_SIP_FROM_URI_TO_CONVERSATION
sendSiprecMetadataToSTT Lorsque cette variable est définie sur true, les métadonnées SIPREC sont envoyées à STT lorsqu'une session est établie. La valeur par défaut est false. Version 1.0.3.0 et versions ultérieures. SEND_SIPREC_METADATA_TO_STT
transferDefaultTarget Identifie le transfert cible vers le point de terminaison. Doit être un protocole SIP ou un URI de téléphone valide (par ex. sip:10.10.10.10). Cette cible de transfert par défaut est utilisée uniquement en cas d'incident ; la cible du transfert d'appel ne peut pas être obtenue depuis l'API Watson Assistant. TRANSFER_DEFAULT_TARGET
transferFailedReplyMessage Si disconnectCallOnTransferFailure est défini sur True, le message est transmis à l'appelant si le transfert d'appel échoue. TRANSFER_FAILED_REPLY_MESSAGE
transferFailedReplyAudioURL URL pointant vers un fichier audio qui est lu si le service Text to Speech ne peut pas être contacté lorsque Voice Gateway tente de lire le message transferFailedReplyMessage. TRANSFER_FAILED_REPLY_AUDIO_URL
useOptimalConfiguration Spécifie si la configuration optimale doit être utilisée pour la version. Lorsque la valeur est true, les paramètres de configuration optimale sont utilisés pour la version Voice Gateway qui est définie dans la variable d'environnement OPTIMAL_CONFIGURATION_VERSION ou dans la propriété JSON optimalConfigurationVersion. La valeur par défaut est false. Versions 1.0.0.6c et suivantes. USE_OPTIMAL_CONFIGURATION
optimalConfigurationVersion Spécifie la version Voice Gateway des paramètres de configuration optimale à utiliser. Par exemple, 1.0.0.6c. Défini sur la version la plus récente par défaut. Versions 1.0.0.6.c et ultérieures. OPTIMAL_CONFIGURATION_VERSION
whitelistFromUri Quand cette variable est définie, Voice Gateway n'accepte que les appels contenant la chaîne spécifiée (numéro de téléphone, par exemple) dans l'URI SIP From. WHITELIST_FROM_URI
type Valeurs possibles : agentAssist, selfService et continuousRecognition. agentAssist est la valeur par défaut pour les session d'assistant d'agent et SIPREC. selfService est la valeur par défaut pour les sessions en libre-service. Quand le type de titulaire est défini sur agentAssist ou continuousRecognition, la reconnaissance vocale ouverte pour la durée de l'appel plutôt que sur la base d'un échange conversationnel. Les transcriptions de la reconnaissance vocale sont mises en file d'attente chaque fois qu'une demande sortante existante est envoyée à Watson Assistant ou au moteur d'orchestration de service. TENANT_TYPE
URIs Liste d'URI de téléphone/SIP associés à ce titulaire. Quand un appel entrant ne peut pas être mappé à l'URI de titulaire configuré, Voice Gateway recherche une correspondance dans cette liste. Exemple : "URIs": [
{
"name": "dc-office",
"uri": "111111111"
},
{
"name": "nyc-office",
"uri": "222222222"
}
]		 N/A
whitelistSiprecAttrName Si cette variable est définie, Voice Gateway n'accepte que les appels contenant l'attribut spécifié dans les métadonnées SIPREC. Cette valeur d'attribut doit correspondre à la valeur spécifiée dans l'attribut whitelistSiprecAttrValue. WHITELIST_SIPREC_ATTR_NAME
whitelistSiprecAttrValue Cet attribut est obligatoire si la propriété whitelistSiprecAttrName est configurée. S'il est défini, Voice Gateway n'accepte que les appels contenant l'attribut spécifié dans whitelistSiprecAttrName avec la valeur qui correspond à celle spécifiée dans cet attribut, dans les métadonnées SIPREC. WHITELIST_SIPREC_ATTR_VALUE

Retour en haut de page

Propriétés de l'objet conversation

Le service IBM Watson™ Assistant que vous souhaitez utiliser pour chaque titulaire doit être défini en tant que propriétés JSON. Les valeurs des variables d'environnement Docker associées ne sont pas utilisées.

Comme avec d'autres méthodes de configuration, l'objet conversation et l'objet wva ne peuvent pas être définis dans un seul titulaire.

Tableau 3. Propriétés JSON de l'objet conversation
Propriété JSON Description Variable d'environnement associée
url Adresse url de Watson Assistant. WATSON_CONVERSATION_URL
workspaceID ID espace de travail de l'API Watson Assistant. WATSON_CONVERSATION_WORKSPACE_ID
username Nom d'utilisateur (username) de Watson Assistant. WATSON_CONVERSATION_USERNAME
password Mot de passe (password) de Watson Assistant. WATSON_CONVERSATION_PASSWORD
apikey Clé d'API, apikey, de votre service Watson Assistant. Vous pouvez configurer les connexions avec les services Watson avec apikey et en définissant tokenServiceProviderUrl sur https://iam.cloud.ibm.com/identity/token, ou avec username et password (uniquement disponible pour la région de Sydney). Versions 1.0.0.6a et ultérieures. WATSON_CONVERSATION_APIKEY
apiVersion Version de l'API Watson Assistant à utiliser. Valeurs possibles : v1 et v2. v2 est pris en charge dans la version 1.0.1 ou ultérieure. WATSON_CONVERSATION_API_VERSION
bearerToken Jeton d'authentification qui sera utilisé lors des demandes au service Watson Assistant. Version 1.0.3.0 et versions ultérieures. N/A
connectTimeout Délai d'attente en secondes observé par Voice Gateway avant d'établir une connexion socket à Watson Assistant. Si le délai est dépassé, Voice Gateway tente à nouveau de se connecter à Watson Assistant. Si le service n'est toujours pas joignable, l'appel échoue. La valeur par défaut est 5 secondes. Version 1.0.0.3 et ultérieures. WATSON_CONVERSATION_CONNECT_TIMEOUT
connectionKeepAliveEnabled true ou false. La valeur par défaut est true. Indique si une connexion au service Watson Assistant doit rester ouverte ou être fermée après chaque demande ou chaque réponse.
Remarque : la réutilisation des connexions n'est pas prise en charge. Une connexion est fermée après chaque demande ou réponse. Lorsque le signal de présence est activé, des problèmes peuvent se produire avec certains serveurs REST qui s'attendent à ce qu'une connexion reste ouverte. Vous pouvez désactiver le signal de présence en définissant ce paramètre sur false. 1.0.0.7a et versions ultérieures.		 WATSON_CONVERSATION_CONNECTION_KA_ENABLED
readTimeout Délai d'attente en secondes pendant lequel Voice Gateway attend une réponse de Watson Assistant. Si le délai est dépassé, Voice Gateway tente à nouveau de contacter Watson Assistant. Si le service n'est toujours pas joignable, l'appel échoue. La valeur par défaut est 5 secondes. WATSON_CONVERSATION_READ_TIMEOUT
tokenAuthEnabled Active l'authentification par jeton pour Watson Assistant. Cette propriété est désactivée par défaut. Version 1.0.0.5a et ultérieures. WATSON_CONVERSATION_TOKEN_AUTH_ENABLED
tokenServiceProviderUrl Il s'agit de l'URL réelle du service d'authentification par jeton du service Watson Assistant. Vous devrez éventuellement mapper cette URL à une autre à des fins de routage. Version 1.0.0.5a et ultérieures. WATSON_CONVERSATION_TOKEN_SERVICE_PROVIDER_URL
tokenServiceUrl URL de service qui est intégrée dans la demande de jeton. Version 1.0.0.5a et ultérieures. WATSON_CONVERSATION_TOKEN_SERVICE_URL
providers Configuration pour plusieurs fournisseurs de services, permettant la prise en charge de la configuration de service au niveau racine. Versions 1.0.0.6 et ultérieures.
  • name : nom de l'instance de service.
  • Vous pouvez configurer les mêmes propriétés JSON au niveau providers que celles définies au niveau racine de l'objet conversation. Ceci inclut des propriétés telles que url, workspaceID, username, password, tokenAuthEnabled, tokenServiceProviderUrl et tokenServiceUrl.
Voir Configuration de plusieurs fournisseurs de services.		 N/A
providerSelectionPolicy En cas de défaillance d'un service, processus par lequel Voice Gateway transforme des instances de service Watson Assistant actives lorsque plusieurs fournisseurs sont configurés pour le titulaire. Voice Gateway passe au fournisseur suivant dans la liste uniquement lorsqu'une erreur de conversation se produit lors du premier échange avec le service Watson Assistant. Une fois qu'un appel est établi, Voice Gateway ne passe pas à un autre fournisseur de conversation au milieu d'un appel. La valeur par défaut est sequential. N/A
httpHeaders Mappe JSON incluant le nom et la valeur des en-têtes HTTP. Ces zones d'en-tête HTTP sont ajoutées dans les demandes REST sortantes à Watson Assistant. N/A
assistantID ID Watson Assistant pour l'API Watson Assistant version 2. ID assistant utilisé uniquement par l'API Watson Assistant version 2. Voice Gateway version 1.0.1 ou ultérieure. WATSON_ASSISTANT_ID

Pour configurer le titulaire afin de se connecter à Watson Assistant via un moteur d'orchestration de service, configurez le moteur d'orchestration de service sur les propriétés à la place. Si le moteur d'orchestration de service est configuré pour une authentification obligatoire, indiquez le nom d'utilisateur et le mot de passe pour l'authentification HTTP de base.

Tableau 4. Propriétés JSON pour la connexion à un moteur d'orchestration de service
Propriété JSON Description Variable d'environnement associée
url Adresse URL exacte vers le moteur d'orchestration de service. WATSON_CONVERSATION_URL
username Nom d'utilisateur en texte en clair pour le moteur d'orchestration de service. Requis uniquement si l'authentification est activée dans le moteur d'orchestration de service. WATSON_CONVERSATION_USERNAME
password Mot de passe en texte en clair pour le moteur d'orchestration de service. Requis uniquement si l'authentification est activée dans le moteur d'orchestration de service. WATSON_CONVERSATION_PASSWORD

Retour en haut de page

Propriétés de l'objet wva

Remarque : il n'est plus possible de créer de nouvelles instances de Watson Virtual Agent depuis le 19 juin 2018. Ce service a été supprimé du catalogue IBM Cloud le 19 mars 2019.

L'agent conversationnel Watson Virtual Agent que vous souhaitez utiliser pour chaque titulaire doit être défini sous forme de propriétés JSON. Les valeurs des variables d'environnement Docker associées ne sont pas utilisées. Pour vous connecter à Virtual Agent via un moteur d'orchestration de service, configurez le moteur sur l'objet conversation.

Comme avec d'autres méthodes de configuration, l'objet conversation et l'objet wva ne peuvent pas être définis dans un seul titulaire.

Tableau 5. Propriétés JSON de l'objet wva
Propriété JSON Description Variable d'environnement associée
wvaURL url de l'API Watson Virtual Agent. WATSON_VA_URL
wvaBotID bot_id de l'API Watson Virtual Agent. WATSON_VA_BOT_ID
wvaClientId Clé d'authentification de la zone d'en-tête X-IBM-Client-Id pour les appels API vers Watson Virtual Agent. WATSON_VA_CLIENT_ID
wvaClientSecret Clé d'authentification de la zone d'en-tête X-IBM-Client-Secret pour les appels API vers Watson Virtual Agent. WATSON_VA_CLIENT_SECRET

Retour en haut de page

Propriétés de l'objet stt

L'objet stt contient les propriétés de configuration du service Speech to Text ou des services de reconnaissance vocale tiers activés par Speech to Text Adapter. Si aucune propriété JSON n'est définie, la valeur de la variable d'environnement Docker associée est utilisée.

Vous pouvez définir les propriétés suivantes pour configurer le service Speech to Text :

Tableau 6. Propriétés JSON de l'objet stt
Propriété JSON Description Variable d'environnement associée
credentials Données d'identification pour le service Speech to Text. Voir Propriété credentials de l'objet stt
config Paramètres du service Speech to Text. Consultez la référence d'API WebSockets pour le service Speech to Text. Voir les variables Speech to Text (WATSON_STT) dans la configuration de Media Relay
broadbandConfig Paramètres du service Speech To Text lors de l'activation de l'audio à large bande. Requis uniquement lorsque le paramètre bandPreference est défini sur broadband. Le modèle de langue doit au minimum être défini sur la propriété model. Pour obtenir la liste complète des propriétés, consultez la référence d'API WebSockets pour le service Speech to Text. Versions 1.0.0.4 et ultérieures. Consultez les variables d'environnement à large bande dans Activation de la prise en charge d'une large bande
bandPreference Définit la bande audio à privilégier lors de la négociation des codecs audio dans la session. Définissez ce paramètre sur broadband pour utiliser l'audio à large bande quand cela est possible. La valeur par défaut est narrowband. Versions 1.0.0.4 et ultérieures. WATSON_STT_BAND_PREFERENCE
disableFirstTurnBargeIn Définissez cette valeur sur true pour désactiver l'interruption de parole au premier échange de conversation. Version 1.0.2.0 ou ultérieure. WATSON_STT_DISABLE_FIRST_TURN_BARGE_IN
bargeInResume La valeur true permet de reprendre la lecture audio après une interruption si la cote de confiance de l'énoncé final est inférieure au seuil spécifié par la propriété confidenceScoreThreshold. Versions 1.0.0.5 et ultérieures. BARGE_IN_RESUME
confidenceScoreThreshold Seuil de fiabilité des messages provenant du service Speech to Text. Les messages avec une cote de fiabilité inférieure au seuil ne sont pas transmis à Watson Assistant. La valeur par défaut 0 signifie que toutes les réponses seront utilisées. Les valeurs recommandées se situent entre 0 et 1. WATSON_STT_CONFIDENCE_SCORE_THRESHOLD
connectionTimeout Durée en secondes pendant laquelle Voice Gateway attend pour établir une connexion de sockets avec le service Watson Speech to Text. Si cette durée est dépassée, Voice Gateway réessaie de se connecter au service Watson Speech to Text. Si le service n'est toujours pas joignable, l'appel échoue. Versions 1.0.0.5 et ultérieures. WATSON_STT_CONNECTION_TIMEOUT
requestTimeout Durée en secondes pendant laquelle Voice Gateway attend pour établir une session de reconnaissance vocale avec le service Watson Speech to Text. Si cette durée est dépassée, Voice Gateway réessaie de se connecter au service Watson Speech to Text. Si le service n'est toujours pas joignable, l'appel échoue. Versions 1.0.0.5 et ultérieures. WATSON_STT_REQUEST_TIMEOUT
echoSuppression Indique s'il convient de supprimer les résultats de Speech to Text pouvant se produire à partir d'un écho de la synthèse Text to Speech. Versions 1.0.0.4c et ultérieures. ECHO_SUPPRESSION
providers Configuration pour plusieurs fournisseurs de services, permettant la prise en charge de la configuration de service au niveau racine. Versions 1.0.0.6 et ultérieures.
  • name : nom de l'instance de service.
  • providerType : définit le fournisseur de voix comme mrcpv2 ou watson. La valeur par défaut est watson. Versions 1.0.0.7 et ultérieures.
  • config : Définitions de configuration obligatoire pour WatsonSpeechtoTextConfig ou MrcpRecognizerConfig. Versions 1.0.0.7 et ultérieures.
  • Si vous utilisez IBM® Speech to Text, vous devez configurer la propriété credentials. Vous pouvez également configurer les mêmes propriétés JSON au niveau providers que celles définies au niveau racine de l'objet conversation. Ceci inclut des propriétés, telles que url, workspaceID, username, password, tokenAuthEnabled, tokenServiceProviderUrl et tokenServiceUrl.
Voir Configuration de plusieurs fournisseurs de services. Pour obtenir des informations sur la configuration d'un serveur MRCP, voir Configuration des services avec MRCPv2		 N/A
providerSelectionPolicy En cas de défaillance d'un service, processus par lequel Voice Gateway transforme des instances de service Speech to Text actives lorsque plusieurs fournisseurs sont configurés pour le titulaire. Voice Gateway passe au fournisseur suivant dans la liste uniquement lorsqu'une erreur se produit lors du premier échange avec le service. Une fois qu'un appel est établi, Voice Gateway ne passe pas à un autre fournisseur parole-texte en milieu d'appel. La valeur par défaut est sequential. N/A
trackLatency Lorsque cette variable est définie sur true, Media Relay suit la latence de réponse avec détection d'énergie. La latence est le temps écoulé en millisecondes entre le moment où Media Relay détecte un silence dans la parole de l'appelant et le moment où Media Relay reçoit un résultat final de Speech to Text. Versions 1.0.0.8 et ultérieures. STT_TRACK_LATENCY

Retour en haut de page

Propriété credentials de l'objet stt

Tableau 7. Détails de configuration des attributs de la propriété JSON credentials.
Attribut Description Variable d'environnement associée
url Adresse url de l'API de service Speech to Text WATSON_STT_URL
username Nom d'utilisateur (username) de votre service Speech to Text WATSON_STT_USERNAME
password Mot de passe (password) du service Speech to Text WATSON_STT_PASSWORD
apikey Clé d'API, apikey, de votre service Speech to Text. Vous pouvez configurer les connexions avec les services Watson avec apikey et en définissant tokenServiceProviderUrl sur https://iam.cloud.ibm.com/identity/token, ou avec username et password. Versions 1.0.0.6a et ultérieures. WATSON_STT_APIKEY
bearerToken Jeton d'authentification qui sera utilisé lors des demandes au service Speech To Text. Version 1.0.3.0 et versions ultérieures. N/A
tokenAuthEnabled Vous pouvez activer l'authentification par jeton en redéfinissant tokenAuthEnabled sur true. Voir Activation de l'authentification par jeton basée sur le nom d'utilisateur et le mot de passe pour les services Watson. Version 1.0.0.5a et ultérieures. WATSON_STT_TOKEN_AUTH_ENABLED
tokenServiceProviderUrl La valeur de ces données d'identification est l'URL du service d'authentification de Speech to Text. Version 1.0.0.5a et ultérieures. WATSON_STT_TOKEN_SERVICE_PROVIDER_URL
tokenServiceUrl URL de service imbriquée dans la demande de jeton. Version 1.0.0.5a et ultérieures. WATSON_STT_TOKEN_SERVICE_URL

Retour en haut de page

Propriétés de Speech to Text Adapter

Si vous avez déployé Voice Gateway avec Speech to Text Adapter, définissez les propriétés suivantes à la place :

Tableau 8. Propriétés JSON de l'API Google Cloud Speech
Propriété JSON Description Variable d'environnement associée
config Paramètres de la demande RecognitionConfig de l'API Google Cloud Speech. Pour obtenir la liste complète des paramètres, consultez la documentation d'APIRecognitionConfig. Reportez-vous aux variables Google Cloud Speech (GOOGLE_SPEECH) dans la configuration de Speech to Text Adapter
thirdPartyCredentials Contenu d'un fichier JSON relatif à un compte de service de projet Google Cloud. GOOGLE_APPLICATION_CREDENTIALS

Retour en haut de page

Propriétés de l'objet tts

Si aucune propriété JSON n'est définie, la valeur de la variable d'environnement Docker associée est utilisée.

Tableau 9. Propriétés JSON de l'objet tts
Propriété JSON Description Variable d'environnement associée
credentials Données d'identification du service IBM® Text to Speech. Voir La propriété credentials de l'objet tts
config Paramètres du service IBM® Text to Speech. Voir la référence d'API WebSockets pour le service Watson Text to Speech. Voir les variables Text to Speech (WATSON_TTS) dans la configuration de Media Relay
jitterBufferDelay Durée, en millisecondes, de la zone tampon avant la répétition audio depuis le service Text to Speech. Cette zone tampon s'applique pour toute fluctuation au niveau de l'audio en continu. WATSON_TTS_JITTER_BUFFER_DELAY
connectionTimeout Durée en secondes pendant laquelle Voice Gateway attend pour établir une connexion socket avec le service Watson Text to Speech. Si cette durée est dépassée, Voice Gateway réessaie de se connecter au service Watson Text to Speech. Si le service n'est toujours pas joignable, l'appel échoue. Versions 1.0.0.5 et ultérieures. WATSON_TTS_CONNECTION_TIMEOUT
requestTimeout Durée en secondes pendant laquelle Voice Gateway attend pour établir une session de synthèse vocale avec le service Watson Text to Speech. Si cette durée est dépassée, Voice Gateway réessaie de se connecter au service Watson Text to Speech. Si le service n'est toujours pas joignable, l'appel échoue. Versions 1.0.0.5 et ultérieures. WATSON_TTS_REQUEST_TIMEOUT
cacheTimeToLive Nombre d'heures pendant lequel garder en cache les réponses du service Text to Speech pour améliorer le temps de réponse en lecture. Lorsque ce paramètre est activé, toutes les réponses de Text to Speech sont mises en cache, sauf si elles en ont été exclues du dialogue Watson Assistant. TTS_CACHE_TIME_TO_LIVE
providers Configuration pour plusieurs fournisseurs de services, permettant la prise en charge de la configuration de service au niveau racine. Versions 1.0.0.6 et ultérieures.
  • name : nom de l'instance de service.
  • providerType : définit le fournisseur de voix comme mrcpv2 ou watson. La valeur par défaut est watson. Versions 1.0.0.7 et ultérieures.
  • config: définitions de configuration requises pour WatsonTexttoSpeechConfig ou MrcpSpeechConfig. Versions 1.0.0.7 et ultérieures.
  • Si vous utilisez IBM® Text to Speech, vous devez configurer la propriété credentials. Vous pouvez également configurer les mêmes propriétés JSON au niveau providers que celles définies au niveau racine de l'objet conversation. Ceci inclut des propriétés, telles que url, workspaceID, username, password, tokenAuthEnabled, tokenServiceProviderUrl et tokenServiceUrl.
Voir Configuration de plusieurs fournisseurs de services. Pour obtenir des informations sur la configuration d'un serveur MRCP, voir Configuration des services avec MRCPv2		 N/A
providerSelectionPolicy En cas de défaillance d'un service, processus par lequel Voice Gateway transforme des instances de service Text to Speech actives lorsque plusieurs fournisseurs sont configurés pour le titulaire. Voice Gateway passe au fournisseur suivant dans la liste uniquement lorsqu'une erreur de conversation se produit lors du premier échange avec le service Text to Speech. Une fois qu'un appel est établi, Voice Gateway ne passe pas à un autre fournisseur au milieu d'un appel. La valeur par défaut est sequential. N/A

Retour en haut de page

Propriétés de Text to Speech Adapter

Si vous avez déployé Voice Gateway avec Text to Speech Adapter, définissez les propriétés suivantes :

Tableau 10. Propriétés JSON de l'API Google Cloud Text-to-Speech
Propriété JSON Description Variable d'environnement associée
config Paramètres du message de l'API Google Cloud Text-To-Speech SynthesizeSpeechRequest. Pour obtenir une liste complète des paramètres, voir la documentation d'API SynthesizeSpeechRequest. Voir les variables Google Cloud Text-To-Speech (GOOGLE_TTS) dans la configuration de Text to Speech Adapter.
thirdPartyCredentials Contenu d'un fichier JSON relatif à un compte de service de projet Google Cloud. GOOGLE_APPLICATION_CREDENTIALS

Propriété credentials de l'objet tts

Tableau 11. Détails de configuration des attributs de la propriété JSON credentials.
Attribut Description Variable d'environnement associée
url Adresse url de l'API de service Text to Speech WATSON_TTS_URL
username Nom d'utilisateur (username) de votre service Text to Speech WATSON_TTS_USERNAME
password Mot de passe (password) du service Text to Speech WATSON_TTS_PASSWORD
apikey Clé d'API, apikey, de votre service Text to Speech. Vous pouvez configurer les connexions avec les services Watson avec apikey et en définissant tokenServiceProviderUrl sur https://iam.cloud.ibm.com/identity/token ou avec username et password. Versions 1.0.0.6a et ultérieures. WATSON_TTS_APIKEY
bearerToken Jeton d'authentification qui sera utilisé lors des demandes au service Text To Speech. Version 1.0.3.0 et versions ultérieures. N/A
tokenAuthEnabled Vous pouvez activer l'authentification par jeton en redéfinissant tokenAuthEnabled sur true. Voir Activation de l'authentification par jeton basée sur le nom d'utilisateur et le mot de passe pour les services Watson. Version 1.0.0.5a et ultérieures. WATSON_TTS_TOKEN_AUTH_ENABLED
tokenServiceProviderUrl La valeur de ces données d'identification est l'URL du service d'authentification de Text to Speech. Version 1.0.0.5a et ultérieures. WATSON_TTS_TOKEN_SERVICE_PROVIDER_URL
tokenServiceUrl URL de service imbriquée dans la demande de jeton. Version 1.0.0.5a et ultérieures. WATSON_TTS_TOKEN_SERVICE_URL

Retour en haut de page

Propriétés de l'objet reporting

Pour permettre la génération de rapports dans un titulaire, le serveur de génération de rapport et le type d'événement doivent être définis en tant que propriétés JSON. Les valeurs des variables d'environnement Docker associées ne sont pas utilisées.

Tableau 12. Propriétés JSON de l'objet reporting
Propriété JSON Description Variable d'environnement associée
url Nom d'hôte du serveur Splunk HEC ou du serveur REST qui reçoit les événements. REPORTING_URL
username Nom d'autorisation utilisé pour l'authentification de base. Pour Splunk HEC, cette valeur peut être toute chaîne. REPORTING_USERNAME
password Mot de passe d'autorisation utilisé pour l'authentification de base. Pour Splunk HEC, définissez cette valeur sur le jeton généré par Splunk. REPORTING_PASSWORD
cdrEventInd Pour générer les événements d'enregistrement des détails d'appel (CDR), définissez une chaîne identifiant l'événement en tant que CDR, tel que cdr. La valeur spécifiée est incluse dans la zone d'index de tout événement d'enregistrement des détails d'appel (CDR). Si aucune valeur n'est définie, aucun événement CDR n'est généré. REPORTING_CDR_EVENT_INDEX
convEventInd Pour générer les événements d'échange Watson Assistant, définissez une chaîne qui identifie l'événement en tant qu'événement d'échange Watson Assistant, par exemple conv. La valeur spécifiée est incluse dans la zone d'index de tout événement d'échange Watson Assistant. Si aucune valeur n'est définie, les événements d'échange Watson Assistant ne sont pas générés. REPORTING_CONVERSATION_EVENT_INDEX
convRequestEventInd Chaîne qui identifie l'événement comme événement d'échange Watson Assistant, par exemple convRequest. Si cette propriété est configurée, un événement est généré avant l'envoi d'une demande d'échange à Watson Assistant. La valeur spécifiée est incluse dans la zone d'index de tous les événements d'échange Watson Assistant générés avant une demande d'échange. Cette variable doit être définie pour générer des événements d'échange Watson Assistant avant l'envoi d'une demande à Watson Assistant. REPORTING_CONVERSATION_REQUEST_EVENT_INDEX
transcriptionEventInd Pour générer des événements de transcription, définissez une chaîne identifiant l'événement en tant qu'événement de transcription, par exemple transcription. La valeur spécifiée est incluse dans la zone d'index de tous les événements de transcription. Si aucune valeur n'est définie, aucun événement de transcription n'est généré. REPORTING_TRANSCRIPTION_EVENT_INDEX
cdrCloudant Pour publier des événements CDR dans une base de données noSQL IBM Cloudant, fournissez les informations d'autorisation et les informations d'hôte. Versions 1.0.0.5d et ultérieures. Voir La propriété cdrCloudant de l'objet reporting. N/A
convCloudant Pour publier des événements d'échange Watson Assistant dans une base de données noSQL IBM Cloudant, fournissez les informations d'autorisation et les informations d'hôte. Versions 1.0.0.6 et ultérieures. Voir La propriété convCloudant de l'objet reporting. N/A
trancriptionCloudant Pour publier des événements de transcription dans une base de données noSQL IBM Cloudant, fournissez les informations d'autorisation et les informations d'hôte. Versions 1.0.0.6 et ultérieures. Voir La propriété transcriptionCloudant de l'objet reporting. N/A
maskCallerID Indique s'il faut masquer l'identification de l'appelant dans les rapports de transcription. La valeur par défaut est false. REPORTING_MASK_CALLER_ID

Retour en haut de page

La propriété cdrCloudant de l'objet reporting

Utilisez la propriété cdrCloudant pour configurer la publication d'événements d'échange CDR dans une base de données IBM Cloudant.

Tableau 13. Détails de configuration des attributs de la propriété JSON cdrCloudant.
Attribut Description Variable d'environnement associée
account Nom du compte IBM Cloudant, s'il est différent du nom d'utilisateur REPORTING_CDR_CLOUDANT_ACCOUNT
url URL où votre instance IBM Cloudant est hébergée pour stocker les événements CDR. Versions 1.0.0.5d et ultérieures. REPORTING_CDR_URL
username Si vous utilisez IBM Cloudant, nom d'utilisateur associé aux données d'identification de service de votre compte REPORTING_CDR_CLOUDANT_USERNAME
password Si vous utilisez IBM Cloudant, mot de passe associé aux données d'identification de service de votre compte REPORTING_CDR_CLOUDANT_PASSWORD
apikey Clé d'API, apikey, de votre service IBM Cloudant. Lorsque vous créez votre instance IBM Cloudant, vous pouvez autoriser l'accès à l'aide de l'option IAM uniquement ou de l'option Combinaison nom d'utilisateur/mot de passe OU clé d'API. Vous pouvez configurer les connexions avec les services IBM Cloud en utilisant apikey et en définissant url sur l'URL de votre service IBM Cloudant, comme par exemple https://3a14b-15g9-67aa-bluemix.cloudant.com. Vous pouvez également utiliser username et password. Versions 1.0.0.7 et ultérieures. REPORTING_CDR_CLOUDANT_APIKEY
dbName Nom de la base de données IBM Cloudant REPORTING_CDR_CLOUDANT_DB_NAME
eventInd Pour générer des événements CDR pour votre base de données IBM Cloudant, définissez une chaîne qui identifie l'événement en tant que CDR, comme par exemple cdr. La valeur spécifiée est incluse dans la zone d'index de tous les événements d'enregistrement des détails d'appel (CDR) dans votre base de données. Si aucune valeur n'est définie, aucun événement CDR n'est généré REPORTING_CDR_CLOUDANT_EVENT_INDEX

Retour en haut de page

La propriété convCloudant de l'objet reporting

Utilisez la propriété convCloudant pour configurer la publication des événements d'échange Watson Assistant dans une base de données IBM Cloudant.

Tableau 14. Détails de configuration des attributs de la propriété JSON convCloudant.
Attribut Description Variable d'environnement associée
account Nom du compte IBM Cloudant, s'il est différent du nom d'utilisateur REPORTING_CONVERSATION_CLOUDANT_ACCOUNT
url Adresse URL à laquelle votre instance IBM Cloudant est hébergée pour stocker les événements d'échange. Versions 1.0.0.5d et ultérieures. REPORTING_CONVERSATION_URL
username Si vous utilisez IBM Cloudant, nom d'utilisateur associé aux données d'identification de service de votre compte REPORTING_CONVERSATION_CLOUDANT_USERNAME
password Si vous utilisez IBM Cloudant, mot de passe associé aux données d'identification de service de votre compte REPORTING_CONVERSATION_CLOUDANT_PASSWORD
apikey Clé d'API, apikey, de votre service IBM Cloudant. Lorsque vous créez votre instance IBM Cloudant, vous pouvez autoriser l'accès à l'aide de l'option IAM uniquement ou de l'option Combinaison nom d'utilisateur/mot de passe OU clé d'API. Vous pouvez configurer les connexions avec les services IBM Cloud en utilisant apikey et en définissant url sur l'URL de votre service IBM Cloudant, comme par exemple https://3a14b-15g9-67aa-bluemix.cloudant.com. Vous pouvez également utiliser username et password. Versions 1.0.0.7 et ultérieures. REPORTING_CONVERSATION_CLOUDANT_APIKEY
dbName Nom de la base de données IBM Cloudant REPORTING_CONVESATION_CLOUDANT_DB_NAME
eventInd Pour générer des événements d'échange Watson Assistant pour votre base de données IBM Cloudant, définissez une chaîne qui identifie l'événement comme un échange Watson Assistant, comme par exemple conversation. La valeur spécifiée est incluse dans la zone d'index de tous les événements d'échange Watson Assistant dans votre base de données IBM Cloudant. Si aucune valeur n'est définie, les événements d'échange Watson Assistant ne sont pas générés. REPORTING_CONVERSATION_CLOUDANT_EVENT_INDEX

Retour en haut de page

La propriété transcriptionCloudant de l'objet reporting

Utilisez la propriété transcriptionCloudant pour configurer la publication des événements de transcription dans une base de données IBM Cloudant.

Tableau 15. Détails de configuration des attributs de la propriété JSON transcriptionCloudant.
Attribut Description Variable d'environnement associée
account Nom du compte IBM Cloudant, s'il est différent du nom d'utilisateur. REPORTING_TRANSCRIPTION_CLOUDANT_ACCOUNT
url Adresse URL à laquelle votre instance IBM Cloudant est hébergée pour stocker les événements de transcription. Versions 1.0.0.5d et ultérieures. REPORTING_TRANSCRIPTION_URL
username Si vous utilisez IBM Cloudant, nom d'utilisateur associé aux données d'identification de service de votre compte. REPORTING_TRANSCRIPTION_CLOUDANT_USERNAME
password Si vous utilisez IBM Cloudant, mot de passe associé aux données d'identification de service de votre compte. REPORTING_TRANSCRIPTION_CLOUDANT_PASSWORD
apikey Clé d'API, apikey, de votre service IBM Cloudant. Lorsque vous créez votre instance IBM Cloudant, vous pouvez autoriser l'accès à l'aide de l'option IAM uniquement ou de l'option Combinaison nom d'utilisateur/mot de passe OU clé d'API. Vous pouvez configurer les connexions avec les services IBM Cloud en utilisant apikey et en définissant url sur l'URL de votre service IBM Cloudant, comme par exemple https://3a14b-15g9-67aa-bluemix.cloudant.com. Vous pouvez également utiliser username et password. Versions 1.0.0.7 et ultérieures. REPORTING_TRANSCRIPTION_CLOUDANT_APIKEY
dbName Nom de la base de données IBM Cloudant REPORTING_TRANSCRIPTION_CLOUDANT_DB_NAME
eventInd Pour générer des événements de transcription pour votre base de données IBM Cloudant, définissez une chaîne qui identifie l'événement en tant qu'événement de transcription, comme par exemple transcription. La valeur spécifiée est incluse dans la zone d'index de tous les événements de transcription dans votre base de données. Si aucune valeur n'est définie, aucun événement de transcription n'est généré. REPORTING_TRANSCRIPTION_CLOUDANT_EVENT_INDEX

Retour en haut de page

Propriétés de l'objet smsPipe

Pour activer l'intégration de la messagerie SMS durant un appel, vous pouvez configurer un titulaire avec des informations sur votre instance SMS Gateway. Voir Intégration de SMS Gateway à Voice Gateway.

Tableau 16. Propriétés JSON de l'objet smsPipe
Propriété JSON Description Variable d'environnement associée
connectTimeout Délai d'attente en secondes observé par Voice Gateway avant d'établir une connexion socket à SMS Gateway. Si le délai est dépassé, Voice Gateway tente à nouveau de se connecter à SMS Gateway. Si le service n'est toujours pas joignable, Voice Gateway avertit le service de conversation qu'un message SMS ne peut pas être envoyé. La valeur par défaut est 5 secondes pour les versions 1.0.0.6 et ultérieures. SMS_GW_CONNECT_TIMEOUT
enableInboundSMS Détermine si un message SMS entrant est attendu en provenance d'un appelant. Les valeurs possibles sont True ou False. Lorsque cette variable à pour valeur True, un canal de communication SMS est créé. Sinon, seuls les messages SMS sortants vers un appelant sont pris en charge. Facultatif. Versions 1.0.0.6 et ultérieures. ENABLE_INBOUND_SMS
password Mot de passe de serveur SMS Gateway pour l'authentification. Cette valeur doit être identique à la valeur password dans la configuration d'objet controlCredentials de titulaire SMS Gateway. Voir Propriétés de l'objet controlCredentials. Versions 1.0.0.6 et ultérieures. SMS_GW_PASSWORD
username Nom d'utilisateur de serveur SMS Gateway pour l'authentification. Cette valeur doit être identique à la valeur username dans la configuration d'objet controlCredentials de titulaire SMS Gateway. Voir Propriétés de l'objet controlCredentials. Versions 1.0.0.6 et ultérieures. SMS_GW_USERNAME
expirationInterval Intervalle en secondes au terme duquel un canal de communication SMS arrive à expiration. La valeur par défaut de cette variable est 1200 secondes (20 minutes). Versions 1.0.0.6 et ultérieures. SMS_PIPE_EXPIRATION_INTERVAL
readTimeout Délai d'attente en secondes pendant lequel Voice Gateway attend une réponse de SMS Gateway. Si le délai est dépassé, Voice Gateway tente à nouveau de contacter SMS Gateway. Si le service n'est toujours pas joignable, Voice Gateway avertit le service de conversation qu'un message SMS ne peut pas être envoyé. La valeur par défaut est 5 secondes. Versions 1.0.0.6 et ultérieures. SMS_GW_READ_TIMEOUT
tenantPhoneNumber Facultatif. Numéro de téléphone du titulaire, par exemple, "+12222222222". Versions 1.0.0.6 et ultérieures. TENANT_PHONE_NUMBER
url URL de serveur SMS Gateway vers laquelle envoyer des demandes. Par exemple, http://host:port/sms.gateway/smsPipe, avec les paramètres host et port définis. Versions 1.0.0.6 et ultérieures. SMS_GW_URL

Retour en haut de page

Propriétés de l'objet outboundCalls

Pour activer les appels sortants dans un titulaire, les propriétés JSON des appels sortants doivent être définies.

Table 17. Propriétés JSON de l'objet outboundCalls
Propriété JSON Description Variable d'environnement associée
enableOutboundCalls Facultatif. true/false. Active ou désactive la fonctionnalité des appels sortants. Définie sur false par défaut. Version 1.0.2 ou ultérieure. ENABLE_OUTBOUND_CALLS
statusWebhook Facultatif. URL HTTP/HTTPS à utiliser pour les notifications asynchrones. Version 1.0.2 ou ultérieure. OUTBOUND_CALLS_STATUS_WEBHOOK
statusWebhookUsername Facultatif. Nom d'utilisateur à utiliser pour l'authentification lors de l'envoi de notifications à un webhook. Version 1.0.2 ou ultérieure. OUTBOUND_CALLS_STATUS_WEBHOOK_USERNAME
statusWebhookPassword Facultatif. Mot de passe à utiliser pour l'authentification lors de l'envoi de notifications à un webhook. Version 1.0.2 ou ultérieure. OUTBOUND_CALLS_STATUS_WEBHOOK_PASSWORD
tenantURI Facultatif. URI SIP/Téléphone du titulaire. Cette valeur est utilisée dans l'en-tête De d'un appel sortant si elle n'est pas spécifiée dans l'appel d'API REST. Version 1.0.2 ou ultérieure. OUTBOUND_CALLS_TENANT_URI
connectTimeout Facultatif. Durée en secondes pendant laquelle Voice Gateway attend avant d'établir une connexion de sockets avec le point d'ancrage Web. Si cette valeur est dépassée, Voice Gateway tente de se reconnecter. La valeur par défaut est 5 secondes. Version 1.0.2 ou ultérieure. OUTBOUND_CALLS_STATUS_WEBHOOK_CONNECT_TIMEOUT
readTimeout Facultatif. Durée en secondes pendant laquelle Voice Gateway attend une réponse du point d'ancrage Web. Si cette valeur est dépassée, Voice Gateway tente de se reconnecter. La valeur par défaut est 5 secondes. Version 1.0.2 ou ultérieure. `OUTBOUND_CALLS_STATUS_WEBHOOK_READ_TIMEOUT
maxRetryNo Facultatif. Nombre maximum de fois que Voice Gateway tente de se connecter au point d'ancrage Web en raison d'un incident de connexion. Définie sur 2 par défaut. Version 1.0.2 ou ultérieure. OUTBOUND_CALLS_STATUS_WEBHOOK_MAX_RETRY_NUM
username Facultatif. Nom d'utilisateur pour l'authentification des appels de l'API REST. Version 1.0.2 ou ultérieure. REST_API_USERNAME
password Facultatif. Mot de passe pour l'authentification des appels de l'API REST. Version 1.0.2 ou ultérieure. REST_API_PASSWORD

Retour en haut de page