smsmode_get_balance
Get the account balance
The credit balance of the connected smsmode account (and sub-organisations an administrator key can see): amount and currency (negative = owed on a POST_PAY account), payment type (PRE_PAY / POST_PAY), state, monthly consumption and its limit. Good first call; check it before sending SMS. GET /commons/v1/organisations.
Takes no parameters.
smsmode_get_organisation
Get an organisation
Full details of one organisation: contacts, addresses, company information, balance, monthly limit and consumption. GET /commons/v1/organisations/{id}.
Parametersorganisation_idrequired
smsmode_list_channels
List channels
List messaging channels (SMS or RCS; flow TRANSACTIONAL / MARKETING / OTP) with default sender, daily and monthly limits and consumption. A channel id is needed to scope messages or consumption to one channel. GET /commons/v1/channels.
Parametersflownamepagetypepage_size
smsmode_get_channel
Get a channel
Details of one channel: type, flow, default sender ID and authorized sender IDs, limits and consumption. GET /commons/v1/channels/{id}.
Parameterschannel_idrequired
smsmode_list_consumptions
List consumption statistics
Sent-message counts and money spent per month or per day (price amount and currency), optionally for one channel. Default: monthly, the last 3 months. GET /commons/v1/consumptions.
Parametersflowpageend_datepage_sizechannel_idstart_dateperiod_typechannel_typesort_by_start_date
smsmode_get_consumption
Get a consumption with its breakdown
One consumption record broken down by country (mcc) or network (mccMnc) with quantity and price per sub-item, optionally with delivery statuses. GET /commons/v1/consumptions/{id}.
Parametersgroup_byconsumption_idrequireddetail_statuses
smsmode_lookup_number
Look up a phone number's network
Country and mobile network (mcc/mnc, operator) of a phone number. Only for customers with a premium smsmode subscription and, for now, only French numbers (403 otherwise). GET /commons/v1/lookup/{msisdn}.
Parametersphone_numberrequired
smsmode_list_messages
List sent and received messages
Messages with delivery status (SCHEDULED, ENROUTE, DELIVERED, UNDELIVERABLE, UNDELIVERED; status.detail names the cause), recipient, sender, text, parts and price. Default window: the last 10 days. Filter by direction (MT = sent, MO = replies received), recipient, your reference, channel or campaign. Paged: pass next_page as page. GET /sms/v1/messages.
Parameterstopageend_datedirectionpage_sizechannel_idref_clientstart_datecampaign_idorigin_message_idsort_by_sent_date
smsmode_get_message
Get a message and its delivery status
One message: delivery status and detail, delivery date, recipient network, text, parts and price. GET /sms/v1/messages/{id}.
Parameterschannel_idmessage_idrequired
smsmode_list_campaigns
List SMS campaigns
Existing SMS campaigns (grouped sends) with status SCHEDULED / ONGOING / ENDED, quantity, price and per-status delivery counts. Read only: this server does not send campaigns. GET /sms/v1/campaigns.
Parameterspagestatusend_datepage_sizechannel_idref_clientstart_date
smsmode_get_campaign
Get an SMS campaign
One campaign: state, period, recipients count, text, price and delivery counts per status. Use smsmode_list_messages with campaign_id for its individual messages. GET /sms/v1/campaigns/{id}.
Parameterscampaign_idrequired
smsmode_send_sms
Send an SMS to 1-10 recipients
WRITE, SPENDS CREDIT: sends one SMS text to 1 to 10 recipients (one message each, a batch of unit messages) and texts REAL people immediately, or at send_at. Cost: every message is charged to the account at its destination's price per SMS part (GSM7: 160 characters for 1 part, 306 for 2, 459 for 3...; UNICODE: 70, 134, 201...); the accept reply returns each message's id and status (the price may only appear later on smsmode_get_message / smsmode_list_messages; total_price is given when present). A batch can partly fail: failures lists the refused numbers, which are not charged. A message is never retried: after a timeout or error, check smsmode_list_messages (ref_client) before sending again. Max 10 recipients, no campaigns or lists. Check smsmode_get_balance first. POST /sms/v1/messages.
Parameterstorequiredfromstoptextrequiredsend_atencodingref_client
smsmode_cancel_scheduled_message
Cancel a scheduled message
WRITE: cancels ONE message that is still scheduled (status SCHEDULED, sent with send_at) so it is not sent; smsmode refuses messages already sent. Cannot be undone. DELETE /sms/v1/messages/{id}.
Parametersmessage_idrequired