Setup and usage

The PHP API supplies a collection of PHP functions that underpin the majority of SmartAi Support functionality. To start using the PHP API follow the steps below.

Usage

Include the file functions.php in your PHP file. The file is located in the include folder of the plugin folder. If you are using the PHP or WP versions, you’re done! You can start using the functions of this documentation

require(“include/functions.php”);

Get the absolute path of your SmartAI Support installation from Settings > Miscellaneous > Get Path. You can also use the variable $_SERVER[“DOCUMENT_ROOT”]. E.g. require($_SERVER[“DOCUMENT_ROOT”] . “/smartai.support/include/functions.php”);.

SaaS version

If you are using the SaaS version you also have to add the code sb_cloud_load(); immediately after the require(“include/functions.php”); code. To make the functions related to a single customer work follow one of the methods below.

• Login to the SmartAI Support with the customer account, after that, run the PHP API functions from the same browser you are logged in.
• Use the function sb_cloud_load_by_url() and add the URL attribute ?cloud=TOKEN to the PHP file containing the API functions. Replace TOKEN with the token of the customer.
• Use the function sb_cloud_set_login(TOKEN). Replace TOKEN with the token of the customer.

Information

• Some functions are protected for security reasons, enter the code $GLOBALS['SB_FORCE_ADMIN'] = true before calling the function to execute it correctly. Enter the code $GLOBALS[‘SB_FORCE_ADMIN’] = false immediately after the function call for security reasons.
• Some functions require the user details of the active user, use the code $GLOBALS[‘SB_LOGIN’] = [‘id’ => ”, ‘first_name’ => ”, ‘last_name’ => ”, ’email’ => ”, ‘user_type’ => ”, ‘department’ => ”]; to set the active user.

PHP API

Users

Functions to manage users, agents, and admins.

sb_login()

Logins a user or agent. The login can be completed in two ways: via email and password, or user ID and token.

Arguments

Response

[
    {
        "id": "913",
        "profile_image": "https://smartai.support/user.svg",
        "first_name": "User",
        "last_name": "#29902",
        "email": null,
        "user_type": "visitor",
        "token": "9b25351047ee758aa97ee4868d130cc1ceb8decf"
    },
    "YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn..."
]

The last value is the encrypted login data ready to be stored in the Web Storage of the user’ browser. Returns false if the login is unsuccessful.

sb_logout()

Log out the logged-in user, only on the server side.

Response

This function logout the user only from the server. Use the Javascript API function SBF.logout(); to log out the user also in the client-side.

sb_get_active_user()

Returns the user details of the logged-in user.

Arguments

Response

[
    {
        "id": "913",
        "profile_image": "https://smartai.support/user.svg",
        "first_name": "User",
        "last_name": "#29902",
        "email": null,
        "user_type": "visitor",
        "token": "9b25351047ee758aa97ee4868d130cc1ceb8decf"
    },
    "YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn..."
]

sb_get_user()

Returns the user details of the given user ID.

Arguments

Response

{
    "id": "123456",
    "first_name": "John",
    "last_name": "Doe",
    "email": "johon@example.com",
    "profile_image": "https://smartai.support/user.svg",
    "user_type": "visitor",
    "creation_time": "2020-05-12 14:28:57",
    "last_activity": "2020-05-12 14:28:57",
    "department": null,
    "token": "a521773c5a566a251c3fb00e93162b20ff955b12",
    "password": "",
    "details": [
        {
            "slug": "location",
            "name": "Location",
            "value": "New York, United States"
        },
        {
            "slug": "country_code",
            "name": "Country code",
            "value": "America/New_York"
        },
        ...
    ]
}

sb_get_user_extra()

Returns the extra user details of the given user ID, or the requested one.

Arguments

Response

[
    {
        "slug": "browser",
        "name": "Browser",
        "value": "Chrome"
    },
    {
        "slug": "current_url",
        "name": "Current URL",
        "value": "https://smartai.support/"
    },
    {
        "slug": "os",
        "name": "OS",
        "value": "Windows 10"
    },
    {
        "slug": "phone",
        "name": "Phone",
        "value": "3203057977"
    },
    ...
]

sb_get_user_name()

Returns the full name of the active user, or the given one.

Arguments

user | The user object.

Response

The user name string

sb_get_users()

Returns the user details of all the users.

Arguments

Response

[
    {
        "id": "880",
        "first_name": "User",
        "last_name": "#29938",
        "email": null,
        "profile_image": "https://smartai.support/user.svg",
        "user_type": "visitor",
        "creation_time": "2020-05-13 08:58:18",
        "last_activity": "2020-05-13 09:07:39",
        "department": null,
        "token": "6d969f64f5ed6263714b9b39f3d3700b66f16820"
    },
    {
        "id": "879",
        "first_name": "User",
        "last_name": "#86773",
        "email": null,
        "profile_image": "https:/smartai.support/user.svg",
        "user_type": "visitor",
        "creation_time": "2020-05-13 08:38:41",
        "last_activity": "2020-05-13 08:58:12",
        "department": null,
        "token": "2e5064670707d06b661d04353f4a462ec927f19a"
    },
    ...
]

sb_get_new_users()

Returns the users created after the given date/ID

Arguments

Response

[
    {
        "id": "880",
        "first_name": "User",
        "last_name": "#29938",
        "email": null,
        "profile_image": "https://smartai.support/user.svg",
        "user_type": "visitor",
        "creation_time": "2020-05-13 08:58:18",
        "last_activity": "2020-05-13 09:07:39",
        "department": null,
        "token": "6d969f64f5ed6263714b9b39f3d3700b66f16820"
    },
    {
        "id": "879",
        "first_name": "User",
        "last_name": "#86773",
        "email": null,
        "profile_image": "https://smartai.support/user.svg",
        "user_type": "visitor",
        "creation_time": "2020-05-13 08:38:41",
        "last_activity": "2020-05-13 08:58:12",
        "department": null,
        "token": "2e5064670707d06b661d04353f4a462ec927f19a"
    },
    ...
]

sb_get_online_users()

Returns the online users or the online agents and admins.

Arguments

Response

[
    {
        "id": "881",
        "first_name": "Don",
        "last_name": "John",
        "email": null,
        "profile_image": "https://smartai.support/user.svg",
        "user_type": "visitor",
        "creation_time": "2020-05-13 09:18:59",
        "last_activity": "2020-05-13 09:32:34",
        "department": null,
        "token": "e435a5c67f4276cdb9c6fc19b7c015990ffc3268"
    },
    {
        "id": "880",
        "first_name": "User",
        "last_name": "#29938",
        "email": null,
        "profile_image": "https://smartai.support/user.svg",
        "user_type": "visitor",
        "creation_time": "2020-05-13 08:58:18",
        "last_activity": "2020-05-13 09:32:28",
        "department": null,
        "token": "6d969f64f5ed6263714b9b39f3d3700b66f16820"
    }
    ...
]

sb_get_online_user_ids()

Returns an array with the IDs of the online users and agents.

Arguments

Response

sb_get_users_with_details()

Returns an array with the user IDs and details of the users who have the requested details.

Arguments

Response

{
    "email": [
        {
            "id": 4561,
            "value": "albert@example.com"
        },
        {
            "id": 98436,
            "value": "jessica@example.com"
        },
        ...
    ],
    "phone": [
        {
            "id": 12563,
            "value": "+4462367136"
        },
        {
            "id": 778956,
            "value": "+4462999345"
        },
        ...
    ],
    ...
} 

sb_search_users()

Returns the users matching the search.

Arguments

Response

[
    {
        "id": "881",
        "first_name": "Don",
        "last_name": "John",
        "email": null,
        "profile_image": "https://smartai.support/user.svg",
        "user_type": "visitor",
        "creation_time": "2020-05-13 09:18:59",
        "last_activity": "2020-05-13 09:32:34",
        "department": null,
        "token": "e435a5c67f4276cdb9c6fc19b7c015990ffc3268"
    },
    {
        "id": "880",
        "first_name": "User",
        "last_name": "#29938",
        "email": null,
        "profile_image": "https://smartai.support/user.svg",
        "user_type": "visitor",
        "creation_time": "2020-05-13 08:58:18",
        "last_activity": "2020-05-13 09:32:28",
        "department": null,
        "token": "6d969f64f5ed6263714b9b39f3d3700b66f16820"
    },
    ...
]

sb_add_user()

Creates a new user.

Arguments

123456

Response

Responses: ID of the new user on success, otherwise, duplicate-email, invalid-user-type, SQL error message.

Sb_add_user_and_login()

Creates a new user, log ins it, and returns the login data for the client-side.

Arguments

This function uses the same arguments of the sb_add_user() function.

Response

This function returns the same response of the sb_login() function.

sb_add_new_user_extra()

Adds additional user details to the user of the given ID. Existing user details will not be updated

Arguments

Response

true

sb_update_user()

Updates the details of an existing user.

Arguments

Response

true

Other possible responses: duplicate-email, invalid-user-type, SQL error message

sb_update_user_value()

Updates a single detail, or extra detail, of an existing user, agent, or admin.

Arguments

Response

true

sb_update_login()

Updates the login details of the logged-in user and returns the login data for the client-side. Use the Javascript API function SBF.loginCookie(response); to update the login details also in the client-side, the response is the response data returned by this function.

Arguments

Response

YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn…

sb_delete_user()

Deletes a user and all the linked conversations and messages.

Arguments

Response

true

Sb_delete_users()

Deletes multiple users and all the linked conversations and messages.

Arguments

Response

true

Sb_delete_leads()

Deletes all leads, including all the linked conversations and messages.

Response

true

Sb_current_url()

Gets or sets the current URL of the user or the last visited URL.

Arguments

Response

https://smartai.support/

Return false if the URL is not found. Return true if the url argument is set.

sb_count_users()

Returns the total users’ count grouped by user type.

Response

{
    "all": "335",
    "lead": "288",
    "user": "15",
    "visitor": "28"
}

sb_update_user_to_lead()

Changes the user type to lead.

Arguments

Response

true

sb_slack_users()

Returns the agents-slack members’ connection information. The Slack App is required.

Response

          "name": "Support Schio"
        },
        {
            "id": "UR5F0GK7T",
            "name": "Robert Pitt"
        }
        ...
    ],
    "agents": [
        {
            "id": "2",
            "name": "Alex Smith"
        },
        {
            "id": "445",
            "name": "Federico Schiocchet"
        },
        {
            "id": "724",
            "name": "Alberto Prade"
        }
        ...
    ],
    "saved": {
        "U328T701Z": "445",
        "UR5F0GK7T": "2"
        ...
    }
}

Response

true

sb_password_verify()

Checks if the given password matches the given password hash. The password hash is saved in the database in the password column of the sb_users table.

Arguments

Response

Return true if the password matches the hash, otherwise, return false.

sb_user_autodata()

Adds the following user details to the active user: city, location, country, timezone, currency, browser, browser language, os. These details are generated automatically.

Arguments

Response

true

Sb_is_typing()

Checks if a user or agent is typing a message in a conversation.

Parameters

Response

Return true if the user is typing, otherwise, return false.

sb_set_typing()

Assigns the typing status to a user or agent relative to a conversation.

Parameters

Response

true

sb_is_online()

Checks if the given date and time are recognized as online by Smartai support.

Arguments

Response

true if online, false if offline.

sb_is_user_online()

Checks if the user is online. This function is compatible with Pusher and Slack.

Arguments

Response

true if online, false if offline.

sb_get_bot_id()

Returns the ID of the bot.

Response

123456

Sb_get_user_from_conversation()

Returns the details of the user, or last agent, of the given conversation.

Arguments

Response

{
  "id": "123456",
  "email": "email@example.com"
}

sb_get_avatar()

Arguments

Generates the user profile image by using the first letter of first name, and last name, save the image, and returns the image URL.

Response

https://example.com/smartai/uploads/13-04-21/9455859.png

sb_get_active_user_ID()

Returns the ID of the active user.

Response

The User ID.

Sb_get_user_by

Searches for a user with the specified user details and returns it.

Arguments

Response

{
    "id": "881",
    "first_name": "Don",
    "last_name": "John",
    "email": "example@example.com",
    "user_type": "visitor",
    "department": null
 }

sb_update_bot

Updates the profile details of the chatbot. If the chatbot is not found a new chatbot profile is created.

Arguments

Response

Returns true on success, false otherwise.

PHP API

Agents And Admins

Functions related to agents and admins only. For more functions visit the users section.

sb_get_agents_ids()

Returns an array with the IDs of Agents.

Arguments

Response

[
    881,
    153,
    ...
]

sb_supervisor()

Checks if the active admin is the supervisor and returns the supervisor settings if true.

Response

Return the supervisor settings if the active agent ID is the same of the one set in Settings > Admin > Supervisor > Admin ID, otherwise returns false.

sb_get_agent()

Returns the profile details of an agent or admin.

Arguments

Response

{
    "id": "881",
    "first_name": "Don",
    "last_name": "John",
    "email": "example@example.com",
    "user_type": "visitor",
    "department": null
}

sb_is_agent()

Checks if the given user type string is an admin, an agent, or the bot.

Arguments

Response

Return true if the user type string is “admin”, “agent”, or “bot”, otherwise return false.

Sb_get_agent_department()

Returns the department of the active agent or admin.

Response

Returns the department ID if set, otherwise, return false.

sb_is_agent_typing()

Checks if an agent is typing a message in a conversation, and returns the agent details.

Parameters

Response

{
  "id": "",
  "first_name": "",
  "last_name": ""
}

Return false if no agents are typing.

sb_agents_online()
Checks if at least one agent or admin is online.

Response
Returns true if there are agents or admin online, or false if all Agents are offline.

PHP API

Conversations

Functions to manage conversations and messages.

sb_get_conversation()

Returns a conversation and the messages of the conversation.

Arguments

Response

{
    "messages": [
        {
            "id": "2044",
            "user_id": "802",
            "message": "Hello!",
            "creation_time": "2020-05-0410:06:30",
            "attachments": "",
            "status_code": "0",
            "payload": "",
            "conversation_id": "946",
            "first_name": "Don",
            "last_name": "John",
            "profile_image": "https://smartai.support/user.svg",
            "user_type": "lead"
        },
        {
            "id": "2045",
            "user_id": "377",
            "message": "Hello,howcanIhelp?",
            "creation_time": "2020-05-0410:06:33",
            "attachments": "",
            "status_code": "0",
            "payload": "",
            "conversation_id": "946",
            "first_name": "Bruce",
            "last_name": "Peterson",
            "profile_image": "https://smartai.support/agent.svg",
            "user_type": "agent"
        },
        ...
    ],
    "details": {
        "user_id": "802",
        "first_name": "Don",
        "last_name": "John",
        "profile_image": "https://smartai.support/user.svg",
        "user_type": "lead",
        "id": "946",
        "title": "",
        "conversation_time": "2020-05-0410:06:30",
        "conversation_status_code": "3",
        "department": null
    }
}

sb_get_conversations()

Returns all the conversations. Each conversation includes the last message of the conversation.

Arguments

Response

[
    {
        "message": "Hello World!",
        "message_id": "7351",
        "attachments": "",
        "payload": "",
        "message_status_code": "2",
        "last_update_time": "2023-10-02 16:00:06",
        "message_user_id": "377",
        "message_first_name": "Smart Assistant",
        "message_last_name": "",
        "message_profile_image": "https://example.com/image.jpg",
        "message_user_type": "bot",
        "conversation_id": "4084",
        "conversation_user_id": "4446",
        "conversation_status_code": "3",
        "conversation_creation_time": "2023-10-02 15:59:59",
        "department": "1",
        "agent_id": null,
        "title": "",
        "source": "tk",
        "extra": null,
        "tags": null,
        "conversation_first_name": "User",
        "conversation_last_name": "#26147",
        "conversation_profile_image": "https://example.com/image.jpg",
        "conversation_user_type": "lead"
    },
    ...
]

sb_get_new_conversations()

Returns the conversations created after the given date/ID or with a message created after the given date/ID. Each conversation includes the last message of the conversation.

Arguments

Response

[
    {
        "message": "Hello World!",
        "message_id": "7351",
        "attachments": "",
        "payload": "",
        "message_status_code": "2",
        "last_update_time": "2023-10-02 16:00:06",
        "message_user_id": "377",
        "message_first_name": "Smart Assistant",
        "message_last_name": "",
        "message_profile_image": "https://example.com/image.jpg",
        "message_user_type": "bot",
        "conversation_id": "4084",
        "conversation_user_id": "4446",
        "conversation_status_code": "3",
        "conversation_creation_time": "2023-10-02 15:59:59",
        "department": "1",
        "agent_id": null,
        "title": "",
        "source": "tk",
        "extra": null,
        "tags": null,
        "conversation_first_name": "User",
        "conversation_last_name": "#26147",
        "conversation_profile_image": "https://example.com/image.jpg",
        "conversation_user_type": "lead"
    },
    ...
]

sb_get_user_conversations()

Returns the conversations of a user. Each conversation includes the last message of the conversation.

Arguments

Response

[
    {
        "message": "Hello World!",
        "message_id": "7351",
        "attachments": "",
        "payload": "",
        "message_status_code": "2",
        "last_update_time": "2023-10-02 16:00:06",
        "message_user_id": "377",
        "message_first_name": "Smart Assistant",
        "message_last_name": "",
        "message_profile_image": "https://example.com/image.jpg",
        "message_user_type": "bot",
        "conversation_id": "4084",
        "conversation_user_id": "4446",
        "conversation_status_code": "3",
        "conversation_creation_time": "2023-10-02 15:59:59",
        "department": "1",
        "agent_id": null,
        "title": "",
        "source": "tk",
        "extra": null,
        "tags": null
    },
    ...
]

sb_get_last_conversation_id_or_create()

Returns the ID of the last user conversation if any, otherwise create a new conversation and returns its ID.

Arguments

Response

The conversation ID

sb_get_new_user_conversations()

Returns the user conversations created after the given date/ID or with a message created after the given date/ID. Each conversation includes the last message of the conversation.

Arguments

Response

[
    {
        "message": "Hello World!",
        "message_id": "7351",
        "attachments": "",
        "payload": "",
        "message_status_code": "2",
        "last_update_time": "2023-10-02 16:00:06",
        "message_user_id": "377",
        "message_first_name": "Smart Assistant",
        "message_last_name": "",
        "message_profile_image": "https://example.com/image.jpg",
        "message_user_type": "bot",
        "conversation_id": "4084",
        "conversation_user_id": "4446",
        "conversation_status_code": "3",
        "conversation_creation_time": "2023-10-02 15:59:59",
        "department": "1",
        "agent_id": null,
        "title": "",
        "source": "tk",
        "extra": null,
        "tags": null
    },
    ...
]

sb_search_conversations()

Returns the conversations matching the search terms.

Arguments

Response

[
    {
        "message": "Hello World!",
        "message_id": "7351",
        "attachments": "",
        "payload": "",
        "message_status_code": "2",
        "last_update_time": "2023-10-02 16:00:06",
        "message_user_id": "377",
        "message_first_name": "Smart Assistant",
        "message_last_name": "",
        "message_profile_image": "https://example.com/image.jpg",
        "message_user_type": "bot",
        "conversation_id": "4084",
        "conversation_user_id": "4446",
        "conversation_status_code": "3",
        "conversation_creation_time": "2023-10-02 15:59:59",
        "department": "1",
        "agent_id": null,
        "title": "",
        "source": "tk",
        "extra": null,
        "tags": null,
        "conversation_first_name": "User",
        "conversation_last_name": "#26147",
        "conversation_profile_image": "https://example.com/image.jpg",
        "conversation_user_type": "lead"
    },
    ...
]

sb_search_user_conversations()

Returns the conversations of the active user or given user ID that matches the search terms.

Arguments

Response

[
    {
        "message": "Hello World!",
        "message_id": "7351",
        "attachments": "",
        "payload": "",
        "message_status_code": "2",
        "last_update_time": "2023-10-02 16:00:06",
        "message_user_id": "377",
        "message_first_name": "Smart Assistant",
        "message_last_name": "",
        "message_profile_image": "https://example.com/image.jpg",
        "message_user_type": "bot",
        "conversation_id": "4084",
        "conversation_user_id": "4446",
        "conversation_status_code": "3",
        "conversation_creation_time": "2023-10-02 15:59:59",
        "department": "1",
        "agent_id": null,
        "title": "",
        "source": "tk",
        "extra": null,
        "tags": null
    },
    ...
]

sb_new_conversation()

Creates a new conversation.

Arguments

Response

{
    "messages": [],
    "details": {
        "user_id": "882",
        "first_name": "Don",
        "last_name": "John",
        "profile_image": "https://smartai.support/user.svg",
        "user_type": "lead",
        "id": "1007",
        "title": "",
        "conversation_time": "2020-05-15 12:51:39",
        "conversation_status_code": "0",
        "department": null
    }
}

Other possible responses: Conversation details array on success, otherwise, user-not-found, SQL error message

sb_update_conversation_status()

Updates the status code of a conversation.

Arguments

Response

true

Return invalid-status-code if the status code is invalid.

sb_update_conversation_department()

Updates the department of a conversation and optionally sends an email to all the agents in the new department.

Arguments

Response

true

sb_set_rating()

Assigns a rating to a conversation and optionally updates a message of the conversation.

Arguments

Response

true

sb_get_rating()

Gets the ratings of the conversations assigned to an agent.

Arguments

Response

[4, 2]

The response array: [count of positive ratings, count of negative ratings]. In the example above there are 4 positive ratings and 2 negative ratings.

sb_get_new_messages()

Returns the messages of a conversation created after the given date/ID.

Arguments

Response

[
    {
        "id": "2319",
        "user_id": "377",
        "message": "Welcome to our support chat!",
        "creation_time": "2020-05-12 18:04:50",
        "attachments": "",
        "status_code": "0",
        "payload": "",
        "conversation_id": "1004",
        "first_name": "Virtual",
        "last_name": "Agent",
        "profile_image": "https://smartai.support/bot.svg",
        "user_type": "bot"
    },
    {
        "id": "2320",
        "user_id": "877",
        "message": "Thank you! I need help.",
        "creation_time": "2020-05-12 18:04:51",
        "attachments": "",
        "status_code": "0",
        "payload": "",
        "conversation_id": "1004",
        "first_name": "Don",
        "last_name": "John",
        "profile_image": "https://smartai.support/user.svg",
        "user_type": "lead"
    },
    ...
]

sb_get_last_message()

Returns the last message in a conversation.

Arguments

Response

{
    "message": "Welcome to our support chat!",
    "attachments": "",
    "payload": ""
}

sb_send_message()

Adds a new message to an existing conversation.

Arguments

Response

{
    "status": "success",
    "message-id": 123456,
    "queue": false,
    "notifications": ["sms", "email"],
    "message": "Text of the message"
}

Other possible responses: invalid-status-code, SQL error message. The notifications response include the notifications sent to the user or agents.

sb_direct_message()

Sends a direct chat message, email, or text message to a single user, or several users. No email and text message notifications are sent for direct chat message. You need to send the notifications manually via sb_email() and sb_send_sms().

Arguments

Response

true

sb_messaging_platforms_send_message()

Sends a message to the messaging platform linked to the conversation. Available messaging platforms: Facebook Messenger, Instagram, WhatsApp, Twitter, Telegram, Google Business Messages, WeChat, LINE, Viber, Tickets, Emails, Text messages.

Arguments

Response

true

sb_send_slack_message()

Sends a message to Slack. The Slack App is required and Slack must be active in the settings area.

Arguments

Response

["success", "C011JFFGSKY"]

Other possible responses: slack-not-active, SQL, or cURL error message.

sb_update_message()

Updates an existing message.

Arguments

Response

true

sb_update_messages_status()

Updates the status code of multiple messages.

Arguments

Response

true

sb_delete_message()

Deletes an existing message.

Arguments

Response

true

sb_delete_attachments()

Deletes all attachments of a conversation or message, including the ones stored in AWS S3.

Arguments

Response

true

sb_close_message()

Sends the close message to a user conversation. The close message’ contents can be set in the Settings > Chat > Close message area.

Arguments

Response

{
    "status": "success",
    "message-id": 123456
}

sb_text_formatting_to_html()

Converts the text formatting of chat messages to the equivalent HTML codes and returns the message.

Arguments

Response

Lorem ipsum dolor <b>sit amet</b>, <i>consectetur adipiscing elit</i>, <code>sed</code> do eiusmod tempor incididunt. 

sb_clear_text_formatting()

Removes the text formatting from a chat messages.

Arguments

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt. 

sb_conversation_security_error()

Checks if the active user is authorized to update the conversation. Agents and admins can always update all conversations, users can only update their own conversations.

Arguments

Response

Returns true if the active user is not authorized, otherwise, returns false.

sb_is_active_conversation_busy()

Checks if an agent is replying to a conversation. This function checks if the function sb_set_agent_active_conversation() has been executed for the given conversation by another agent within 2 hours.

Arguments

Response

Returns true if an agent is replying to the conversation.

sb_set_agent_active_conversation()

Notify that an agent is responding to a conversation. The conversation is marked as busy for 2 hours if this function is not executed again by the same agent for another conversation.

Arguments

sb_get_agents_in_conversation()

Returns an array with all the agents with at least one message in the conversation.

Arguments

Response

{
    "1546": [
        {
            "id": 5463,
            "first_name": "Don",
            "last_name": "John",
            "profile_image": "https://smartai.support/user.svg",
            "conversation_id": 1546
        },
        {
            "id": 6413,
            "first_name": "Steven",
            "last_name": "Travolta",
            "profile_image": "https://smartai.support/user.svg",
            "conversation_id": 1546
        }, 
        ...
    ],
    ...
}

sb_update_conversation_agent()

Changes the agent assigned to a conversation or assigns it. This feature also sends notifications to other agents notifying the change, refreshing the chat widget if needed, and triggering the related event.

Arguments

Response

Returns true on success, otherwise returns false.

sb_count_conversations()

Returns the nubmer of conversations with the specified status code.

Arguments

Response

123456

sb_check_conversations_assignment()

Checks if the specified conversations are assigned to the specified agent or department and returns only unassigned conversation IDs.

Arguments

Response

[12, 345, 6, ...]

sb_get_last_agent_in_conversation()

Returns the last agent who answered a conversation.

Arguments

Response

{
   "id": 123,
   "first_name": "Don",
   "last_name": "John",
   "email": "email@example.com",
   "password": "$P$BcCpYeU21wYnXKW2LpJj/F9xRdSmLM/"
}

Returns false the conversation has no replies from agents.

sb_execute_bot_message()

Sends a bot message and returns its content.

Arguments

Response

{
   "message": "Lorem ipsum dolor",
   "attachments": [],
   "id": 123,
   "settings": {
      "active": true,
      "title": "",
      "message": ""
   }
}

ID is the ID of the message that was just created.

PHP API

Database

Functions to read data from the database and to save data in it.

sb_db_get()

Returns the data of a SQL query.

Arguments

Response

The result of the query as a single value or as an array of values. Return SBError if the query is invalid.

sb_db_query()

Runs a SQL query to update the data in the database.

Arguments

Response

Return true, the returns value, or SBError if the query is invalid.

sb_db_escape()

Escapes special characters in a string for use it in an SQL query. Use this function to escape every variable used in a SQL query containing strings without a known value.

Arguments

Response

Returns the escaped string.

sb_db_json_enconde()

Converts an array to JSON and escapes the values for using them in an SQL query. Use this function to convert every variable containing arrays that is used in a SQL query.

Arguments

Response

Returns the converted array.

sb_db_check_connection()

Checks if the database connection is valid or checks if the details provided are valids. All arguments are optional. If an argument is not provided will be used the one provided during the installation.

Arguments

Response

Returns true if the connection is valid, otherwise, returns the connection error message.

PHP API

Language and Translations

Functions to translate strings in other languages and to manage the translations.

sb_()

Translates a string to the active user language. Use the function sb_e($string) to translate and echo the string. Use sb_s to translate a setting and sb_se to translate and echo it.

Arguments

Response

Returns the translated string if available, otherwise, returns the original string.

sb_get_translations()

Returns the translations of the back-end and the front-end, for all the available languages.

Response

{
    "ar": {
        "name": "Arabic",
        "front": {
            "Activities": "أنشطة",
            "All": "الكل",
            ...
        },
        "admin": {
            "A conversation was started by": "",
            "Activate": "",
            ...
        },
        "admin/js": {
            "Add new user": "",
            "Add translation": "",
            ...
        },
        "admin/settings": {
            "Active for agents": "",
            "Active for users": "",
            ...
        }
    },
    "da": {
        "name": "Danish",
        "front": {
            "Activities": "Aktiviteter",
            "All": "Alle",
            ...
        },
        ...
    },
    ...
}

sb_get_translation()

Returns the translations of the back-end and the front-end of a single language.

Response

{
    "name": "Arabic",
    "front": {
        "Activities": "أنشطة",
        "All": "الكل",
        ...
    },
    "admin": {
        "A conversation was started by": "",
        "Activate": "",
        ...
    },
    "admin/js": {
        "Add new user": "",
        "Add translation": "",
        ...
    },
    "admin/settings": {
        "Active for agents": "",
        "Active for users": "",
        ...
    }
}

sb_save_translations()

Saves the translations and overwrites the translations files. Warning! If the given translations array is corrupted you could corrupt the translations files. Make a backup of the translations folder (\resources\languages\) first. Each time a translation is saved a backup is created automatically in the uploads folder.

Arguments

Response

true

sb_get_user_language()

Returns the active language code used by the user. By default, it’s the user browser language.

Arguments

Response

The two-digit language code. Examples: es, it.

sb_get_admin_language()

Returns the language code of the admin area relative to the active user.

Arguments

Response

Response

The two-digit language code. Examples: es, it.

sb_t()

Translates a string in the language of the specified language code if the translation is available(only for front translations). Otherwise, if the Artificial Intelligence app is active and the multilingual translation setting is enabled, the string will be translated into the user’s language.

Arguments

Response

Returns the translated string, otherwise returns the original string.

PHP API

Settings

Functions related to settings, articles, translations and more.

sb_get_setting()

Returns a setting of the settings area.

Arguments

Response

Returns the value of the setting.

sb_get_settings()

Returns an array with all the settings.

Response

{
    "chat_manual_init": [
        false,
        "checkbox"
    ],
    "chat_login_init": [
        false,
        "checkbox"
    ],
    "init-dashboard": [
        true,
        "checkbox"
    ],
    "chat_timetable_disable": [
        false,
        "checkbox"
    ],
    "rtl": [
        false,
        "checkbox"
    ],
    "front_auto_translations": [
        true,
        "checkbox"
    ],
    ...
}

sb_save_settings()

Saves the chat settings. This function overwrites all settings with the given ones.

Arguments

Response

true

sb_get_multilingual_setting()

Returns the translated value of a multilingual setting.

Arguments

Response

Returns the value of the setting in the specified language if available, otherwise returns the value of the setting in the original language.

sb_get_external_setting()

Returns an external setting. External settings are saved on a dedicated database row.

Arguments

Response

Returns the value of the setting if available, otherwise returns the default value.

sb_save_external_setting()

Saves an external setting. External settings are saved on a dedicated database row.

Arguments

Response

true

sb_get_multi_setting()

Returns a subsetting of another setting.

Arguments

Response

Returns the value of the subsetting if available, otherwise returns the default value.

sb_export_settings()

Exports all SmartAI Support settings to a JSON file and returns the URL of the file.

Response

{
  "success": true,
  "response": "http://example.com/smartaisupport/uploads/settings_855776223.json"
}

sb_import_settings()

Imports the SmartAI Support settings from a JSON file generated via the export-settings function.

Arguments

Response

true

sb_get_departments()

Returns the SmartAI Support departments.

Response

{
    "1": {
        "name": "Example",
        "color": "yellow",
        "image": "https://example.com/image.png"
    },
    "2": {
        "name": "Example",
        "color": "red",
        "image": "https://example.com/image.png"
    },
    ...
}

PHP API

Articles

Article/Knowledge Base functions.

sb_get_articles()

Returns an array with all the articles or a single article.

Arguments

Response

[
    {
        "id": "6P2Oq",
        "title": "What's new with the API V2?p",
        "content": "The API V2 is the new iteration of o ...",
        "link": "https://smartai.support"
        "categories": ["ols85"]
    },
    {
        "id": "qf7kD"
        "title": "Should I move to the new API?",
        "content": "Yes. The newest version (V2) of the Actions ...",
        "link": "https://smartai.support",
        "categories": []
    },
    ...
]

Single article response

{
    "id": "6P2Oq",
    "title": "What's new with the API V2?p",
    "content": "The API V2 is the new iteration of our developer API. The new API integrates...",
    "link": "https://smartai.support",
    "categories": ["ols85"]
}

sb_save_articles()

Saves all the articles. This function replaces all the existing articles with the articles of the given array.

Arguments

Response

true

sb_search_articles()

Returns the articles matching the search.

Arguments

Response

[
    {
        "id": "6P2Oq",
        "title": "What's new with the API V2?p",
        "content": "The API V2 is the new iteration of o ...",
        "link": "https://smartai.support",
        "categories": ["ols85"]
    },
    {
        "id": "qf7kD"
        "title": "Should I move to the new API?",
        "content": "Yes. The newest version (V2) of the Actions ...",
        "link": "https://smartai.support",
        "categories": []
    },
    ...
]

sb_get_articles_categories()

Returns an array with all the articles categories.

Response

[
    {
        "id": "Nv9PG",
        "title": "Business"
    },
    {
        "id": "csPVh",
        "title": "Travel And Tourism"
    },
    {
        "id": "pl5S7",
        "title": "Finance"
    },
    ...
]

sb_save_articles_categories()

Saves or update the articles categories array.

Arguments

Response

true

sb_article_ratings()

Gets the ratings of an article or adds a new rating to it.

Arguments

Response

[-1, 1, 1, -1, ...]

Returns true if the rating argument is set.

PHP API

Pusher

List of functions for Pusher. More details at pusher.com.

sb_push_notification()

Sends a Push notification to an agent, user, or all agents.

Arguments

Response

{
    "publishId": "pubid-781799f5-6el4-4789-bc60-ee293543781"
}

Returns false it the Push notifications are disabled in the settings area.

sb_pusher_trigger()

Triggers an avent on a Pusher channel.

Arguments

Response

true

sb_pusher_get_online_users()

Returns the array of IDs of online users and agents subscribed to the presence channel.

Response

[
    {
        "id": "1538"
    },
    {
        "id": "1758"
    },  
    ...
]

sb_pusher_agents_online()

Checks if there is at least one agent online by checking the presence channel.

Response

true if online, false if offline.

sb_pusher_active()

Checks if Pusher is active in Settings > Miscellneous > Pusher.

Response

true if active, false otherwise.

sb_pusher_init()

Initializes the Pusher PHP SDK.

PHP API

More functions

Various functions that perform different tasks.

sb_email()

Sends an email to an existing user using the email templates, and settings, of the Settings > Notifications area. The email is translated automatically.

Arguments

Response

true

sb_email_send()

Sends a generic email to an email address. The sender email and name are the ones set in Settings > Notifications > Email settings.

Arguments

Response

true

sb_email_piping()

Runs the email piping synchronization with the SmartAI Support and converts emails to chat messages.

Arguments

Response

true

sb_send_sms()

Sends a text message to a user or agent. If the template argument is true, the message is translated automatically.

Arguments

Response

{
    "sid": "SM1f0e8ae6ade43cb3c0ce4525424e404f",
    "date_created": "Fri, 13 Aug 2010 01:16:24 +0000",
    "date_updated": "Fri, 13 Aug 2010 01:16:24 +0000",
    "date_sent": null,
    "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "to": "+15305431221",
    "from": "+15104564545",
    "body": "A Test Message",
    "status": "queued",
    "flags":["outbound"],
    "api_version": "2010-04-01",
    "price": null,
    "uri": "\/2010-04-01\/Accounts\/ACXXXX\/Messages\/SM1f004f.json"
}

sb_send_agents_notifications()

Sends all the agent notifications: email notification, push notification, and SMS notification.

Arguments

Response

true

sb_is_error()

Checks if a variable is of type SBError. Use the method $error->code() to get the error code, the method $result->function_name() to get the function name that generated the error, the method $result->message() to get the error message.

Arguments

Response

Return true if the variable is of type SBError, otherwise, return false.

sb_is_validation_error()

Checks if a variable is of type SBValidationError. Use the method $error->code() to get the error code.

Arguments

Response

Returns true if the variable is of type SBValidationError, otherwise, returns false.

sb_isset()

Checks if an array key exists and returns its value only if it exists and if it isn’t an empty string.

Arguments

Response

Returns the value of the key or the default value.

sb_archive_slack_channels()

Archives all the Slack channels. If you have a lot of channels, this operation may take a long time to complete and you could need to execute it again multiple times. Important: All of your slack channels will be archived. The Slack App is required_.

Response

true

sb_updates_available()

Checks if there are updates available for SmartAI Support and the SmartAI Support apps.

Response

Returns true if at least one update is available, otherwise returns false.

sb_get_versions()

Returns the installed version of SmartAI Support and the Apps.

Response

{
    "sb": "3.0.4",
    "dialogflow": "1.0.2",
    "slack": "1.0.3"
}

sb_update()

Starts the update of SmartAI Support and all the apps. This function forces the update and always overwrite all plugin and apps files.

Response

success

sb_app_get_key()

Returns the License Key of a SmartAI Support App like the Slack App or the Artificial Intelligence app.

Arguments

Response

9300AB16-014ZEE12-91E199EA-997CEX40

sb_app_activation()

Activates an app, downloads it, and installs it.

Arguments

Response

success

sb_csv_users()

Exports all the users in a CSV file and returns the URL.

Arguments

Response

Returns the URL of the CSV file.

sb_transcript()

Exports a conversation in a CSV or TXT file and returns the URL.

Arguments

Response

Returns the URL of the CSV file.

sb_json_array()

Converts a JSON string to an array.

Arguments

Response

Returns a PHP array if the conversion is successful, otherwise, returns the default value.

sb_office_hours()

Checks if the current time is within the office hours.

Response

Return true if the current time is within the office hours, otherwise, returns false.

sb_encryption()

Encrypts a string or decrypts an encrypted string.

Arguments

Response

Returns the encrypted string or the decrypted string.

sb_string_slug()

Converts a string to a slug or a slug to a string. When converting a string to a slug all spaces are converted to – and all chars are in lowercase. When converting a slug to a string all the occurrences of the chat – are converted to spaces and the first chat is in uppercase.

Arguments

Response

Returns the slug or the converted string.

sb_curl()

Sends data to a URL.

Arguments

Response

Returns a PHP array with the data of the JSON array returned by the server.

sb_download()

Returns the data of a URL.

Arguments

Response

Returns the file or the data returned by the server.

sb_download_file()

Downloads a file, saves it in the uploads folder, and returns the URL.

Arguments

Response

Returns the URL of the file saved in the uploads folder.

sb_csv()

Creates a CSV file from an array.

Arguments

Response

Returns the URL of the CSV file. The file is saved into the uploads folder. By default, it’s located in the smartai support plugin folder or in the wp-content/uploads folder if you’re using the WordPress version.

sb_file()

Creates a new file containing the given content and saves it in the destination path.

Arguments

Response

true

sb_clean_data()

This function performs the following tasks: delete visitors older than 24h, delete messages in trash older than 30 days, archive conversation older than 24h with status code equal to 0 or 1 (waiting an answer from the user or without any user reply).

Response

true

sb_cron_jobs()

Runs the cron jobs.

sb_get_shortcode()

Converts a shortcode into an array containing the shortcode name and the shortcode settings.

Arguments

Response

{
    "shortcode": "[rating title="Rate your conversation" message="Tell us your experience." success="Thank you!"]",
    "shortcode_name": "rating",
    "title": "Rate your conversation",
    "message": "Tell us your experience.",
    "success": "Thank you!"
}

sb_cron_jobs()

Checsk the cron jobs and runs them if the date and time matchs the job time.

sb_css()

Returns or echos the CSS style for the chat colors.

Arguments

Response

The CSS code

sb_get_notes()

Returns the internal notes of a conversation.

Arguments

Response

[
    {
        "id": 98207,
        "user_id": "1538",
        "name": "Lorem ipsum dolor sit amet",
        "message": "Lorem ipsum dolor sit amet, consectetur elit, sed do eiusmod tempor incididunt."
    },
    {
        "id": 76986,
        "user_id": "1596",
        "name": "Lorem ipsum dolor",
        "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor."
    },
    ...
]

sb_add_note()

Adds a new internal note.

Arguments

Response

The note ID

sb_delete_note()

Deletes an internal note.

Arguments

Response

true

sb_automations_get()

Returns all automations.

Response

[
    {
        "emails": [
            {
                "id": "0BOaG",
                "conditions": [
                    [
                        "datetime",
                        "is-between",
                        "10/04/2021 - 13/04/2021"
                    ],
                    [
                        "include_urls",
                        "contains",
                        "https://example.com"
                    ],
                    ...
                ],
                "name": "Excepteur sint",
                "message": "Excepteur sint occaecat cupidatat non proident.",
                "subject": "Cupidatat non proident"
            },
            ...
        ],
        "sms": [
            {
                "id": "vo2sY",
                "conditions": [
                    [
                        "datetime",
                        "is-exactly",
                        "13/04/2021"
                    ]
                ],
                "name": "Excepteur sint",
                "message": "Excepteur sint occaecat cupidatat non caecat cupidatat non proident"
            },
            {
                "id": "hwkmQ",
                "name": "Excepteur sint occaecat cupidatat non proident",
                "message": "Excepteur sint occaecat cupidatat non  occaecat cupidatat non proident"
            },
            ...
        ],
        "messages": [],
        "popups": [
            {
                "id": "ckN24",
                "conditions": [
                    [
                        "user_type",
                        "is-user"
                    ],
                    [
                        "languages",
                        "en"
                    ]
                ],
                "name": "s",
                "message": "Excepteur sint occaecat cupidatat non prcaecat cupidatat non proident",
                "title": "Excepteur sint occaecat",
                "profile_image": "https://example.com/image.jpg"
            },
            ...
        ],
        "design": [
            {
                "id": "bX1qA",
                "conditions": [
                    [
                        "user_type",
                        "is-user"
                    ]
                ],
                "name": "Excepteur sint",
                "message": "Excepteur sint occaecat cupidatat caecat cupidatat non proident",
                "title": "",
                "color_1": "rgb(0, 235, 26)",
                "color_2": "rgb(255, 0, 0)",
                "color_3": "rgb(255, 0, 0)",
                "background": "https://example.com/image.jpg",
                "brand": "https://example.com/image.jpg",
                "icon": "https://example.com/image.jpg"
            },
            ...
        ]
    },
    {
        "fr": {
            "messages": [
                {
                    "id": "y6hNE",
                    "name": "XXXX",
                    "message": "XXXX"
                }
            ]
        },
        ...
    }
]

sb_automations_save()

Saves all automations.

Arguments

Response

true

sb_automations_validate()

Validates an automations.

Arguments

Response

 {
      "conditions": [
          [
              "user_type",
              "is-user"
          ],
          ...
      ],
      "repeat_id": ""
  }

Returns only the client-side conditions and invalid server-side conditions that can be validated in a later time. If no conditions are returned, the automation is valid and can be executed. Returns false if the automation is invalid.

sb_automations_run_all()

Validates all automations, executes the valid ones, and returns the automations with client-side conditions, invalid server-side conditions, and popup, design automations.

Response

[
    {
        "id": "0BOaG",
        "conditions": [
            [
                "datetime",
                "is-between",
                "10/04/2021 - 13/04/2021"
            ],
            [
                "include_urls",
                "contains",
                "https://example.com"
            ],
            ...
        ],
        "name": "Excepteur sint",
        "message": "Excepteur sint occaecat cupidatat non proident.",
        "subject": "Cupidatat non proident",
        "type": "emails"
    },
    {
        "id": "bX1qA",
        "conditions": [
            [
                "user_type",
                "is-user"
            ]
        ],
        "name": "Excepteur sint",
        "message": "Excepteur sint occaecat cupidatat caecat cupidatat non proident",
        "title": "",
        "color_1": "rgb(0, 235, 26)",
        "color_2": "rgb(255, 0, 0)",
        "color_3": "rgb(255, 0, 0)",
        "background": "https://example.com/image.jpg",
        "brand": "https://example.com/image.jpg",
        "icon": "https://example.com/image.jpg",
        "type": "design"
    },
    ...
]

sb_automations_run()

Executes a single automation and optionally validates it before executing it.

Arguments

Response

true

sb_automations_is_sent()

Checks if an automation has already been sent to a user.

Arguments

Response

Returns true if the automation has already been sent, otherwise returns false.

sb_newsletter()

Adds a subscriber to the newsletter service set in Settings > Miscellaneous > Newsletter. The setting Settings > Miscellaneous > Newsletter > Active must be active.

Arguments

Response

Returns the newsletter service response.

sb_upload_path()

Returns the SmartAI Support uploads path.

Arguments

Response

\var\www\htdocs\smartaisupport\uploads\10-03-23

 https://www.example.com/smartaisupport/uploads/10-03-23

sb_is_allowed_extension()

Checks if uploading files with the specified file extension is allowed.

Arguments

Response

Returns true if the extension is allowed, otherwise returns false.

sb_debug()

Saves a message in a log file saved in the same directory as the PHP file calling this function. Each call to this function adds the message to the existing contents of the log.

Arguments

sb_system_requirements()

Checks if the host machine supports the SmartAI Support system requirements.

Response

{
      "php-version": true,
      "zip-archive": true,
      "plugin-folder": true,
      "uploads-folder": true,
      "apps-folder": true,
      "languages-folder": true,
      "ajax": true,
      "curl": true,
      "UTF8mb4": true
  }

sb_logs()

Adds a log message to the log file.

Arguments

Response

true

sb_aws_s3()

Uploads a file to Amazon S3, or deletes a file from Amazon S3. Amazon S3 must be active and configured at Settings > Miscellaneous > Amazon S3.

Arguments

Response

 https://example.s3.amazonaws.com/example.txt

Returns the URL of the Amazon S3 file.

sb_reports()

Returns the the specified reports.

Parameters

Response

{
   "title": "Conversations count",
   "description": "Count of new conversations started by users.",
   "data": {
       "03/2021": [
           2
       ],
       "04/2021": [
           0
       ],
       "05/2021": [
           0
       ],
       ...
   },
   "table": [
       "Date",
       "Count"
   ],
   "table-inverse": true,
   "label_type": 1,
   "chart_type": "line"
}  

sb_reports_update

Adds a new row to the sb_reports database table.

Parameters

Response

{
    "success": true,
    "response": true
}

sb_reports_export()

Export a report in CSV format.

Parameters

Response

Returns the URL of the exported report.

PHP API

Dialogflow

Dialogflow

Artificial Intelligence app functions to manage the chatbot and more. The Artificial Intelligence app is required to use this set of APIs.

sb_dialogflow_message()

Sends a message to Dialogflow and add the Dialogflow response to an existing conversation as a new message.

Arguments

Response

{
    "token": "ya29.a0AfH6SMB5Y04TwKvxeah5pCEtcupfncTOLMlewxlnUAhH5H4HE4SVIeOPWSfxRVfHNcJIoR-IvRTtrEe4P9VXHa",
    "messages": [
        {
            "message": "Hi! How are you doing?",
            "attachments": []
        }
    ],
    "response": {
        "responseId": "1a5e30d0-d6d4-4f0c-83e3-2fb9e31c2a5e-e15c53b8",
        "queryResult": {
            "queryText": "Hello",
            "action": "input.welcome",
            "parameters": [],
            "allRequiredParamsPresent": true,
            "fulfillmentText": "Hi! How are you doing?",
            "fulfillmentMessages": [
                {
                    "platform": "ACTIONS_ON_GOOGLE",
                    "simpleResponses": {"simpleResponses": [ { "textToSpeech": "Example"} ]}
                },
                {
                    "text": { "text": [ "Hi! How are you doing?" ]  }
                }
            ],
            "intent": {
                "name": "projects/api-project-655517752147/agent/intents/fe275c2e-f39d-4db3-92c2-e55582ce38fb",
                "displayName": "Default Welcome Intent"
            },
            "intentDetectionConfidence": 1,
            "languageCode": "en"
        },
        "alternativeQueryResults": [
            {
                "queryText": "Hello",
                "languageCode": "en"
            }
        ]
    }
}

Other possible responses: dialogflow-not-active, SQL, or cURL error message.

sb_dialogflow_curl()

Sends data to Dialogflow. Use this function to submit the queries to Dialogflow.

Arguments

Response

Returns the Dialogflow response in associative array format. More details at https://cloud.google.com/dialogflow/es/docs/reference/rest/v2-overview

sb_dialogflow_get_token()

Generates a new Dialogflow Token and returns it. The token is valid for 1 hour.

Response

ya27.a1AfH6SMDu9dn0TfRbNVAIEsSoeJPD1_jr1JpfL15...

sb_dialogflow_get_agent()

Returns the details of the Dialogflow agent.

Response

{
    "parent": "projects/woocommerce-abcde",
    "displayName": "ABCDE",
    "defaultLanguageCode": "en",
    "timeZone": "Europe/Madrid",
    "enableLogging": true,
    "matchMode": "MATCH_MODE_HYBRID" ,
    "classificationThreshold": 0.6,
    "apiVersion": "API_VERSION_V2",
    "tier": "TIER_STANDARD"
}

sb_dialogflow_set_active_context()

Activates a Dialogflow context in the active user session.

Arguments

Response

{
   "responseId": "4f6912db-71ac-41e1-b006-088b7647cb59-fddac234",
   "queryResult":{
      "queryText": "sb-trigger-context",
      "parameters":{
         "any": "sb-trigger-context"
      },
      "allRequiredParamsPresent":true,
      "fulfillmentMessages":[
         {
            "text":{
               "text":[
                  ""
               ]
            }
         }
      ],
      "outputContexts":[
         {
            "name": "projects/abcde/agent/sessions/244/contexts/abcde",
            "lifespanCount":1,
            "parameters":{
               "woocommerce-products": "",
               "any": "sb-trigger-context",
               "any.original": "sb-trigger-context"
            }
         }
      ],
      "intent":{
         "name": "projects/abcd/agent/intents/abcde",
         "displayName": "woocommerce-waiting-list"
      },
      "intentDetectionConfidence":0.6,
      "languageCode": "en"
   }
}

sb_dialogflow_create_intent()

Creates a new Dialogflow Intent. The Intent will be linked to the Dialogflow agent synchronized in the admin area.

Arguments

sb_dialogflow_batch_intents()

Creates multiple Dialogflow Intents and allow a deeper customization than the sb_dialogflow_create_intent() function.

Arguments

Response

{
   "name": "projects/woocommerce-app-rojq/operations/bg-f0adhdc5-a1a1-472b-a06c-15559a12cfc7",
   "done":true,
   "response":{
      "@type": "type.googleapis.com/google.cloud.dialogflow.v2.BatchUpdateIntentsResponse",
      "intents":[
         {
            "name": "projects/abcde/agent/intents/abcde",
            "displayName": "Cart details",
            "priority":500000,
            "outputContexts":[
               {
                  "name": "projects/abcde/agent/sessions/-/contexts/abcde",
                  "lifespanCount":5
               }
            ],
            "messages":[
               {
                  "text":{
                     "text":[
                        "Hi there!"
                     ]
                  }
               }
            ]
         },
         ...
      ]
   }
}

sb_dialogflow_batch_intents_delete()

Deletes multiple Intents at once.

Arguments

sb_dialogflow_create_entity()

Creates a new Dialogflow Entity.

Arguments

Response

Returns true on success, otherwise returns the Dialogflow error response.

sb_dialogflow_update_entity()

Updates an existing Dialogflow Entity.

Arguments

Response

Return true on success, otherwise returns the Dialogflow error response.

sb_dialogflow_get_entity()

Returns a Dialogflow Entity, or all Entities of the agent.

Arguments

Response

[
   {
      "name": "projects/small-talk-43da7/agent/entityTypes/t5td1425-2k13-16cc-a7bb-f119b8d94112a",
      "displayName": "woocommerce-products",
      "kind": "KIND_MAP",
      "autoExpansionMode": "AUTO_EXPANSION_MODE_DEFAULT",
      "entities":[
         {
            "value": "Abstract Print Cotton Blouse",
            "synonyms":[
               "Abstract Print Cotton Blouse"
            ]
         },
         {
            "value": "Cashmere Carpenter Beanie",
            "synonyms":[
               "Cashmere Carpenter Beanie"
            ]
         },
         ...
      ],
      "enableFuzzyExtraction":true
   }
]

sb_open_ai_curl()

Calls the OpenAI API (ChatGPT) and return the response.

Arguments

Response

Returns the openAI response. More details at https://beta.openai.com/docs/api-reference/.

PHP API

WordPress

WordPress functions.

sb_wp_get_user()

Returns the details of a WordPress user.

Arguments

Response

{
   "id": 123,
   "first_name": "Don",
   "last_name": "John",
   "email": "email@example.com",
   "password": "$P$BcCpYeU21wYnXKW2LpJj/F9xRdSmLM/"
}

Returns false if no user was found.

sb_wp_get_active_user()

Gets the currently active WordPress user and register it as a SmartAI Support user. If a SmartAI Support user is currently active, update it with the WordPress details. After the registration the user is logged-in. Returns the login details and encrypted data of the SmartAI Support user.

Arguments

Response

[
   {
       "id": "913",
       "profile_image": "https://smartai.support/user.svg",
       "first_name": "User",
       "last_name": "#29902",
       "email": null,
       "user_type": "visitor",
       "token": "9b25351047ee758aa97ee4868d130cc1ceb8decf"
   },
   "YXNkWGNSeTdtRTdDYVkxVG8wckN4YWF6V2s0Tk1mczBSVHdQbHBpOWdmejVUTTdOUUxEUENhdUVoYmROWn..."
                                ]

sb_wp_synch()

Syncronizes the WordPress users with the SmartAI Support users. If Ultimate Membership Pro App is installed, the syncronization imports also the additional users details.

Response

true

sb_wp_get_user_id()

Returns the user ID of the WordPress user with the given email.

Arguments

Response

1234

Returns false if no user was found.

sb_wp_post()

Saves a new WordPress post (page, post, …). This function is equivalent to wp_insert_post().

Arguments

Response

Returns the ID of new post.

sb_wp_update_option()

Creates or update a WordPress option. This function is equivalent to update_option().

Arguments

Response

Returns the ID of new option.

sb_wp_get_option()

Returns the value of a WordPress option. This function is equivalent to get_option().

Arguments

Response

Returns the option value, or false if no option with given name was found.

sb_wp_get_image()

Returns the URL of the image with the given ID. This function is equivalent to wp_get_attachment_image_src().

Arguments

Response

https://example.com/image.jpg

Returns an empty string if no image with the given ID was found.

sb_wp_site_url()

Returns the website URL.

Response

https://www.example.com

sb_wp_language_settings()

Returns the languages settings of WordPress.

Arguments

Response

{
    "default": "en",
    "languages": [
        "en",
        "de",
        "it"
    ],
    "post-types": [
        "attachment",
        "wp_block",
        "product",
        "product_variation",
        "food",
        "post",
        "page"
    ],
    "taxonomies": [
        "translation_priority",
        "product_cat",
        "product_tag",
        "product_shipping_class",
        "pa_colore-prodotti",
        "pa_taglia-prodotti",
        "category",
        "post_tag"
    ],
    "link-type": "3",
    "plugin": "wpml"
}

sb_wp_language_get_page_id()

Returns the translated page ID of the given page ID.

Arguments

Response

Returns the translated page ID if the translation is found, otherwise returns the given ID.

PHP API

WooCommerce

WooCommerce App functions. The WooCommerce App is required to use this set of APIs.

sb_woocommerce_get_customer()

Returns the details of a WooCommerce customer.

Arguments

Response

{
   "customer_id": "1",
   "user_id":null,
   "username": "",
   "first_name": "Don",
   "last_name": "John",
   "email": "email@example.com",
   "date_last_active": "2020-08-03 07:21:18",
   "date_registered":null,
   "country": "UK",
   "postcode": "E14HR",
   "city": "London",
   "state": ""
}

sb_woocommerce_get_user_orders()

Returns an array with the orders summary of the user. Use the function sb_woocommerce_get_last_order() to get only the last order of the user.

Arguments

Response

[
    {
        "id": "602",
        "date": "2020-10-19 14:02:35",
        "total": "0",
        "status": "wc-on-hold",
    },
    {
        "id": "601",
        "date": "2020-10-18 14:02:35",
        "total": "0",
        "status": "wc-processing",
    },
    ...
]

Returns the details of an order.

Arguments

Response

{
    "id": "601",
    "date": "2020-10-19 14:02:10",
    "total": "19",
    "status": "wc-on-hold",
    "products": [
        {
            "name": "Sony Play Station 5",
            "id": "53",
            "quantity": "1",
            "price": "199"
        }
    ],
    "billing_address": "Don John\\n501 Baker Street\\nEW578H London, UK",
    "shipping_address": "",
    "currency_symbol": "€"
}

sb_woocommerce_get_product()

Returns the details of a product.

Arguments

Response

{
    "id": "53",
    "name": "Sony Play Station 5",
    "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elite...",
    "price": "19",
    "image": "https://example.com/image.jpg",
    "rating": "",
    "url": "https://example.com/?p=53"
}

sb_woocommerce_get_products()

Returns the products matching the given query if any, otherwise returns all products.

Arguments

Response

[
    {
        "id": "53",
        "name": "Sony Play Station 5",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elite...",
        "date": "2020-08-03 07:06:25",
        "price": "19",
        "image": "https://example.com/image.jpg",
        "rating": "",
        "url": "https://example.com?p=53"
    },
    {
        "id": "54",
        "name": "Xbox Series X",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elite...",
        "date": "2020-08-03 07:08:19",
        "price": "59",
        "image": "https://example.com/image.jpg",
        "rating": "",
        "url": "https://example.com?p=54"
    },
    ...
]

sb_woocommerce_search_products()

Returns the products matching the search.

Arguments

Response

[
    {
        "id": "53",
        "name": "Sony Play Station 5",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elite...",
        "date": "2020-08-03 07:06:25",
        "price": "19",
        "image": "https://example.com/image.jpg",
        "rating": "",
        "url": "https://example.com?p=53"
    },
    {
        "id": "54",
        "name": "Xbox Series X",
        "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elite...",
        "date": "2020-08-03 07:08:19",
        "price": "59",
        "image": "https://example.com/image.jpg",
        "rating": "",
        "url": "https://example.com?p=54"
    },
    ...
]

sb_woocommerce_get_taxonomies()

Returns the WooCommerce product categories or tags.

Arguments

Response

[
    {
        "id": "33",
        "name": "Clothes",
        "slug": "clothes"
    },
    {
        "id": "34",
        "name": "Accessories",
        "slug": "accessories"
    },
    ...
]

sb_woocommerce_get_attributes()

Returns the WooCommerce product attributes and attribute terms.

Arguments

Response

All

{
    "colors": {
        "id": "1",
        "name": "Color",
        "slug": "pa_color",
        "terms": {
            "red": "Red",
            "yellow": "Yellow",
            "green": "Green",
            ...
        }
    },
    ...
}

Terms

[
    {
        "name": "Red"
    },
    {
        "name": "Yellow"
    },
    {
        "name": "Small"
    },
    {
        "name": "Medium"
    },
    {
        "name": "Large"
    },
    ...
]

Attributes

[
    {
        "id": "1",
        "name": "Color",
        "slug": "pa_color"
    },
    {
        "id": "2",
        "name": "Size",
        "slug": "pa_size"
    },
    ...
]

sb_woocommerce_get_product_id_by_name()

Searches a product by name and returns its ID.

Arguments

Response

Returns the product ID, or false if no products with the given name are found.

sb_woocommerce_get_product_images()

Returns an array with the images of a product.

Arguments

Response

[
    "https://example.com/image.jpg",
    "https://example.com/image.jpg",
    ...
]

sb_woocommerce_get_product_taxonomies()

Returns the categories and tags of a product.

Arguments

Response

[
    {
        "term_id": "34",
        "name": "Red",
        "slug": "red",
        "term_group": "0",
        "taxonomy": "product_cat"
    },
    {
        "term_id": "35",
        "name": "Summer Edition",
        "slug": "summer-edition",
        "term_group": "0",
        "taxonomy": "product_tag"
    },
    ...
]

sb_woocommerce_get_attribute_by_term()

Returns the attribute of an attribute term.

Arguments

Response

{
    "id": "1",
    "name": "Color",
    "slug": "pa_color"
}

sb_woocommerce_get_attribute_by_name()

Searches an attribute by its name and returns it.

Arguments

Response

{
    "id": "1",
    "name": "Color",
    "slug": "pa_color"
}

sb_woocommerce_is_in_stock()

Checks if a product is in stock.

Arguments

Response

Return true if the product is available, otherwise return false.

sb_woocommerce_coupon()

Generates a coupon and returns the coupon code.

Arguments

Response

[ "fxsocl3490oq", "50" ]

[ coupon code, discount value ]

sb_woocommerce_coupon_check()

Checks if there are coupons linked to the given user.

Arguments

Response

Returns true if there are coupons linked to the user, otherwise returns false.

sb_woocommerce_coupon_delete_expired()

Deletes all expired coupons. This function runs automatically every hour via cron jobs.

Response

true

sb_woocommerce_rating()

Calculates and returns the average rating.

Arguments

Response

4.56

sb_woocommerce_get_url()

Returns a WooCommerce URL.

Arguments

Response

Returns the URL if found, otherwise returns an empty string.

sb_woocommerce_get_session()

Returns the session variable of a user. The session variable contains the user cart details and more.

Arguments

Response

{
    "cart": {
        "d82c8d1619ah8176d665453cfb2e66f0": {
            "key": "d82c8d1619ah8176d665453cfb2e66f0",
            "product_id": 53,
            "variation_id": 0,
            "variation": [],
            "quantity": 3,
            "data_hash": "b5c1d6ca8bae6d4896jf1807cdf713f0",
            "line_tax_data": {
                "subtotal": [],
                "total": []
            },
            "line_subtotal": 57,
            "line_subtotal_tax": 0,
            "line_total": 57,
            "line_tax": 0
        }
    },
    "cart_totals": {
        "subtotal": "57.00",
        "subtotal_tax": 0,
        "shipping_total": "0.00",
        "shipping_tax": 0,
        "shipping_taxes": [],
        "discount_total": 0,
        "discount_tax": 0,
        "cart_contents_total": "57.00",
        "cart_contents_tax": 0,
        "cart_contents_taxes": [],
        "fee_total": "0.00",
        "fee_tax": 0,
        "fee_taxes": [],
        "total": "57.00",
        "total_tax": 0
    },
    "applied_coupons": "a:0:{}",
    "coupon_discount_totals": "a:0:{}",
    "coupon_discount_tax_totals": "a:0:{}",
    "removed_cart_contents": "a:0:{}",
    "customer": {
        "id": "1",
        "date_modified": "2020-08-20T09:33:03+00:00",
        "postcode": "",
        "city": "",
        "address_1": "",
        "address": "",
        "address_2": "",
        "state": "",
        "country": "",
        "shipping_postcode": "",
        "shipping_city": "",
        "shipping_address_1": "",
        "shipping_address": "",
        "shipping_address_2": "",
        "shipping_state": "",
        "shipping_country": "",
        "is_vat_exempt": "",
        "calculated_shipping": "",
        "first_name": "",
        "last_name": "",
        "company": "",
        "phone": "",
        "email": "",
        "shipping_first_name": "",
        "shipping_last_name": "",
        "shipping_company": ""
    }
}

sb_woocommerce_get_session_key()

Returns the session key of a user.

Arguments

Response

Returns the session key if found, otherwise returns false.

sb_woocommerce_payment_methods()

Returns the available payment methods of the shop.

Response

[
    "Direct bank transfer",
    "Check payments",
    "Cash on delivery",
    "Alipay",
    "Multibanco",
    "Credit Card (Stripe)"
]

sb_woocommerce_shipping_locations()

Returns the shop shipping locations, or checks if the shop ships to a specific location.

Arguments

Response

[
    "Australia, Italy, United States, ...",
    [
        [
            "Australia",
            "AU"
        ],
        [
            "Italy",
            "IT"
        ],
        [
            "United States",
            "US"
        ],
        ...
    ],
    false
]

The last array value is true if the shop does not ship to the returned countries.

Artificial Intelligence #

5

• Installation
• Human takeover
• Smart reply
• Optimal configuration
• Problems?

Conversations #

5

• 💬 Managing Conversations
• Text Editor
• 💬 Using Rich Messages in SmartAI
• 🧠 Built-in Messages in SmartAI
• 📎 Sending & Managing Attachments in SmartAI

Getting Started #

3

• 🚀 Getting Started with SmartAI.Support
• ✅ Best Practices for Using SmartAI.Support
• 🛠 Need Help? We’re Here for You

Google #

9

• Synchronization
• Dialogflow
• Dialogflow Chatboat
• Actions
• Dialogflow fulfillment

Explore More

Integrations #

4

• API
• PHP API
• JAVASCRIPT API
• Use cases

LINE #

2

• Installation
• More Informations

Messenger #

3

• Installation
• Instagram
• More Information

OpenAI #

7

• 🔄Synchronization
• 🤖 Chatbot Setup
• ⚙️ AI Settings Overview
• 📚 Chatbot Training Guide
• ❓ Q&A

Explore More

Perfex #

1

• Installation

Frequently Asked Questions #

Find the answers #

• How Can I Create a Chatbot for My Help Desk?

  Utilize knowledge base software and integrate it with an AI chatbot platform. This combination allows you to create an interactive chatbot that assists users 24/7.

• What Is GPT (Generative Pre-trained Transformer)?

  GPT is a type of AI model that uses deep learning to generate human-like text. It can be used for chatbots, content creation, and more.

• How Can I Optimize My FAQ Page Using Knowledge Base Software?

  Leverage knowledge base software to organize and manage your FAQ content effectively. Categorize questions, provide clear answers, and keep the information up-to-date.

• Is Help Desk Software Safe?

  Yes, modern help desk software, including AI-powered solutions, prioritizes security. Ensure that your chosen software complies with industry standards and protects user data.

• What Role Does NLP Play in AI Chatbots?

  Natural Language Processing (NLP) enables chatbots to understand and respond to user queries in a human-like manner. It processes and interprets natural language, making interactions more intuitive and effective.

• How Does AI Improve Customer Support?

  AI chatbots work alongside FAQ pages to direct users to relevant information quickly. These chatbots learn from each interaction, becoming better at providing accurate answers over time. By integrating AI, you enhance user experience and allow your help desk support team to focus on more complex issues.

• What is an AI-Enabled Help Desk?

  An AI-enabled Help Desk combines artificial intelligence (AI) technology with customer support to provide efficient and timely assistance. It uses chatbots, natural language processing (NLP), and knowledge base software to address common queries and streamline user interactions.

Artificial Intelligence #

5

• Installation
• Human takeover
• Smart reply
• Optimal configuration
• Problems?

Conversations #

5

• 💬 Managing Conversations
• Text Editor
• 💬 Using Rich Messages in SmartAI
• 🧠 Built-in Messages in SmartAI
• 📎 Sending & Managing Attachments in SmartAI

Getting Started #

3

• 🚀 Getting Started with SmartAI.Support
• ✅ Best Practices for Using SmartAI.Support
• 🛠 Need Help? We’re Here for You

Google #

9

• Synchronization
• Dialogflow
• Dialogflow Chatboat
• Actions
• Dialogflow fulfillment

Explore More

Integrations #

4

• API
• PHP API
• JAVASCRIPT API
• Use cases

LINE #

2

• Installation
• More Informations

Messenger #

3

• Installation
• Instagram
• More Information

OpenAI #

7

• 🔄Synchronization
• 🤖 Chatbot Setup
• ⚙️ AI Settings Overview
• 📚 Chatbot Training Guide
• ❓ Q&A

Explore More

Perfex #

1

• Installation

Frequently Asked Questions #

Find the answers #

• How Can I Create a Chatbot for My Help Desk?

  Utilize knowledge base software and integrate it with an AI chatbot platform. This combination allows you to create an interactive chatbot that assists users 24/7.

• What Is GPT (Generative Pre-trained Transformer)?

  GPT is a type of AI model that uses deep learning to generate human-like text. It can be used for chatbots, content creation, and more.

• How Can I Optimize My FAQ Page Using Knowledge Base Software?

  Leverage knowledge base software to organize and manage your FAQ content effectively. Categorize questions, provide clear answers, and keep the information up-to-date.

• Is Help Desk Software Safe?

  Yes, modern help desk software, including AI-powered solutions, prioritizes security. Ensure that your chosen software complies with industry standards and protects user data.

• What Role Does NLP Play in AI Chatbots?

  Natural Language Processing (NLP) enables chatbots to understand and respond to user queries in a human-like manner. It processes and interprets natural language, making interactions more intuitive and effective.

• How Does AI Improve Customer Support?

  AI chatbots work alongside FAQ pages to direct users to relevant information quickly. These chatbots learn from each interaction, becoming better at providing accurate answers over time. By integrating AI, you enhance user experience and allow your help desk support team to focus on more complex issues.

• What is an AI-Enabled Help Desk?

  An AI-enabled Help Desk combines artificial intelligence (AI) technology with customer support to provide efficient and timely assistance. It uses chatbots, natural language processing (NLP), and knowledge base software to address common queries and streamline user interactions.