Introduction

This API is in Alpha, pricing and usage limitations to be determined

Welcome to the BOTGRIDA API! You can use our API to access BOTGRIDA API endpoints, which can get information on various in our database.

We have language bindings in PHP, Ruby, Python and NODE You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

API Endpoint

https://api.botgrida.com/v1/call

Authentication

Botgrida uses API keys to allow access to the API. You can register a new Botgrida API key at our developer page.

Authenticate your account when using the API by including your secret API key in the request. You can manage your API keys in the Dashboard. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Botgrida expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization : Bearer <API_KEY>

Expects project based token for authentication as described on the API page.

Request example

CURL -X GET \

-H 'Content-Type: application/json' \

-H 'Authorization: Bearer api_key' \

--url 'https://api.botgrida.com/v1/call'

<?php
$url = 'https://api.botgrida.com/v1/call';
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_TIMEOUT, 5);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER,
        array(
            'Content-Type: application/json',
            'Authorization: Bearer api_key')
        );

$data = curl_exec($ch);
curl_close($ch);
return $data;
?>

# No sample code available
# No sample code available
# No sample code available

JSON Response example

# No sample code available

NLP

This API is in Alpha, pricing and usage limitations to be determined

Welcome to the BOTGRIDA API! You can use our API to access BOTGRIDA API endpoints, which can get information on various in our database.

We have language bindings in PHP, Ruby, Python and NODE You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Name	Type	Description
`uuid`	`String`	The universally unique id for this request
`source`	`String`	The text we processed
`intents`	`Array` of intent	The intents we found, sorted by probability
`intent.slug`	`String`	The slug of the intent which matched
`intent.confidence`	`Float`	The maching score of the intent
`act`	`String`	The act of the request, more info in the glossary
`type`	`String`	The type of the request, more info in the glossary
`sentiment`	`String`	The sentiment of the request, more info in the glossary
`entities`	`Object`	Every keys are an array of entity, more infos in the glossary
`language`	`String`	The language detected (or given) from the processed sentence, follows the ISO 639-1 standard
`version`	`String`	The version of our JSON, follows the Semantic Versioning Specification
`timestamp`	`String`	The UTC timestamp at the end of our processing, follows the ISO 8061 standard
`status`	`Integer`	The status of our Natural Language processor

Request example

CURL -X GET \

-H 'Content-Type: application/json' \

-H 'Authorization: Bearer api_key' \

--url 'https://api.botgrida.com/v1/call'

<?php
    $url = 'https://api.botgrida.com/v1/call';
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_TIMEOUT, 5);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_HTTPHEADER,
    array(
    'Content-Type: application/json',
    'Authorization: Bearer api_key')
    );

    $data = curl_exec($ch);
    curl_close($ch);
    return $data;
?>

# No sample code available
# No sample code available
# No sample code available

JSON Response example

{ 
  "results":{
    "domain":"call_test",
    "user":{
        "id":1517545029,
        "name":"guest"
        },
    "request":{
        "source":{
            "message":"Hello",
            "custom_entities":
            []
        },
        "intent":"greeting",
        "time":{
            "send":1517544025
        }
    },
    "response":{
        "bot":{
            "id":"53",
            "name":"botgrida"
        },
        "reaction":{
            "message":"안녕하세요!",
            "messages":[
                "안녕하세요!",
                "o(≧∇≦o) 안녕!",
                "σ(≧ε≦ｏ) 안녕!!",
                "안녕하세요!~ 점심은 맛있게 드셨어요?^^;",
                "안녕하세요~ 오후 날씨가 많이 따스해졌죠?"
                ]
            },
        "time":{
            "checked":1517542791,
            "send":1517598346
            }
        }
    }
}

Templates

JSON object which contains the contents of the message you send.

Text

Hello, world

Format

Field	Type	Required	Description
type	String	Yes	text
text	String	Yes	Message text Max: 2000 characters

JSON Response example

{
 type: "text",
   message: {
        text: "Hello, world"
    }
}

Image

Format

Field	Type	Required	Description
type	String	Yes	image
url	String	Yes	Image URL

JSON Response example

{
 type: "image",
 url: "https://i.imgur.com/PglQz8O.jpg"
}

Emoji

Format

Field	Type	Required	Description
type	String	Yes	image
emoji	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 type: "emoji",
 url: "https://www.example.com/emoji/emoji.jpg"
}

Video

트립그리다_홍보영상.avi

Size : 20 MB

유효기간 : 2017.10.12 ~ 2017.12.12

영상 보기

Format

Field	Type	Required	Description
type	String	Yes	image
video	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 type: "video",
 url: "https://www.example.com/video/video.avi"
}

Audio

내목소리.wav

Size : 20 MB

유효기간 : 2017.10.12 ~ 2017.12.12

음성 듣기

Format

Field	Type	Required	Description
type	String	Yes	image
audio	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 type: "text",
 url: "https://www.example.com/audio/audio.wav"
}

Document

트립그리다제휴문의.doc

Size : 20 MB

유효기간 : 2017.10.12 ~ 2017.12.12

음성 듣기

Format

Field	Type	Required	Description
type	String	Yes	image
files	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 type: "text",
 url: "https://www.example.com/files/document.doc"
}

Generic

여행정보

Travel better! Like Locals!

VIEW
LINK
CALL

Format

Field	Type	Required	Description
type	String	Yes	image
files	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 type: "card",
 content: {
  title : "TITLE",
  imageUrl : "IMAGE_URL",
  buttons : [
        {
          title: "BUTTON_TITLE",
          type: "BUTTON_TYPE",
          value: "BUTTON_VALUE"
        }
     ]
  }
}

Message Buttons

예 가본적 있어요
아니요 가본적 없어요
꿈에서

Format

Field	Type	Required	Description
type	String	Yes	image
files	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 type: "message_button",
 content: {
   title : "TITLE",
   buttons : [
         {
           title: "BUTTON_TITLE",
           type: "BUTTON_TYPE",
           value: "BUTTON_VALUE"
         }
      ]
   }
}

Carousel

여행정보

Travel better! Like Locals!
- VIEW
- LINK
- CALL
여행정보

Travel better! Like Locals!
- VIEW
- LINK
- CALL

Format

Field	Type	Required	Description
type	String	Yes	image
files	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 type: "carousel",
 content: [
        {
            title : "TITLE",
            imageUrl : "IMAGE_URL",
            buttons : [
            {
               title: "BUTTON_TITLE",
               type: "BUTTON_TYPE",
               value: "BUTTON_VALUE"
            }
          ]
       }
     ]
}

List

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

View

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

View

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

View

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

View
- View More
여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg
- Read More

Format

Field	Type	Required	Description
type	String	Yes	image
files	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 type: "list",
 content: [
        {
            title : "TITLE",
            imageUrl : "IMAGE_URL",
            buttons : [
            {
               title: "BUTTON_TITLE",
               type: "BUTTON_TYPE",
               value: "BUTTON_VALUE"
            }
          ]
       }
     ]
}

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

View

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

View

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

View

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

View
- View More
여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg

여행정보

Travel better! Like Locals!

www.tripgrida.com/img.jpg
- Read More

Format

Field	Type	Required	Description
type	String	Yes	image
files	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 "type": "text",
 "text": "value"
}

Profile Card

Choi Seungpil

Tripgrida

Following 2016.12.21

Following

Message

Block

Format

Field	Type	Required	Description
type	String	Yes	image
audio	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 "type": "text",
 "text": "value"
}

Weather

Cloud Rainy

-3 °C

Seoul, South Korea

Rainy

Clear

Rainy

Cloud

Format

Field	Type	Required	Description
type	String	Yes	image
audio	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 "type": "text",
 "text": "value"
}

Boarding Ticket

Date

2017/05/12

Boarding Time

12:30

Departing

13:00

Flight

LT 4060

Terminal

1

Gate

C1

Passenger

Seat

Choi seungpil

A12

Kang Seongmin

A13

Jung Woosung

A14

Format

Field	Type	Required	Description
type	String	Yes	image
audio	String	Yes	Image URL JPEG/PNG/GIF Max: 1024 x 1024 Max: 1 MB

JSON Response example

{
 "type": "text",
 "text": "value"
}

Errors

Botgrida service uses standard HTTP response codes to display whether a method completed successfully. A 200 response always indicates success. A 400 type response is usually an error with the call, and a 500 type response usually indicates an internal system error.

Error Format

Name	Description
code	Error code
error	Error description

Botgrida API uses the following error codes:

Code	Meaning
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
402 - Request Failed	The parameters were valid but the request failed.
403 - Forbidden	The requested is hidden for administrators only
404 - Not Found	The requested resource doesn't exist.
405 - Method Not Allowed	You tried to access a kitten with an invalid method
406 - Not Acceptable	The requested a format that isn't json
410 - Gone	The requested has been removed from our servers
500 -Internal Server Error	We had a problem with our server. Try again later.
503 - Service Unavailable	We're temporarily offline for maintenance. Please try again later.

JSON Response example

{
 "code": 400,
 "error": "Bad Request"
}