User Management
User Management Services:
A series of services to allow for dynamic user management.
Devices **Plural
-
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).
- sig: 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.
- authorizationStatus: The status of the list: All, Approved, Declined, and Deleted
- devices: A list of all MDNs with the requested status
-
Example
- Request
- Response
-
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.
Get:
http://sprintdevelopersandbox.com/developerSandbox/resources/v1/devices.xml?key=abc123&type=p×tamp=2010-01-14T13:47:00CST&sig=abc123def456
<devices user="jrrall">
<authorizationStatus>ALL</authorizationStatus>
<devices>9137075431-7855654020-913231214-7853412486</devices>
</devices>
Device **Singular
-
device.{format}
- http://sprintdevelopersandbox.com/developerSandbox/resources/v1/presence.{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).
- sig: 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
- Response
-
Errors
-
- INVALID_KEY: INVALID_KEY The API key sent was invalid.
- EXPIRED_KEY The API key has expired.
- INVALID_MDN:
- NON_UNIQUE
Post:
http://sprintdevelopersandbox.com/developerSandbox/resources/v1/device.xml?key=abc123&method=add×tamp=2010-01-14T13:47:00CST&sig=abc123def456
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<device>
<mdn>7675554321</mdn>
<message>SUCCESS</message>
</device>