Sprint Services



Sprint is providing a set of network and product services.

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
  • Each Sandbox account is limited to 5 devices.
  • 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

The Sprint Developer Sandbox offers two forms of authentication to secure your service calls:

  • A generated MD5 Signature
    • This is a MD5 digest of the parameters sorted in alphabetical order appended with the shared secret.
    • For more information on generating a digital signature in your applications read the Authentication page.
  • Token based authentication: Token based authentication is simply the Developer's API key.

 

Geofence

The following series of services are part of the Geofence API. Click here for a high-level overview of Geofence.

Fence Operations (Click Here for the Definition)

This segment of services is used to create, review and modify your geofences.

List (Click Here for the Definition)

list.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/list.{format}?{params}

This service is used to return all geofences associated with a user.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key Your API Key, click here to view.
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]
  • [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • fenceId ID of the fence associated with the user.
  • status Whether or not the fence is currently active (monitoring) or inactive (not monitoring).
  • startEndTime The times between which the fence monitors (if active), i.e. 915-1430, times are military.
  • days Days the fence monitors (if active), note: H=Thurs, A=Sat.
  • lastMonitor Date\Time of the last check on this fence.
  • latitude Center latitude on which the fence is based.
  • longitude Center longitude on which the fence is based.
  • dimensions Dimensions of the fence (currently “radius” is v1 of geofence).

Example Request

Get
    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/list?key=123abckey×tamp=2010-03-05T10:12:00CST&sig=123abcdef456
Example Response
    110(Inactive, 900-1700, MTWHF, NEVER, 38.9178, -94.6598, 50), 427(Active, 930-1115, SA, NEVER, 38.9178, -94.6598, 500)

Add (Click Here for the Definition)

add.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/add.{format}?{params}

This service is used to add a fence.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key Your API Key, click here to view.
  • name The name of the fence.
  • strtTime Earliest time to start monitoring the fence, format [HH][MM]
  • note: [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

  • endTime Latest time to monitor the fence, format [HH][MM]
  • note: [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

  • lat Center latitude on which to base the fence.
  • long Center longitude on which to base the fence.
  • dim Dimensions of the fence (for v1 of geofence, this is the radius).
  • interval The interval at which the fence should be checked;

    note: only increments of 5 min are allowed; i.e. 5, 15, 25, etc.

  • days Days on which the fence should be monitored, as a String with a single representing each day
  • note: H=Thurs, A=Sat; i.e. SMTWHFA.

  • notifyEvent Whether the fence should notify on “in”, “out” or “both” (excluding this param will default to “both”).
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]
  • note: [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response:

  • message Success message if recipient was added or an error message.
Example Request: Get http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/add?key=123abckey& name=My%20Fence&strtTime=900&endTime=1700&lat=38.917806&long=-94.659787&dim=50&interval=15&days=MTWHF×tamp=2010-03-05T10:12:00CST&sig=123abcdef456

Example Response

FENCE_ADDED

Activate (Click Here for the Definition)

activate.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/activate.{format}?{params}

This service is used to activate an existing fence.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key Your API Key, click here to view.
  • fenceId The ID of the fence to activate.
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]
  • [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

message: Success message if fence was activated or an error message.
Example Request
Get
    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/activate?key=123abckey&fenceId=110×tamp=2010-03-05T10:12:00CST&sig=123abcdef456
Example Response
    FENCE_ACTIVATED

Deactivate (Click Here for the Definition)

deactivate.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/deactivate.{format}?{params}
This service is used to deactivate an existing fence.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key Your API Key, click here to view.
  • fenceId The ID of the fence to activate.
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]
  • [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

message Success message if fence was deactivated or an error message.

Example Request

Get:
    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/deactivate?key=123abckey&fenceId=110×tamp=2010-03-05T10:12:00CST&sig=123abcdef456
Example Response
    FENCE_DEACTIVATED

Device Operations (Click Here for the Definition)

The services following are used to maintain devices being tracked in relation to a specific geofence.

List (Click Here for the Definition)

listDevices.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/listDevices.{format}?{params}
This service is used to return all devices associated with a geofence.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key Your API Key, click here to view.
  • fenceId The ID of the fence whose recipients you want listed.
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]
  • [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • deviceId ID of the device associated with the fence.
  • mdn MDN of the fence device.

Example Request

Get
    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/listDevices?key=123abckey&fenceId=110×tamp=2010-03-05T10:12:00CST&sig=123abcdef456
Example Response
    1(8165551111), 14(9135552121)

Add (Click Here for the Definition)

addDevice.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/addDevice.{format}?{params} This service is used to add a device to a fence.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key Your API Key, click here to view.
  • fenceId The ID of the fence to add the device to.
  • Mdn MDN of the device.
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]
  • [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).

  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

message Success message if device was added or an error message.

Example Request

Get
    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/addDevice?key=123abckey&fenceId=110&mdn=9135552121×tamp=2010-03-05T10:12:00CST&sig=123abcdef456
Example Response
    DEVICE_ADDED

Delete (Click Here for the Definition)

deleteDevice.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/deleteDevice.{format}?{params}
This service is used to delete an existing fence device.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key Your API Key, click here to view.
  • deviceId The ID of the device to delete.
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ] [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).
  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

message Success message if device was deleted or an error message.

Example Request

Get
    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/deleteDevice?key=123abckey&deviceId=217×tamp=2010-03-05T10:12:00CST&sig=123abcdef456
Example Response
    DEVICE_DELETED

Recipient Operations (Click Here for the Definition)

Recipients of notifications for a particular geofence are managed with these services.

List (Click Here for the Definition)

listRecipients.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/listRecipients.{format}?{params}
This service is used to return all recipients associated with a geofence.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key Your API Key, click here to view.
  • fenceId The ID of the fence whose recipients you want listed.
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ] [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).
  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • recipientId: ID of the recipient associated with the fence.
  • mdnURL: MDN or URL of the notification recipient.

Example Request

Get
    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/listRecipients?key=123abckey&fenceId=110×tamp=2010-03-05T10:12:00CST&sig=123abcdef456
Example Response
    112(8165551111), 146(9135552121), 327(http://www.notifymyapp.com)

Add (Click Here for the Definition)

addRecipient.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/addRecipient.{format}?{params}
This service is used to add a recipient (may be either an MDN or URL) to a fence.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key Your API Key, click here to view.
  • fenceId The ID of the fence to add the recipient to.
  • mdnURL MDN or URL for the notification recipient.
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ] [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).
  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • message Success message if recipient was added or an error message.

Example Request

Get
    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/addRecipient?key=123abckey&fenceId=110&mdnURL=9135552121×tamp=2010-03-05T10:12:00CST&sig=123abcdef456
Example Response
    RECIPIENT_ADDED

Delete (Click Here for the Definition)

deleteRecipient.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/deleteRecipient.{format}?{params} This service is used to delete an existing fence notification recipient.
Authentication
This method requires a generated MD5 signature.

Arguments

  • key Your API Key, click here to view.
  • recipientId The ID of the recipient to delete.
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ] note: [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).
  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

message Success message if recipient was deleted or an error message.

Example Request

Get
    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/deleteRecipient?key=123abckey&recipientId=217×tamp=2010-03-05T10:12:00CST&sig=123abcdef456
Example Response
    RECIPIENT_DELETED

Perimeter Check (Click Here for the Definition)

checkPerimeter.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/checkPerimeter.{format}?{params}
This service is used to determine if a device is inside a defined area, or “fence.”
Authentication
This method requires a generated MD5 signature.

Arguments

  • mdn The MDN of the device to be located.
  • key Your API Key, click here to view.
  • lat The latitude of the center of the geofence.
  • long The longitude of the center of the geofence.
  • rad The size of the fence in meters.
  • timestamp The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ] Note: [HH] refers to a zero-padded hour between 00 and 23 (where 00 is used to notate midnight at the start of a calendar day).
  • sig The MD5 Digest value of the parameters of the geofence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • mdn The mdn of the device that was located.
  • latReq The requested latitude for the center of the fence.
  • lonReq The requested longitude for the center of the fence.
  • radReq The requested radius of the fence, in meters.
  • latRes The actual latitude of the requested device.
  • lonRes The actual longitude of the requested device.
  • accuracy The accuracy of the location fix for the device.
  • status The status of the request, meaning that if device is inside or outside of the fence.
  • comment Additional information pertaining to the fence, this is only displayed if there is an issue with one of your parameters, e.g. your radius is smaller than your accuracy.

Example Request

Get
    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/geofence/checkPerimeter?key=123abckey&mdn=9135555151&lat=38.917806&long=-94.659787&rad=5×tamp=2010-03-05T10:12:00CST&sig=123abcdef456
Example Response
    9135555151,38.917806,-94.659787,5.0,38.914948, -94.65723,0.0,OUTSIDE

Geofence Errors (Click Here for the Definition)

Errors

  • INVALID_LAT_LONG Latitude\Longitude is invalid.
  • INVALID_COORDINATES Coordinates are invalid.
  • INVALID_ACTION Action (i.e. checkPerimeter, add, addRecipient, etc) is invalid.
  • INVALID_KEY Key is invalid.
  • INVALID_FENCE Fence referenced is invalid.
  • INVALID_FENCE_ID Fence ID is invalid.
  • INVALID_RECIPIENT Recipient referenced isn’t valid.
  • INVALID_TIME Time entered for fence isn’t valid.
  • INVALID_LATITUDE Latitude is not valid.
  • INVALID_LONGITUDE Um, what do you think this means?
  • INVALID_RADIUS Radius isn’t valid.
  • EXPIRED_KEY The API key has expired.
  • INVALID_MDN Not a valid 10 digit number.
  • LOCATION_ERROR A service exception occurred on the server side.
  • EXHAUSTED_DIPS You have exceeded your transaction limit.
  • GENERAL_FAILURE We don’t really know what happened.

Location Services:

A series of network level LBS services.

Location 3G (Click Here for the Definition)

location.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/location.{format}?{params}

Determines the location of a Sprint CDMA Device that is opted in to a developer's account. This service can be accessed once every 5 minutes for a new location, otherwise it will returned a cached location.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key: You're API Key, click here to view.
  • mdn: The MDN of the device to be located.
  • Timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]
  • [HH] refers to a zero-padded hour between 00 and 23 (where 00 is only used to notate midnight at the start of a calendar day).

  • Signature: The MD5 Digest value of the parameters of the location service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • mdn: The mdn of the device that was located.
  • lat: The latitude of the device.
  • lon: The longitude of the device.
  • accuracy: The accuracy of the location fix in meters.
  • oldLocation: Only appears if the location has been requested more than once in the last 5 minutes for this mdn.

Example

Request

Get:

    http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/location.xml?mdn=9135555154&key=abc123×tamp=2010-01-14T09:35:00CDT&sig=123abc456

Response
    <response>
    <mdn>9135555154</mdn>
    <lat>38.98163</lat>
    <lon>94.71923</lon>
    <oldLocation>OLD_LOCATION</oldLocation>
    </response>

Errors

  • INVALID_KEY The API key sent was invalid.
  • EXPIRED_KEY The API key has expired.
  • MDN_NOTVALID The MDN requested was not opted in.
  • INVALID_MDN Not a valid 10 digit number.
  • LOCATION_ERROR A service exception occoured on the server side.
  • EXHAUSTED_DIPS Exceeded transaction limit
  • Failure
  • Error

Location 4G (Click Here for the Definition)

location4g.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/location4g.{format}?{params}

Determines the location of a Sprint 4G Device that is opted in to a developer's account. In order to have your devices opted into this service please contact us.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key: You're API Key, click here to view.
  • MAC: The mac address of the 4G device you wish to locate.
  • Mdn (Optional): The 3G fallback mdn of the device you wish to locate.
  • Timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

    [HH] refers to a zero-padded hour between 00 and 23 (where 00 is only used to notate midnight at the start of a calendar day).

  • Signature: The MD5 Digest value of the parameters of the location service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • mac: The mac address of the device that was located.
  • lat: The latitude of the device.
  • lon: The longitude of the device.
  • accuracy: The accuracy of the location fix in meters.
  • oldLocation: Only appears if the location has been requested more than once in the last 5 minutes for this mdn.

Example

Request

Get:

    http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/location4g.xml?mac=0123456789ab&mdn=9135555154&key=abc123×tamp=2010-01-14T09:35:00CDT&sig=123abc456

Response
    <response>
    <mac>0123456789ab</mac>
    <lat>38.98163</lat>
    <lon>94.71923</lon>
    <oldLocation>OLD_LOCATION</oldLocation>
    </response>

Errors

  • INVALID_KEY The API key sent was invalid.
  • EXPIRED_KEY The API key has expired.
  • MAC_NOTVALID The MDN requested was not opted in.
  • MDN_NOTVALID The MDN requested was not opted in.
  • INVALID_MAC Not a valid 12 character mac address.
  • INVALID_MDN Not a valid 10 digit number.
  • LOCATION_ERROR A service exception occurred on the server side.
  • EXHAUSTED_DIPS Exceeded transaction limit
  • Failure
  • Error

Messaging Services

A series of network messaging services.

SMS (Click Here for the Definition)

sms.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/sms.{format}?{params}

A service to send SMS messages to sprint CDMA Devices.

Authentication

This method requires a generated MD5 signature.

Arguments

  • Mdn: The MDN of the device you wish to send a sms.
  • key: You're API Key, click here to view.
  • senderName: Your name.
  • Message: The SMS message body.
  • Timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

    [HH] refers to a zero-padded hour between 00 and 23 (where 00 is only used to notate midnight at the start of a calendar day).

  • Signature: The MD5 Digest value of the parameters of the sms service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • mdn: The mdn of the device that the message was sent to.
  • sms: The message that was sent from the service.
  • tranno: The tracking-number of the message, used by the SMS-Status Service.

Example

Request

Get:

    http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/sms.xml?mdn=9135551234&senderName=Developer&message=Welcome%20to%20the%20sandbox&key=abc123×tamp=2010-01-14T15:12:00CST&sig=abc123def456

Response
    <response>
    <mdn>9135551234</mdn>
    <tranno>6145260</tranno>
    </response>

Errors

  • INVALID_KEY The API key sent was invalid.
  • EXPIRED_KEY The API key has expired.
  • MDN_NOTVALID The MDN requested is not opted in.
  • INVALID_MDN Not a valid 10 digit number.
  • EXHAUSTED_DIPS Exceeded transaction limit
  • Failure
  • Error

SMS Status (Click Here for the Definition)

smsstatus.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/smsstatus.{format}?{params}

Authentication

This method requires a generated MD5 signature.

Arguments

  • Mdn: The MDN of the device to be located.
  • key: You're API Key, click here to view.
  • Tranno: the tracking number of the sms you would like to track.
  • Timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

    [HH] refers to a zero-padded hour between 00 and 23 (where 00 is only used to notate midnight at the start of a calendar day).

  • Signature: The MD5 Digest value of the parameters of the sms status service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • tranno: The tracking-number of the message, used by the SMS-Status Service.
  • mdn: The status of the messages delivery.

Example

Request

Get:

    http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/smsstatus.xml?mdn=9135551234&tranno=6145260&key=e97c4aaaeb9fbe91×tamp=2010-01-15T12:30:00CST&sig=def12abc321


Response
    <response>
    <tranno>6171525</tranno>
    <mdn>DeliveryUncertain</mdn>
    </response>
  • Note that DeliveryUncertain means that the message was successfully delivered
  • DeliveryUnpossible means that the message was not successfully delivered
  • statusFailure means that the service was unable to determine if the message has been delivered

Errors

  • INVALID_KEY The API key sent was invalid.
  • EXPIRED_KEY The API key has expired.
  • MDN_NOTVALID The MDN requested is not opted in.
  • INVALID_MDN Not a valid 10 digit number.
  • EXHAUSTED_DIPS Exceeded transaction limit
  • Failure
  • Error

presence.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/presence.{format}?{params}

A A service to determine if a device is present on the Sprint cdma network.

Authentication

This method requires a generated MD5 signature.

Arguments

  • Mdn: The MDN of the device you would like to see the status of.
  • key: You're API Key, click here to view.
  • Timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

    [HH] refers to a zero-padded hour between 00 and 23 (where 00 is only used to notate midnight at the start of a calendar day).

  • Signature: The MD5 Digest value of the parameters of the presence service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • mdn: The mdn of the device checked.
  • status: The status of the device.

Example

Request

Get:

    http://www.sprintdevelopersandbox.com/developerSandbox/resources/v1/presence.txt?mdn=8165553456&key=ABCD123XYZ×tamp=2009-10-01T12:00:00CDT&sig=123abc456


Response
    <response>
    <mdn>9132212444$&t;/mdn>
    <status>Reachable$&t;/status>
    </response>

Errors

  • INVALID_KEY The API key sent was invalid.
  • EXPIRED_KEY The API key has expired.
  • MDN_NOTVALID The MDN requested is not opted in.
  • INVALID_MDN Not a valid 10 digit number.
  • EXHAUSTED_DIPS Exceeded transaction limit
  • Failure
  • Error

User Management Services:

A series of services to allow for dynamic user management.

Devices **Plural (Click Here for the Definition)

devices.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/devices.{format}?{params}

A service to retrieve a developer's list of devices from the database.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key: You're API Key, click here to view.
  • type (optional): The type of devices you wish to receive a list of:
    • p: pending, a list of devices that have been added but the user has yet to either opt-in or out
    • a: approved, a list of devices that have approved their device to be a part of the sandbox
    • x: declined, a list of devices that have declined their device to be a part of the sandbox
    • d: deleted, a list of devices that have been deleted
    • mdn: retrieves the status of a single mdn
    • null: retrieves a list of all mdns active,deleted, and declined
  • mdn (optional): the mdn of a single device, used to check the status of the device
  • Timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

    [HH] refers to a zero-padded hour between 00 and 23 (where 00 is only used to notate midnight at the start of a calendar day).

  • Signature: The MD5 Digest value of the parameters of the devices service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • userName: The userName of the developer who owns the list.
  • status: The status of the list: All, Approved, Declined, and Deleted
  • mdn: The mdn of the device.

Example

Request

Get:

    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/devices.xml?key=abc123&type=p×tamp=2010-01-14T13:47:00CST&sig=abc123def456

Response
    <devices user="jrrall">
    <status>ALL</status>
    <devices>9137075431</devices>
    <devices>7855654020</devices>
    <devices>9132312142</devices>
    <devices>7853412486</devices>
    </devices>

Errors

  • INVALID_KEY: INVALID_KEY The API key sent was invalid.
  • EXPIRED_KEY The API key has expired.
  • PHONE LIST_ERROR: Service Exception on server side.

Device **Singular (Click Here for the Definition)

device.{format}

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/device.{format}?{params}

A service for adding/deleting devices from a developers account.

Authentication

This method requires a generated MD5 signature.

Arguments

  • key: The developer API Key, click here to view.
  • method: The operation being preformed to the device.
    • add: Adds a new device to the developer's account.
    • delete: Removes a device from the developer's account.
  • mdn: the mdn of the device.
  • Timestamp: The current time of the request: [YYYY]-[MM]-[DD]T[HH]:[MM]:[SS][ZZZ]

    [HH] refers to a zero-padded hour between 00 and 24 (where 24 is only used to notate midnight at the end of a calendar day).

  • Signature: The MD5 Digest value of the parameters of the device service and your secret. The directions for generating this signature can be found here.

Http Method

Get

Response

  • userName: The userName of the developer who owns the list.
  • status: The status of the list: All, Approved, Declined, and Deleted
  • mdn: The mdn of the device.

Example

Request

Post:

    http://sprintdevelopersandbox.com/developerSandbox/resources/v1/device.xml?key=abc123&method=add×tamp=2010-01-14T13:47:00CST&sig=abc123def456

Response
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <device>
    <mdn>7675554321</mdn>
    <message>SUCCESS</message>
    </device>

Errors

  • INVALID_KEY: INVALID_KEY The API key sent was invalid.
  • EXPIRED_KEY The API key has expired.
  • INVALID_MDN: The MDN entered is not a valid MDN.
  • MAX_DEVICE_FOR_TRIAL: Sandbox trial keys are limited to 5 devices.
  • NON_UNIQUE

iden

http://sprintdevelopersandbox.com/developerSandbox/resources/v1/iden?{params}

A service meant to upload applications to iDen devices.

Authentication

This method requires token based authentication.

Arguments

  • key: The developer API Key, click here to view.
  • ptn: The PTN of the device you would like to send the application to.
  • appLink - Link to the application (Zip file that has Jad and Jar)
  • appSize - Exact Size of the Zip file in bytes.

Instructions

  1. Build your application (jar/jad)
  2. Zip your jar/jad files together
  3. record the size in bytes of the zip file
  4. place the zip file on your server in place where there is a public url to fetch it for example: (www.yoursite.com/some/directory/appname.zip)
  5. send request to Sprint ADP Sandbox service including:
    1. you developer key
    2. the PTN (phone number) of phone to send app to
    3. the url to the zip file
    4. the size of the zip file
  6. User will download/install app from phone using the Download Apps program found in the Java menu.

Additional Instructions

If you are utilizing this service from a website (PC or Mobile)
  1. You will need to get the users phone number
  2. Make the iDEN Content Uploader service call and pass the files into Sprint
  3. Show a message to the user on the screen (PC or Mobile) on how to download the app to their device 'To download your requested application, Please go to Menu -> Java Apps -> Download Apps -> New Purchases to download the Application'

Http Method

Post

Response

  • Message: a message detailing if the application was successfully added to the device.

Example

Request

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
											
											

Errors

  • INVALID_KEY: INVALID_KEY The API key sent was invalid.
  • EXPIRED_KEY The API key has expired.
  • PHONE LIST_ERROR: Service Exception on server side.