notifyre_list_sent_sms
List sent SMS
List SMS messages sent from the account, newest first by default, with recipient, status and cost. Without from_date the window is the last 30 days. Filter by status (processing, submitted, sent, failed), numbers, or a message id in search. Page with skip = next_skip. Notifyre API: GET /sms/send.
Parametersskipsortlimitsearchstatusto_datefrom_dateto_numberfrom_number
notifyre_get_sent_sms
Get a sent SMS
Get one sent SMS message with every recipient: status, delivery status, message parts, cost. Use the id from notifyre_list_sent_sms or notifyre_send_sms. Notifyre API: GET /sms/send/{id}.
Parametersmessage_idrequired
notifyre_get_sms_recipient
Get an SMS recipient message
Get the text and delivery details of one recipient of a sent SMS (status, parts, cost). Notifyre API: GET /sms/send/{messageId}/recipients/{recipientId}.
Parametersmessage_idrequiredrecipient_idrequired
notifyre_list_sms_replies
List SMS replies
List SMS replies received on the account's numbers. Without from_date the window is the last 30 days. from_number and to_number must be given together. include_reply_content adds the reply texts (then at most 20 per page). Page with skip = next_skip. Notifyre API: GET /sms/received.
Parametersskipsortlimitto_datefrom_dateto_numberfrom_numberrecipient_idinclude_reply_content
notifyre_get_sms_reply
Get an SMS reply
Get one received SMS reply with its text, sender and receiving number. Use the replyID from notifyre_list_sms_replies. Notifyre API: GET /sms/received/{id}.
Parametersreply_idrequired
notifyre_list_sms_numbers
List SMS numbers and sender IDs
List the account's SMS numbers (E.164, status, 10DLC campaign) and approved alphanumeric sender IDs. Use one of them as `from` when sending. Notifyre API: GET /sms/numbers.
Takes no parameters.
notifyre_list_sms_prices
List SMS prices
List the price of one SMS per destination country (country code, calling prefix, price, currency). Check it before sending: the cost of a send is price x message parts x recipients. Notifyre API: GET /sms/send/prices.
Takes no parameters.
notifyre_list_sent_faxes
List sent faxes
List faxes sent from the account (recipient, pages, quality, status, failure reason). Without from_date the window is the last 30 days. Filter by status (accepted, successful, in_progress, failed, queued). Page with skip = next_skip. Notifyre API: GET /fax/send.
Parametersskipsortlimitsearchstatusto_datefrom_date
notifyre_list_received_faxes
List received faxes
List faxes received on the account's fax numbers (sender, number, time, pages, duration, read flag). The fax documents are not downloaded. Without from_date the window is the last 30 days. Page with skip = next_skip. Notifyre API: GET /fax/received.
Parametersskipsortlimitto_datefrom_dateto_number
notifyre_list_fax_numbers
List fax numbers
List the account's fax numbers (E.164, region, status). Notifyre API: GET /fax/numbers.
Takes no parameters.
notifyre_list_fax_prices
List fax prices
List the price of sending a fax per destination country (country code, calling prefix, price, currency). Notifyre API: GET /fax/send/prices.
Takes no parameters.
notifyre_list_fax_cover_pages
List fax cover pages
List the fax cover page templates of the account (name and whether it is the default). The HTML of each template is left out. Notifyre API: GET /fax/coverpages.
Takes no parameters.
notifyre_list_contacts
List address book contacts
Search the address book. search_query matches the name; type FaxNumber or MobileNumber keeps contacts that have that number; group_ids limits to groups. Page numbers start at 0. Contacts that unsubscribed are left out unless include_unsubscribed is true. The unsubscribe key of a contact is never shown. Notifyre API: POST /addressbook/contacts/search (a read).
Parameterspagetypelimitsort_bysort_dirgroup_idssearch_queryinclude_unsubscribed
notifyre_get_contact
Get an address book contact
Get one contact: names, organization, email, fax and mobile number, groups, custom fields, unsubscribed flag. Notifyre API: GET /addressbook/contacts/{id}.
Parameterscontact_idrequired
notifyre_list_groups
List address book groups
List the address book groups with their contact counts. Notifyre API: GET /addressbook/groups.
Parameterssort_bysort_dirsearch_query
notifyre_list_brands
List 10DLC brands
List the account's registered 10DLC brands (US SMS sender registration). Notifyre API: GET /numbers/brands.
Takes no parameters.
notifyre_list_campaigns
List 10DLC campaigns
List the account's 10DLC campaigns (US SMS use-case registrations) and their status. Notifyre API: GET /numbers/campaigns.
Takes no parameters.
notifyre_send_sms
Send SMS
WRITE: SENDS REAL SMS to real people and SPENDS the prepaid balance of the user's Notifyre account; it cannot be undone or recalled and is never retried. One text to 1 to 10 mobile numbers in international format with "+" (e.g. +61412345678); no contacts, no groups, no scheduling. Cost = price per message part (see notifyre_list_sms_prices; it depends on the destination country) x number of parts x number of recipients; the text may be up to 640 characters (160 per part, 70 with emoji or non-GSM characters, a little less per part when it is longer). Only send what the user explicitly asked for: confirm the exact text, the recipients and the sender first. Recipients must have agreed to receive messages. A commercial SMS needs an opt-out (Australia: Spam Act 2003; Notifyre Terms and Conditions 13.5): set add_unsubscribe_link true to append Notifyre's opt-out link, or put your own opt-out instruction in the text. The default is false, so the requirement is yours to meet. US numbers need a registered 10DLC campaign. Omit `from` to send from a Notifyre shared number. An unclear result (timeout, HTTP 5xx) means the message may still have been sent: check notifyre_list_sent_sms before trying again. Notifyre API: POST /sms/send.
Parameterstorequiredbodyrequiredfromcampaign_nameadd_unsubscribe_link
notifyre_create_contact
Create a contact
WRITE: adds one contact to the Notifyre address book. Give at least a name or a number. Numbers in international format (e.g. +61412345678). groups takes existing group ids; group_name puts the contact in that group and CREATES the group if it does not exist. Creating the same contact twice may make a duplicate. Notifyre API: POST /addressbook/contacts.
Parametersemailgroup_idslast_namefax_numberfirst_namegroup_nameorganizationmobile_number
notifyre_create_group
Create a contact group
WRITE: creates one address book group with the given name. Notifyre API: POST /addressbook/groups.
Parametersnamerequired
notifyre_add_contacts_to_groups
Add contacts to groups
WRITE: adds existing contacts to existing groups (up to 100 contacts and 20 groups). Contacts keep their other groups. Adding a contact to a group does not send anything, but a later send to that group reaches it. Notifyre API: POST /addressbook/groups/contacts.
Parametersgroup_idsrequiredcontact_idsrequired