FireText SMS API

https://www.firetext.co.uk/docs
Admin
The FireText SMS API Gateway documentation provides comprehensive guides for integrating SMS...
Tokens:12,169
Snippets:135
Trust Score:9.6
Update:3 months ago
Show doc for...
Tokens:
Raw
### Add Template Request Example

Source: https://www.firetext.co.uk/docs

An example GET request to add a new template using an API key, template name, and message content.

```text
https://www.firetext.co.uk/api/addtemplate?apiKey=myApiKey&name=my+template+1&message=Message+content+for+my+new+template
```

--------------------------------

### View Transfers Request Example

Source: https://www.firetext.co.uk/docs

An example GET request to view transfers using an API key and sub-account ID.

```text
https://www.firetext.co.uk/api/transfers?apiKey=myApiKey&subaccount=mysubID
```

--------------------------------

### Example SMS Request

Source: https://www.firetext.co.uk/docs

A sample GET request demonstrating how to pass parameters for authentication, message content, sender ID, recipients, scheduling, and references.

```text
https://www.firetext.co.uk/api/sendsms?apiKey=myApiKey&message=This+is+a+test+message&from=FireText&to=07123456789,447712345678&schedule=2010-05-22%2017:00&reference=1234567
```

--------------------------------

### View Scheduled Messages Request Example

Source: https://www.firetext.co.uk/docs

Example request using an API key and pagination parameters.

```text
https://www.firetext.co.uk/api/scheduledmessages?apiKey=myApiKey&pp=50
```

--------------------------------

### View Contact Information Request Example

Source: https://www.firetext.co.uk/docs

Example request for viewing contact information using an API key.

```text
https://www.firetext.co.uk/api/contactinfo?apiKey=myApiKey&mobile=447700000000
```

--------------------------------

### Add a Group Request Example

Source: https://www.firetext.co.uk/docs

Example request for adding a group using an API key.

```text
https://www.firetext.co.uk/api/addgroup?apiKey=myApiKey&name=Group1&description=My+New+Group&from=FireText
```

--------------------------------

### Unsubscribe Contact Request Example

Source: https://www.firetext.co.uk/docs

Example request for unsubscribing a contact using an API key.

```text
https://www.firetext.co.uk/api/unsubscribe?apiKey=myApiKey&mobile=07712345678
```

--------------------------------

### Query Delivery Reports Example

Source: https://www.firetext.co.uk/docs

Example request for delivery reports using an API key and message ID.

```text
https://www.firetext.co.uk/api/deliveryreport?apiKey=myApiKey&message=1652211&pp=10000
```

--------------------------------

### Query Sent Messages Example

Source: https://www.firetext.co.uk/docs

Example request for sent messages within a specific date range.

```text
https://www.firetext.co.uk/api/sentmessages?apiKey=myApiKey&from=2011-01-01&to=2011-01-31&pp=50
```

--------------------------------

### Unsubscribed Contacts Request Example

Source: https://www.firetext.co.uk/docs

Example request URL using an API key and date range parameters.

```text
https://www.firetext.co.uk/api/unsubscribed?apiKey=myApiKey&from=2011-01-01&to=2011-01-31&pp=50
```

--------------------------------

### Query Received Messages with Parameters

Source: https://www.firetext.co.uk/docs

Example request URL demonstrating the use of an API key, date filtering, and pagination parameters.

```text
https://www.firetext.co.uk/api/receivedmessages/xml?apiKey=myApiKey&from=last&pp=50
```

--------------------------------

### Remove Scheduled Message Request Example

Source: https://www.firetext.co.uk/docs

Example request to unschedule a message using an API key and reference ID.

```text
https://www.firetext.co.uk/api/unschedule?apiKey=myApiKey&reference=mymessageID1
```

--------------------------------

### GET /api/subaccounts

Source: https://www.firetext.co.uk/docs

Retrieves a list of sub-accounts associated with the main account.

```APIDOC
## GET /api/subaccounts

### Description
Retrieves a list of your sub-accounts. Results can be filtered by sub-account ID and paginated.

### Method
POST or GET

### Endpoint
https://www.firetext.co.uk/api/subaccounts

### Parameters
#### Query Parameters
- **username** (string) - Required - Your FireText.co.uk username
- **password** (string) - Required - Your FireText.co.uk password
- **apiKey** (string) - Required (alternative) - An alternative authentication method
- **subaccount** (string) - Optional - Your sub-account ID
- **pp** (integer) - Optional - Number of results per page (10, 25, 50, or 100)
- **page** (integer) - Optional - Page of results

### Response
#### Success Response (200)
- **status** (string) - Returns a status code and total number of results
- **data** (array) - A dataset containing accountID, accountName, accountNotes, and allocation
```

--------------------------------

### Add Single Contact

Source: https://www.firetext.co.uk/docs

Endpoint for adding a single contact to the account via POST or GET.

```http
https://www.firetext.co.uk/api/subscribe
```

```http
https://www.firetext.co.uk/api/subscribe?apiKey=myApiKey&mobile=07712345678&firstname=John&lastname=Smith&update=1
```

--------------------------------

### GET /api/clickreport

Source: https://www.firetext.co.uk/docs

Retrieves a list of click reports for a specific message that contains the FireText Trackable SMS feature.

```APIDOC
## GET /api/clickreport

### Description
Retrieves click report details for a specific message ID. Only applicable to messages with the Trackable SMS feature enabled.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/clickreport

### Parameters
#### Query Parameters
- **username** (string) - Required - Your FireText.co.uk username
- **password** (string) - Required - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **message** (string) - Required - FireText Message ID
- **pp** (integer) - Optional - Results per page (10000 or 25000)
- **page** (integer) - Optional - Page of results
- **subaccount** (string) - Optional - Sub-account ID

### Response
#### Success Response (200)
- **mobile** (string) - Mobile number of recipient
- **firstName** (string) - First name of recipient
- **lastName** (string) - Last name of recipient
- **customField1** (string) - Custom 1 of recipient
- **customField2** (string) - Custom 2 of recipient
- **customField3** (string) - Custom 3 of recipient
- **clicked** (string) - Date/Time of click
- **userAgent** (string) - UserAgent returned when clicked
```

--------------------------------

### GET /api/sentreport

Source: https://www.firetext.co.uk/docs

Retrieves a summary of sent messages for a FireText account or sub-account within a specified date range.

```APIDOC
## GET /api/sentreport

### Description
Retrieves the number of sent messages and summary statistics for a given account or sub-account.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/sentreport

### Parameters
#### Query Parameters
- **username** (string) - Required - Your FireText.co.uk username
- **password** (string) - Required - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **from** (string) - Required - Start date (YYYY-MM-DD)
- **to** (string) - Required - End date (YYYY-MM-DD)
- **subaccount** (string) - Optional - Sub-account ID

### Response
#### Success Response (200)
- **from** (string) - Start date of chosen period
- **to** (string) - End date of chosen period
- **campaigns** (integer) - Total number of campaigns
- **recipients** (integer) - Total number of recipients
- **credits** (integer) - Total number of credits
```

--------------------------------

### Add a Group Response Format

Source: https://www.firetext.co.uk/docs

The expected response string format for the add group request.

```text
<status no> : <description> - e.g: 0: Group successfully added
```

--------------------------------

### GET/POST /api/keywords

Source: https://www.firetext.co.uk/docs

Retrieve a list of keywords associated with your FireText account or sub-account.

```APIDOC
## GET/POST /api/keywords

### Description
Retrieve a list of keywords on your FireText account or sub-account.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/keywords

### Parameters
#### Query/Body Parameters
- **username** (string) - Optional - Your FireText.co.uk username
- **password** (string) - Optional - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **pp** (integer) - Optional - Number of results per page (10, 25, 50, or 100)
- **page** (integer) - Optional - Page of results
- **subaccount** (string) - Optional - Your sub-account ID

### Response
#### Success Response (200)
- **status** (integer) - 0 for success
- **total** (integer) - Total number of results
- **data** (string) - URL-Encoded keyword data separated by newlines
```

--------------------------------

### View Contact Information Response Format

Source: https://www.firetext.co.uk/docs

The expected response string format for the contact information request.

```text
<status no>: <description> - e.g: 0: Successful Request
```

--------------------------------

### Add Sub-Account API Endpoint

Source: https://www.firetext.co.uk/docs

Endpoint for creating a new sub-account. Requires authentication via username/password or API key.

```http
https://www.firetext.co.uk/api/addsubaccount
```

```http
https://www.firetext.co.uk/api/addsubaccount?apiKey=myApiKey&subaccount=mysubID&name=mysubname&messages=500
```

--------------------------------

### Add Template Endpoint

Source: https://www.firetext.co.uk/docs

The base URL for adding a new message template to an account or sub-account.

```text
https://www.firetext.co.uk/api/addtemplate
```

--------------------------------

### Credit Response Format

Source: https://www.firetext.co.uk/docs

The expected string format returned by the credit check endpoint.

```text
 <status no>:<no of credits remaining> <description> - eg: 0:1652 Successful Request
```

--------------------------------

### API Response Format

Source: https://www.firetext.co.uk/docs

The format of the string returned upon a successful request, indicating status, credits used, and a description.

```text
<status no>:<no of credits used> <description> - e.g: 0:1 SMS successfully queued
```

--------------------------------

### Contact Management Response Format

Source: https://www.firetext.co.uk/docs

The expected string format returned by contact management endpoints.

```text
<status no> : <description> - e.g: 0: Contact successfully added
```

--------------------------------

### View Keywords API Request

Source: https://www.firetext.co.uk/docs

Endpoints for retrieving a list of keywords from a FireText account or sub-account.

```http
https://www.firetext.co.uk/api/keywords
```

```http
https://www.firetext.co.uk/api/keywords?apiKey=myApiKey
```

--------------------------------

### Requesting XML Response Format

Source: https://www.firetext.co.uk/docs

Append /xml to the request URL to receive API responses in XML format.

```text
https://www.firetext.co.uk/api/receivedmessages/xml
```

--------------------------------

### GET/POST /api/addtemplate

Source: https://www.firetext.co.uk/docs

Adds a new message template to a FireText account or sub-account.

```APIDOC
## GET/POST /api/addtemplate

### Description
Add a message template to an account for your FireText account or sub-account.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/addtemplate

### Parameters
#### Query/Body Parameters
- **username** (string) - Required (unless apiKey provided) - Your FireText.co.uk username
- **password** (string) - Required (unless apiKey provided) - Your FireText.co.uk password
- **apiKey** (string) - Required (alternative) - An apiKey can be used as an alternative authentication method
- **name** (string) - Required - Name of the message template
- **message** (string) - Required - Message content of the template
- **api** (string) - Optional - Optional API ID to allow for messages to be sent using the template
- **subaccount** (string) - Optional - Your sub-account ID

### Request Example
https://www.firetext.co.uk/api/addtemplate?apiKey=myApiKey&name=my+template+1&message=Message+content+for+my+new+template

### Response
#### Success Response (200)
- **status** (string) - Returns a string in format '<status no> : <description>'. Status 0 indicates template successfully added.
```

--------------------------------

### View Delivery Reports Endpoint

Source: https://www.firetext.co.uk/docs

The base URL for querying delivery reports.

```text
https://www.firetext.co.uk/api/deliveryreport
```

--------------------------------

### View Contact Information API Endpoint

Source: https://www.firetext.co.uk/docs

Base URL for retrieving contact information.

```text
https://www.firetext.co.uk/api/contactinfo
```

--------------------------------

### Retrieve Sent Message Summary

Source: https://www.firetext.co.uk/docs

Endpoint for requesting a summary of sent messages. Use an apiKey for authentication as the preferred alternative to username and password.

```text
https://www.firetext.co.uk/api/sentreport
```

```text
https://www.firetext.co.uk/api/sentreport?apiKey=myApiKey&from=2011-01-01&to=2011-01-31
```

--------------------------------

### Receive SMS via POST

Source: https://www.firetext.co.uk/docs

Configures a webhook to receive incoming SMS messages sent to your FireText number.

```APIDOC
## POST [Webhook URL]

### Description
Receives an incoming SMS message via HTTP POST to your specified script URL.

### Method
POST

### Parameters
#### Request Body
- **source** (string) - The mobile number of the incoming message
- **destination** (string) - The inbound message number
- **message** (string) - The text message body
- **keyword** (string) - The keyword used (if applicable)
- **time** (string) - Time and date of the message (YYYY-MM-DD HH:MM:SS)
```

--------------------------------

### Add a Group API Endpoint

Source: https://www.firetext.co.uk/docs

Base URL for adding a new group to a FireText account.

```text
https://www.firetext.co.uk/api/addgroup
```

--------------------------------

### Add Contacts via CSV

Source: https://www.firetext.co.uk/docs

Endpoint for uploading a CSV file of contacts to a specified group.

```http
https://www.firetext.co.uk/api/uploadcontacts
```

--------------------------------

### POST /api/addsubaccount

Source: https://www.firetext.co.uk/docs

Adds a new sub-account to your main FireText account.

```APIDOC
## POST /api/addsubaccount

### Description
Adds a new sub-account to your main FireText account. Authentication can be performed via username/password or an API key.

### Method
POST or GET

### Endpoint
https://www.firetext.co.uk/api/addsubaccount

### Parameters
#### Query Parameters
- **username** (string) - Required - Your FireText.co.uk username
- **password** (string) - Required - Your FireText.co.uk password
- **apiKey** (string) - Required (alternative) - An alternative authentication method
- **subaccount** (string) - Required - Your new sub-account ID
- **email** (string) - Optional - An optional login email for your new sub-account
- **passphrase** (string) - Optional - An optional login password for your new sub-account
- **name** (string) - Optional - Assign a name to your new sub-account
- **notes** (string) - Optional - Add your own reference notes to this sub-account
- **messages** (integer) - Optional - The number of messages you wish to transfer
- **key** (integer) - Optional - If set to 1, an API Key is returned in the header under X-Key

### Response
#### Success Response (200)
- **status** (string) - Returns a status code and description (e.g., 0: Sub-account successfully added)
```

--------------------------------

### GET/POST /api/forward

Source: https://www.firetext.co.uk/docs

Add or remove a forward for a specific keyword on your FireText account.

```APIDOC
## GET/POST /api/forward

### Description
Add a forward to a specific keyword on your FireText account or sub-account.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/forward

### Parameters
#### Query/Body Parameters
- **username** (string) - Optional - Your FireText.co.uk username
- **password** (string) - Optional - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **keyword** (string) - Required - The keyword ID
- **type** (string) - Required - The type of forward (mobile, email, or url)
- **destination** (string) - Required - The destination for the type specified
- **remove** (integer) - Optional - Set to 1 to remove the forward
- **subaccount** (string) - Optional - Your sub-account ID

### Response
#### Success Response (200)
- **status** (integer) - 0 for success
- **description** (string) - Status description
```

--------------------------------

### POST/GET /api/addgroup

Source: https://www.firetext.co.uk/docs

Adds a new group to your FireText account.

```APIDOC
## POST/GET /api/addgroup

### Description
Adds a new group to your FireText account.

### Method
POST or GET

### Endpoint
https://www.firetext.co.uk/api/addgroup

### Parameters
#### Query Parameters
- **username** (string) - Optional - Your FireText.co.uk username
- **password** (string) - Optional - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **name** (string) - Required - The group name
- **description** (string) - Required - A description for your new group
- **from** (string) - Required - The default From (Sender ID) setting
- **api** (string) - Optional - An optional API ID for your new group
- **subaccount** (string) - Optional - Your sub-account ID

### Response
#### Success Response (200)
- **status** (string) - Returns a status code and description (e.g., 0: Group successfully added)
```

--------------------------------

### View Sub-Accounts API Endpoint

Source: https://www.firetext.co.uk/docs

Endpoint for retrieving a list of sub-accounts associated with the main account.

```http
https://www.firetext.co.uk/api/subaccounts
```

```http
https://www.firetext.co.uk/api/subaccounts?apiKey=myApiKey&subaccount=mysubID
```

--------------------------------

### POST /api/deliveryreport

Source: https://www.firetext.co.uk/docs

Retrieves delivery reports for a specific message or reference.

```APIDOC
## POST /api/deliveryreport

### Description
Retrieves a list of delivery reports for a specified message or reference on your FireText account or sub-account.

### Method
POST or GET

### Endpoint
https://www.firetext.co.uk/api/deliveryreport

### Parameters
#### Query Parameters
- **username** (string) - Optional - Your FireText.co.uk username
- **password** (string) - Optional - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **message** (string) - Optional - FireText Message ID
- **reference** (string) - Optional - API reference of the message
- **pp** (integer) - Optional - Number of results per page (10000 or 25000)
- **page** (integer) - Optional - Page of results
- **subaccount** (string) - Optional - Your sub-account ID

### Request Example
https://www.firetext.co.uk/api/deliveryreport?apiKey=myApiKey&message=1652211&pp=10000

### Response
#### Success Response (200)
- **status** (string) - Status code and description
- **data** (array) - List of delivery reports containing mobile, firstName, lastName, customFields, messageSent, messageUpdate, and status.
```

--------------------------------

### View Scheduled Messages Endpoint

Source: https://www.firetext.co.uk/docs

Base URL for retrieving scheduled messages.

```text
https://www.firetext.co.uk/api/scheduledmessages
```

--------------------------------

### POST/GET /api/contactinfo

Source: https://www.firetext.co.uk/docs

Retrieves stored contact information for a specific mobile number.

```APIDOC
## POST/GET /api/contactinfo

### Description
View the stored contact information for a given mobile number in your account.

### Method
POST or GET

### Endpoint
https://www.firetext.co.uk/api/contactinfo

### Parameters
#### Query Parameters
- **username** (string) - Optional - Your FireText.co.uk username
- **password** (string) - Optional - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **mobile** (string) - Required - The mobile telephone number
- **subaccount** (string) - Optional - Your sub-account ID

### Response
#### Success Response (200)
- **status** (string) - Returns a status code and description
- **data** (object) - Returns contact details including firstname, lastname, mobile, and custom fields
```

--------------------------------

### View Transfers Endpoint

Source: https://www.firetext.co.uk/docs

The base URL for retrieving transferred messages between accounts.

```text
https://www.firetext.co.uk/api/transfers
```

--------------------------------

### API Response Format

Source: https://www.firetext.co.uk/docs

The structure of the status response returned by the API.

```text
<status no>:<total number of results> <description>
```

--------------------------------

### GET/POST /api/scheduledmessages

Source: https://www.firetext.co.uk/docs

Retrieves a list of scheduled messages for the account or a specified sub-account.

```APIDOC
## GET/POST /api/scheduledmessages

### Description
Retrieves a list of scheduled messages for your FireText account or sub-account.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/scheduledmessages

### Parameters
#### Query/Body Parameters
- **username** (string) - Required (if no apiKey) - Your FireText.co.uk username
- **password** (string) - Required (if no apiKey) - Your FireText.co.uk password
- **apiKey** (string) - Required (if no username/password) - Alternative authentication method
- **pp** (integer) - Optional - Number of results per page (10, 25, 50, 100). Default: 25
- **page** (integer) - Optional - Page of results
- **subaccount** (string) - Optional - Your sub-account ID

### Response
#### Success Response (200)
- **status** (string) - Status code and total number of results
- **data** (string) - URL-Encoded data set of scheduled messages (messageID, queuedOn, scheduledFor, recipientCount, sourceAddress, sendTo, message)
```

--------------------------------

### GET/POST https://www.firetext.co.uk/api/credit

Source: https://www.firetext.co.uk/docs

Request the number of messages remaining on your FireText account.

```APIDOC
## GET/POST https://www.firetext.co.uk/api/credit

### Description
Request the number of messages remaining on your FireText account.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/credit

### Parameters
#### Query/Request Parameters
- **username** (string) - Optional - Your FireText.co.uk username
- **password** (string) - Optional - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **subaccount** (string) - Optional - Your sub-account ID

### Response
#### Success Response (200)
- **response** (string) - A string consisting of <status no>:<no of credits remaining> <description>
```

--------------------------------

### GET/POST https://www.firetext.co.uk/api/subscribe

Source: https://www.firetext.co.uk/docs

Add a single contact into your FireText account.

```APIDOC
## GET/POST https://www.firetext.co.uk/api/subscribe

### Description
Add a single contact into your FireText account.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/subscribe

### Parameters
#### Query/Request Parameters
- **username** (string) - Optional - Your FireText.co.uk username
- **password** (string) - Optional - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **mobile** (string) - Required - The mobile telephone number to insert
- **firstname** (string) - Optional - The first name of the contact
- **lastname** (string) - Optional - The surname of the contact
- **custom1** (string) - Optional - Custom field 1
- **custom2** (string) - Optional - Custom field 2
- **custom3** (string) - Optional - Custom field 3
- **group** (string) - Optional - API ID of a pre-defined group
- **update** (string) - Optional - Set to 1 to update existing contact
- **subaccount** (string) - Optional - Your sub-account ID

### Response
#### Success Response (200)
- **response** (string) - A string consisting of <status no> : <description>
```

--------------------------------

### Unsubscribe Contact Response Format

Source: https://www.firetext.co.uk/docs

The expected response string format for the unsubscribe request.

```text
<status no> : <description> - e.g: 0: Contact successfully unsubscribed
```

--------------------------------

### POST /api/transfercredit

Source: https://www.firetext.co.uk/docs

Transfers message credits between the main account and a sub-account.

```APIDOC
## POST /api/transfercredit

### Description
Transfers messages (credit) from your main account to a sub-account or vice versa.

### Method
POST or GET

### Endpoint
https://www.firetext.co.uk/api/transfercredit

### Parameters
#### Query Parameters
- **username** (string) - Required - Your FireText.co.uk username
- **password** (string) - Required - Your FireText.co.uk password
- **apiKey** (string) - Required (alternative) - An alternative authentication method
- **subaccount** (string) - Required - Your sub-account ID
- **type** (string) - Required - 'add' or 'deduct'
- **amount** (integer) - Required - Number of messages to transfer

### Response
#### Success Response (200)
- **status** (string) - Returns a status code and description (e.g., 0: Successful transfer)
```

--------------------------------

### GET/POST /api/transfers

Source: https://www.firetext.co.uk/docs

Retrieves a list of transferred messages (credit) from a main account to a sub-account.

```APIDOC
## GET/POST /api/transfers

### Description
Retrieve transferred messages (credit) from your main account to a sub-account.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/transfers

### Parameters
#### Query/Body Parameters
- **username** (string) - Required (unless apiKey provided) - Your FireText.co.uk username
- **password** (string) - Required (unless apiKey provided) - Your FireText.co.uk password
- **apiKey** (string) - Required (alternative) - An apiKey can be used as an alternative authentication method
- **subaccount** (string) - Required - Your sub-account ID
- **pp** (integer) - Optional - Number of results per page (10, 25, 50, or 100)
- **page** (integer) - Optional - Page of results

### Request Example
https://www.firetext.co.uk/api/transfers?apiKey=myApiKey&subaccount=mysubID

### Response
#### Success Response (200)
- **status** (string) - Returns a string in format '<status no> : <description>'. Status 0 indicates success.
```

--------------------------------

### Check Account Credit

Source: https://www.firetext.co.uk/docs

Endpoint for retrieving the number of remaining messages on a FireText account.

```http
https://www.firetext.co.uk/api/credit
```

```http
https://www.firetext.co.uk/api/credit?apiKey=myApiKey
```

--------------------------------

### GET/POST https://www.firetext.co.uk/api/unsubscribed

Source: https://www.firetext.co.uk/docs

Retrieves a list of unsubscribed contacts based on optional date ranges, pagination, and group filters.

```APIDOC
## GET/POST https://www.firetext.co.uk/api/unsubscribed

### Description
Retrieves a list of unsubscribed contacts for a FireText account or sub-account.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/unsubscribed

### Parameters
#### Query/Body Parameters
- **username** (string) - Required (if no apiKey) - Your FireText.co.uk username
- **password** (string) - Required (if no apiKey) - Your FireText.co.uk password
- **apiKey** (string) - Required (if no username/password) - Alternative authentication method
- **from** (string) - Optional - Select messages sent from date (YYYY-MM-DD) or 'last'
- **to** (string) - Optional - Select messages sent to date (YYYY-MM-DD)
- **pp** (integer) - Optional - Results per page (10, 25, 50, 100). Default: 25
- **page** (integer) - Optional - Page of results
- **group** (string) - Optional - Group API ID
- **subaccount** (string) - Optional - Sub-account ID

### Response
#### Success Response (200)
- **status** (integer) - 0 for success
- **total** (integer) - Total number of results
- **data** (array) - List of contacts containing firstname, lastname, mobile, customField1, customField2, customField3, addedOn, unsubscribedOn, and reason.
```

--------------------------------

### View Sent Messages Endpoint

Source: https://www.firetext.co.uk/docs

The base URL for querying sent message history.

```text
https://www.firetext.co.uk/api/sentmessages
```

--------------------------------

### FireText API Endpoint

Source: https://www.firetext.co.uk/docs

The base URL for sending SMS messages.

```text
https://www.firetext.co.uk/api/sendsms
```

--------------------------------

### Retrieve Received Messages Endpoint

Source: https://www.firetext.co.uk/docs

Base URL for querying the received messages API.

```text
https://www.firetext.co.uk/api/receivedmessages
```

--------------------------------

### POST/GET /api/unsubscribe

Source: https://www.firetext.co.uk/docs

Unsubscribes a contact from your FireText account.

```APIDOC
## POST/GET /api/unsubscribe

### Description
Unsubscribe a contact from your FireText account or a specific group.

### Method
POST or GET

### Endpoint
https://www.firetext.co.uk/api/unsubscribe

### Parameters
#### Query Parameters
- **username** (string) - Optional - Your FireText.co.uk username
- **password** (string) - Optional - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **mobile** (string) - Required - The mobile telephone number to unsubscribe
- **group** (string) - Optional - Group API ID to unsubscribe from
- **subaccount** (string) - Optional - Your sub-account ID

### Response
#### Success Response (200)
- **status** (string) - Returns a status code and description (e.g., 0: Contact successfully unsubscribed)
```

--------------------------------

### Add Forward API Request

Source: https://www.firetext.co.uk/docs

Endpoints for adding or removing a forward for a specific keyword.

```http
https://www.firetext.co.uk/api/forward
```

```http
https://www.firetext.co.uk/api/forward?apiKey=myApiKey&type=email&destination=abc@example.com
```

--------------------------------

### Retrieve Click Reports

Source: https://www.firetext.co.uk/docs

Endpoint for requesting click reports for a specific message ID. Requires the message to have the Trackable SMS feature enabled.

```text
https://www.firetext.co.uk/api/clickreport
```

```text
https://www.firetext.co.uk/api/clickreport?apiKey=myApiKey&message=1652211&pp=10000
```

--------------------------------

### Transfer Credits API Endpoint

Source: https://www.firetext.co.uk/docs

Endpoint for transferring message credits between the main account and a sub-account.

```http
https://www.firetext.co.uk/api/transfercredit
```

```http
https://www.firetext.co.uk/api/addsubaccount?apiKey=myApiKey&subaccount=mysubID&type=add&amount=500
```

--------------------------------

### View Received Messages

Source: https://www.firetext.co.uk/docs

Retrieves a list of received messages from your FireText account or sub-account.

```APIDOC
## POST/GET https://www.firetext.co.uk/api/receivedmessages

### Description
Fetches a list of received messages based on authentication and optional date or pagination filters.

### Method
POST or GET

### Endpoint
https://www.firetext.co.uk/api/receivedmessages

### Parameters
#### Query/Body Parameters
- **username** (string) - Required (unless apiKey used) - Your FireText username
- **password** (string) - Required (unless apiKey used) - Your FireText password
- **apiKey** (string) - Required (alternative) - API key for authentication
- **from** (string) - Optional - Select messages sent from date (YYYY-MM-DD) or 'last'
- **to** (string) - Optional - Select messages sent to date (YYYY-MM-DD)
- **pp** (integer) - Optional - Results per page (10, 25, 50, 100)
- **page** (integer) - Optional - Page of results
- **subaccount** (string) - Optional - Sub-account ID

### Response
#### Success Response (200)
- **status** (string) - Status code and description
- **data** (string) - URL-encoded dataset of messages containing messageID, sentTo, keyword, receivedFrom, receivedOn, and message
```

--------------------------------

### Remove Scheduled Message Response Format

Source: https://www.firetext.co.uk/docs

The structure of the response string returned after an unschedule request.

```text
<status no> : <description>
```

--------------------------------

### Unsubscribe Contact API Endpoint

Source: https://www.firetext.co.uk/docs

Base URL for unsubscribing a contact.

```text
https://www.firetext.co.uk/api/unsubscribe
```

--------------------------------

### Unsubscribed Contacts API Endpoint

Source: https://www.firetext.co.uk/docs

The base URL for requesting unsubscribed contacts.

```text
https://www.firetext.co.uk/api/unsubscribed
```

--------------------------------

### POST /api/sentmessages

Source: https://www.firetext.co.uk/docs

Retrieves a list of sent messages from your FireText account.

```APIDOC
## POST /api/sentmessages

### Description
Retrieves a list of sent messages on your FireText account or sub-account within a specified date range.

### Method
POST or GET

### Endpoint
https://www.firetext.co.uk/api/sentmessages

### Parameters
#### Query Parameters
- **username** (string) - Optional - Your FireText.co.uk username
- **password** (string) - Optional - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **from** (string) - Optional - Select messages sent from date (YYYY-MM-DD)
- **to** (string) - Optional - Select messages sent to date (YYYY-MM-DD)
- **pp** (integer) - Optional - Number of results per page (10, 25, 50, or 100)
- **page** (integer) - Optional - Page of results
- **subaccount** (string) - Optional - Your sub-account ID

### Request Example
https://www.firetext.co.uk/api/sentmessages?apiKey=myApiKey&from=2011-01-01&to=2011-01-31&pp=50

### Response
#### Success Response (200)
- **status** (string) - Status code and description
- **data** (array) - List of sent messages containing messageID, sentOn, sentTo, groupDescription, recipientCount, and message content.
```

--------------------------------

### GET/POST /api/unschedule

Source: https://www.firetext.co.uk/docs

Removes a scheduled message from your FireText account using the message ID or reference.

```APIDOC
## GET/POST /api/unschedule

### Description
Removes a scheduled message from your FireText account.

### Method
GET or POST

### Endpoint
https://www.firetext.co.uk/api/unschedule

### Parameters
#### Query/Body Parameters
- **username** (string) - Required (if no apiKey) - Your FireText.co.uk username
- **password** (string) - Required (if no apiKey) - Your FireText.co.uk password
- **apiKey** (string) - Required (if no username/password) - Alternative authentication method
- **message** (string) - Required (if no reference) - The message ID of the message to unschedule (up to 25 IDs comma separated)
- **reference** (string) - Required (if no message) - The API reference of the message to unschedule
- **subaccount** (string) - Optional - Your sub-account ID

### Response
#### Success Response (200)
- **status** (string) - Status code and description of the operation result
```

--------------------------------

### POST https://www.firetext.co.uk/api/uploadcontacts

Source: https://www.firetext.co.uk/docs

Upload contacts using CSV via your FireText account.

```APIDOC
## POST https://www.firetext.co.uk/api/uploadcontacts

### Description
Upload contacts using CSV via your FireText account.

### Method
POST

### Endpoint
https://www.firetext.co.uk/api/uploadcontacts

### Parameters
#### Request Body
- **username** (string) - Optional - Your FireText.co.uk username
- **password** (string) - Optional - Your FireText.co.uk password
- **apiKey** (string) - Optional - Alternative authentication method
- **file** (file) - Required - The file containing the CSV contacts
- **md5sum** (string) - Optional - MD5 check sum of the file
- **group** (string) - Required - The API ID of the group
- **update** (string) - Optional - Set to 1 to update existing contacts
- **columns** (string) - Optional - Column mapping
- **postback** (string) - Optional - HTTP address for summary results
- **subaccount** (string) - Optional - Your sub-account ID

### Response
#### Success Response (200)
- **response** (string) - A string consisting of <status no> : <description>
```

--------------------------------

### POST/GET https://www.firetext.co.uk/api/sendsms

Source: https://www.firetext.co.uk/docs

Sends an SMS message via the FireText gateway. Supports authentication via username/password or an API key.

```APIDOC
## POST/GET https://www.firetext.co.uk/api/sendsms

### Description
Sends a text message to one or more mobile numbers. The message can be scheduled for future delivery or set to repeat.

### Method
POST or GET

### Endpoint
https://www.firetext.co.uk/api/sendsms

### Parameters
#### Query/Body Parameters
- **username** (string) - Required (if no apiKey) - Your FireText.co.uk username
- **password** (string) - Required (if no apiKey) - Your FireText.co.uk password
- **apiKey** (string) - Required (if no username/password) - Alternative authentication method
- **message** (string) - Required - The text message body in utf-8
- **from** (string) - Required - The Sender ID (alpha numeric, 3-11 chars)
- **to** (string) - Required - Comma separated list of up to 50 mobile numbers
- **schedule** (string) - Optional - Scheduled date/time (YYYY-MM-DD HH:MM)
- **expires** (string) - Optional - Repeat message expiry date (YYYY-MM-DD)
- **interval** (integer) - Optional - Repeat interval in days
- **reference** (string) - Optional - Custom ID for the message batch
- **group** (string) - Optional - Pre-defined group API ID
- **receipt** (string) - Optional - Alternate receipt URL
- **template** (string) - Optional - Pre-defined template API ID
- **unicode** (integer) - Optional - 0: GSM (default), 1: Unicode, 2: Auto-detect
- **subaccount** (string) - Optional - Sub-account ID

### Response
#### Success Response (200)
- **X-Message** (header) - Message identifier for delivery reports
- **Body** (string) - Format: <status no>:<no of credits used> <description>
```

--------------------------------

### Remove Scheduled Message Endpoint

Source: https://www.firetext.co.uk/docs

Base URL for removing a scheduled message.

```text
https://www.firetext.co.uk/api/unschedule
```
Tokens:
Raw