apiDocsTitle
apiDocsSubtitle
apiDocsOverviewTitle
apiDocsOverviewText
apiDocsBaseUrl:
https://nexontech.org/api/widgetapiDocsQuickStartTitle
apiDocsQuickStartText
1. apiDocsQuickStep1
POST /api/widget/init
Content-Type: application/json
{
"key": "wk_your_widget_key"
}2. apiDocsQuickStep2
POST /api/widget/chat
Content-Type: application/json
{
"key": "wk_your_widget_key",
"conversation_id": "conv_id_from_step_1",
"text": "Hello, I need help!"
}apiDocsAuthTitle
apiDocsAuthText
apiDocsAuthWhereKey
- apiDocsAuthStep1
- apiDocsAuthStep2
- apiDocsAuthStep3
apiDocsInitTitle
POST
/api/widget/initapiDocsInitDesc
apiDocsRequestBody
| apiDocsTableField | apiDocsTableType | apiDocsTableRequired | apiDocsTableDescription |
|---|---|---|---|
key | string | Yes | apiDocsInitKeyDesc |
visitor_id | string | No | apiDocsInitVisitorDesc |
page_url | string | No | apiDocsInitPageDesc |
apiDocsResponse 200 OK
{
"conversation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"visitor_id": "v_abc123",
"chatbot_name": "Support Bot",
"config": {}
}| apiDocsTableField | apiDocsTableType | apiDocsTableDescription |
|---|---|---|
conversation_id | string | apiDocsInitRespConvId |
visitor_id | string | apiDocsInitRespVisitorId |
chatbot_name | string | apiDocsInitRespChatbotName |
config | object | apiDocsInitRespConfig |
apiDocsChatTitle
POST
/api/widget/chatapiDocsChatDesc
apiDocsRequestBody
| apiDocsTableField | apiDocsTableType | apiDocsTableRequired | apiDocsTableDescription |
|---|---|---|---|
key | string | Yes | apiDocsChatKeyDesc |
conversation_id | string | Yes | apiDocsChatConvDesc |
text | string | Yes | apiDocsChatTextDesc |
visitor_id | string | No | apiDocsChatVisitorDesc |
lang | string | No | apiDocsChatLangDesc |
apiDocsResponse 200 OK
{
"response": "Hi! I'd be happy to help. What can I do for you today?",
"user_reply_options": ["Check order status", "Talk to a human", "Browse products"]
}| apiDocsTableField | apiDocsTableType | apiDocsTableDescription |
|---|---|---|
response | string | apiDocsChatRespResponse |
user_reply_options | string[] | apiDocsChatRespOptions |
apiDocsNote: apiDocsChatNoteText
apiDocsRateLimitTitle
apiDocsRateLimitText
apiDocsErrorsTitle
apiDocsErrorsText
| apiDocsErrorCode | apiDocsErrorMeaning |
|---|---|
| 400 Bad Request | apiDocsError400 |
| 403 Forbidden | apiDocsError403 |
| 429 Too Many Requests | apiDocsError429 |
| 502 Bad Gateway | apiDocsError502 |
| 504 Gateway Timeout | apiDocsError504 |
apiDocsErrorFormat
{
"error": "Invalid or inactive widget key"
}apiDocsEmbedTitle
apiDocsEmbedText
<script src="https://nexontech.org/widget.js" data-key="wk_your_widget_key"></script>apiDocsEmbedNote
apiDocsCtaText