¶ Description
Query the status of a SMS sent with OVH.
¶ Parameters
¶ Parameters tab
Parameters:
- SMS ID
- Filter on creation date (from) (>=)
- Filter on creation date (to) (>=)
- Filter on receiver
- Filter on sender
- Filter on tag
- Application key
- Application secret
- Consumer key
- Debug information level
- Optional: extra parameters for cURL
- Number of retries on connection error
¶ Description tab
Parameters:
- Script name
- Short description
- Revision
- Decription
¶ Configuration tab
See dedicated page for more information.
¶ About
ovhQuerySMS retrieves SMS messages and their delivery metadata from your OVHcloud SMS account. You can:
- Look up a single SMS by its unique
smsID. - List multiple messages within a date range, optionally filtered by sender, receiver, or tag.
- Inspect delivery information (e.g., state, timestamps, error info), useful for reconciliation and monitoring.
Typical uses: confirm delivery of a message you sent, export messages from the last day/week for analytics, or audit messages sent by a specific sender.
¶ Prerequisites
-
OVHcloud SMS account with API access.
-
The three OAuth credentials:
- AK – Application Key
- AS – Application Secret
- CK – Consumer Key (grants rights to your account’s SMS endpoints)
If you haven’t created these yet, follow the “First-time setup & credentials” section from the ovhSendSMS action documentation (same credentials are used here).
¶ Add the action & wire your flow
- Drag OVH – Query SMS into your pipeline.
- Connect its input pin to the data step that holds the filters you plan to use (e.g., a table with
smsID, dates, etc.), or leave it unconnected if you’ll enter values manually.
¶ Parameters (how to fill them)
¶ Identify what to retrieve
You can use one of two approaches:
- Query a specific SMS
SMS ID: Provide the uniquesmsID(either type a value or pick a column via the selector).
WhenSMS IDis set, date/sender/receiver/tag filters are typically ignored.
- List a set of messages
Filter on creation date (from) (≥)/Filter on creation date (to) (≥): Creation-time window in ISO-8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
Example:2025-09-11T00:00:00+02:00.Filter on receiver: Limit to a specific destination number (E.164 recommended, e.g.,+33612345678).Filter on sender: Limit to a specific sender (alphanumeric or number configured in OVH).Filter on tag: Limit to messages tagged with a given value (if you tag messages at send time).
Filters combine with AND logic (e.g., date range and sender). Leave a filter empty to ignore it.
¶ Authentication
AK: Your OVH Application KeyAS: Your OVH Application SecretCK: Your OVH Consumer Key
¶ Run-time controls
idDebug: Logging detail (nothing,basic,verbose)idOptional: Extra cURL flags if your network setup requires them (rare).nRetry: How many times to retry on transient connection errors.
¶ Output
The action returns one row per SMS that matches your query. Common fields include:
- Identifiers & parties:
id/smsID,sender,receiver - Timestamps: creation, sending, delivery (as available)
- Status & diagnostics: delivery state (e.g., sent, delivered, failed), carrier codes/messages
- Misc: message length/parts, tags, and other provider metadata
Field names may vary slightly by account/endpoint; use the Records or Data tab after a test run to see the exact schema returned in your environment.
¶ Examples
¶ A) Check one message by ID
SMS ID: Select a column (e.g.,smsID) from the upstream table using the column selector, or type the ID.- Leave date/sender/receiver/tag filters empty.
- Provide AK/AS/CK.
- Run. You’ll get a single row (if found) with its current delivery state.
¶ B) List messages from the last 24 hours
Filter on creation date (from) (≥):{{ now_utc_minus_24h_iso }}(or type yesterday’s ISO date/time)Filter on creation date (to) (≥):{{ now_utc_iso }}(or type now)Filter on sender/Filter on receiver/Filter on tag: leave empty (or set as needed)- AK/AS/CK set → Run. You’ll get all messages created in that window.
¶ C) All messages to a specific receiver this week
- Set
Filter on creation date (from) (≥)andFilter on creation date (to) (≥)for this week. Filter on receiver:+1XXXXXXXXXX- Provide AK/AS/CK → Run.
¶ Tips & good practices
- Time zone: OVH expects ISO-8601 with an explicit offset. Keep your pipeline consistent (UTC recommended).
- Exact match filters: Sender/receiver/tag are matched as provided; avoid spaces/formatting quirks.
- Pagination: If your date window is very large, prefer smaller windows for faster, lighter runs.
¶ Troubleshooting
| Symptom | Likely cause | Fix |
|---|---|---|
403 Not authorized |
Missing or restricted CK rights | Recreate the Consumer Key with SMS read permissions (see ovhSendSMS setup) and approve it. |
Invalid signature / 401 |
Wrong AK/AS/CK pairing | Ensure AK/AS belong to the same app as CK; paste values carefully. |
| Empty result set | Filters too restrictive | Verify smsID, phone formats, tags, and date window; test a broader time range. |
| Timeout / transient errors | Network hiccups | Increase nRetry and try again; keep date ranges smaller. |
¶ Security notes
- Keep AK/AS/CK in your platform’s secret storage.
- Restrict Consumer Key scopes to SMS endpoints you actually need.
- Rotate keys periodically and revoke unused CKs from the OVH API Console.
