Bot API
Last updated
Last updated
Bot API is an API from 3Dolphins SRM ChatBot which can be used for integration needs with other systems.
Login as ‘Supervisor’ or ‘Administrator’, go to API menu and click the Bot API menus, then you will see a bot API page such as images below.
Field/Notes
Description
Method
Method indicates the allowed interactions (such as GET, POST, PUT or DELETE) with the resource.
Media Type
Specifies the format of the data as type/subtype application/json.
URL
This field supports user attributes, they will be URL-encoded with your request.
Body
The Body of the 3Dolphins API represents the body of the response/request.
Status
HTTP response status codes indicate whether a specific HTTP request has been successfully completed. Responses are grouped in five classes :
1. Informational responses (100
–199
),
2. Successful responses (200
–299
),
3. Redirects (300
–399
),
4. Client errors (400
–499
),
5. Server errors (500
–599
).
Response
The Response interface of the 3Dolphins API represents the response to a request.
Server
Application Url
Username
Username credential
Password
Password credential
GeneratedTokenId
Generated token id