Skip to content

Latest commit

 

History

History
34 lines (33 loc) · 1.54 KB

User status.md

File metadata and controls

34 lines (33 loc) · 1.54 KB

User status

Used to retrieve the services status of the user identified by the id.

Remember to provide the authentication HTTP headers as described in the Authenticate using a session key and the Authenticate using a user tokeny sections.
All the query string parameters in URL must be UTF-8 URL Encoded.

HTTP Headers

user_key / Session_key

HTTP Method

GET

HTTP Request

https://app.gateway.smsend.it/API/v1.0/REST/status?getMoney={value}

Parameters

Parameter Type Description Required Default
getMoneyString “true” or “false”Add user current money to responseNo"false"
typeAliasesString “true” or “false”Returns the actual names for the message types instead of the internal ID. This is not done by default only because of retrocompatibility issues.No, but suggested"false"

Returns

Code Description
200A Json object representing the user status
400Other errors, details are in the body
401[Unauthorized] User_key, Token or Session_key are invalid or not provided
404[Not found] Credentials are incorrect