Download the PHP package apimaticsupport/conversationsapi without Composer

Getting started

Introduction

Send messages using unifonic’s Conversations API. Message your target audience over social channels (WhatsApp for Business, Messenger, SMS, etc..).

Unifonic conversations API Restful and HTTP API's uses The basic Authentication protocol. All request and response bodies are formatted in JSON.

Get an account

To start using the API you need to send an email [email protected] to create an account for you.

Base URL

All URLs referenced in the documentation have the following base: apis.unifonic.com

Security

To ensure privacy, we recommend you to use HTTPS for all unifonic API requests.

Formats

conversations API only supports JSON format. All requests must use the Content-type header set to application/json.

Support

We’re here to help! Get in touch with support at [email protected] and we’ll get back to you as soon as we can or you can contact us throw live chat on our [website] (www.unifonic.com).

How to Build

The generated code has dependencies over external libraries like UniRest. These dependencies are defined in the file that comes with the SDK. To resolve these dependencies, we use the Composer package manager which requires PHP greater than 5.3.2 installed in your system. Visit https://getcomposer.org/download/ to download the installer file for Composer and run it in your system. Open command prompt and type . This should display the current version of the Composer installed if the installation was successful.

• Using command line, navigate to the directory containing the generated files (including ) for the SDK.
• Run the command . This should install all the required dependencies and create the directory in your project directory.

[For Windows Users Only] Configuring CURL Certificate Path in php.ini

CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:

1. Download the certificate bundle (.pem file) from https://curl.haxx.se/docs/caextract.html on to your system.
2. Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.

How to Use

The following section explains how to use the ConversationsAPI library in a new project.

1. Open Project in an IDE

Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Click on in PhpStorm to browse to your generated SDK directory and then click .

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Name the directory as "test"

Add a PHP file to this project

Name it "testSDK"

Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.

It is important that the path inside require_once correctly points to the file inside the vendor directory created during dependency installations.

After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

3. Run the Test Project

To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.

Open from menu.

Select from within

Browse for Interpreters near the option and choose your interpreter.

Once the interpreter is selected, click

To run your project, right click on your PHP file inside your Test project and click on

How to Test

Unit tests in this SDK can be run using PHPUnit.

1. First install the dependencies using composer including the require-dev dependencies.
2. Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

API client can be initialized as following.

Class Reference

List of Controllers

• OutboundMessagesController
• WhatsappOutboundTemplateMessageController
• WhatsappOutboundSessionMessageController

OutboundMessagesController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

sendMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

Back to List of Controllers

WhatsappOutboundTemplateMessageController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

sendTemplateTextMessage

This API works only with WhatsApp channel, it allows you to check whether a phone number has an active WhatsApp account or not. This end API allows you to implement call center IVR to WhatsApp deflection.

Parameters

Example Usage

Errors

Back to List of Controllers

WhatsappOutboundSessionMessageController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

sendTextSessionMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

sendImageSessionMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

sendVideoSessionMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

sendAudioSessionMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

sendFileSessionMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

sendContactsSessionMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

sendLocationSessionMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

sendListMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

sendReplyButtonMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

sendProductMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

sendProductListMessage

This endpoint allows you to send a message across any of our conversations channels, supported messages types can be found under the Structures section.

Parameters

Example Usage

Errors

Back to List of Controllers