PHPackages                             messente/messente-api-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [HTTP & Networking](/categories/http)
4. /
5. messente/messente-api-php

ActiveLibrary[HTTP & Networking](/categories/http)

messente/messente-api-php
=========================

\[Messente\](https://messente.com) is a global provider of messaging and user verification services. \* Send and receive SMS, Viber and WhatsApp messages. \* Manage contacts and groups. \* Fetch detailed info about phone numbers. \* Blacklist phone numbers to make sure you're not sending any unwanted messages. Messente builds \[tools\](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.

3.5.0(4mo ago)6132.9k—4.8%61unlicensePHPPHP >=7.1CI passing

Since Apr 24Pushed 2mo ago5 watchersCompare

[ Source](https://github.com/messente/messente-api-php)[ Packagist](https://packagist.org/packages/messente/messente-api-php)[ Docs](https://messente.com)[ RSS](/packages/messente-messente-api-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (2)Versions (45)Used By (1)

Messente API Library
====================

[](#messente-api-library)

- Messente API version: 2.0.0
- PHP artifact version: 3.5.0

[Messente](https://messente.com) is a global provider of messaging and user verification services. \* Send and receive SMS, Viber and WhatsApp messages. \* Manage contacts and groups. \* Fetch detailed info about phone numbers. \* Blacklist phone numbers to make sure you're not sending any unwanted messages. Messente builds [tools](https://messente.com/documentation) to help organizations connect their services to people anywhere in the world.

Installation
------------

[](#installation)

Install Messente API library with `composer require messente/messente-api-php`.

Features
--------

[](#features)

Messente API has the following features:

- Omnichannel ([external docs](https://messente.com/documentation/omnichannel-api)),
- Phonebook ([external docs](https://messente.com/documentation/phonebook-api)).

Messente API Library provides the operations described below to access the features.

### AccountBalanceApi

[](#accountbalanceapi)

1. Get account balance [`getAccountBalance`](docs/Api/AccountBalanceApi.md#getaccountbalance)
2. Get account balance [`getAccountBalanceUsingPost`](docs/Api/AccountBalanceApi.md#getaccountbalanceusingpost)

### BlacklistApi

[](#blacklistapi)

1. Adds a phone number to the blacklist [`addToBlacklist`](docs/Api/BlacklistApi.md#addtoblacklist)
2. Deletes a phone number from the blacklist [`deleteFromBlacklist`](docs/Api/BlacklistApi.md#deletefromblacklist)
3. Returns all blacklisted phone numbers [`fetchBlacklist`](docs/Api/BlacklistApi.md#fetchblacklist)
4. Checks if a phone number is blacklisted [`isBlacklisted`](docs/Api/BlacklistApi.md#isblacklisted)

### BulkMessagingApi

[](#bulkmessagingapi)

1. Sends a bulk Omnimessage [`sendBulkOmnimessage`](docs/Api/BulkMessagingApi.md#sendbulkomnimessage)

### ContactsApi

[](#contactsapi)

1. Adds a contact to a group [`addContactToGroup`](docs/Api/ContactsApi.md#addcontacttogroup)
2. Creates a new contact [`createContact`](docs/Api/ContactsApi.md#createcontact)
3. Deletes a contact [`deleteContact`](docs/Api/ContactsApi.md#deletecontact)
4. Lists a contact [`fetchContact`](docs/Api/ContactsApi.md#fetchcontact)
5. Lists groups of a contact [`fetchContactGroups`](docs/Api/ContactsApi.md#fetchcontactgroups)
6. Returns all contacts [`fetchContacts`](docs/Api/ContactsApi.md#fetchcontacts)
7. Removes a contact from a group [`removeContactFromGroup`](docs/Api/ContactsApi.md#removecontactfromgroup)
8. Updates a contact [`updateContact`](docs/Api/ContactsApi.md#updatecontact)

### DeliveryReportApi

[](#deliveryreportapi)

1. Retrieves the delivery report for the Omnimessage [`retrieveDeliveryReport`](docs/Api/DeliveryReportApi.md#retrievedeliveryreport)

### GroupsApi

[](#groupsapi)

1. Creates a new group with the provided name [`createGroup`](docs/Api/GroupsApi.md#creategroup)
2. Deletes a group [`deleteGroup`](docs/Api/GroupsApi.md#deletegroup)
3. Lists a group [`fetchGroup`](docs/Api/GroupsApi.md#fetchgroup)
4. Returns all groups [`fetchGroups`](docs/Api/GroupsApi.md#fetchgroups)
5. Updates a group with the provided name [`updateGroup`](docs/Api/GroupsApi.md#updategroup)

### NumberLookupApi

[](#numberlookupapi)

1. Requests info about phone numbers [`fetchInfo`](docs/Api/NumberLookupApi.md#fetchinfo)

### NumberVerificationApi

[](#numberverificationapi)

1. verify number [`verifyNumber`](docs/Api/NumberVerificationApi.md#verifynumber)
2. verified the PIN code entered by the user. [`verifyPin`](docs/Api/NumberVerificationApi.md#verifypin)

### OmnimessageApi

[](#omnimessageapi)

1. Cancels a scheduled Omnimessage [`cancelScheduledMessage`](docs/Api/OmnimessageApi.md#cancelscheduledmessage)
2. Sends an Omnimessage [`sendOmnimessage`](docs/Api/OmnimessageApi.md#sendomnimessage)

### PricingApi

[](#pricingapi)

1. Get pricelist for account [`getPricelist`](docs/Api/PricingApi.md#getpricelist)
2. Get pricing for a specific country [`getPrices`](docs/Api/PricingApi.md#getprices)

### StatisticsApi

[](#statisticsapi)

1. Requests statistics reports for each country [`createStatisticsReport`](docs/Api/StatisticsApi.md#createstatisticsreport)

### WhatsAppTemplatesApi

[](#whatsapptemplatesapi)

1. Creates a WhatsApp template [`createWhatsappTemplate`](docs/Api/WhatsAppTemplatesApi.md#createwhatsapptemplate)
2. Deletes a WhatsApp template [`deleteWhatsappTemplate`](docs/Api/WhatsAppTemplatesApi.md#deletewhatsapptemplate)
3. Requests a WhatsApp template with the given ID [`getWhatsappTemplateById`](docs/Api/WhatsAppTemplatesApi.md#getwhatsapptemplatebyid)
4. Requests a list of WhatsApp templates [`listWhatsappTemplates`](docs/Api/WhatsAppTemplatesApi.md#listwhatsapptemplates)
5. Updates a WhatsApp template [`updateWhatsappTemplate`](docs/Api/WhatsAppTemplatesApi.md#updatewhatsapptemplate)

Auth
----

[](#auth)

**Type**: HTTP basic authentication

Read the [external getting-started article](https://messente.com/documentation/getting-started) which explains API keys and Sender ID logic.

Getting started: sending an omnimessage
---------------------------------------

[](#getting-started-sending-an-omnimessage)

```