Auto Translation
You need the Manage Settings permission to manage Auto Translation.
Auto Translations
- Auto Translations Manage
GET global/autoTranslationConfig
PUT global/autoTranslationConfig
Model
Auto Translation JSON Format
Auto Translation is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
excludedWords |
string [] | Words/phrases that do not require translation. |
isEnabledInTicketingAndMessaging |
bool | To indicate these whether the auto translation feature is enabled for Ticketing&Messaging product or not. |
isEnabledInLiveChat |
bool | To indicate these whether the auto translation feature is enabled for LiveChat product or not. |
translationSuffixInTicketingAndMessaging |
string | To indicate whitch text will be used as the suffix of the translated message. |
originalSuffixInTicketingAndMessaging |
string | To indicate whitch text will be used as the suffix of the original message. |
messageContentInTicketingAndMessaging |
string | To indicate whether to only send translation in Ticketing&Messaging channnels, or send both original and translation.Allowed values are "sendBothOriginalAndTranslation", "onlySendTheTranslation". |
messageContentInLiveChat |
string | To indicate whether to only send translation in LiveChat channnels, or send both original and translation.Allowed values are "sendBothOriginalAndTranslation", "onlySendTheTranslation". |
Endpoint
Get a single Auto Translation
GET global/autoTranslationConfig
Example
Sample Request:
curl https://api11.comm100.io/v4/global/autoTranslationConfig \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Update the Auto Translation
PUT global/autoTranslationConfig
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
excludedWords |
string [] | body | no | Words/phrases that do not require translation. |
isEnabledInTicketingAndMessaging |
bool | body | no | To indicate these whether the auto translation feature is enabled for Ticketing&Messaging product or not. |
isEnabledInLiveChat |
bool | body | no | To indicate these whether the auto translation feature is enabled for LiveChat product or not. |
translationSuffixInTicketingAndMessaging |
string | body | no | To indicate whitch text will be used as the suffix of the translated message. |
originalSuffixInTicketingAndMessaging |
string | body | no | To indicate whitch text will be used as the suffix of the original message. |
messageContentInTicketingAndMessaging |
string | body | yes | To indicate whether to only send translation in Ticketing&Messaging channnels, or send both original and translation.Allowed values are "sendBothOriginalAndTranslation", "onlySendTheTranslation". |
messageContentInLiveChat |
string | body | yes | To indicate whether to only send translation in LiveChat channnels, or send both original and translation.Allowed values are "sendBothOriginalAndTranslation", "onlySendTheTranslation". |
Response:
Example
Sample Request:
curl https://api11.comm100.io/v4/global/autoTranslationConfig \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"excludedWords":["Test"],"isEnabledInTicketingAndMessaging":true,"isEnabledInLiveChat":true,"translationSuffixInTicketingAndMessaging":"","originalSuffixInTicketingAndMessaging":"","messageContentInTicketingAndMessaging":"","messageContentInLiveChat":""}'
Response:
HTTP/1.1 200 OK