Sprint Services
Sprint is providing a set of network and product services (please note these services are available
only to CDMA devices at this time)
- iDEN Content upload service
- Location 4G
- Geo-Fencing
- User Management
- LBS
- Messaging
- Presence
- Additional services are planned in the future
High Level overview of Terms and Conditions
Please see detailed Terms and Conditions for complete details.
- Sprint will cap total service requests per each developer to 500 per day
- This is a developer Sandbox, not a production environment
- No SLAs on uptime or QOS
- If a developer has a need for a higher number of requests, SLA on uptime or QOS then we recommend using a Platform Enabler that we have signed contracts with
Authentication
All Sprint Sandbox API requests will need to be authenticated by a digital signature. The signature is a MD5 digest of the parameters sorted in alphabetical order appended with the shared secret. The API Key, the request created timestamp and the signature are the minimum required parameters for every API request.
http://sprintdevelopersandbox.com/developerSandbox/resource/v1/location.txt?
key=ABCD123XYZ&mdn=8005554679×tamp=2009-10-01T12:00:00CDT
&sig=952a9bdc6b918c452905d62f085557be
sig = MD5("keyABCD123XYZmdn8005554679timestamp2009-10-01T12:00:00CDTSECRET")API Key
The API Key is a system generated value assigned to each Sandbox
Developer Account. The API Key can be found on the
User Management page.
Created Timestamp
This is the timestamp of when the request was created formatted in ISO-8601.
Shared Secret
A value shared between the developer and the Sprint Sandbox to be used for secure communication. The shared secret is located below the API Key on the User Management page.
Signature
An MD5 digest of the parameters sorted in alphabetical order, appended by the shared secret.
params = "mdn=8005554679&key=ABCD123XYZ×tamp=2009-10-01T12:00:00CDT"
sig = MD5("keyABCD123XYZmdn8005554679timestamp2009-10-01T12:00:00CDTSECRET")Overview of the services
- iDEN Content upload service
- Sprint http: response codes
- The service should be used to upload the content to a iDEN device.
- This service currently support only "Java" applications.
- Geofencing
- Sprint http: response codes
- Determines if an MDN is within a requested location.
- User Management
- Sprint http: response codes
- Provides functionality to list, add and remove MDNs.
- Location Service
- Sprint HTTP response codes
- Network based using AFLT triangulation
- Approximately within 100 meters in accuracy
- Can get updated LBS info every 5 minutes per each mobile device number
Any request received within the 5 minutes will get a cached LBS response
- 4G Location Service
- Sprint HTTP response codes
- Network based using AFLT triangulation
- Approximately within 100 meters in accuracy
- This service allows for 3G/4G location interoperability
- Messaging
- Sprint HTTP response codes
- SMTP will be delivered as a SMS
- Messages longer than 160 characters will be broken up into separate messages
- SMS Status
- Sprint HTTP response code
- Presence
- Sprint http: response codes
- Determine whether device is on/off the network (either the device is powered off or roaming)
- Error Codes
Web Service Descriptions
The general API URL is composed of four segments; two segments for the URL path, one segment to denote version and the last segment denoting the resource.
iDEN Content upload service
Back to Overview- Method
- iDEN Content upload service
- Additional Instructions
- After a successful transaction assigns the app to a iDEN device and the user has to navigate on the device to Menu -> Java Apps -> Download Apps -> New Purchases to download the Application.
- Url
- http://sprintdevelopersandbox.com/developerSandbox/resources/v1/iden
- Http Method
- POST *URL Post, not Form Post
- URL Param
-
- Key - Key from sandbox
- PTN - phone Number ( 10 digit - No special chars)
- Link to the App - Link to the application (Zip file that has Jad and Jar)
- Size of the app - Exact Size of the Zip file in bytes.
- Example Inputs
- ABCD123XYZ, 8005554679, http://144.230.114.37/adp6/upload/upload/C2s.zip, 16892
- Example Call
- POST http://sprintdevelopersandbox.com/developerSandbox/resources/v1/iden?key=ABCD123XYZ&ptn=8005554679&appLink=http://144.230.114.37/adp6/upload/upload/C2s.zip&appSize=16892
- Response
- ASSIGNMENT_COMPLETE
- Error
-
- INVALID_PTN - Not a 10 digit phone number
- INVALID_FILENAME - Not a "zip" file.
- INVALID_FILESIZE - File size less than 50 bytes
- SERVER_EXCEPTION - Unexpected exception. Please try Again.
Geofencing
Back to Overview- Method
- Geo Fencing
- Url
- http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence.{format}
- Http Method
- GET
- Format
- plain text (.txt)
json (.json)
xml (.xml) - Inputs
- mdn, key, lat, lon, rad, sig, timestamp
- Example Inputs
- 8005554679, ABCD123XYZ, 35.66, 139.70, 5, 123abc456, 2009-10-01T12:00:00CDT
- Example Call
- GET http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence.txt?mdn=8005554679&key=ABCD123XYZ&lat=35.66&long=139.70&rad=5×tamp=2009-10-01T12:00:00CDT&sig=123abc456
- Response
- mdn, requested lat, requested lon, radius, actual lat, actual lon, accuracy in meters, status, comments
8005554679,35.66,139.70,5,38.91484,-94.65733,127,OUTSIDE,
8005554679,35.66,139.70,200,38.91484,-94.65733,127,OUTSIDE, RADIUS_LOWER_THAN_LOCATION_ACCURACY
- Error
-
INVALID_KEY (Key not found, Not a valid key)
EXPIRED_KEY (Key Expired)
MDN_NOTVALID (MDN is not Opted-in)
INVALID_MDN (Not authorized to track location, Not a valid 10 digit number)
GEO FENCING_ERROR (Service Exception on server side)
EXHAUSTED_DIPS (Exceeded transaction limit)
Failure
Error
User Management
Back to Overview- Method
- Devices *plural
- Url
- http://sprintdevelopersandbox.com/developerSandbox/resources/v1/devices.{format}
- Http Method
- GET
- Format
- plain text (.txt)
json (.json)
xml (.xml) - Inputs
- key, timestamp, sig, type (optional), mdn (optional)
- Input "Type" Options
-
- No including type for All MDNs
- "p" for Pending MDNs
- "a" for Approved MDNs
- "mdn" to show a single MDN, MDN parameter is required with this type.
- For a list of all MDNs, do not include type param
- Example Inputs
- ABCD123XYZ, 2009-10-01T12:00:00CDT, 123abc456, A
- Example Call
-
GET http://sprintdevelopersandbox.com/developerSandbox/resources/v1/devices.txt?key=ABCD123XYZ&type=p×tamp=2009-10-01T12:00:00CDT&sig=123abc456
GET http://sprintdevelopersandbox.com/developerSandbox/resources/v1/devices.txt?key=ABCD123XYZ&type=mdn&mdn=8005554561×tamp=2009-10-01T12:00:00CDT&sig=123abc456 - Response
- userName, status, MDN
user1,Pending,8005554561,8885559876
user1,Approved,8005551728,8005554679 - Error
-
INVALID_KEY (Key not found, Not a valid key)
INVALID_MDN (Not authorized to track location, Not a valid 10 digit number)
PHONE LIST_ERROR (Service Exception on server side)
Failure
Error
- Method
- Device *singular
- Url
- http://sprintdevelopersandbox.com/developerSandbox/resources/v1/device.{format}
- Http Method
- GET
- Format
- plain text (.txt)
json (.json)
xml (.xml) - Inputs
- key, mdn, method, timestamp, sig
- Input "Method" Options
-
- "add" to add an MDN
- "delete" to remove an MDN
- Example Inputs
- ABCD123XYZ, 8005554679, add, 2009-10-01T12:00:00CDT, 123abc456
- ABCD123XYZ, 8005554679, delete, 2009-10-01T12:00:00CDT, 123abc456
- Example Call
- GET http://sprintdevelopersandbox.com/developerSandbox/resources/v1/device.txt?method=add&key=ABCD123XYZ&mdn=8005554679×tamp=2009-10-01T12:00:00CDT&sig=123abc456
- GET http://sprintdevelopersandbox.com/developerSandbox/resources/v1/device.txt?method=delete&key=ABCD123XYZ&mdn=8005554679×tamp=2009-10-01T12:00:00CDT&sig=123abc456
- Response
- status
SUCCESS - Error
-
INVALID_KEY (Key not found, Not a valid key)
EXPIRED_KEY (Key Expired)
MDN_NOTVALID (MDN is not Opted-in)
INVALID_MDN (Not authorized to track location, Not a valid 10 digit number)
ADD PHONE_ERROR (Service Exception on server side)
EXHAUSTED_DIPS (Exceeded transaction limit)
Failure
Error
Location
Back to Overview- Method
- Location
- Url
- http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/location.{format}
- Http Method
- GET
- Format
- plain text (.txt)
json (.json)
xml (.xml) - Inputs
- mdn, key, timestamp, sig
- Example Inputs
- 8165553456, ABCD123XYZ, 2009-10-01T12:00:00CDT, 123abc456
- Example Call
- GET http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/location.txt?mdn=8165553456&key=ABCD123XYZ×tamp=2009-10-01T12:00:00CDT&sig=123abc456
- Response
- mdn, lat, long, accuracy in meters
9998887777,38.87447,-94.665115, 134
9132212444,38.87422,-94.66496,134,PREVIOUS_LOCATION (If tried within 5 Mins) - Error
-
INVALID_KEY (Key not found, Not a valid key)
EXPIRED_KEY (Key Expired)
MDN_NOTVALID (MDN is not Opted-in)
INVALID_MDN (Not authorized to track location, Not a valid 10 digit number)
LOCATION_ERROR (Service Exception on server side)
EXHAUSTED_DIPS (Exceeded transaction limit)
Failure
Error
4G Location
Back to Overview- Method
- Location4g
- Url
- http://sprintdevelopersandbox.com/developerSandbox/resources/v1/location4g.{format}
- Http Method
- GET
- Format
- plain text (.txt)
json (.json)
xml (.xml) - Inputs
- key, mac, mdn(optional), timestamp, sig
- Example Inputs
- 8165553456, ABCD123XYZ, 2009-10-01T12:00:00CDT, 123abc456
- Example Calls
- GET http://sprintdevelopersandbox.com/developerSandbox/resources/v1/location4g.txt?mac=XXXXXXXXXXXX&mdn=8165553456&key=ABCD123XYZ×tamp=2009-10-01T12:00:00CDT&sig=123abc456
- GET http://sprintdevelopersandbox.com/developerSandbox/resources/v1/location4g.txt?mac=XXXXXXXXXXXX&key=ABCD123XYZ×tamp=2009-10-01T12:00:00CDT&sig=123abc456
- Response
- mdn, lat, long, accuracy in meters
9998887777,38.87447,-94.665115, 134 - Error
-
INVALID_KEY (Key not found, Not a valid key)
EXPIRED_KEY (Key Expired)
MAC_NOTVALID (Not a valid 12 digit mac address)
MDN_NOTVALID (MDN is not Opted-in)
INVALID_MAC (Not authorized to track location)
INVALID_MDN (Not authorized to track location, Not a valid 10 digit number)
LOCATION_ERROR (Service Exception on server side)
EXHAUSTED_DIPS (Exceeded transaction limit)
Failure
Error
SMS
Back to Overview- Method
- SMS
- Url
- http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/sms.{format}
- Http Method
- GET
- Format
- plain text (.txt)
json (.json)
xml (.xml) - Inputs
- mdn, senderName, message, key, timestamp, sig
- Example Inputs
- 8165553456,Joe,Ready to learn about sprint dev sandbox?,ABCD123XYZ, 2009-10-01T12:00:00CDT, 123abc456
- Example Call
- GET http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/sms.txt?mdn=8165553456&senderName=Developer&message=Ready%20to%20learn%20about%20sprint%20dev%20sandbox&key=ABCD123XYZ×tamp=2009-10-01T12:00:00CDT&sig=123abc456
- Response
- mdn, sms tracking number
8165553456, 4608614 - Error
-
INVALID_KEY (Key not found, Not a valid key)
EXPIRED_KEY (Key Expired)
MDN_NOTVALID (MDN is not Opted-in)
INVALID_MDN (Not authorized to track location, Not a valid 10 digit number)
SMS_ERROR (Service Exception on server side)
EXHAUSTED_DIPS (Exceeded transaction limit)
Failure
Error
SMS Status
Back to Overview- Method
- SMS Status
- Url
- http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/smsStatus.{format}
- Http Method
- GET
- Format
- plain text (.txt)
json (.json)
xml (.xml) - Inputs
- sms tracking nunber, key, timestamp, sig
- Example Inputs
- 4608614, ABCD123XYZ, 2009-10-01T12:00:00CDT, 123abc456
- Example Call
- GET http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/smsStatus.txt?tranno=4608614&key=ABCD123XYZ×tamp=2009-10-01T12:00:00CDT&sig=123abc456
- Response
- sms tracking number, mdn Message sent to,status
4608614, 8165553456, DeliveryUncertain (SMS Deliverd)
4608614, 8165553456, DeliveryImpossible (SMS Failed) - Error
-
INVALID_KEY (Key not found, Not a valid key)
EXPIRED_KEY (Key Expired)
MDN_NOTVALID (MDN is not Opted-in)
INVALID_MDN (Not authorized to track location, Not a valid 10 digit number)
SMS STATUS_ERROR (Service Exception on server side)
EXHAUSTED_DIPS (Exceeded transaction limit)
Failure
Error
Presence
Back to Overview- Method
- Presence
- Url
- http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/presence.{format}
- Http Method
- GET
- Format
- plain text (.txt)
json (.json)
xml (.xml) - Inputs
- mdn, key, timestamp, sig
- Example Inputs
- 8165553456, ABCD123XYZ, 2009-10-01T12:00:00CDT, 123abc456
- Example Call
- GET http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/presence.txt?mdn=8165553456&key=ABCD123XYZ×tamp=2009-10-01T12:00:00CDT&sig=123abc456
- Response
- mdn, status
8165553456, Reachable (On Sprint Network and Device is Powered On)
8165553456, Unreachable (Off Sprint Network and Device is Powered Off) - Error
-
INVALID_KEY (Key not found, Not a valid key)
EXPIRED_KEY (Key Expired)
MDN_NOTVALID (MDN is not Opted-in)
INVALID_MDN (Not authorized to track location, Not a valid 10 digit number)
PRESENCE_ERROR (Service Exception on server side)
EXHAUSTED_DIPS (Exceeded transaction limit)
Failure
Error
Error Codes
Back to OverviewPossible Reasons for INVALID_MDN:
- Not Opted In or Opted Out
- Not a valid 10 digit MDN Number
Possible reasons for *Failure* or *Error* (* is a wildcard, examples include SMS_ERROR, Presence_ERROR, etc)
- Tried to call a service more than once in a minute
- Server or Webservice Exception
- Server Outage
Questions/Feedback
Please go to the Sprint Forum for Sprint Developer Sandbox ? Network and Product Services to post any questions or provide feedback
| What do you want to do? |
|
| Share and Save |
|
| Related Items |
|