Note: Status reports can be routed back to you via HTTP, which is the preferred way for you to receive status reports.
This API call may be useful to you, however, if you are not permanently connected to the Internet, but still need to be able to query for status reports.
URL: http://www.flashsms.co.uk:5567/eapi/status_reports/get_report/2/2.0
Example: http://www.flashsms.co.uk:5567/eapi/status_reports/get_report/2/2.0?username=john&password=abcd1234&batch_id=123456
Required parameters
- username
- password
- batch_id: the id returned by a successful submission to send_sms (>= ver 2.0)
Optional parameters
- msisdn: supply if querying the status of a single recipient.
- optional_fields: a comma-separated list of optional fields to return in the output, chosen from this list:
- body
- completed_time
- created_time
- credits
- origin_address
- source_id
Returns on failure:
request_status_code|request_status_description
values for status_code are:
- 22: Internal error
- 23: Authentication failure
- 24: Data validation failed
Returns on success:
0|Results to follow\n\n
Followed by one or more newline-separated items in the format:
msisdn|status_code[|optional_field_1][|optional_field_2]...
Optional fields will be returned in the order that you specified them.
values for status_code are:
- 0: In progress (a normal message submission, with no error encountered so far).
- 10: Delivered upstream
- 11: Delivered to mobile
- 12: Delivered upstream unacknowledged (assume message is in progress)
- 22: Internal fatal error
- 23: Authentication failure
- 24: Data validation failed
- 25: You do not have sufficient credits
- 26: Upstream credits not available
- 27: You have exceeded your daily quota
- 28: Upstream quota exceeded
- 29: Message sending cancelled
- 31: Unroutable
- 32: Blocked (probably because of a recipient's complaint against you)
- 33: Failed: censored
- 40: Temporarily unavailable
- 50: Delivery failed - generic failure
- 51: Delivery to phone failed
- 52: Delivery to network failed
- 53: Message expired
- 54: Failed on remote network
- 56: Failed: remotely censored
- 57: Failed due to fault on handset (e.g. SIM full)
- 60: Transient upstream failure (transient)
- 61: Upstream status update (transient)
- 62: Upstream cancel failed (transient)
- 63: Queued for retry after temporary failure delivering (transient)
- 64: Queued for retry after temporary failure delivering, due to fault on handset (transient)
- 70: Unknown upstream status
Previous versions
Documentation for older versions of this API can be found here
Upgrading notes
Incompatibilities: if upgrading from v1.x to v2.x, note that you should also be using version 2.x of send_sms. Correspondingly, msg_id has been replaced by batch_id, and also note that a successful query will result in status code 0 being returned, instead of the previous status code 1000. For other enhancements and backward-compatible changes, see the Changelog below.
|
16-Mar-2007
- Added statuses 33, 54 and 56.
05-Mar-2007
- Added statuses 57, 63 and 64.
22-Feb-2006
- Removed status 30, added 31 and 32.
13-Aug-2004
- Version 2.0:
- changed content type to text/plain.
- now supporting batch ids instead of message ids, for compatibility with send_sms 2.0.
- successful status changed from 1000 to 0.
- Removed error status 1001 in the case where no matching batch is found: will now just return zero result rows.
-
Added optional fields in output.
|
