firetext_get_click_report

Link clicks for one sent message (mobile, names, clicked, userAgent). Only for messages that used FireText's Trackable SMS feature (otherwise the vendor answers URL error). FireText: /clickreport.

read-only

Argument	Type	Description
pp	any	Results per page: 10000 or 25000 (the vendor's only choices for this report). Large; omit for the vendor default.
page	integer	Page number (1-based).
message*	string	FireText message ID (see firetext_list_sent_messages).
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "message"
  ],
  "properties": {
    "pp": {
      "anyOf": [
        {
          "type": "number",
          "const": 10000
        },
        {
          "type": "number",
          "const": 25000
        }
      ],
      "description": "Results per page: 10000 or 25000 (the vendor's only choices for this report). Large; omit for the vendor default."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based)."
    },
    "message": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,40}$",
      "description": "FireText message ID (see firetext_list_sent_messages)."
    },
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

firetext_get_contact

Stored details of one contact by mobile number (firstname, lastname, mobile, customField1-3). FireText: /contactinfo.

read-only

Argument	Type	Description
mobile*	string	Mobile number: UK 07700900123 / 447700900123, or international without + and leading zeros (e.g. 33612345678).
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "mobile"
  ],
  "properties": {
    "mobile": {
      "type": "string",
      "maxLength": 32,
      "minLength": 1,
      "description": "Mobile number: UK 07700900123 / 447700900123, or international without + and leading zeros (e.g. 33612345678)."
    },
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

firetext_get_credit

Number of SMS credits (messages) remaining on the FireText account or a sub-account. FireText: /credit.

read-only

Argument	Type	Description
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

firetext_get_delivery_report

Per-recipient delivery status of one sent message (mobile, names, messageSent, messageUpdate, status: Delivered / Declined / Buffered / Pending with Network / Rejected / Unconfirmed). Give the FireText message id OR the custom reference used when sending. FireText: /deliveryreport.

read-only

Argument	Type	Description
pp	any	Results per page: 10000 or 25000 (the vendor's only choices for this report). Large; omit for the vendor default.
page	integer	Page number (1-based).
message	string	FireText message ID (see firetext_list_sent_messages).
reference	string	The custom reference set when sending (alternative to message).
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "pp": {
      "anyOf": [
        {
          "type": "number",
          "const": 10000
        },
        {
          "type": "number",
          "const": 25000
        }
      ],
      "description": "Results per page: 10000 or 25000 (the vendor's only choices for this report). Large; omit for the vendor default."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based)."
    },
    "message": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,40}$",
      "description": "FireText message ID (see firetext_list_sent_messages)."
    },
    "reference": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "The custom reference set when sending (alternative to message)."
    },
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

firetext_get_sent_summary

Totals for a date range: number of campaigns, recipients and credits used. FireText: /sentreport.

read-only

Argument	Type	Description
to*	string	End date YYYY-MM-DD.
from*	string	Start date YYYY-MM-DD.
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "from",
    "to"
  ],
  "properties": {
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End date YYYY-MM-DD."
    },
    "from": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "Start date YYYY-MM-DD."
    },
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

firetext_list_keywords

SMS keywords on the account (keywordID, number, keyword, reference). FireText: /keywords.

read-only

Argument	Type	Description
pp	any	Results per page: 10, 25 (default), 50 or 100.
page	integer	Page number (1-based).
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "pp": {
      "anyOf": [
        {
          "type": "number",
          "const": 10
        },
        {
          "type": "number",
          "const": 25
        },
        {
          "type": "number",
          "const": 50
        },
        {
          "type": "number",
          "const": 100
        }
      ],
      "description": "Results per page: 10, 25 (default), 50 or 100."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based)."
    },
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

firetext_list_received_messages

Inbound SMS received on the account's FireText numbers/keywords (messageID, sentTo, keyword, receivedFrom, receivedOn, message). Dates YYYY-MM-DD; from="last" returns only what is new since the last call. FireText: /receivedmessages.

read-only

Argument	Type	Description
pp	any	Results per page: 10, 25 (default), 50 or 100.
to	string	End date YYYY-MM-DD.
from	string	Start date YYYY-MM-DD, or "last" for only what is new since the last access.
page	integer	Page number (1-based).
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "pp": {
      "anyOf": [
        {
          "type": "number",
          "const": 10
        },
        {
          "type": "number",
          "const": 25
        },
        {
          "type": "number",
          "const": 50
        },
        {
          "type": "number",
          "const": 100
        }
      ],
      "description": "Results per page: 10, 25 (default), 50 or 100."
    },
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End date YYYY-MM-DD."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4}-\\d{2}-\\d{2}|last)$",
      "description": "Start date YYYY-MM-DD, or \"last\" for only what is new since the last access."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based)."
    },
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

firetext_list_scheduled_messages

Messages queued for later sending (messageID, queuedOn, scheduledFor, recipientCount, sourceAddress, sendTo, message). FireText: /scheduledmessages.

read-only

Argument	Type	Description
pp	any	Results per page: 10, 25 (default), 50 or 100.
page	integer	Page number (1-based).
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "pp": {
      "anyOf": [
        {
          "type": "number",
          "const": 10
        },
        {
          "type": "number",
          "const": 25
        },
        {
          "type": "number",
          "const": 50
        },
        {
          "type": "number",
          "const": 100
        }
      ],
      "description": "Results per page: 10, 25 (default), 50 or 100."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based)."
    },
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

firetext_list_sent_messages

Messages (campaigns) sent from the account: messageID, sentOn, sentTo (group), recipientCount, message. The messageID is what the delivery and click reports need. Dates YYYY-MM-DD. FireText: /sentmessages.

read-only

Argument	Type	Description
pp	any	Results per page: 10, 25 (default), 50 or 100.
to	string	End date YYYY-MM-DD.
from	string	Start date YYYY-MM-DD, or "last" for only what is new since the last access.
page	integer	Page number (1-based).
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "pp": {
      "anyOf": [
        {
          "type": "number",
          "const": 10
        },
        {
          "type": "number",
          "const": 25
        },
        {
          "type": "number",
          "const": 50
        },
        {
          "type": "number",
          "const": 100
        }
      ],
      "description": "Results per page: 10, 25 (default), 50 or 100."
    },
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End date YYYY-MM-DD."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4}-\\d{2}-\\d{2}|last)$",
      "description": "Start date YYYY-MM-DD, or \"last\" for only what is new since the last access."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based)."
    },
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

firetext_list_unsubscribed

Contacts that opted out (names, mobile, custom fields, addedOn, unsubscribedOn, reason). Optional date range and group API id. FireText: /unsubscribed.

read-only

Argument	Type	Description
pp	any	Results per page: 10, 25 (default), 50 or 100.
to	string	End date YYYY-MM-DD.
from	string	Start date YYYY-MM-DD, or "last" for only what is new since the last access.
page	integer	Page number (1-based).
group	string	Group API ID to restrict to one group.
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "pp": {
      "anyOf": [
        {
          "type": "number",
          "const": 10
        },
        {
          "type": "number",
          "const": 25
        },
        {
          "type": "number",
          "const": 50
        },
        {
          "type": "number",
          "const": 100
        }
      ],
      "description": "Results per page: 10, 25 (default), 50 or 100."
    },
    "to": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "End date YYYY-MM-DD."
    },
    "from": {
      "type": "string",
      "pattern": "^(\\d{4}-\\d{2}-\\d{2}|last)$",
      "description": "Start date YYYY-MM-DD, or \"last\" for only what is new since the last access."
    },
    "page": {
      "type": "integer",
      "maximum": 100000,
      "minimum": 1,
      "description": "Page number (1-based)."
    },
    "group": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.-]{1,64}$",
      "description": "Group API ID to restrict to one group."
    },
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

firetext_send_sms

WRITE, SPENDS MONEY: sends a REAL SMS to real phones and uses the account's SMS credits (one credit per 160 GSM characters per recipient; long and unicode messages cost more). Cannot be undone. At most 10 recipients per call; no groups, templates, scheduling or repeats. Only call after the user confirmed the exact text, sender and numbers. FireText: /sendsms.

destructive

Argument	Type	Description
to*	array	Recipient mobile numbers (1-10): UK 07... / 447..., or international without + and leading zeros.
from*	string	Sender ID shown on the handset: 3-11 characters, letters and digits only (a company name or a reply number).
message*	string	Message text (UTF-8), up to 612 characters (160 per single GSM SMS, 153 per part when longer; unicode 70/66).
unicode	any	0 = GSM characters only (default), 1 = always unicode, 2 = auto-detect from the text.
reference	string	Optional custom reference stored against the message (usable in firetext_get_delivery_report).
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

firetext_subscribe_contact

WRITE: adds a contact (by mobile number) to the FireText account, optionally into a group, or with update=true refreshes the names/custom fields of an existing contact. Does not send any SMS. A contact that opted out cannot be re-added this way (they must rejoin by SMS). FireText: /subscribe.

destructive

Argument	Type	Description
group	string	Group API ID to add the contact to.
mobile*	string	Mobile number: UK 07700900123 / 447700900123, or international without + and leading zeros (e.g. 33612345678).
update	boolean	true = overwrite firstname, lastname and custom1-3 of an existing contact.
custom1	string
custom2	string
custom3	string
lastname	string
firstname	string
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

firetext_unsubscribe_contact

WRITE: opts a contact out of the FireText account (all groups by default), so it no longer receives group messages. The contact can only rejoin by SMS. Does not send any SMS. FireText: /unsubscribe.

destructive

Argument	Type	Description
group	string	Group API ID, only if the account unsubscribes per group.
mobile*	string	Mobile number: UK 07700900123 / 447700900123, or international without + and leading zeros (e.g. 33612345678).
subaccount	string	Sub-account ID (only when the account has the sub-account module). Omit for the main account.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "mobile"
  ],
  "properties": {
    "group": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.-]{1,64}$",
      "description": "Group API ID, only if the account unsubscribes per group."
    },
    "mobile": {
      "type": "string",
      "maxLength": 32,
      "minLength": 1,
      "description": "Mobile number: UK 07700900123 / 447700900123, or international without + and leading zeros (e.g. 33612345678)."
    },
    "subaccount": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_.@-]{1,64}$",
      "description": "Sub-account ID (only when the account has the sub-account module). Omit for the main account."
    }
  }
}

FireText MCP by usefulapi

Try it

firetext_get_click_report Read-only

FireText MCP by usefulapi

Try it

firetext_get_click_report Read-only

Tools (13)