UserEndpoint
The following resources are applicable:
- /user/balance/get
- /user/create
- /user/delete
- /user/feature/get
- /user/login
- /user/msisdn/verify
- /user/password/change
- /user/password/reset
- /user/setting/get
- /user/setting/set
- /user/smsrouting/get
- /user/smsrouting/set
/user/balance/get
Mount Point: /rest/user/balance/get
POST
Returns the user's free sms and credits.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userGetBalanceRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userGetBalanceResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/create
Mount Point: /rest/user/create
POST
Creates an new user with a verified mobile number. The API Key needs the right to do that.
Error Codes
| 1 | Method is not allowed by this api key |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 102 | The password has a wrong format (4-15 chars) |
| 400 | The msisdn verify pin is invalid |
| 404 | The check is blocked for a specific time, because some wrong checks were made |
| 500 | The country is not allowed to login or register |
| 501 | The msisdn is invalid for the country |
| 600 | The api key is invalid |
Request Body
| element: | userCreateRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userCreateResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/delete
Mount Point: /rest/user/delete
POST
Deletes an user.
Error Codes
| 1 | Method is not allowed by this api key |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userDeleteRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userDeleteResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/feature/get
Mount Point: /rest/user/feature/get
POST
Returns the user's features.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userGetFeatureRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userGetFeatureResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/login
Mount Point: /rest/user/login
POST
Authenticates an user and returns the auth token which have to be used on any following api call to a method which needs authentication.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 101 | The credentials are wrong |
| 107 | The user msisdn not exists |
| 108 | The key is wrong |
| 109 | The login is blocked for a specific time, because some wrong logins were made |
| 600 | The api key is invalid |
Request Body
| element: | userLoginRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userLoginResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/msisdn/verify
Mount Point: /rest/user/msisdn/verify
POST
Verifies a user's msisdn.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 103 | The given msisdn is already registered |
| 400 | The msisdn verify pin is invalid |
| 404 | The check is blocked for a specific time, because some wrong checks were made |
| 600 | The api key is invalid |
Request Body
| element: | userVerifyMsisdnRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userVerifyMsisdnResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/password/change
Mount Point: /rest/user/password/change
POST
Updates a user password with an new one. On success the authToken is invalid and a new login is required.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 102 | The password has a wrong format (4-15 chars) |
| 600 | The api key is invalid |
Request Body
| element: | userChangePasswordRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userChangePasswordResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/password/reset
Mount Point: /rest/user/password/reset
POST
Generates a new password and send's it to the user. On success the authToken is invalid and a new login is required.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 104 | The password reset was blocked, because a new password was requested shortly. Use the last password or wait some time. |
| 600 | The api key is invalid |
Request Body
| element: | userResetPasswordRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userResetPasswordResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/setting/get
Mount Point: /rest/user/setting/get
POST
Gives the current user settings.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userGetSettingRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userGetSettingResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/setting/set
Mount Point: /rest/user/setting/set
POST
Sets the user settings.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userSetSettingRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userSetSettingResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/smsrouting/get
Mount Point: /rest/user/smsrouting/get
POST
Gives the sms routing for a recipient msisdn.
Error Codes
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userGetSmsRoutingRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userGetSmsRoutingResponse |
| media types: | */* application/xml application/json |
(no documentation provided)
/user/smsrouting/set
Mount Point: /rest/user/smsrouting/set
POST
Sets the sms routing for a recipient msisdn.
Error Codes
| 2 | A required parameter was not given |
| 97 | The access to the api was denied |
| 98 | You made too much requests in a short time |
| 99 | The service is currently not available |
| 100 | The auth token is invalid |
| 600 | The api key is invalid |
Request Body
| element: | userSetSmsRoutingRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | userSetSmsRoutingResponse |
| media types: | */* application/xml application/json |
(no documentation provided)