Download the PHP package brandchat/api-php without Composer
On this page you can find all versions of the php package brandchat/api-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download brandchat/api-php
More information about brandchat/api-php
Files in brandchat/api-php
Package api-php
Short Description PHP client library for the BrandChat API
License MIT
Homepage https://github.com/brandchat/api-php
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-php
BrandChat API Client PHP implementation
Requirements
- PHP >= 5.5
- Guzzle
Help and docs
Installing
The recommended way to install the BrandChat API client is through Composer.
Next, run the Composer command to install the latest stable version of the BrandChat API:
You can then later update the BrandChat API using composer:
Quickstart guide
Configuring the framework
Before using the BrandChatApi framework, you need to initialise it with your bot's api key and bot identifier. Both of these can be found on the BrandChat dashboard menu for your bot after enabling the API for your bot.
Processing inbound events
Ensure that you've initialised the framework as above. Then, to handle an incoming event, register one or more handlers for different event types. In the following example, we'll handle inbound text messages, and send a reply to the user with "Hello world!"
Notes:
- You need to register at least one event handler, otherwise the framework will generate an exception.
- The relevant event handler will be called once you invoke the
run()method on theBrandChatApiinstance. - If the event was of a type without a registered event handler, nothing will happen.
- The code sample above would typically be contained in your controller for the route which you register as the callback URL on the BrandChat API dashboard.
- As you can see in the snippet, it's possible to respond immediately to (subscribe and message) events with one or more messages back to the user.
Sending a message
As before, please ensure that you have initialised the framework. Then, provided you have the user ID for a valid user (e.g. obtained from a previous inbound event), you can send a message to the user later.
In general, the preferred way to send messages to the user is by responding with one or more messages to a message event (as per Processing inbound events example above).
Sending messages asynchronously should only be done if:
- it will take several seconds or longer to respond to an inbound message event, or
- you want to send a message to a user later that isn't directly triggered by a message from a user.
Please note that different messaging platforms have different rules about asynchronous messages to users. WeChat, for example, only allows them in a 48 hour window since the user's last interaction with your bot. Facebook narrows that interaction window to 24 hours for most bots.
Web authentication
As always, please ensure that you have initialised the framework. Then, on the web route you've configured for authenticated web access as per the documentation, get the one-time code that is passed through, and use it to retrieve the user's profile. The following example assumes that you've configured your URL to pass through the one-time code in the code parameter of the query string.
Happy coding!
