Bot_AgentAssistSynonym
Bot_AgentAssistSynonyms
- Bot_AgentAssistSynonyms Manage
GET bot/agentAssistSynonyms
GET bot/agentAssistSynonyms/{id}
POST bot/agentAssistSynonyms
PUT bot/agentAssistSynonyms/{id}
DELETE bot/agentAssistSynonyms/{id}
Model
Bot_AgentAssistSynonym JSON Format
Bot_AgentAssistSynonym is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
id |
guid | Id of the synonym. |
keyword |
string | Keyword of the synonym. |
synonyms |
string [] | Synonymous words or phrases. |
Endpoint
Get the list of Bot_AgentAssistSynonyms
GET bot/agentAssistSynonyms
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
keywords |
string | query | no | Search synonym name by the keyword. |
sortBy |
string | query | no | Allowed values are "keyword", "Synonyms?. |
Response:
An array of Bot_AgentAssistSynonym
Example
Sample Request:
curl https://api11.comm100.io/v4/bot/agentAssistSynonyms \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get a single Bot_AgentAssistSynonym
GET bot/agentAssistSynonyms/{id}
Example
Sample Request:
curl https://api11.comm100.io/v4/bot/agentAssistSynonyms/1576fc67-e153-4060-8b04-d554d81d6162 \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Create a new Bot_AgentAssistSynonym
POST bot/agentAssistSynonyms
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
keyword |
string | body | yes | Keyword of the synonym. |
synonyms |
string [] | body | yes | Synonymous words or phrases. |
Response:
Example
Sample Request:
curl https://api11.comm100.io/v4/bot/agentAssistSynonyms \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"keyword":"zn","synonyms":["China"]}'
Response:
HTTP/1.1 201 Created
Update the Bot_AgentAssistSynonym
PUT bot/agentAssistSynonyms/{id}
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
keyword |
string | body | yes | Keyword of the synonym. |
synonyms |
string [] | body | yes | Synonymous words or phrases. |
Response:
Example
Sample Request:
curl https://api11.comm100.io/v4/bot/agentAssistSynonyms/1576fc67-e153-4060-8b04-d554d81d6162 \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"keyword":"zn","synonyms":["China"]}'
Response:
HTTP/1.1 200 OK
Remove the Bot_AgentAssistSynonym
DELETE bot/agentAssistSynonyms/{id}
Parameters:
No Parameters
Response:
No Content
Example
Sample Request:
curl https://api11.comm100.io/v4/bot/agentAssistSynonyms/1576fc67-e153-4060-8b04-d554d81d6162 \
-X
'DELETE'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 204 No Content