Download the PHP package nessworthy/textmarketer without Composer
On this page you can find all versions of the php package nessworthy/textmarketer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nessworthy/textmarketer
More information about nessworthy/textmarketer
Files in nessworthy/textmarketer
Package textmarketer
Short Description An unofficial helper to allow you to send SMS messages using Text Marketer.
License wtfpl
Informations about the package textmarketer
Text Marketer PHP SDK
An unofficial library-in-progress to assist with text marketer API interactions.
Requirements
- PHP 7.3 or higher
ext-mbstring
ext-dom
Composer
Example Usage
- Setting Up
- Creating and Sending SMS Messages
- Scheduling Messages
- Deleting Scheduled Messages
- Handling and Transferring Credits
- Fetching your Current Credits
- Transferring Credits by Account ID or Credentials
- Keyword Availability
- Group Management
- Fetching your List of Groups
- Adding One or More Numbers to a Group
- Creating a New Group
- Fetching Information for an Existing Group
- Delivery Reports
- Filtering by Report Name
- Filtering by Report Name and Date Range
- Filtering by Report Name and Tag
- Filtering by Report Name, Tag, and Date Range
- Account Management
- Fetching your Account Information
- Fetching Account Information by Account ID
- Updating Your Account Information
- Creating a New Sub-Account
- Exception and Error Handling
Setting up
Parameters
- Credentials - An implementation of
\Nessworthy\TextMarketer\Authentication
- Endpoint (optional) - The text marketer endpoint to use when sending out messages. Should be one of:
\Nessworthy\TextMarketer\TextMarketer::ENDPOINT_PRODUCTION
(default)\Nessworthy\TextMarketer\TextMarketer::ENDPOINT_SANDBOX
- HTTP Client (optional) - The HTTP client to send requests out.
- Expects an implementation of
GuzzleHttp\ClientInterface
- By default, an instance of
GuzzleHttp\Client
is used.
- Expects an implementation of
Creating and Sending SMS Messages
Scheduling Messages
Deleting Scheduled Messages
Handling and Transferring Credits
Fetching your Current Credits
Transferring Credits by Account ID or Credentials
Keyword Availability
Group Management
Fetching Your List of Groups
Adding One or More Numbers to a Group
Creating a New Group
Fetching Information for an Existing Group
Delivery Reports
All report-related calls return the results in the same format as above.
Filtering by Report Name
Filtering By Report Name and Date Range
Filtering by Report Name and Tag
Filtering by Report Name, Tag, and Date Range
Account Management
All methods here return an instance of Nessworthy\TextMarketer\Account\AccountInformation
.
These objects contain both account and API credentials - it would be wise to not cache or otherwise save them as-is!
Fetching Your Account Information
Fetching Account Information by Account ID
Note: The account ID should be typed as a string.
Updating Your Account Information
Note: There's no way to update another account's information - you must use their credentials.
All of the fields for UpdateAccountInformation
are optional - pass null
when you don't
want to change a particular field.
Certain restrictions apply when updating your account information. See here for what you can use.
Creating a New Sub-Account
Note: Creating new account is disabled by default - you will need to contact TextMarketer to enable this. Like updating your account, you must at least provide a notification email address OR a notification mobile number
These fields are subject to the same restrictions as that when updating you account information.